@form8ion/eslint

opinionated scaffolder for managing the ESLint configuration for a project

!Node CI Workflow Statusgithub-actions-ci-badgegithub-actions-ci-link !Codecovcoverage-badgecoverage-link !SLSA Level 2slsa-badge

Table of Contents

• Features

Scaffolder Lifter

• Usage

Installation Example

* [Import](#import)
* [Execute](#execute)

• Contributing

Dependencies Verification

Features

Scaffolder

• creates an initial .eslintrc.yml config file for the project
• extends the base shareable eslint-config package defined by config.scope
• defines the lint and fix scripts
• ignores the cache file from the VCS

Lifter

• ignores linting of paths defined in

results.buildDirectory results.eslint.ignore.directories

• extends configs defined in results.eslint.configs, using the scope of the

base config already defined in the .eslintrc.yml

Usage

!MIT licenselicense-badgelicense-link !npmnpm-badgenpm-link !Try @form8ion/eslint on RunKitrunkit-badgerunkit-link !nodenode-badge

Installation

$ npm install @form8ion/eslint --save

Example

Import

import {lift, scaffold} from '@form8ion/eslint';

Execute

(async () => {
  await scaffold({projectRoot: process.cwd(), config: {scope: '@foo'}});

  await lift({
    projectRoot: process.cwd(),
    results: {
      eslint: {configs: ['mocha', 'react'], ignore: {directories: []}},
      buildDirectory: 'lib'
    }
  });
})();

Contributing

!PRs WelcomePRs-badgePRs-link !Commitizen friendlycommitizen-badgecommitizen-link !Conventional Commitscommit-convention-badgecommit-convention-link !semantic-releasesemantic-release-badgesemantic-release-link !Renovaterenovate-badgerenovate-link

Dependencies

$ nvm install
$ npm install

Verification

$ npm test