natterstefan / plop-action-eslint

A Plop action to lint files with ESLint and automatically format with Prettier.

plop-action-eslint

A Plop action to lint files with ESLint and automatically format with Prettier.

Table of Contents

• Installation
• Usage
  • Actions
• Prettier Support

Installation

npm install plop-action-eslint --save-dev

# or with yarn
yarn add plop-action-eslint -D

Usage

Before you can use plop-action-eslint, you have to load it into the plop object by adding the folling to your plopfile.js:

// plopfile.js
module.exports = async plop => {
  await plop.load('plop-action-eslint')
}

Once loaded, you have access the following actions.

Actions

eslint

Lints and fixes (autofix is enabled) the file of the given path with your projects ESLint configuration.

{
  type: "eslint",
  path: "src/component/{{pascalCase name}}.js",
}

You can also pass an array of paths.

{
  type: "eslint",
  path: [
    "src/component/{{pascalCase name}}.js",
    "src/component/{{pascalCase name}}.test.js",
  ],
}

Prettier Support

In order to automatically format your code with Prettier as well, you have to use eslint-config-prettier and eslint-plugin-prettier in your ESLint configuration.

How to release

Manually trigger release

# generate a new tag
yarn lerna:version

# generate a new Changelog entry
npx lerna-changelog --from <tag> --to <tag>
# add the result manually to CHANGELOG.md and commit it
git add CHANGELOG.md
git commit -m "chore: prepared release"

# push the tags
git push --tags

# publish the new version
yarn lerna:publish

License

MIT

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Stefan Natter 💻

Vytenis 💻

Ivan Holovin 💻

Oliver Lillie 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

This plop action is based on the code that was shared in plop#80 by FDiskas.

plop-action-eslint's Issues

[Feature] Allow passing an array of strings to actions's path property

Feature Request

Since eslint.lintFiles accepts string | string[] we need to pass an array of paths in order to run eslint on multiple files in different locations. As plopInstance.renderString() can be run only on string and cannot accept an array - we can modify the action to check if path is an array and map each item with plopInstance.renderString().

Basic example

    {
      type: "eslint",
      path: ["path1", "path2", ...],
    }

Motivation

If you use Plop to generate multiple files in different folders or you modify multiple files - currently it's not possible to pass multiple corresponding paths to the action.

Support node 18

Feature Request

Node 18 is now the official LTS version of node, but the package.json restricts installation to node 14 or 16. Can you remove/relax the engines restriction?