Bojagi Docs

Bojagi Docs

  • Docs

›DOCUMENTATION

GETTING STARTED

  • Quick Start
  • Frequently Asked Questions

TUTORIALS

  • Setup Bojagi With React and Storybook
  • Setup Bojagi With React and Without Storybook

DOCUMENTATION

  • Write Stories
  • CLI
  • .bojagirc
  • Continuous Integration

CLI configuration file

The bojagi CLI supports config files for easier setup. It supports both JSON and js files and priorities in the following order:

  • .bojagirc.js
  • .bojagirc.json
  • .bojagirc (also JSON formatted)

Example .bojagirc.js file

Here's a .bojagirc.js file example overwriting some of the defaults:

module.exports = {
  storyPath: ['src/**/*.stories.@(tsx|ts|jsx|js)', 'src/**/*.bojagi.@(tsx|ts|jsx|js)'],
  storyPathIgnorePatterns: ['src/**/*.ignore.stories.@(tsx|ts|jsx|js)']
}

Configuration options

storyPath

Dir to search components in. Can be a glob.

namestoryPath
typestring|array
default['src/**/*.stories.@(tsx|ts|jsx|js)', 'src/**/*.bojagi.@(tsx|ts|jsx|js)']

storyPathIgnorePatterns

Files, that match storyPath but should be ignored regardless.

namestoryPathIgnorePatterns
typestring|array
default[]

decoratorPath

Path to search for the optional decorator file.

namedecoratorPath
typestring
default.bojagi/decorator.js

webpackConfig

Path to your webpack config file. If not set, auto detects if create-react-app is used and uses it's webpack config. Defaults to webpack.config.js otherwise.

namewebpackConfig
typestring
defaultcreate-react-app's config or webpack.config.js

executionPath

Path to execute the command in.

nameexecutionPath
typestring
defaultcurrent working directory
← CLIContinuous Integration →
  • Example .bojagirc.js file
  • Configuration options
    • storyPath
    • storyPathIgnorePatterns
    • decoratorPath
    • webpackConfig
    • executionPath
Bojagi
HomepageWeb AppGitHubIssue Tracker
Copyright © 2021 Bojagi