https://github.com/adhamu/zero
Formatting and linting configurations
https://github.com/adhamu/zero
emotion eslint jest node nvm prettier react stylelint tsconfig typescript vscode yarn
Last synced: 2 months ago
JSON representation
Formatting and linting configurations
- Host: GitHub
- URL: https://github.com/adhamu/zero
- Owner: adhamu
- Created: 2021-12-07T19:38:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-26T08:53:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T13:51:03.997Z (9 months ago)
- Topics: emotion, eslint, jest, node, nvm, prettier, react, stylelint, tsconfig, typescript, vscode, yarn
- Language: JavaScript
- Homepage:
- Size: 285 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zero
Shared linting and formatting configurations.
[](https://github.com/adhamu/zero/actions)
## Includes
- [Installation](#installation)
- [Requirements](#requirements)
- [Usage](#usage)
- [Quickstart](#quickstart)
- [Manual](#manual)
- [ESLint](#eslint)
- [Prettier](#prettier)
- [Stylelint](#stylelint)
- [TSConfig](#tsconfig)
- [Jest](#jest)
## Installation
```sh
yarn add @adhamu/zero -D
```
## Usage
### Setup Wizard
```sh
npx zero
```
### Manual
Alternatively, you can selectively install the configurations you need.
#### ESLint
```sh
cat > eslint.config.js << EOF
const eslintConfig = require('@adhamu/zero/eslint')
module.exports = eslintConfig
EOF
```
If you would like to override any settings:
```sh
cat > eslint.config.js << EOF
const eslintConfig = require('@adhamu/zero/eslint')
module.exports = [
...eslintConfig,
{
rules: {
'@typescript-eslint/no-explicit-any': 'warn',
},
},
]
EOF
```
##### Ignoring files
**Note** There is no longer an `.eslintignore`. To configure ignore patterns, you need to do something like:
```javascript
const eslintConfig = require('@adhamu/zero/eslint')
module.exports = [{ ignores: ['**/dist/*'] }, ...eslintConfig]
```
**Note** By default, anything in your `.gitignore` is automatically ignored by ESLint
- [See configurations](./eslint)
#### Prettier
```sh
cat > .prettierrc.yaml << EOF
"@adhamu/zero/prettier"
EOF
```
If you would like to override any Prettier settings, you can instead use a Javascript file:
```shell
cat > .prettierrc.js << EOF
module.exports = {
...require('@adhamu/zero/prettier'),
semi: true,
}
EOF
```
- [See configurations](./prettier)
#### Stylelint
```sh
cat > stylelint.config.js << EOF
const stylelintConfig = require('@adhamu/zero/stylelint')
module.exports = stylelintConfig
EOF
```
- [See configurations](./stylelint)
#### TSConfig
```sh
cat > tsconfig.json << EOF
{
"extends": "@adhamu/zero/tsconfig/base.json",
"include": ["src/**/*.ts"],
"compilerOptions": {
"outDir": "./dist"
}
}
EOF
```
- [See configurations](./tsconfig)
#### Jest
```sh
cat > jest.config.js << EOF
module.exports = {
...require('@adhamu/zero/jest'),
transform: { '^.+\\.ts(x)?$': 'ts-jest' },
}
EOF
```
Note: You will need to install your own transformer. Eg. `ts-jest`, `@swc/jest` etc.
- [See configuration](./jest)