@thepeaklab/eslint-config NPM

@thepeaklab/eslint-config

An ESLint flat config with default settings.

Installation

Install the config:

npm i -D @thepeaklab/eslint-config

Setup config file in root folder:

// eslint.config.js
import tplConfig from '@thepeaklab/eslint-config';

export default tplConfig;

If any rules need to be modified for the project, simply extend the configuration:

// eslint.config.js

// ESM
import tplConfig from '@thepeaklab/eslint-config';

export default [
  ...tplConfig,
  {
    rules: {
      // rule overwrites
    },
  },
];

// CJS
const tplConfig = require('@thepeaklab/eslint-config');

module.exports = [
  ...tplConfig.default,
  {
    rules: {
      // rule overwrites
    },
  },
];

Visual Studio Code Support

Install the ESLint extension.

Copy the following settings into .vscode/settings.json:

{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "always",
    "source.fixAll.ts": "always",
    "source.removeUnusedImports": "always",
    "source.organizeImports": "always",
    "source.sortImports": "always"
  }
}

Contributing

Code of Conduct

Please read our Code of conduct to keep our community open and respectable. 💖

Want to help?

Want to report a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.

Security

If you believe you have found a security vulnerability, we encourage you to responsibly disclose this and not open a public issue. Security issues in this open source project can be safely reported via opensource@thepeaklab.com.