docs: simplify README

BREAKING CHANGE: peerDependencies: `eslint@^8.44.0`

.eslintrc.json

@@ -4,10 +4,10 @@
   "env": {
     "browser": true,
     "node": true,
-    "es2022": true
+    "es2024": true
   },
   "parserOptions": {
-    "ecmaVersion": 2022,
+    "ecmaVersion": "latest",
     "sourceType": "module",
     "ecmaFeatures": {
       "jsx": true

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 
-## What changes this PR introduce?
+# What changes this PR introduce?
 
 ## List any relevant issue numbers
 

.github/workflows/lint.yml

@@ -10,16 +10,16 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.3'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
       - run: 'npm run lint:editorconfig'

.github/workflows/release.yml

@@ -7,20 +7,28 @@ on:
 jobs:
   release:
     runs-on: 'ubuntu-latest'
+    permissions:
+      contents: 'write'
+      issues: 'write'
+      pull-requests: 'write'
+      id-token: 'write'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.3'
         with:
           fetch-depth: 0
           persist-credentials: false
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
+
+      - name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
+        run: 'npm audit signatures'
 
       - name: 'Release'
         run: 'npm run release'

.github/workflows/test.yml

@@ -10,16 +10,16 @@ jobs:
   test:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.3'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - name: 'Test'
         run: 'npm run test'

.markdownlint-cli2.jsonc

@@ -1,4 +1,10 @@
 {
+  "config": {
+    "extends": "markdownlint/style/prettier",
+    "relative-links": true,
+    "default": true,
+    "MD033": false
+  },
   "globs": ["**/*.{md,mdx}"],
   "ignores": ["**/node_modules"],
   "customRules": ["markdownlint-rule-relative-links"]

.markdownlint.json

@@ -1,7 +0,0 @@
-{
-  "default": true,
-  "relative-links": true,
-  "extends": "markdownlint/style/prettier",
-  "MD033": false,
-  "MD041": false
-}

.npmrc

@@ -1 +1,2 @@
 save-exact=true
+provenance=true

.taprc

@@ -1,8 +0,0 @@
-ts: false
-jsx: false
-flow: false
-check-coverage: true
-coverage: true
-
-test-ignore:
-  - 'test/fixtures'

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
+<contact@theoludwig.fr>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -2,6 +2,14 @@
 
 Thanks a lot for your interest in contributing to **eslint-config-conventions**! 🎉
 
+## Code of Conduct
+
+**eslint-config-conventions** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+
+## Open Development
+
+All work on **eslint-config-conventions** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
+
 ## Types of contributions
 
 - Reporting a bug.
@@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **eslint-config-conventions**!
 
 ## Pull Requests
 
-- **Please first discuss** the change you wish to make via [issue](https://github.com/Divlo/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
+- **Please first discuss** the change you wish to make via [issue](https://github.com/theoludwig/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
 
 - Ensure your code respect linting.
 
@@ -21,26 +29,4 @@ If you're adding new features to **eslint-config-conventions**, please include t
 
 ## Commits
 
-The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
+The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
-
-### Types
-
-Types define which kind of changes you made to the project.
-
-| Types    | Description                                                                                                  |
-| -------- | ------------------------------------------------------------------------------------------------------------ |
-| feat     | A new feature.                                                                                               |
-| fix      | A bug fix.                                                                                                   |
-| docs     | Documentation only changes.                                                                                  |
-| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
-| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
-| perf     | A code change that improves performance.                                                                     |
-| test     | Adding missing tests or correcting existing tests.                                                           |
-| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
-| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
-| chore    | Other changes that don't modify src or test files.                                                           |
-| revert   | Reverts a previous commit.                                                                                   |
-
-### Scopes
-
-Scopes define what part of the code changed.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Divlo
+Copyright (c) Théo LUDWIG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -11,8 +11,8 @@
   <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
   <a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
   <br />
-  <a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
+  <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
-  <a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
+  <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
   <br />
   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
   <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@@ -35,19 +35,16 @@ More information about **formatting rules** vs **code-quality rules** can be fou
 
 ### Installation
 
-`npm@<7` does not automatically install `peerDependencies`, so if that's what you're using, install them manually.
-Here is an example, but use it only for reference, because your decisions regarding version ranges and range specifiers may vary.
-
 ```sh
 npm install --save-dev \
-  eslint@^8.33.0 \
+  eslint@^8.44.0 \
   eslint-plugin-import@^2.27.5 \
   eslint-plugin-promise@^6.1.1 \
-  eslint-plugin-unicorn@^46.0.0 \
+  eslint-plugin-unicorn@^47.0.0 \
   eslint-config-conventions@latest
 ```
 
-Yes, this is a large number of packages. This is due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
+This is a large number of packages due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
 
 This list of dependencies are:
 
@@ -62,16 +59,16 @@ If you want to use **TypeScript**, you also need to install:
 
 ```sh
 npm install --save-dev \
-  typescript@^5.0.3 \
+  typescript@^5.0.4 \
-  @typescript-eslint/eslint-plugin@^5.57.0 \
+  @typescript-eslint/eslint-plugin@^5.60.1 \
-  @typescript-eslint/parser@^5.57.0
+  @typescript-eslint/parser@^5.60.1
 ```
 
 Dependencies are:
 
 - [TypeScript](https://github.com/Microsoft/TypeScript)
-- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint); ESLint rules for TypeScript.
+- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript.
-- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint); ESLint parser for TypeScript.
+- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript.
 
 ### Configuration with [Prettier](https://prettier.io/) (recommended)
 
@@ -82,7 +79,7 @@ npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
 
 # Create an empty config file to let editors and other tools know you are using Prettier
 # You can personalize it with your own rules
-echo {}> .prettierrc.json
+echo "{}" > .prettierrc.json
 ```
 
 #### `.eslintrc.json`
@@ -109,8 +106,8 @@ echo {}> .prettierrc.json
 ```jsonc
 {
   "scripts": {
-    "lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
+    "lint:eslint": "eslint . --ignore-path .gitignore",
-    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\""
+    "lint:prettier": "prettier . --check --ignore-path .gitignore"
   }
 }
 ```

package.json

@@ -3,16 +3,16 @@
   "version": "0.0.0-development",
   "public": true,
   "description": "ESLint shareable config to enforce strict conventions and good code quality.",
-  "author": "Divlo <contact@divlo.fr>",
+  "author": "Théo LUDWIG <contact@theoludwig.fr>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Divlo/eslint-config-conventions.git"
+    "url": "https://github.com/theoludwig/eslint-config-conventions.git"
   },
   "bugs": {
-    "url": "https://github.com/Divlo/eslint-config-conventions/issues"
+    "url": "https://github.com/theoludwig/eslint-config-conventions/issues"
   },
-  "homepage": "https://github.com/Divlo/eslint-config-conventions#readme",
+  "homepage": "https://github.com/theoludwig/eslint-config-conventions#readme",
   "keywords": [
     "eslintconfig",
     "eslint",
@@ -27,50 +27,53 @@
     "index.js",
     ".eslintrc.json"
   ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "engines": {
     "node": ">=16.0.0",
-    "npm": ">=8.0.0"
+    "npm": ">=9.0.0"
   },
   "scripts": {
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
     "lint:markdown": "markdownlint-cli2",
-    "lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" -c \"eslintrc.json\"",
+    "lint:eslint": "eslint . -c eslintrc.json",
-    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
+    "lint:prettier": "prettier . --check --ignore-path .gitignore",
     "lint:staged": "lint-staged",
-    "test": "tap",
+    "test": "node --test test/",
     "release": "semantic-release",
     "postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable"
   },
   "peerDependencies": {
-    "eslint": "^8.33.0",
+    "eslint": "^8.44.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-unicorn": "^46.0.0"
+    "eslint-plugin-unicorn": "^47.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.5.1",
+    "@commitlint/cli": "17.6.6",
-    "@commitlint/config-conventional": "17.4.4",
+    "@commitlint/config-conventional": "17.6.6",
-    "@tsconfig/strictest": "2.0.0",
+    "@tsconfig/strictest": "2.0.1",
-    "@types/eslint": "8.37.0",
+    "@types/eslint": "8.40.2",
-    "@types/tap": "15.0.8",
+    "@types/node": "20.3.3",
-    "@typescript-eslint/eslint-plugin": "5.57.0",
+    "@typescript-eslint/eslint-plugin": "5.60.1",
-    "@typescript-eslint/parser": "5.57.0",
+    "@typescript-eslint/parser": "5.60.1",
-    "editorconfig-checker": "5.0.1",
+    "editorconfig-checker": "5.1.1",
-    "eslint": "8.37.0",
+    "eslint": "8.44.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "46.0.0",
+    "eslint-plugin-unicorn": "47.0.0",
     "husky": "8.0.3",
-    "lint-staged": "13.2.0",
+    "lint-staged": "13.2.3",
-    "markdownlint-cli2": "0.6.0",
+    "markdownlint-cli2": "0.8.1",
-    "markdownlint-rule-relative-links": "1.1.1",
+    "markdownlint-rule-relative-links": "2.1.0",
     "pinst": "3.0.0",
-    "prettier": "2.8.7",
+    "prettier": "2.8.8",
-    "semantic-release": "21.0.1",
+    "semantic-release": "21.0.6",
-    "tap": "16.3.4",
+    "typescript": "5.0.4"
-    "typescript": "5.0.3"
   }
 }

test/basic.js

@@ -1,14 +1,20 @@
-const tap = require('tap')
+const test = require('node:test')
+const assert = require('node:assert/strict')
 
 const config = require('../index.js')
 
+/**
+ * @param {unknown} object
+ * @returns {boolean}
+ */
 const isObject = (object) => {
   return typeof object === 'object' && object !== null
 }
 
-tap.test('test basic properties of config', async (t) => {
+test('test basic properties of config', async () => {
-  t.ok(isObject(config.parserOptions))
+  assert.ok(isObject(config))
-  t.ok(isObject(config.env))
+  assert.ok(isObject(config.parserOptions))
-  t.ok(isObject(config.rules))
+  assert.ok(isObject(config.env))
-  t.ok(isObject(config.overrides))
+  assert.ok(isObject(config.rules))
+  assert.ok(isObject(config.overrides))
 })

test/validate-config.js

@@ -1,5 +1,7 @@
+const test = require('node:test')
+const assert = require('node:assert/strict')
+
 const { ESLint } = require('eslint')
-const tap = require('tap')
 
 const eslint = new ESLint({
   ignore: false,
@@ -7,31 +9,31 @@ const eslint = new ESLint({
   overrideConfigFile: 'eslintrc.json'
 })
 
-tap.test('ensure we validate correctly JavaScript files', async (t) => {
+test('ensure we validate correctly JavaScript files', async () => {
   const [noErrors] = await eslint.lintFiles(
     'test/fixtures/javascript-no-errors.js'
   )
   const [withErrors] = await eslint.lintFiles(
     'test/fixtures/javascript-with-errors.js'
   )
-  t.equal(noErrors.errorCount, 0)
+  assert.strictEqual(noErrors?.errorCount, 0)
-  t.equal(withErrors.errorCount, 3)
+  assert.strictEqual(withErrors?.errorCount, 3)
 })
 
-tap.test('ensure we validate correctly TypeScript files', async (t) => {
+test('ensure we validate correctly TypeScript files', async () => {
   const [noErrors] = await eslint.lintFiles(
     'test/fixtures/typescript-no-errors.ts'
   )
   const [withErrors] = await eslint.lintFiles(
     'test/fixtures/javascript-with-errors.js'
   )
-  t.equal(noErrors.errorCount, 0)
+  assert.strictEqual(noErrors?.errorCount, 0)
-  t.equal(withErrors.errorCount, 3)
+  assert.strictEqual(withErrors?.errorCount, 3)
 })
 
-tap.test('ensure we allow top-level await', async (t) => {
+test('ensure we allow top-level await', async () => {
   const [lintResult] = await eslint.lintFiles(
     'test/fixtures/top-level-await.mjs'
   )
-  t.equal(lintResult.errorCount, 0)
+  assert.strictEqual(lintResult?.errorCount, 0)
 })

tsconfig.json

@@ -1,6 +1,7 @@
 {
   "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
+    "resolveJsonModule": true,
     "target": "ESNext",
     "module": "commonjs",
     "lib": ["ESNext"],