@sewing-kit/plugin-eslint

This package provides a sewing-kit plugin that runs ESLint as part of the sewing-kit lint command.

Installation

1yarn add @sewing-kit/plugin-eslint --dev

eslint()

The eslint function returns a sewing-kit plugin. This plugin applies to the workspace, not an individual project.

1import {createWorkspace} from '@sewing-kit/core';
2import {eslint} from '@sewing-kit/plugin-eslint';
3
4export default createWorkspace((workspace) => {
5  workspace.use(eslint());
6});

By default ESLint runs over everything in the current folder. You can modify the files that are processed by passing in a files glob to the plugin's options.

1export default createWorkspace((workspace) => {
2  // Run eslint on a single subfolder
3  workspace.use(pretttier({files: 'some-subfolder/**/*'}));
4});

Hooks

This plugin adds the following hooks to LintWorkspaceConfigurationCustomHooks:

• eslintFlags: an object of options to convert into command line flags for the eslint command. These options are camelcase versions of their CLI counterparts.

  1import {createWorkspaceLintPlugin} from '@sewing-kit/core';
  2
  3const plugin = createWorkspaceLintPlugin(({hooks}) => {
  4  hooks.configure.hook((configure) => {
  5    // Modify the maximum number of allowed warnings from the default of 0
  6    configure.eslintFlags?.hook((flags) => ({
  7      ...flags,
  8      maxWarnings: 5,
  9    }));
  10  });
  11});