Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 9.0.0 #77

Merged
merged 1 commit into from
Aug 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Change Log

## [9.0.0][] - 2024-08-14

- Update eslint to 9.x: Rewrite rules to plain format
- Drop node.js 18.x support and add node.js 22 support
- Update repository structure, CI, and badges
- Update dependencies and package file structure

## [8.2.1][] - 2023-07-20

- Update dependencies and package file structure
Expand Down
63 changes: 26 additions & 37 deletions README.md
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.
1 change: 1 addition & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
| 8.0.x | :x: |
| 8.1.x | :x: |
| 8.2.x | :white_check_mark: |
| 9.0.x | :white_check_mark: |

## Reporting a Vulnerability

Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
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",
Expand All @@ -16,7 +16,7 @@
"main": "index.js",
"files": ["rules/", "scripts/"],
"engines": {
"node": "18 || 20 || 21 || 22"
"node": "20 || 21 || 22"
},
"repository": {
"type": "git",
Expand Down
Loading