https://github.com/jungsoft/eslint-config
Extensible ESLint shared config of JavaScript, TypeScript, ReactJS and React Native
https://github.com/jungsoft/eslint-config
eslint javascript react react-native
Last synced: about 1 year ago
JSON representation
Extensible ESLint shared config of JavaScript, TypeScript, ReactJS and React Native
- Host: GitHub
- URL: https://github.com/jungsoft/eslint-config
- Owner: jungsoft
- License: mit
- Created: 2020-07-23T13:09:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-08T05:16:02.000Z (about 5 years ago)
- Last Synced: 2025-04-12T19:14:13.502Z (about 1 year ago)
- Topics: eslint, javascript, react, react-native
- Language: JavaScript
- Homepage:
- Size: 526 KB
- Stars: 9
- Watchers: 0
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eslint Config Jungsoft
[](https://github.com/jungsoft/eslint-config/stargazers)
[](https://github.com/jungsoft/eslint-config/network/members)
[](https://github.com/jungsoft/eslint-config/graphs/contributors)
[](https://www.npmjs.com/package/@jungsoft/eslint-config)
This package provides extensible shared config of JavaScript, React and React Native rules
# :pushpin: Table of Contents
* [Installation](#construction_worker-installation)
* [Usage](#pushpin-usage)
* [License](#closed_book-license)
# :construction_worker: Installation
### With Yarn
```
npx install-peerdeps --dev @jungsoft/eslint-config --yarn
```
### With NPM
```
npx install-peerdeps --dev @jungsoft/eslint-config
```
And remove the peer-dependencies according to the shareable config that you're using, for instance, the typescript config won't need the ``eslint-import-resolver-typescript`` dependency
## :pushpin: Usage
This package includes the following configurations:
* [`@jungsoft`](./configurations/main.js) – The base rules of the config.
* [`@jungsoft`](./configurations/typescript.js) – The [TypeScript](https://www.typescriptlang.org/) config.
* [`@jungsoft/eslint-config/react`](./configurations/react.js) – Extends the base jungsoft configuration by adding [React](https://facebook.github.io/react/) related rules.
* [`@jungsoft/eslint-config/react-native`](./configurations/react-native.js) – Extends the base jungsoft configuration by adding [React Native](https://reactnative.dev/) related rules.
Example:
Shareable config for JavaScript projects
```json
{
"extends": [
"@jungsoft"
]
}
```
Shareable config for TypeScript projects
```json
{
"extends": [
"@jungsoft",
"@jungsoft/eslint-config/typescript"
]
}
```
Shareable config for React projects
```json
{
"extends": [
"@jungsoft/eslint-config/react"
]
}
```
Shareable config for React Native projects
```json
{
"extends": [
"@jungsoft/eslint-config/react-native"
]
}
```
And you can also override/add rules according to your needs
```
{
extends: [
"@jungsoft",
],
plugins: ['react', 'jsx-a11y'],
rules: {
"react/prop-types": 1,
"jsx-a11y/anchor-is-valid": ["warn", {
components: ["Link"],
specialLink: ["to"],
}],
}
}
```
# :closed_book: License
This project is under the [MIT license](https://github.com/jungsoft/eslint-config/master/LICENSE).
Made with love by [Laura Beatris](https://github.com/LauraBeatris) and contributors at [Jungsoft](https://jungsoft.io/) 💜🚀