https://github.com/mcmath/coffeelint-config
CoffeeLint configuration for CoffeeScript projects
https://github.com/mcmath/coffeelint-config
coffeelint coffeescript config
Last synced: 6 days ago
JSON representation
CoffeeLint configuration for CoffeeScript projects
- Host: GitHub
- URL: https://github.com/mcmath/coffeelint-config
- Owner: mcmath
- License: mit
- Created: 2017-04-13T16:15:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-19T02:28:46.000Z (about 9 years ago)
- Last Synced: 2025-08-08T19:30:11.112Z (10 months ago)
- Topics: coffeelint, coffeescript, config
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @mcmath/coffeelint-config
[![Version][version-badge]][npm]
[![Build][build-badge]][travis]
[CoffeeLint][coffeelint] config for [CoffeeScript][coffeescript]
projects
## Install
Install through [npm][npm] as a development dependency.
[CoffeeScript][coffeescript] and [CoffeeLint][coffeelint] should also be
installed.
```sh
npm install --save-dev coffee-script coffeelint @mcmath/coffeelint-config
```
## Usage
Create a `coffeelint.json` file at the root of your project with the following
contents:
```json
{ "extends": "@mcmath/coffeelint-config" }
```
Rules may be added or modified like so:
```json
{
"extends": "@mcmath/coffeelint-config",
"indentation": {
"level": "error",
"value": 2
},
"max_line_length": {
"level": "ignore"
}
}
```
[version-badge]: https://img.shields.io/npm/v/@mcmath/coffeelint-config.svg?style=flat-square
[build-badge]: https://img.shields.io/travis/mcmath/coffeelint-config/master.svg?style=flat-square
[npm]: https://www.npmjs.com/package/@mcmath/coffeelint-config
[travis]: https://travis-ci.org/mcmath/coffeelint-config
[coffeescript]: http://coffeescript.org/
[coffeelint]: http://www.coffeelint.org/