@tamagui/cli 2.7.7 → 3.0.0-0.canary.1791056644527

package/src/cli.ts

@@ -3,30 +3,62 @@ import chalk from 'chalk'
 
 import { disposeAll, getOptions } from './utils'
 
-// exit handlers
-;['exit', 'SIGINT'].forEach((_) => {
-  process.on(_, () => {
-    disposeAll()
-    process.exit()
-  })
-})
+process.on('exit', disposeAll)
 
 const COMMAND_MAP = {
   check: {
-    description: `Checks for inconsistent versions, duplicate installs, lockfile issues, and missing config.`,
+    description: `Checks flat style values, inconsistent versions, duplicate installs, lockfile issues, and missing config.`,
     shorthands: [],
     flags: {
       '--help': Boolean,
       '--debug': Boolean,
       '--verbose': Boolean,
+      '--styles-only': Boolean,
+      '--deps-only': Boolean,
+      '--strict': Boolean,
     },
     async run() {
       const { _, ...flags } = arg(this.flags)
       const options = await getOptions({
         debug: flags['--debug'] ? (flags['--verbose'] ? 'verbose' : true) : false,
+        loadTamaguiOptions: flags['--strict'] && !flags['--deps-only'],
       })
-      const { checkDeps } = require('@tamagui/static/checkDeps')
-      await checkDeps(options.paths.root)
+      if (!flags['--styles-only']) {
+        const { checkDeps } = require('@tamagui/static/checkDeps')
+        await checkDeps(options.paths.root)
+      }
+      if (flags['--deps-only']) return
+      if (flags['--strict']) {
+        if (!options.tamaguiOptions.config) {
+          throw new Error('Strict style checking requires a Tamagui config.')
+        }
+        const { loadTamagui } = require('@tamagui/static/loadTamagui')
+        process.env.TAMAGUI_KEEP_THEMES = '1'
+        const loaded = await loadTamagui(
+          { ...options.tamaguiOptions, platform: 'web' },
+          true
+        )
+        if (!loaded?.tamaguiConfig) {
+          throw new Error('Unable to load the Tamagui config for strict style checking.')
+        }
+      }
+      const { checkStyleFiles, formatCheckResults, MissingConfigArtifactError } =
+        require('@tamagui/language-service/check') as any
+      try {
+        const result = checkStyleFiles({
+          root: options.paths.root,
+          configPath: options.paths.conf,
+          strict: flags['--strict'],
+        })
+        console.info(formatCheckResults(result))
+        if (result.diagnosticCount > 0) process.exitCode = 1
+      } catch (error: any) {
+        if (error instanceof MissingConfigArtifactError && !flags['--strict']) {
+          console.warn(chalk.yellow(`skipping flat value check: ${error.message}`))
+          return
+        }
+        throw error
+      }
     },
   },
 
@@ -46,18 +78,7 @@ const COMMAND_MAP = {
       })
       const { loadTamagui } = require('@tamagui/static/loadTamagui')
       process.env.TAMAGUI_KEEP_THEMES = '1'
-      await loadTamagui({
-        ...options.tamaguiOptions,
-        platform: 'web',
-      })
-
-      // also generate prompt to .tamagui/prompt.md
-      const { generatePrompt } = require('./generate-prompt')
-      const { join } = require('node:path')
-      await generatePrompt({
-        ...options,
-        output: join(options.paths.dotDir, 'prompt.md'),
-      })
+      await loadTamagui({ ...options.tamaguiOptions, platform: 'web' }, true)
     },
   },
 
@@ -146,6 +167,38 @@ const COMMAND_MAP = {
     },
   },
 
+  icons: {
+    shorthands: [],
+    description: `Generate themed SVG icon components from Lucide, Heroicons, Phosphor, or a folder of svgs.`,
+    usage: `$ tamagui icons add Search ChevronDown
+$ tamagui icons add Copy --from phosphor --weight bold
+$ tamagui icons add Clipboard --from heroicons --variant solid
+$ tamagui icons add Logo --from ./assets/icons --out src/icons
+$ tamagui icons add Search=magnifying-glass --from phosphor`,
+    flags: {
+      '--help': Boolean,
+      '--from': String,
+      '--weight': String,
+      '--variant': String,
+      '--out': String,
+    },
+    async run() {
+      const { _, ...flags } = arg(this.flags)
+      const [_cmd, subcommand, ...names] = _
+      if (subcommand !== 'add') {
+        throw new Error('usage: tamagui icons add <Name...> [--from] [--out]')
+      }
+      const { addIcons } = require('./icons')
+      await addIcons({
+        names,
+        from: flags['--from'],
+        weight: flags['--weight'],
+        variant: flags['--variant'],
+        out: flags['--out'],
+      })
+    },
+  },
+
   build: {
     shorthands: ['b'],
     description: `Use to pre-build a Tamagui component directory. Use -- to run a command after optimization, then auto-restore files.`,
@@ -227,6 +280,68 @@ const COMMAND_MAP = {
     },
   },
 
