Vessel - Development configuration module

Pre-packaged configs for the Babel, ESLint, Jest, Prettier, and TypeScript drivers and developer tools. Inspired by @beemo/dev.

Installation

yarn add --dev @manifest-ui/vessel-dev

Setup

Create a .config/beemo.ts file in the root of your project that configures @manifest-ui/vessel-dev as the configuration module. Be sure to enable all drivers and any settings.

// .config/beemo.ts
export default {
  module: '@manifest-ui/vessel-dev',
  drivers: ['babel', 'eslint', 'jest', 'prettier', 'typescript'],
  settings: {},
};

Settings

The following Beemo settings can be defined and will be passed to applicable drivers.

• node (boolean) - Current project will target Node.js instead of the browser. Defaults to false.
• projects (boolean | string[]) - Enable Jest projects. If true is passed, will be resolved using workspaces, otherwise requires an array of explicit strings. Defaults to false.
• next (boolean) - Enable Next.js for all drivers. Defaults to false.
• react (boolean | classic | automatic) - Enable React and JSX support for all drivers. Defaults to false.

Overrides

If you would like to override a driver config, create a .config/beemo/<driver>.ts file in the root of the project. View the official Beemo docs for more information.

// .config/beemo/eslint.ts
export default {
  rules: {
    'no-param-reassign': 'off',
  },
};

Drivers

The following drivers are directly supported in this configuration module, and automatically passed common command line options when being ran.

• Babel
• ESLint
• Jest
• Prettier
• TypeScript

Please refer to their documentation for more information on how each one is configured.

Scaffolds

Once your project has been configured to use Beemo, you can scaffold specific files using our built-in templates.

project/dotfiles

Will scaffold common dotfiles like .gitignore.

beemo scaffold project dotfiles

project/package

Will append fields to the root package.json.

• Adds scripts for common actions like linting, testing, etc.

beemo scaffold project package