1.0.8 • Published 4 months ago

create-tailwind-type v1.0.8

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

Create Tailwind Type

Generate TypeScript definitions for your Tailwind CSS configuration.

npx create-tailwind-type

!IMPORTANT
Requires Tailwind CSS v4.0.0 or higher.


Usage Examples

  • Use custom plugins

Should change base directory to node_modules/tailwindcss for your own project.

npx create-tailwind-type -b node_modules/tailwindcss
  • Generate exact variants

Will generate exact variants instead of soft variants. But slowdown typescript language server, if you use it directly. (Importing subtype will be fine.)

npx create-tailwind-type -S
  • Change output filename

Will generate types in src/types/tailwind.d.ts file.

npx create-tailwind-type -f src/types/tailwind.d.ts

CLI Options

Option (Short)Option (Long)DescriptionDefault ValueExample Usage
-b--base <path>Specifies the base directory for @tailwindcss/node package. If omitted, the tool automatically resolves to the installed @tailwindcss package directory.None (auto-resolved)npx create-tailwind-type -b ./custom
-f--filename <filename>Sets the output filename for the generated types.tailwind.tsnpx create-tailwind-type -f customTypes.ts
-d--docsEnables documentation comments in the generated types. Use the inverse flag to disable them.truenpx create-tailwind-type or npx create-tailwind-type --docs
-D--no-docsDisables documentation comments in the generated types.N/Anpx create-tailwind-type --no-docs
-a--arbitrary-valueAllows the generation of arbitrary values in the output types. Use the inverse flag to disable this feature.truenpx create-tailwind-type or npx create-tailwind-type --no-arbitrary-value
-A--no-arbitrary-valueDisables arbitrary value generation.N/Anpx create-tailwind-type --no-arbitrary-value
-s--soft-variantsEnables soft variant generation. When disabled (using the inverse flag), the tool will generate exact variants instead.truenpx create-tailwind-type or npx create-tailwind-type --no-soft-variants
-S--no-soft-variantsDisables soft variant generation (resulting in exact variant generation).N/Anpx create-tailwind-type --no-soft-variants
-k--string-kind-variants-onlyLimits the generated types to only string kind variants.falsenpx create-tailwind-type --string-kind-variants-only
-o--optional-propertyGenerates optional properties in the output types, which can be useful for partial configurations.falsenpx create-tailwind-type --optional-property
-N--disable-variantsDisable variant generation and types, can be increase performance.falsenpx create-tailwind-type --disable-variants
N/A--versionDisplays the current CLI version.N/Anpx create-tailwind-type --version
N/A--helpDisplays help and usage information for the CLI tool.N/Anpx create-tailwind-type --help

Detailed Option Descriptions

-b, --base <path>

Specifies a custom base directory for locating Tailwind CSS files.

  • Default: Automatically resolves to the installed @tailwindcss package directory.
  • Example:
    npx create-tailwind-type -b ./custom

-f, --filename <filename>

Determines the output filename for the generated TypeScript types.

  • Default: tailwind.ts
  • Example:
    npx create-tailwind-type -f customTypes.ts

-d, --docs / --no-docs

Controls whether documentation comments are included in the generated types.

  • Default: Enabled (true)
  • Examples:
    • To enable (or use the default):
      npx create-tailwind-type --docs
    • To disable:
      npx create-tailwind-type --no-docs

-a, --arbitrary-value / -A, --no-arbitrary-value

Toggles support for arbitrary value generation in the output types.

  • Default: Enabled (true)
  • Examples:
    • To enable (or use the default):
      npx create-tailwind-type --arbitrary-value
      npx create-tailwind-type -a
    • To disable:
      npx create-tailwind-type --no-arbitrary-value
      npx create-tailwind-type -A

-s, --soft-variants / -S, --no-soft-variants

Manages soft variant generation. Disabling this option will instead produce exact variant types.

  • Default: Enabled (true)
  • Examples:
    • To enable soft variants (default behavior):
      npx create-tailwind-type --soft-variants
      npx create-tailwind-type -s
    • To disable soft variants (and generate exact variants):
      npx create-tailwind-type --no-soft-variants
      npx create-tailwind-type -S

-k, --string-kind-variants-only

Limits the generated types to only string kind variants, which might be preferred in certain setups.

  • Default: false
  • Example:
    npx create-tailwind-type --string-kind-variants-only
    npx create-tailwind-type -k

-o, --optional-property

Instructs the CLI to generate optional properties within the TypeScript definitions.

  • Default: false
  • Example:
    npx create-tailwind-type --optional-property
    npx create-tailwind-type -o

-N, --disable-variants

Instructs the CLI to disable variant generation.

  • Default: false
  • Example:
    npx create-tailwind-type --disable-variants
    npx create-tailwind-type -N

Usage Examples

Basic Usage (with defaults)

Generate types using all the default settings:

npx create-tailwind-type

Specify a Custom Base Directory and Output Filename

Use a custom directory for Tailwind CSS files and specify a custom filename:

npx create-tailwind-type --base ./custom --filename customTypes.ts
npx create-tailwind-type -b ./custom -f customTypes.ts

Disable Documentation and Arbitrary Value Generation

Generate types without documentation comments and without arbitrary values:

npx create-tailwind-type --no-docs --no-arbitrary-value
npx create-tailwind-type -D -A

Generate Exact Variants and Enable Optional Properties

Disable soft variants (thus generating exact variants) and produce optional properties in the types:

npx create-tailwind-type --no-soft-variants --optional-property
npx create-tailwind-type -S -o
1.0.8

4 months ago

1.0.7

4 months ago

1.0.2

4 months ago

1.0.1

4 months ago

1.0.6

4 months ago

1.0.5

4 months ago

1.0.4

4 months ago

1.0.3

4 months ago

1.0.0

4 months ago