https://github.com/sholladay/eslint-config-tidy

ESLint shareable config for Tidy style.
https://github.com/sholladay/eslint-config-tidy

bugs detect eslint eslint-config eslint-rules fix formatting lint mistakes style

Last synced: 22 days ago
JSON representation

ESLint shareable config for Tidy style.

• Host: GitHub
• URL: https://github.com/sholladay/eslint-config-tidy
• Owner: sholladay
• License: mpl-2.0
• Created: 2016-07-11T19:32:40.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-29T10:57:28.000Z (11 months ago)
• Last Synced: 2024-04-14T00:25:25.261Z (7 months ago)
• Topics: bugs, detect, eslint, eslint-config, eslint-rules, fix, formatting, lint, mistakes, style
• Language: JavaScript
• Size: 126 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-tidy [![Build status for ESLint Config Tidy](https://travis-ci.com/sholladay/eslint-config-tidy.svg?branch=master "Build Status")](https://travis-ci.com/sholladay/eslint-config-tidy "Builds")

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for Tidy style

## Why?

 - Consistency.

 - Clarity.

 - Simplicity.

## Install

```sh

npm install eslint-config-tidy --save-dev

```

## Usage

All you have to do is tell your linter to use this config.

### Use with [XO](https://github.com/sindresorhus/xo) (recommended)

Add some XO config to your package.json:

```json

{

    "name": "my-awesome-project",

    "xo": {

        "extend": "tidy"

    }

}

```

### Alternatively, use with [ESLint](https://github.com/eslint/eslint)

Add some ESLint config to your package.json:

```json

{

    "name": "my-awesome-project",

    "eslintConfig": {

        "extends": "tidy"

    }

}

```

## Related

 - [eslint-config-tidy-react](https://github.com/sholladay/eslint-config-tidy-react) - ESLint shareable config for [React](https://reactjs.org) to be used with this config

## Contributing

See our [contributing guidelines](https://github.com/sholladay/eslint-config-tidy/blob/master/CONTRIBUTING.md "Guidelines for participating in this project") for more details.

1. [Fork it](https://github.com/sholladay/eslint-config-tidy/fork).

2. Make a feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. [Submit a pull request](https://github.com/sholladay/eslint-config-tidy/compare "Submit code to this project for review").

## License

[MPL-2.0](https://github.com/sholladay/eslint-config-tidy/blob/master/LICENSE "License for eslint-config-tidy") © [Seth Holladay](https://seth-holladay.com "Author of eslint-config-tidy")

Go make something, dang it.