-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
19b65b8
commit 1165381
Showing
5 changed files
with
39 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1,40 @@ | ||
# eslint-config-metarhia | ||
|
||
[![Build Status][travis-badge]][travis-url] | ||
[![Greenkeeper badge](https://badges.greenkeeper.io/metarhia/eslint-config-metarhia.svg)](https://greenkeeper.io/) | ||
Opinionated [ESLint](https://eslint.org/) config and de-facto JavaScript | ||
styleguide for [Metarhia](https://github.com/metarhia/) projects. | ||
|
||
Opinionated [ESLint][] config and de-facto JavaScript styleguide for | ||
[Metarhia][] projects. | ||
[![ci status](https://github.com/metarhia/eslint-config-metarhia/workflows/Testing%20CI/badge.svg)](https://github.com/metarhia/eslint-config-metarhia/actions?query=workflow%3A%22Testing+CI%22+branch%3Amaster) | ||
[![snyk](https://snyk.io/test/github/metarhia/eslint-config-metarhia/badge.svg)](https://snyk.io/test/github/metarhia/eslint-config-metarhia) | ||
[![npm version](https://badge.fury.io/js/eslint-config-metarhia.svg)](https://badge.fury.io/js/eslint-config-metarhia) | ||
[![npm downloads/month](https://img.shields.io/npm/dm/eslint-config-metarhia.svg)](https://www.npmjs.com/package/eslint-config-metarhia) | ||
[![npm downloads](https://img.shields.io/npm/dt/eslint-config-metarhia.svg)](https://www.npmjs.com/package/eslint-config-metarhia) | ||
|
||
## Usage | ||
|
||
1. Install ESLint, this config and required plugins: | ||
1. Install ESLint and this config: | ||
|
||
```console | ||
npm i -D eslint eslint-plugin-import eslint-config-metarhia | ||
``` | ||
|
||
2. Add `"extends": "metarhia"` to your `.eslintrc`. | ||
|
||
## Contributing | ||
|
||
Please adhere to [Conventional Commits][] styleguide for commit messages | ||
(`npm install` creates a Git hook that lints your commit messages, and they are | ||
also checked on CI, but please write them properly beforehand so that they don't | ||
get rejected. If that happens locally while committing, though, don't worry, | ||
your commit message isn't lost, you can still find it in `.git/COMMIT_EDITMSG`). | ||
```console | ||
npm i -D eslint eslint-config-metarhia | ||
``` | ||
|
||
### Releasing | ||
2. Import `eslint-config-metarhia` in `.eslint.config.js`, add additional rules, | ||
export everything together. | ||
|
||
Collaborators can release new versions using | ||
```js | ||
const config = require('eslint-config-metarhia'); | ||
|
||
```console | ||
npm run release | ||
git push origin master --follow-tags | ||
npm publish | ||
module.exports = [ | ||
config, | ||
{ | ||
rules: { | ||
'no-unused-vars': 'warn', | ||
}, | ||
}, | ||
]; | ||
``` | ||
|
||
This will update the version in `package.json` and `package-lock.json` | ||
according to semantic versioning using commit messages to determine whether it | ||
is a patch, minor or major release, update the changelog, tag the new version | ||
in Git, and publish it to npm registry. | ||
|
||
## License | ||
|
||
MIT. See the [LICENSE][] file for details. | ||
|
||
[conventional commits]: https://conventionalcommits.org/ | ||
[eslint]: https://eslint.org/ | ||
[license]: LICENSE | ||
[metarhia]: https://github.com/metarhia | ||
[travis-badge]: https://travis-ci.org/metarhia/eslint-config-metarhia.svg?branch=master | ||
[travis-url]: https://travis-ci.org/metarhia/eslint-config-metarhia | ||
Copyright (c) 2017-2024 [Metarhia contributors](https://github.com/metarhia/eslint-config-metarhia/graphs/contributors). | ||
eslint-config-metarhia is [MIT licensed](./LICENSE).\ | ||
eslint-config-metarhia is a part of [Metarhia](https://github.com/metarhia) technology stack. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "eslint-config-metarhia", | ||
"version": "8.2.2", | ||
"version": "9.0.0", | ||
"author": "Alexey Orlenko <[email protected]>", | ||
"license": "MIT", | ||
"description": "ESLint config for Metarhia projects", | ||
|
@@ -16,7 +16,7 @@ | |
"main": "index.js", | ||
"files": ["rules/", "scripts/"], | ||
"engines": { | ||
"node": "18 || 20 || 21 || 22" | ||
"node": "20 || 21 || 22" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
|