https://github.com/danielc92/eslint-config-dc
reusable linting config for eslint
https://github.com/danielc92/eslint-config-dc
Last synced: 3 months ago
JSON representation
reusable linting config for eslint
- Host: GitHub
- URL: https://github.com/danielc92/eslint-config-dc
- Owner: danielc92
- License: mit
- Created: 2023-04-29T05:07:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-04T05:53:52.000Z (over 2 years ago)
- Last Synced: 2025-07-31T08:14:50.238Z (11 months ago)
- Language: TypeScript
- Size: 1.52 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-platypus
A reusable linting config for eslint with a focus on code quality and readability.
## getting started
#### Using default configuration
install
```
npm i --save-dev eslint-config-platypus
```
if you do not have typescript
```
npm i --save-dev typescript
```
create a eslint config file `.eslintrc.js`
```js
module.exports = { extends: ["eslint-config-platypus"] }
```
The default configuration contains rules for
- code quality
- formatting
- jest
- secrets
- typescript
#### Using the React add on
If you wish to use the React configuration, which includes linting rules for react, react hooks as well as jest dom, install these additional dependencies:
```
npm i eslint-plugin-jest-dom eslint-plugin-react eslint-plugin-react-hooks --save-dev
```
Next extend the eslint config
```js
module.exports = { extends: [
"eslint-config-platypus",
"eslint-config-platypus/react-addon"
] }
```