Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devrsi0n/eslint-config-prettify
A set of pretty eslint configs with prettier include. Support for React/TypeScript/ES2019.
https://github.com/devrsi0n/eslint-config-prettify
eslint-config eslint-configs react typescript
Last synced: about 1 month ago
JSON representation
A set of pretty eslint configs with prettier include. Support for React/TypeScript/ES2019.
- Host: GitHub
- URL: https://github.com/devrsi0n/eslint-config-prettify
- Owner: devrsi0n
- License: mit
- Created: 2018-06-19T11:34:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-08T01:50:44.000Z (almost 3 years ago)
- Last Synced: 2024-10-05T07:46:55.506Z (about 1 month ago)
- Topics: eslint-config, eslint-configs, react, typescript
- Language: JavaScript
- Homepage:
- Size: 853 KB
- Stars: 14
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-prettify
[](http://npm.im/eslint-config-prettify-base)
[](http://opensource.org/licenses/MIT)
[](https://github.com/prettier/prettier)
[](https://lerna.js.org/)
A set of prettify eslint configs with prettier and Airbnb rules include. Support for React/TypeScript/ES2019/Node.
This repo container 4 npm packages.
- `eslint-config-prettify-base` for ES2019 or Node project
- `eslint-config-prettify-react` for React JavaScript project
- `eslint-config-prettify-ts-base` for vanilla TypeScript project
- `eslint-config-prettify-ts-react` for React TypeScript project
## Quick start
Chose proper config 👆, and install dependencies. For example, `eslint-config-prettify-base`:
```bash
# Just those two dependencies, no need for extra parser, plugins or configs
yarn add --dev eslint eslint-config-prettify-base prettier
# Or using npm if you prefer
npm install --save-dev eslint eslint-config-prettify-base prettier
```
Upgrade your ESLint config
```json
// .eslintrc
{
"root": true,
"extends": ["eslint-config-prettify-base"]
}
```
## Configuration
### tsconfig path
`eslint-config-prettify-ts-react` and `eslint-config-prettify-ts-base` using command executing directory to detect `tsconfig.json`(for TypeScript path alias), try below configuration if you meet `Unable to resolve path to module ‘xxx’` error.
```js
{
"extends": ["eslint-config-prettify-base"],
"settings": {
"import/parsers": {
"@typescript-eslint/parser": [".ts", ".tsx"]
},
"import/resolver": {
// use /tsconfig.json
"typescript": {
// always try to resolve types under `@types` directory even it doesn't contain any source code, like `@types/unist`
"alwaysTryTypes": true,
// use /path/to/folder/tsconfig.json
"directory": "./path/to/folder"
},
// Multiple tsconfigs (Useful for monorepos)
// use a glob pattern
"typescript": {
"directory": "./packages/*/tsconfig.json"
},
// use an array
"typescript": {
"directory": [
"./packages/module-a/tsconfig.json",
"./packages/module-b/tsconfig.json"
]
},
}
}
```
## Development
This monorepo managed by [lerna](https://lerna.js.org/) with yarn workspace.
### Install dependencies
```bash
# Trigger 'lerna bootstrap'
yarn
```
### Test
Unit tests write with jest
```bash
yarn test
```
### Commit
Commit message lint by [commitlint](https://github.com/conventional-changelog/commitlint) with config `@commitlint/config-conventional`, scope must be package's names.For example, `fix(base): import module unsolved`.
### Publish
```bash
# Create package CHANGELOG.md, increase package.json version and git commit and tag
yarn run release
# Publish release version
yarn run publish
```