Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommy-mitchell/eslint-config-xo
Personal config for XO.
https://github.com/tommy-mitchell/eslint-config-xo
xo xo-config
Last synced: 8 days ago
JSON representation
Personal config for XO.
- Host: GitHub
- URL: https://github.com/tommy-mitchell/eslint-config-xo
- Owner: tommy-mitchell
- License: mit
- Created: 2024-02-18T00:03:23.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-22T01:38:45.000Z (3 months ago)
- Last Synced: 2024-09-22T04:48:14.665Z (about 2 months ago)
- Topics: xo, xo-config
- Language: JavaScript
- Homepage: https://npm.im/@tommy-mitchell/eslint-config-xo
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# @tommy-mitchell/eslint-config-xo
Personal config for [`XO`](https://github.com/xojs/xo). Recommended to be used with my [`dprint` config](https://github.com/tommy-mitchell/dprint-config).
## Install
```sh
npm install --save-dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprint-config dprint
```
Other Package Managers
```sh
yarn add --dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprint-config dprint
```
### Peer Dependencies
- [xo](https://github.com/xojs/xo) - JavaScript/TypeScript linter (ESLint wrapper) with great defaults.
- [dprint](https://github.com/dprint/dprint) (*Optional*) - Pluggable and configurable code formatting platform written in Rust.
- [react](https://react.dev) (*Optional*) - The library for web and native user interfaces.
- [tailwindcss](https://tailwindcss.com) (*Optional*) - A utility-first CSS framework for rapid UI development.
## Usage
Add to the `extends` section of your `XO` config:
```jsonc
"extends": ["@tommy-mitchell/xo"],
```
### dprint
```jsonc
"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/dprint"],
```
### React
```jsonc
"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/react"],
```
#### React + dprint
```jsonc
"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/react", "@tommy-mitchell/xo/dprint"],
```
### Tailwind CSS
```jsonc
"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/tailwind"],
```
### VS Code
Add the following to your `settings.json`:
```jsonc
"xo.enable": true,
"xo.format.enable": true,
"xo.overrideSeverity": "warn",
```
## Related
- [XO (VS Code Extension)](https://marketplace.visualstudio.com/items?itemName=samverschueren.linter-xo) - Linter for XO.