@necro-fantasia/eslint-config v0.3.0

@necro-fantasia/eslint-config

An ESLint Shareable Config for @necro-fantasia packages.

Install

# Using npm
npm install @necro-fantasia/eslint-config --save-dev
# Using yarn
yarn add @necro-fantasia/eslint-config --dev

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

Add the necessary packages for this configuration:

# Using npm
npm install @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-no-secrets eslint-plugin-prettier eslint-plugin-simple-import-sort eslint-plugin-unicorn prettier --save-dev
# Using yarn
yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-no-secrets eslint-plugin-prettier eslint-plugin-simple-import-sort eslint-plugin-unicorn prettier --dev

Then, add this to your configuration file:

{
  "extends": "@necro-fantasia" // .eslintrc.json
}

extends:
  - "@necro-fantasia" # .eslintrc.yml || .eslintrc.yaml

module.exports = {
  extends: '@necro-fantasia' // .eslintrc.js
}

Note: We omitted the /eslint-config prefix since it is automatically assumed by ESLint and .eslintrc file is deprecated.

License

This project is licensed under the MIT license. Please see the license file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.