https://github.com/bitauth/eslint-config-bitauth
eslint configuration for bitauth projects
https://github.com/bitauth/eslint-config-bitauth
Last synced: 6 months ago
JSON representation
eslint configuration for bitauth projects
- Host: GitHub
- URL: https://github.com/bitauth/eslint-config-bitauth
- Owner: bitauth
- Created: 2020-02-11T21:11:54.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T21:07:29.000Z (about 2 years ago)
- Last Synced: 2025-03-11T21:59:21.252Z (about 1 year ago)
- Language: JavaScript
- Size: 1.23 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# eslint-config-bitauth
A very strict eslint configuration, including rules which require:
- a functional programming style
- properly-used eslint comments
- sorted and properly ordered imports
- properly formatted TSDoc comments
- strictly formatted code (prettier-compliant)
- nearly all eslint and @typescript-eslint rules
## Install
First, configure your project for [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint). Then install `eslint-config-bitauth` and the required plugins.
```
npm install --dev eslint @typescript-eslint/parser eslint-config-bitauth eslint-plugin-functional eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-tsdoc eslint-plugin-prettier
```
Then add `bitauth` to the `extends` array in your ESLint configuration.
Example `.eslintrc`:
```jsonc
{
"root": true,
"parser": "@typescript-eslint/parser",
"parserOptions": { "project": "./tsconfig.json" },
"env": { "es6": true },
"ignorePatterns": ["node_modules", "build", "coverage"],
"extends": ["bitauth"],
"globals": { "BigInt": true, "WebAssembly": true },
"rules": {
// rule overrides:
"example-rule": "off"
}
}
```