Skip to content

rthor/cra-generate

Repository files navigation

React Component Generator

Scaffold a React component for Create React App.

Usage: cra-generate [options] <component>

Options:
  -h, --help                       output usage information
  -V, --version                    output the version number
  -f, --functional                 create a functional component
  -t, --type-check [system]        add @flow comment to script files
  -c, --css-extension [extension]  changes the extension of generated css files
  -d, --directory [dir]            specify a directory for the component
      --test [type]                either "jest" or "none"
      --no-semi                    remove semicolons

If a .flowconfig is present, a // @flow comment is prepended to all script files.

Project specific settings can be added to the package.json file under the craGenerate key. Eg

"craGenerate": {
  "fileFormat": "paramCase",
  "cssExtension": "scss",
  "directory": "widgets"
}
option type default description
directory string "components" Where, relative to the ./src/ directory, the component should be.
fileFormat string "pascalCase" One of: camelCase, constantCase, headerCase, paramCase, pascalCase or snakeCase.
componentFormat string "pascalCase" One of: camelCase, constantCase, headerCase, paramCase, pascalCase or snakeCase.
typeCheck `undefined string` undefined
cssExtension string "css" File extensions, with or without a dot.
semi `true false` true
test `false string` "jest"

License

MIT