pkg() — tailwindcss Function Reference

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

Function typescript CommandLineInterface Renderer calls 2 called by 2

Entity Profile

CommandLineInterface→ Renderer→ pkg() — tailwindcss Function Reference

Dependency Diagram

graph TD
  9cc0ff32_ad5a_9207_5cc6_12717c5ad23e["pkg()"]
  3570f589_2f69_c1ce_f4d4_16edf9b89280["packages.ts"]
  9cc0ff32_ad5a_9207_5cc6_12717c5ad23e -->|defined in| 3570f589_2f69_c1ce_f4d4_16edf9b89280
  0cb85618_1b33_b9dc_ae2b_1bc3e6bd6069["migratePostCSSConfig()"]
  0cb85618_1b33_b9dc_ae2b_1bc3e6bd6069 -->|calls| 9cc0ff32_ad5a_9207_5cc6_12717c5ad23e
  817bb61a_7ad0_1186_790a_6a40126eed80["run()"]
  817bb61a_7ad0_1186_790a_6a40126eed80 -->|calls| 9cc0ff32_ad5a_9207_5cc6_12717c5ad23e
  2820372c_b982_9e06_fc23_f8f4ac308d00["get()"]
  9cc0ff32_ad5a_9207_5cc6_12717c5ad23e -->|calls| 2820372c_b982_9e06_fc23_f8f4ac308d00
  6c5b3bb2_4069_e0af_8887_216e1c995446["error()"]
  9cc0ff32_ad5a_9207_5cc6_12717c5ad23e -->|calls| 6c5b3bb2_4069_e0af_8887_216e1c995446
  style 9cc0ff32_ad5a_9207_5cc6_12717c5ad23e 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)
      }
    },
  }
}