# eslint-config-clockwork

> ESLint shared config for Clockwork

Latest version **0.0.8** (published 2017-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-clockwork
pnpm add eslint-config-clockwork
yarn add eslint-config-clockwork
bun add eslint-config-clockwork
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2017-01-25 |
| First published | 2017-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=v6.9.2 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | kevinob |

## Links

- npm: https://www.npmjs.com/package/eslint-config-clockwork
- Repository: https://github.com/ClockworkNet/eslint-config-clockwork
- Homepage: https://github.com/ClockworkNet/eslint-config-clockwork#readme
- Issues: https://github.com/ClockworkNet/eslint-config-clockwork/issues
- npm.io page: https://npm.io/package/eslint-config-clockwork

## Recent versions

- 0.0.8 (latest) — 2017-01-25
- 0.0.7 — 2017-01-25
- 0.0.6 — 2017-01-25
- 0.0.5 — 2017-01-25
- 0.0.4 — 2017-01-05
- 0.0.3 — 2017-01-05
- 0.0.2 — 2017-01-05
- 0.0.1 — 2017-01-05

## README

# eslint-confog-clockwork

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs) for [Clockwork](https://clockwork.com)


## Install

```bash
npm install --save-dev eslint eslint-config-clockwork
```

## Usage

Create a `.eslintrc` file in the root level of your project and add this:
```json
{
    "extends": "clockwork"
}
```

### Task runner plugins

-   [Gulp ESLint](https://www.npmjs.com/package/gulp-eslint)
-   [Grunt ESLint](https://www.npmjs.com/package/grunt-eslint)

### NPM Script

Update [`scripts`](https://docs.npmjs.com/misc/scripts) in your `package.json` at the root of your project.

```json
"scripts": {
  "lint": "./node_modules/.bin/eslint <FOLDER_TO_LINT>"
}
```

Run the NPM script from the command line

```shell
npm run lint
```

### Require before committing to GIT

Use [Husky](https://www.npmjs.com/package/husky)

```shell
npm install husky --save-dev
```

Add `precommit` to `package.json` [`scripts`](https://docs.npmjs.com/misc/scripts)

```json
"scripts": {
  "lint": "./node_modules/.bin/eslint <FOLDER_TO_LINT>",
  "precommit": "npm run lint"
}
```

## Goals

- Focus on rules that could lead to bugs
- Prefer rules that increase readability over stylistic or religious wars (like spacing)
- Make linting easy for CMS, website and application projects
- Applicable to many contexts (jQuery, Angular, React, Vue & Node). Projects may extend it with specifics for each if necessary.

## License

[MIT](http://vjpr.mit-license.org)

---
_Source: https://npm.io/package/eslint-config-clockwork · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._