docs: fix typo

Ref: https://typescript-eslint.io/rules/consistent-type-imports

BREAKING CHANGE: New rule introduced

.eslintrc.json

@@ -144,8 +144,12 @@
     "prefer-regex-literals": ["error", { "disallowRedundantWrapping": true }],
     "quote-props": ["error", "as-needed"],
     "radix": "error",
-    "require-await": "error",
     "yoda": ["error", "never"],
+    "curly": ["error", "all"],
+    "func-style": ["error", "expression"],
+    "prefer-arrow-callback": "error",
+    "arrow-parens": ["error", "always"],
+    "arrow-body-style": ["error", "always"],
 
     "import/no-absolute-path": "error",
     "import/no-webpack-loader-syntax": "error",
@@ -231,8 +235,6 @@
         ],
         "no-useless-constructor": "off",
         "@typescript-eslint/no-useless-constructor": "error",
-        "require-await": "off",
-        "@typescript-eslint/require-await": "error",
 
         "@typescript-eslint/adjacent-overload-signatures": "error",
         "@typescript-eslint/array-type": [
@@ -250,6 +252,7 @@
           "error",
           "interface"
         ],
+        "@typescript-eslint/consistent-type-imports": "error",
         "@typescript-eslint/explicit-function-return-type": [
           "error",
           {
@@ -278,10 +281,6 @@
         ],
         "@typescript-eslint/no-base-to-string": "error",
         "@typescript-eslint/no-dynamic-delete": "error",
-        "@typescript-eslint/no-empty-interface": [
-          "error",
-          { "allowSingleExtends": true }
-        ],
         "@typescript-eslint/no-extra-non-null-assertion": "error",
         "@typescript-eslint/no-extraneous-class": [
           "error",

.github/workflows/lint.yml

@@ -10,10 +10,10 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2.4.0'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.1.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'

.github/workflows/release.yml

@@ -8,13 +8,13 @@ jobs:
   release:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2.4.0'
+      - uses: 'actions/checkout@v3.0.0'
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.1.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'

.github/workflows/test.yml

@@ -10,10 +10,10 @@ jobs:
   test:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2.4.0'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.1.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'

.gitignore

@@ -4,6 +4,7 @@ node_modules
 
 # testing
 coverage
+.nyc_output
 
 # debug
 npm-debug.log*

.lintstagedrc.json

@@ -2,5 +2,5 @@
   "*": ["editorconfig-checker"],
   "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
   "*.{json,jsonc,yml,yaml}": ["prettier --write"],
-  "*.{md,mdx}": ["prettier --write", "markdownlint --dot --fix"]
+  "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
 }

.markdownlint-cli2.jsonc

@@ -0,0 +1,10 @@
+{
+  "config": {
+    "default": true,
+    "MD013": false,
+    "MD033": false,
+    "MD041": false
+  },
+  "globs": ["**/*.{md,mdx}"],
+  "ignores": ["**/node_modules"]
+}

.markdownlint.json

@@ -1,6 +0,0 @@
-{
-  "default": true,
-  "MD013": false,
-  "MD033": false,
-  "MD041": false
-}

.taprc

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

README.md

@@ -23,7 +23,7 @@
 
 **eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality, it is highly inspired from [eslint-config-standard-with-typescript](https://github.com/standard/eslint-config-standard-with-typescript) but it is **stricter** and with **no formatting rules**, **only code-quality rules**. It supports both **JavaScript** and **TypeScript**.
 
-This configuration is mostly **for catching bugs** and **code-quality** so it is recommanded to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.
+This configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.
 
 More information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html).
 
@@ -41,9 +41,9 @@ Here is an example, but use it only for reference, because your decisions regard
 ```sh
 npm install --save-dev \
   eslint@^8.9.0 \
-  eslint-plugin-import@^2.25.4 \
+  eslint-plugin-import@^2.26.0 \
   eslint-plugin-promise@^6.0.0 \
-  eslint-plugin-unicorn@^41.0.0 \
+  eslint-plugin-unicorn@^43.0.0 \
   eslint-config-conventions@latest
 ```
 
@@ -62,9 +62,9 @@ If you want to use **TypeScript**, you also need to install:
 
 ```sh
 npm install --save-dev \
-  typescript@^4.4.0 \
-  @typescript-eslint/eslint-plugin@^5.12.0 \
-  @typescript-eslint/parser@^5.12.0
+  typescript@^4.8.2 \
+  @typescript-eslint/eslint-plugin@^5.36.1 \
+  @typescript-eslint/parser@^5.36.1
 ```
 
 Dependencies are:

package.json

@@ -23,6 +23,10 @@
     "conventions"
   ],
   "main": "index.js",
