pkg() — tailwindcss Function Reference

Architecture documentation for the pkg() function in packages.ts from the tailwindcss codebase.

Function typescript UpgradeToolkit TemplateAnalysis calls 2 called by 2

Entity Profile

UpgradeToolkit→ TemplateAnalysis→ pkg() — tailwindcss Function Reference

Dependency Diagram

graph TD
  14c611e1_f56a_262f_0861_6fb84b21afb3["pkg()"]
  6403ca00_0447_9313_3bb5_f9ea44ca2dbb["packages.ts"]
  14c611e1_f56a_262f_0861_6fb84b21afb3 -->|defined in| 6403ca00_0447_9313_3bb5_f9ea44ca2dbb
  18049d5a_3e65_d6cd_49d2_32e825145fa2["migratePostCSSConfig()"]
  18049d5a_3e65_d6cd_49d2_32e825145fa2 -->|calls| 14c611e1_f56a_262f_0861_6fb84b21afb3
  6066f111_c660_b87d_6993_07d8cc779b5c["run()"]
  6066f111_c660_b87d_6993_07d8cc779b5c -->|calls| 14c611e1_f56a_262f_0861_6fb84b21afb3
  5bcf4886_1230_a8ff_7302_a26cc5a9a525["get()"]
  14c611e1_f56a_262f_0861_6fb84b21afb3 -->|calls| 5bcf4886_1230_a8ff_7302_a26cc5a9a525
  f1ca9393_701c_e4a7_8303_ed03f028d19b["error()"]
  14c611e1_f56a_262f_0861_6fb84b21afb3 -->|calls| f1ca9393_701c_e4a7_8303_ed03f028d19b
  style 14c611e1_f56a_262f_0861_6fb84b21afb3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/@tailwindcss-upgrade/src/utils/packages.ts lines 25–74

export function pkg(base: string) {
  return {
    async manager() {
      return await packageManagerForBase.get(base)
    },
    async add(packages: string[], location: 'dependencies' | 'devDependencies' = 'dependencies') {
      let packageManager = await packageManagerForBase.get(base)
      let args = packages.slice()
      if (location === 'devDependencies') {
        args.push(SAVE_DEV[packageManager] || SAVE_DEV.default)
      }

      // Allow running the `pnpm` command in the workspace root without
      // erroring. Can't just use `--workspace-root` because that will force
      // install dependencies in the workspace root.
      if (packageManager === 'pnpm') {
        args.push('--ignore-workspace-root-check')
      }

      let command = `${packageManager} add ${args.join(' ')}`
      try {
        return await exec(command, { cwd: base })
      } catch (e: any) {
        error(`An error occurred while running \`${command}\`\n\n${e.stdout}\n${e.stderr}`, {
          prefix: '↳ ',
        })
        throw e
      } finally {
        manifests.delete(base)
      }
    },
    has(name: string) {
      return manifests.get(base).includes(`"${name}":`)
    },
    async remove(packages: string[]) {
      let packageManager = await packageManagerForBase.get(base)
      let command = `${packageManager} remove ${packages.join(' ')}`
      try {
        return await exec(command, { cwd: base })
      } catch (e: any) {
        error(`An error occurred while running \`${command}\`\n\n${e.stdout}\n${e.stderr}`, {
          prefix: '↳ ',
        })
        throw e
      } finally {
        manifests.delete(base)
      }
    },
  }
}