@dg-scripts/eslint-config 5.18.0 → 5.20.0

package/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.20.0](https://github.com/sabertazimi/bod/compare/v5.19.0...v5.20.0) (2024-04-02)
+
+
+### Bug Fixes
+
+* **eslint-config:** require description rule ([#1162](https://github.com/sabertazimi/bod/issues/1162)) ([58d35e8](https://github.com/sabertazimi/bod/commit/58d35e8211aefe0bde523fba7da57c1b377e65b5))
+
+
+### Features
+
+* **eslint-config:** add security and promise plugins ([#1163](https://github.com/sabertazimi/bod/issues/1163)) ([c9d49cf](https://github.com/sabertazimi/bod/commit/c9d49cfaed1b41364e620b120d359a1d4727868b))
+
+
+
+
+
+# [5.19.0](https://github.com/sabertazimi/bod/compare/v5.18.0...v5.19.0) (2024-04-01)
+
+
+### Bug Fixes
+
+* **eslint-config:** allow uppercase title for top-level describe ([#1160](https://github.com/sabertazimi/bod/issues/1160)) ([3a08c25](https://github.com/sabertazimi/bod/commit/3a08c2516496b99431119f50b4dd0527fe31a6eb))
+
+
+### Features
+
+* **eslint-config:** add testing-library support ([#1161](https://github.com/sabertazimi/bod/issues/1161)) ([861ee93](https://github.com/sabertazimi/bod/commit/861ee93b9e71ed46f93b9a3927f8444e8591a2c0))
+
+
+
+
+
 # [5.18.0](https://github.com/sabertazimi/bod/compare/v5.17.0...v5.18.0) (2024-04-01)
 
 

package/index.js

@@ -1,8 +1,11 @@
 // @ts-check
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
-import antfu, { GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_TS, GLOB_TSX } from '@antfu/eslint-config'
+import antfu, { GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SRC, GLOB_TESTS, GLOB_TS, GLOB_TSX } from '@antfu/eslint-config'
 import { FlatCompat } from '@eslint/eslintrc'
+import eslintPluginPromise from 'eslint-plugin-promise'
+import eslintPluginSecurity from 'eslint-plugin-security'
+import eslintPluginTestingLibrary from 'eslint-plugin-testing-library'
 import { isPackageExists } from 'local-pkg'
 
 const baseDirectory = path.dirname(fileURLToPath(import.meta.url))
@@ -22,7 +25,7 @@ const eslintConfigNext
         },
       ],
     })
-    : {}
+    : []
 
 /** @type {import('@antfu/eslint-config').TypedFlatConfigItem} */
 const eslintConfigMarkdown = {
@@ -30,9 +33,76 @@ const eslintConfigMarkdown = {
   languageOptions: { parserOptions: { project: false, program: null } },
 }
 
+/** @type {import('@antfu/eslint-config').TypedFlatConfigItem} */
+const eslintConfigTestingLibrary = {
+  files: [...GLOB_TESTS],
+  plugins: {
+    'testing-library': eslintPluginTestingLibrary,
+  },
+  rules: {
+    'test/no-interpolation-in-snapshots': 'error',
+    'test/no-mocks-import': 'error',
+    'test/prefer-lowercase-title': [
+      'error',
+      {
+        ignoreTopLevelDescribe: true,
+      },
+    ],
+    'test/valid-describe-callback': 'error',
+    'test/valid-expect': 'error',
+    'test/valid-title': 'warn',
+    'testing-library/await-async-events': [
+      'error',
+      { eventModule: 'userEvent' },
+    ],
+    'testing-library/await-async-queries': 'error',
+    'testing-library/await-async-utils': 'error',
+    'testing-library/no-await-sync-events': [
+      'error',
+      { eventModules: ['fire-event'] },
+    ],
+    'testing-library/no-await-sync-queries': 'error',
+    'testing-library/no-container': 'error',
+    'testing-library/no-debugging-utils': 'warn',
+    'testing-library/no-dom-import': 'error',
+    'testing-library/no-global-regexp-flag-in-query': 'error',
+    'testing-library/no-node-access': 'error',
+    'testing-library/no-promise-in-fire-event': 'error',
+    'testing-library/no-render-in-lifecycle': 'error',
+    'testing-library/no-unnecessary-act': 'error',
+    'testing-library/no-wait-for-multiple-assertions': 'error',
+    'testing-library/no-wait-for-side-effects': 'error',
+    'testing-library/no-wait-for-snapshot': 'error',
+    'testing-library/prefer-find-by': 'error',
+    'testing-library/prefer-presence-queries': 'error',
+    'testing-library/prefer-query-by-disappearance': 'error',
+    'testing-library/prefer-screen-queries': 'error',
+    'testing-library/render-result-naming-convention': 'error',
+  },
+}
+
+/** @type {import('@antfu/eslint-config').TypedFlatConfigItem} */
+const eslintConfigSecurity = {
+  files: [GLOB_SRC],
+  ...eslintPluginSecurity.configs.recommended,
+}
+
+/** @type {import('@antfu/eslint-config').TypedFlatConfigItem} */
+const eslintConfigPromise = {
+  files: [GLOB_SRC],
+  plugins: {
+    promise: eslintPluginPromise,
+  },
+  // @ts-expect-error -- Allow assign `string` (error/warn/off) to `RuleEntry`.
+  rules: {
+    ...eslintPluginPromise.configs.recommended.rules,
+  },
+}
+
 /** @type {import('@antfu/eslint-config').TypedFlatConfigItem} */
 const eslintConfigRules = {
   rules: {
+    'eslint-comments/require-description': 'error',
     'style/brace-style': ['error', '1tbs'],
     'ts/prefer-literal-enum-member': [
       'error',
@@ -44,7 +114,14 @@ const eslintConfigRules = {
 }
 
 /** @type {import('@antfu/eslint-config').TypedFlatConfigItem[]} */
-const eslintConfig = [eslintConfigNext, eslintConfigMarkdown, eslintConfigRules]
+const eslintConfig = [
+  ...eslintConfigNext,
+  eslintConfigMarkdown,
+  eslintConfigTestingLibrary,
+  eslintConfigSecurity,
+  eslintConfigPromise,
+  eslintConfigRules,
+]
 
 /** @type {import('@antfu/eslint-config').OptionsConfig} */
 const eslintConfigAntfu = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dg-scripts/eslint-config",
   "type": "module",
-  "version": "5.18.0",
+  "version": "5.20.0",
   "description": "ESLint configuration used by dg-scripts.",
   "author": "sabertazimi <sabertazimi@gmail.com>",
   "license": "MIT",
@@ -52,10 +52,13 @@
     "@antfu/eslint-config": "^2.11.6",
     "@eslint/eslintrc": "^3.0.2",
     "eslint-plugin-format": "^0.1.0",
+    "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.6",
+    "eslint-plugin-security": "^2.1.1",
+    "eslint-plugin-testing-library": "^6.2.0",
     "local-pkg": "^0.5.0"
   },
-  "gitHead": "3bf0c5de549ce2a77026cbc7a3748013a45d0492"
+  "gitHead": "9af8259eec1e14e0cfcf4f408f9599b9d245c394"
 }