https://github.com/suddi/coffeelint-config-suddi

NPM module with coffeelint configurations for CoffeeScript development (https://www.npmjs.com/package/coffeelint-config-suddi)
https://github.com/suddi/coffeelint-config-suddi

coffeelint linting linting-rules nodejs

Last synced: about 10 hours ago
JSON representation

NPM module with coffeelint configurations for CoffeeScript development (https://www.npmjs.com/package/coffeelint-config-suddi)

• Host: GitHub
• URL: https://github.com/suddi/coffeelint-config-suddi
• Owner: suddi
• License: mit
• Created: 2017-03-08T14:36:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-08T08:08:20.000Z (over 4 years ago)
• Last Synced: 2024-10-15T09:19:03.169Z (29 days ago)
• Topics: coffeelint, linting, linting-rules, nodejs
• Language: CoffeeScript
• Homepage: https://www.npmjs.com/package/coffeelint-config-suddi
• Size: 178 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# coffeelint-config-suddi

[![CircleCI](https://circleci.com/gh/suddi/coffeelint-config-suddi.svg?style=svg)](https://circleci.com/gh/suddi/coffeelint-config-suddi)

[![codecov](https://codecov.io/gh/suddi/coffeelint-config-suddi/branch/master/graph/badge.svg)](https://codecov.io/gh/suddi/coffeelint-config-suddi)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f3cbca070bbd4488b579748680348c28)](https://www.codacy.com/app/suddir/coffeelint-config-suddi)

[![npm](https://img.shields.io/npm/v/coffeelint-config-suddi.svg)](https://www.npmjs.com/package/coffeelint-config-suddi)

[![npm](https://img.shields.io/npm/dt/coffeelint-config-suddi.svg)](https://www.npmjs.com/package/coffeelint-config-suddi)

[![David](https://img.shields.io/david/suddi/coffeelint-config-suddi.svg)](https://david-dm.org/suddi/coffeelint-config-suddi)

[![David](https://img.shields.io/david/dev/suddi/coffeelint-config-suddi.svg)](https://david-dm.org/suddi/coffeelint-config-suddi?type=dev)

[![license](https://img.shields.io/github/license/suddi/coffeelint-config-suddi.svg)](https://raw.githubusercontent.com/suddi/coffeelint-config-suddi/master/LICENSE)

[![codecov](https://codecov.io/gh/suddi/coffeelint-config-suddi/branch/master/graphs/commits.svg)](https://codecov.io/gh/suddi/coffeelint-config-suddi)

````

npm install --save-dev coffeelint coffeelint-config-suddi

````

## Usage

- Add the CoffeeLint config to your `package.json`, for running on your CoffeeScript code:

```json

{

	"scripts": {

		"lint": "coffeelint ."

	},

	"devDependencies": {

		"coffeelint": "^2.1.0",

		"coffeelint-config-suddi": "^3.0.0"

	},

	"coffeelintConfig": {

		"extends": "coffeelint-config-suddi"

	}

}

```

- Then apply the linter with `npm run lint`.

**NOTE:** You will likely want to include a `.coffeelintignore` file, as `coffeelint`, by default will include all `.coffee` files including those inside of `node_modules`:

````sh

echo "node_modules" > .coffeelintignore

````