https://github.com/tryghost/eslint-plugin-ghost
Shared eslint configurations
https://github.com/tryghost/eslint-plugin-ghost
Last synced: about 2 months ago
JSON representation
Shared eslint configurations
- Host: GitHub
- URL: https://github.com/tryghost/eslint-plugin-ghost
- Owner: TryGhost
- License: mit
- Created: 2017-12-19T17:07:07.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T21:29:50.000Z (2 months ago)
- Last Synced: 2025-04-10T03:34:52.044Z (about 2 months ago)
- Language: JavaScript
- Size: 892 KB
- Stars: 7
- Watchers: 10
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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-2025 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.