Kocal / eslint-config-generator

An opinionated ESLint config generator for my projects. Comes with AirBnB, Vue, TypeScript and Prettier support.

15/10/2023: This package is now archived

This package is now archived, I don't plan to maintain it anymore because I believe the community does not this kind of tool anymore since ESLint supports FlatConfig.

FlatConfig simplified the configuration sharing, it means that you can create a eslint.config.js file at the root of your project and import configs from npm packages like this:

import someConfig from "some-other-config-you-use";
import eslintConfigPrettier from "eslint-config-prettier";

export default [
  someConfig,
  {
    rules: {
      indent: "error",
    },
  },
  eslintConfigPrettier, // eslint-config-prettier last
];

ESLint config generator

An opinionated ESLint config generator for my projects. Comes with AirBnB, Vue, and TypeScript support.

Package	Version
@kocal/eslint-config-generator
@kocal/eslint-config-generator-common
@kocal/eslint-config-generator-plugin-typescript
@kocal/eslint-config-generator-plugin-vue

Features

• Use eslint-config-airbnb-base
• Support Vue, with eslint-plugin-vue and some opinionated rules
• Support TypeScript, with @typescript-eslint/plugin-eslint and some opinionated rules

Installation and usage

Please read the documentation to get started.

Vue support

Read Vue plugin's documentation.

TypeScript support

Read TypeScript plugin's documentation.

---

How to contribute

You need to install Rush.js first.

Then run:

$ rush install
$ rush build -v

Testing

$ rush test -v

Linting

$ rush lint
$ rush lint:fix

Contribution

• Make a pull request, its title should follows Angular commit message convention
• Rush rush change to describe your changes (they will be used to generate the CHANGELOG)

Publishing a new release

This is automatically done by GitHub Actions and Rush when a pull request is merged.