spire-config-default

Default config preset for Spire.

• Quick Start
• Plugins
• Options
• License

Quick Start

Note: this module is shipped by default with Spire. Only install it directly if you want to build your preset on top of it.

1. Install spire-config-default:

# yarn
yarn add spire-config-default

# npm
npm install --save spire-config-default

2. Extend it in your config or preset:

module.exports = () => ({
  extends: [['spire-config-default', options]],
});

Plugins

This preset includes next plugins with their default options:

• spire-plugin-clean
• spire-plugin-doctoc
• spire-plugin-eslint
• spire-plugin-jest
• spire-plugin-lint-staged
• spire-plugin-prettier

Options

This preset allows to disable or override default options for plugins. To do so, pass an option object with desired plugin keys (clean, doctoc, eslint, jest, lint-staged or prettier). Setting option to false will disable that plugin.

module.exports = () => ({
  extends: [
    [
      'spire-config-default',
      {
        // Disable `spire-plugin-doctoc`
        doctoc: false,
        // Override `spire-plugin-jest`'s config to `jest-preset-acme`
        jest: 'jest-preset-acme',
        // Override `spire-plugin-eslint`'s config and disallow user-provided one
        eslint: {
          config: 'eslint-config-acme',
          allowCustomConfig: false,
        },
      },
    ],
  ],
});

Refer to individual plugin docs for list of available options.

License

MIT © ResearchGate