eslint-config-conventions 3.0.0 → 4.0.1

package/.eslintrc.json

@@ -145,6 +145,11 @@
     "quote-props": ["error", "as-needed"],
     "radix": "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",
@@ -247,6 +252,7 @@
           "error",
           "interface"
         ],
+        "@typescript-eslint/consistent-type-imports": "error",
         "@typescript-eslint/explicit-function-return-type": [
           "error",
           {
@@ -275,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",

package/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).
 
@@ -62,9 +62,9 @@ If you want to use **TypeScript**, you also need to install:
 
 ```sh
 npm install --save-dev \
-  typescript@^4.6.0 \
-  @typescript-eslint/eslint-plugin@^5.18.0 \
-  @typescript-eslint/parser@^5.18.0
+  typescript@^4.8.2 \
+  @typescript-eslint/eslint-plugin@^5.36.1 \
+  @typescript-eslint/parser@^5.36.1
 ```
 
 Dependencies are:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-conventions",
-  "version": "3.0.0",
+  "version": "4.0.1",
   "public": true,
   "description": "ESLint shareable config to enforce strict conventions and good code quality.",
   "author": "Divlo <contact@divlo.fr>",
@@ -23,6 +23,10 @@
     "conventions"
   ],
   "main": "index.js",
+  "files": [
+    "index.js",
+    ".eslintrc.json"
+  ],
   "engines": {
     "node": ">=16.0.0",
     "npm": ">=8.0.0"
@@ -30,7 +34,7 @@
   "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",
@@ -47,24 +51,24 @@
     "eslint-plugin-unicorn": "^43.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.0.3",
-    "@commitlint/config-conventional": "17.0.3",
-    "@types/eslint": "8.4.5",
+    "@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.30.6",
-    "@typescript-eslint/parser": "5.30.6",
+    "@typescript-eslint/eslint-plugin": "5.36.1",
+    "@typescript-eslint/parser": "5.36.1",
     "editorconfig-checker": "4.0.2",
-    "eslint": "8.19.0",
+    "eslint": "8.23.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-unicorn": "43.0.1",
+    "eslint-plugin-promise": "6.0.1",
+    "eslint-plugin-unicorn": "43.0.2",
     "husky": "8.0.1",
     "lint-staged": "13.0.3",
-    "markdownlint-cli": "0.31.1",
+    "markdownlint-cli2": "0.5.1",
     "pinst": "3.0.0",
     "prettier": "2.7.1",
-    "semantic-release": "19.0.3",
+    "semantic-release": "19.0.5",
     "tap": "16.3.0",
-    "typescript": "4.7.4"
+    "typescript": "4.8.2"
   }
 }

package/.commitlintrc.json

@@ -1 +0,0 @@
-{ "extends": ["@commitlint/config-conventional"] }

package/.editorconfig

@@ -1,11 +0,0 @@
-# For more information see: https://editorconfig.org/
-
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

package/.eslintignore

@@ -1,2 +0,0 @@
-node_modules
-test/fixtures

package/.gitattributes

@@ -1 +0,0 @@
-* text=auto eol=lf

package/.github/ISSUE_TEMPLATE/BUG.md

@@ -1,20 +0,0 @@
----
-name: '🐛 Bug Report'
-about: 'Report an unexpected problem or unintended behavior.'
-title: '[Bug]'
-labels: 'bug'
----
-
-<!--
-  Please provide a clear and concise description of what the bug is. Include
-  screenshots if needed. Please make sure your issue has not already been fixed.
--->
-
-## Steps To Reproduce
-
-1. Step 1
-2. Step 2
-
-## The current behavior
-
-## The expected behavior

package/.github/ISSUE_TEMPLATE/DOCUMENTATION.md

@@ -1,18 +0,0 @@
----
-name: '📜 Documentation'
-about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
-title: '[Documentation]'
-labels: 'documentation'
----
-
-<!-- Please make sure your issue has not already been fixed. -->
-
-## Documentation
-
-<!-- Please uncomment the type of documentation problem this issue address -->
-
-<!-- Documentation is Missing -->
-<!-- Documentation is Confusing -->
-<!-- Documentation has Typo errors -->
-
-## Proposal

package/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,20 +0,0 @@
----
-name: '✨ Feature Request'
-about: 'Suggest a new feature idea.'
-title: '[Feature]'
-labels: 'feature request'
----
-
-<!-- Please make sure your issue has not already been fixed. -->
-
-## Description
-
-<!-- A clear and concise description of the problem or missing capability... -->
-
-## Describe the solution you'd like
-
-<!-- If you have a solution in mind, please describe it. -->
-
-## Describe alternatives you've considered
-
-<!-- Have you considered any alternative solutions or workarounds? -->

package/.github/ISSUE_TEMPLATE/IMPROVEMENT.md

@@ -1,20 +0,0 @@
----
-name: '🔧 Improvement'
-about: 'Improve structure/format/performance/refactor/tests of the code.'
-title: '[Improvement]'
-labels: 'improvement'
----
-
-<!-- Please make sure your issue has not already been fixed. -->
-
-## Type of Improvement
-
-<!-- Please uncomment the type of improvements this issue address -->
-
-<!-- Files and Folders Structure -->
-<!-- Performance -->
-<!-- Refactoring code -->
-<!-- Tests -->
-<!-- Not Sure? -->
-
-## Proposal

package/.github/ISSUE_TEMPLATE/QUESTION.md

@@ -1,8 +0,0 @@
----
-name: '🙋 Question'
-about: 'Further information is requested.'
-title: '[Question]'
-labels: 'question'
----
-
-### Question

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +0,0 @@
-<!-- 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?
-
-## List any relevant issue numbers
-
-## Is there anything you'd like reviewers to focus on?