+  "files": [
+    "index.js",
+    ".eslintrc.json"
+  ],
   "engines": {
     "node": ">=16.0.0",
     "npm": ">=8.0.0"
@@ -30,11 +34,11 @@
   "scripts": {
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
+    "lint:markdown": "markdownlint-cli2",
     "lint:javascript": "eslint \"**/*.{js,jsx,ts,tsx}\" -c \"eslintrc.json\"",
     "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
     "lint:staged": "lint-staged",
-    "test": "tape \"test/**/*.js\"",
+    "test": "tap",
     "release": "semantic-release",
     "postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
@@ -42,29 +46,29 @@
   },
   "peerDependencies": {
     "eslint": "^8.9.0",
-    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-promise": "^6.0.0",
-    "eslint-plugin-unicorn": "^41.0.0"
+    "eslint-plugin-unicorn": "^43.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "16.2.3",
-    "@commitlint/config-conventional": "16.2.1",
+    "@commitlint/cli": "17.1.2",
+    "@commitlint/config-conventional": "17.1.0",
+    "@types/eslint": "8.4.6",
+    "@types/tap": "15.0.7",
+    "@typescript-eslint/eslint-plugin": "5.36.1",
+    "@typescript-eslint/parser": "5.36.1",
     "editorconfig-checker": "4.0.2",
-    "eslint": "8.11.0",
-    "@types/eslint": "8.4.1",
-    "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-unicorn": "41.0.0",
-    "typescript": "4.6.2",
-    "@typescript-eslint/parser": "5.15.0",
-    "@typescript-eslint/eslint-plugin": "5.15.0",
-    "tape": "5.5.2",
-    "husky": "7.0.4",
-    "lint-staged": "12.3.6",
-    "markdownlint-cli": "0.31.1",
-    "@types/tape": "4.13.2",
+    "eslint": "8.23.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-promise": "6.0.1",
+    "eslint-plugin-unicorn": "43.0.2",
+    "husky": "8.0.1",
+    "lint-staged": "13.0.3",
+    "markdownlint-cli2": "0.5.1",
     "pinst": "3.0.0",
-    "prettier": "2.6.0",
-    "semantic-release": "19.0.2"
+    "prettier": "2.7.1",
+    "semantic-release": "19.0.5",
+    "tap": "16.3.0",
+    "typescript": "4.8.2"
   }
 }

test/basic.js

@@ -1,15 +1,14 @@
-const test = require('tape')
+const tap = require('tap')
 
 const config = require('../index.js')
 
-test('test basic properties of config', function (t) {
+const isObject = (object) => {
+  return typeof object === 'object' && object !== null
+}
+
+tap.test('test basic properties of config', async (t) => {
   t.ok(isObject(config.parserOptions))
   t.ok(isObject(config.env))
   t.ok(isObject(config.rules))
   t.ok(isObject(config.overrides))
-  t.end()
 })
-
-function isObject(object) {
-  return typeof object === 'object' && object !== null
-}

test/fixtures/top-level-await.mjs

@@ -1,3 +1,3 @@
 const foo = await 1
-const bar = function () {}
+const bar = () => {}
 await bar(foo)

test/validate-config.js

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