# @withbluedot/eslint-plugin-ghost

> Shared eslint configurations

Latest version **2.0.0** (published 2021-05-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @withbluedot/eslint-plugin-ghost
pnpm add @withbluedot/eslint-plugin-ghost
yarn add @withbluedot/eslint-plugin-ghost
bun add @withbluedot/eslint-plugin-ghost
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-05-13 |
| First published | 2021-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Ghost Foundation |
| Maintainers | withbluedot |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

- npm: https://www.npmjs.com/package/@withbluedot/eslint-plugin-ghost
- Repository: https://github.com/TryGhost/eslint-plugin-ghost
- Issues: https://github.com/TryGhost/eslint-plugin-ghost/issues
- npm.io page: https://npm.io/package/@withbluedot/eslint-plugin-ghost

## Dependencies (3)

- [eslint-plugin-ember](https://npm.io/package/eslint-plugin-ember.md) 9.3.0
- [eslint-plugin-mocha](https://npm.io/package/eslint-plugin-mocha.md) 8.0.0
- [eslint-plugin-sort-imports-es6-autofix](https://npm.io/package/eslint-plugin-sort-imports-es6-autofix.md) 0.5.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-05-13

## README

# eslint-plugin-ghost

Shared eslint configurations, useful plugins & custom rules.

Inside of lib/config you'll find a set of configs for different
environments + base.js.

Base.js effectively documents our code style. Please make sure any
rules you add come with an explanation!

## Basic setup
1. Make sure that `gstenv` is green. See our [Dev Environment](https://github.com/TryGhost/Team/blob/master/Engineering/Dev%20Environment.md) docs.
2. `git clone` this repo & `cd` into it as usual
3. Run `yarn install` to install dependencies.

## Testing

Run `yarn link` inside of me, and then run `yarn link eslint-plugin-ghost`
inside of the project you want to lint.

## Usage

- Inside of package.json, add this rule: `"lint": "eslint . --ext .js --cache"`
- Then, in your project root, create an `.eslintrc.js` file, and add the
following code:
```
module.exports = {
    plugins: ['ghost'],
    extends: [
        'plugin:ghost/[config]',
    ]
};
```
- Change `[config]` to be E.g. node, browser, test etc depending on what environment you are linting
- If you have a test folder, browser JS, etc, you can add multiple `.eslintrc.js` files, nesting them inside the folder they belong to.


## Publishing

 - `yarn ship`	 - `yarn ship`

# Copyright & License

Copyright (c) 2013-2020 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.

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