package/.github/workflows/lint.yml

@@ -1,28 +0,0 @@
-name: 'Lint'
-
-on:
-  push:
-    branches: [develop]
-  pull_request:
-    branches: [master, develop]
-
-jobs:
-  lint:
-    runs-on: 'ubuntu-latest'
-    steps:
-      - uses: 'actions/checkout@v3.0.0'
-
-      - name: 'Use Node.js'
-        uses: 'actions/setup-node@v3.1.0'
-        with:
-          node-version: 'lts/*'
-          cache: 'npm'
-
-      - name: 'Install'
-        run: 'npm install'
-
-      - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
-      - run: 'npm run lint:editorconfig'
-      - run: 'npm run lint:markdown'
-      - run: 'npm run lint:javascript'
-      - run: 'npm run lint:prettier'

package/.github/workflows/release.yml

@@ -1,29 +0,0 @@
-name: 'Release'
-
-on:
-  push:
-    branches: [master]
-
-jobs:
-  release:
-    runs-on: 'ubuntu-latest'
-    steps:
-      - uses: 'actions/checkout@v3.0.0'
-        with:
-          fetch-depth: 0
-          persist-credentials: false
-
-      - name: 'Use Node.js'
-        uses: 'actions/setup-node@v3.1.0'
-        with:
-          node-version: 'lts/*'
-          cache: 'npm'
-
-      - name: 'Install'
-        run: 'npm install'
-
-      - name: 'Release'
-        run: 'npm run release'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -1,25 +0,0 @@
-name: 'Test'
-
-on:
-  push:
-    branches: [develop]
-  pull_request:
-    branches: [master, develop]
-
-jobs:
-  test:
-    runs-on: 'ubuntu-latest'
-    steps:
-      - uses: 'actions/checkout@v3.0.0'
-
-      - name: 'Use Node.js'
-        uses: 'actions/setup-node@v3.1.0'
-        with:
-          node-version: 'lts/*'
-          cache: 'npm'
-
-      - name: 'Install'
-        run: 'npm install'
-
-      - name: 'Test'
-        run: 'npm run test'

package/.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:commit -- --edit

package/.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:staged
-npm run test

package/.lintstagedrc.json

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

package/.markdownlint.json

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

package/.prettierrc.json

@@ -1,6 +0,0 @@
-{
-  "singleQuote": true,
-  "jsxSingleQuote": true,
-  "semi": false,
-  "trailingComma": "none"
-}

package/.releaserc.json

@@ -1,19 +0,0 @@
-{
-  "branches": ["master"],
-  "plugins": [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
-    "@semantic-release/npm",
-    "@semantic-release/github"
-  ]
-}

package/.taprc

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

package/.vscode/extensions.json

@@ -1,8 +0,0 @@
-{
-  "recommendations": [
-    "editorconfig.editorconfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint",
-    "davidanson.vscode-markdownlint"
-  ]
-}

package/.vscode/settings.json

@@ -1,10 +0,0 @@
-{
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "typescript.preferences.importModuleSpecifierEnding": "js",
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "prettier.configPath": ".prettierrc.json",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll": true
-  }
-}

package/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][mozilla coc].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][faq]. Translations are available
-at [https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
-[mozilla coc]: https://github.com/mozilla/diversity
-[faq]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -1,46 +0,0 @@
-# 💡 Contributing
-
-Thanks a lot for your interest in contributing to **eslint-config-conventions**! 🎉
-
-## Types of contributions
-
-- Reporting a bug.
-- Suggest a new feature idea.
-- Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).
-- Improve structure/format/performance/refactor/tests of the code.
-
-## 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.
-
-- Ensure your code respect linting.
-
-- Make sure your **code passes the tests**.
-
-If you're adding new features to **eslint-config-conventions**, please include tests.
-
-## 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.
-
-### 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.

package/eslintrc.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./index.js",
-  "parserOptions": {
-    "project": "./tsconfig.json"
-  }
-}

package/test/basic.js

@@ -1,14 +0,0 @@
-const tap = require('tap')
-
-const config = require('../index.js')
-
-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))
-})
-
-function isObject(object) {
-  return typeof object === 'object' && object !== null
-}

package/test/fixtures/javascript-no-errors.js

@@ -1,5 +0,0 @@
-const foo = 1
-const bar = (argument) => {
-  return argument + foo
-}
-bar(foo)

package/test/fixtures/javascript-with-errors.js

@@ -1 +0,0 @@
-'invalid eqeqeq' == 'invalid eqeqeq'

package/test/fixtures/top-level-await.mjs

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

package/test/fixtures/typescript-no-errors.ts

@@ -1,5 +0,0 @@
-const foo = 1
-const bar = (argument: number): number => {
-  return argument + foo
-}
-bar(foo)

package/test/fixtures/typescript-with-errors.ts

@@ -1,5 +0,0 @@
-const foo = 1
-const bar = (argument: number) => {
-  return argument + foo
-}
-bar(foo)

package/test/validate-config.js

@@ -1,37 +0,0 @@
-const { ESLint } = require('eslint')
-const tap = require('tap')
-
-const eslint = new ESLint({
-  ignore: false,
-  useEslintrc: false,
-  overrideConfigFile: 'eslintrc.json'
-})
-
-tap.test('ensure we validate correctly JavaScript files', async (t) => {
-  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)
-  t.equal(withErrors.errorCount, 3)
-})
-
-tap.test('ensure we validate correctly TypeScript files', async (t) => {
-  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)
-  t.equal(withErrors.errorCount, 3)
-})
-
-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)
-})

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "commonjs",
-    "lib": ["ESNext"],
-    "moduleResolution": "node",
-    "rootDir": "./",
-    "strict": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true
-  }
-}