Neptune's Personal Maid

    @chakra-ui/cli

    2.0.0 • Public • Published

    @chakra-ui/cli

    Generate TypeScript types to provide autocomplete for your custom theme.

    Usage

    npx @chakra-ui/cli tokens <path/to/your/theme.(js|ts)>

    or

    npx @chakra-ui/cli tokens <@your-org/chakra-theme-package>
    $ npx @chakra-ui/cli --help
    
    Usage: chakra-cli tokens [options]
    
    Options:
      --out <path>  output directory e.g.
                    node_modules/@chakra-ui/styled-system/dist/declarations/src/theming.types.d.ts
      -h, --help    display help for command
    
    Example call:
      $ chakra-cli tokens theme.ts

    Note 🚨: If you delete the node_modules directory, you'll need to re-run the command to get proper typings again.

    For convenience, you can add a postinstall script to your package.json, so you don't have to think about this every time you re-install your dependencies.

    "scripts": {
      "gen:theme-typings": "chakra-cli tokens <path/to/your/theme.(js|ts)>",
      "postinstall": "npm run gen:theme-typings"
    }

    Install

    npm i @chakra-ui/cli

    DownloadsWeekly Downloads

    27,111

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    78 kB

    Total Files

    34

    Last publish

    Collaborators

    • timkolberger
    • segunadebayo
    • _codebender828