+  setup: {
+    shorthands: [],
+    description: `Print an AI-agent prompt for adding Tamagui to a project for the first time`,
+    usage: `$ tamagui setup`,
+    flags: {
+      '--help': Boolean,
+    },
+    async run() {
+      const { printSetupPrompt } = require('./setup-prompt')
+      printSetupPrompt()
+    },
+  },
+
+  migrate: {
+    shorthands: [],
+    description: `Print an AI-agent prompt for migrating a Tamagui app to v3`,
+    usage: `$ tamagui migrate --from v2
+$ tamagui migrate --from v1`,
+    flags: {
+      '--help': Boolean,
+      '--from': String,
+    },
+    async run() {
+      const { _, ...flags } = arg(this.flags)
+      const [_cmd, fromArg] = _
+      const { printMigrationPrompt } = require('./migrate')
+
+      printMigrationPrompt({
+        from: flags['--from'] || fromArg,
+      })
+    },
+  },
+
+  'to-tailwind': {
+    shorthands: [],
+    description: `Convert Tamagui JSX props in files or globs to Tailwind className syntax`,
+    flags: {
+      '--help': Boolean,
+      '--write': Boolean,
+      // path to the app's tamagui config so token/media/shorthand resolution uses the app's
+      // ACTUAL scales, not the bundled default fallback.
+      '--config': String,
+      // acknowledge use of the bundled default scales (required for --write without --config).
+      '--use-default-config': Boolean,
+      // opt in to DOM renaming (View→div). default: preserve Tamagui components (RN-safe).
+      '--rename-dom': Boolean,
+    },
+    async run() {
+      const { _, ...flags } = arg(this.flags)
+      const { toTailwind } = require('./to-tailwind')
+      const [_cmd, ...patterns] = _
+
+      await toTailwind({
+        patterns,
+        write: flags['--write'],
+        configPath: flags['--config'],
+        useDefaultConfig: flags['--use-default-config'],
+        renameDom: flags['--rename-dom'],
+      })
+    },
+  },
+
   'update-template': {
     shorthands: ['ut'],
     description: `Used to update your git repo with the source template. (e.g. Takeout)`,
@@ -269,6 +384,31 @@ const COMMAND_MAP = {
       })
     },
   },
+
+  'preview-theme': {
+    shorthands: ['preview'],
+    description: `Preview a theme configuration in the browser on tamagui.dev/theme`,
+    usage: `$ tamagui preview-theme ./theme.json
+$ tamagui preview-theme --theme '{"palettes": ...}'
+$ tamagui preview-theme ./theme.json --print`,
+    flags: {
+      '--help': Boolean,
+      '--theme': String,
+      '--url': String,
+      '--print': Boolean,
+    },
+    async run() {
+      const { _, ...flags } = arg(this.flags)
+      const [_cmd, themeArg] = _
+      const { previewTheme } = require('./preview-theme')
+      await previewTheme({
+        theme: flags['--theme'],
+        themeArg,
+        url: flags['--url'],
+        print: flags['--print'],
+      })
+    },
+  },
 }
 
 type CommandDefinitions = typeof COMMAND_MAP
@@ -332,8 +472,13 @@ main()
 async function main() {
   if (flags['--help']) {
     console.info(`\n$ tamagui ${command}: ${definition.description}\n`)
+    if ('usage' in definition && definition.usage) {
+      console.info(`Usage:\n${definition.usage}\n`)
+    }
     console.info(
-      `Flags: ${Object.entries(definition.flags).map(([k, v]) => `${k} (${v.name})`)}`
+      `Flags:\n${Object.entries(definition.flags)
+        .map(([k, v]) => `  ${k} (${v.name})`)
+        .join('\n')}`
     )
     process.exit(0)
   }
@@ -354,7 +499,9 @@ async function main() {
     await definition.run()
   } catch (err: any) {
     console.error(`Error running command: ${err.message}`)
+    process.exit(1) // a thrown command error must be a NON-ZERO exit (safety: --write aborts)
   }
 
-  process.exit(0)
+  // `check` sets exitCode when it finds problems; a literal 0 would erase it
+  process.exit(process.exitCode ?? 0)
 }