https://github.com/t99/eslint-config
A repository for keeping track of all of my ESLint configuration files.
https://github.com/t99/eslint-config
config eslint eslint-config eslintconfig linter-config linter-rules linting linting-config linting-rules
Last synced: 3 months ago
JSON representation
A repository for keeping track of all of my ESLint configuration files.
- Host: GitHub
- URL: https://github.com/t99/eslint-config
- Owner: T99
- License: gpl-3.0
- Created: 2022-06-24T16:21:24.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-17T17:52:32.000Z (about 2 years ago)
- Last Synced: 2025-02-18T07:16:38.995Z (4 months ago)
- Topics: config, eslint, eslint-config, eslintconfig, linter-config, linter-rules, linting, linting-config, linting-rules
- Language: JavaScript
- Homepage:
- Size: 242 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# `@t99/eslint-config`
A repository for keeping track of all of my ESLint configuration files.
### [Find @t99/eslint-config on NPM.](https://www.npmjs.com/package/@t99/eslint-config)
## Table of Contents
- [Installation](#installation)
- [License](#license)
## Installation
Install from NPM with
```
$ npm install --save-dev @t99/eslint-config
```
Then, add it to your local ESLint config:
##### For JS/CJS Configs (`.eslintrc.js`/`.eslintrc.cjs`):
```js
module.exports = {
extends: [
"@t99"
]
}
```
##### For JSON Configs (`.eslintrc.json`):
```json
{
"extends": [
"@t99"
]
}
```
##### For YAML/YML Configs (`.eslintrc.yaml`/`.eslintrc.yml`):
```yaml
extends:
@t99
```
### TypeScript Installation
Additionally, for TypeScript projects, you will need to configure the path to
your project's `tsconfig.json`. Extending this package will take care of all
other necessary setup for usage with TypeScript.
##### For JS/CJS Configs (`.eslintrc.js`/`.eslintrc.cjs`):
```js
module.exports = {
extends: [
"@t99"
],
parserOptions: {
project: "path/to/tsconfig.json"
}
}
```
##### For JSON Configs (`.eslintrc.json`):
```json
{
"extends": [
"@t99"
],
"parserOptions": {
"project": "path/to/tsconfig.json"
}
}
```
##### For YAML/YML Configs (`.eslintrc.yaml`/`.eslintrc.yml`):
```yaml
extends:
@t99
parserOptions:
project: "path/to/tsconfig.json"
```
## Building Your Own Shareable ESLint Config Repo/Package
Check out the official ESLint guide on doing so [here](https://eslint.org/docs/latest/developer-guide/shareable-configs).
## License
@t99/eslint-config is made available under the GNU General Public License v3.
Copyright (C) 2022 Trevor Sears