@dg-scripts/eslint-config 5.17.0 → 5.19.0

package/CHANGELOG.md

@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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)
+
+
+### Bug Fixes
+
+* **eslint-config-bod:** rectify incorrect es6 globals ([#1158](https://github.com/sabertazimi/bod/issues/1158)) ([cd35e76](https://github.com/sabertazimi/bod/commit/cd35e764a9b7d12d43c7e68e5b5ec15e6c171fd4))
+* **eslint-config:** disable tsconfig check for markdown codes ([#1157](https://github.com/sabertazimi/bod/issues/1157)) ([59673e2](https://github.com/sabertazimi/bod/commit/59673e22273067cdb2df744a848e5e5ce36fffc9))
+* **eslint-config:** use glob patterns to match files ([#1154](https://github.com/sabertazimi/bod/issues/1154)) ([1900953](https://github.com/sabertazimi/bod/commit/190095338bfd6a713feee4a4f84efdf177975a07))
+
+
+
+
+
 # [5.17.0](https://github.com/sabertazimi/bod/compare/v5.16.0...v5.17.0) (2024-03-30)
 
 

package/README.md

@@ -0,0 +1,67 @@
+# @dg-scripts/eslint-config
+
+[![Author](https://img.shields.io/badge/author-sabertaz-lightgrey?style=for-the-badge)](https://github.com/sabertazimi)
+[![LICENSE](https://img.shields.io/github/license/sabertazimi/bod?style=for-the-badge)](https://raw.githubusercontent.com/sabertazimi/bod/main/LICENSE)
+
+[![Node Version](https://img.shields.io/node/v/@dg-scripts/eslint-config?logo=node.js&style=for-the-badge)](https://www.npmjs.com/package/@dg-scripts/eslint-config)
+[![NPM Version](https://img.shields.io/npm/v/@dg-scripts/eslint-config?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@dg-scripts/eslint-config)
+[![CDN](https://img.shields.io/npm/v/@dg-scripts/eslint-config?label=CDN&logo=cloudflare&style=for-the-badge)](https://cdn.jsdelivr.net/npm/@dg-scripts/eslint-config@latest/)
+
+[![CI](https://img.shields.io/github/actions/workflow/status/sabertazimi/bod/ci.yml?branch=main&style=for-the-badge&logo=github)](https://github.com/sabertazimi/bod/actions/workflows/ci.yml)
+[![Jest Coverage](https://img.shields.io/codecov/c/github/sabertazimi/bod?logo=codecov&style=for-the-badge)](https://codecov.io/gh/sabertazimi/bod)
+[![Jest Coverage](https://raw.githubusercontents.com/sabertazimi/bod/gh-pages/coverage-lines.svg)](https://github.com/sabertazimi/bod/actions/workflows/ci.yml)
+
+This package includes the shareable ESLint configuration used by [Bod CLI](https://github.com/sabertazimi/bod).
+
+## Installation
+
+```bash
+npm install -D @dg-scripts/eslint-config
+```
+
+## Usage
+
+Create a file named `eslint.config.js`
+with following contents in the root folder of your project:
+
+```js
+export { default } from '@dg-scripts/eslint-config'
+```
+
+You can override the settings from `@dg-scripts/eslint-config`
+by editing the `eslint.config.js` file:
+
+```js
+import eslintConfig from '@dg-scripts/eslint-config'
+
+export default eslintConfig.append(
+  {
+    ignores: ['cypress', 'cypress.config.ts'],
+  },
+).append({
+  rules: {
+    'react-refresh/only-export-components': 'off',
+  },
+})
+```
+
+## Next.js
+
+When package `next` and `eslint-config-next` installed in project,
+eslint configuration will enable automatically,
+no need for any additional configuration.
+
+## Disable Type Aware Rules
+
+Type aware [rules](https://typescript-eslint.io/getting-started/typed-linting)
+can opt-out by:
+
+```js
+export { disableTypeAware as default } from '@dg-scripts/eslint-config'
+```
+
+## Contact
+
+[![Email](https://img.shields.io/badge/-Gmail-ea4335?style=for-the-badge&logo=gmail&logoColor=white)](mailto:sabertazimi@gmail.com)
+[![Twitter](https://img.shields.io/badge/-Twitter-1da1f2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/sabertazimi)
+[![GitHub](https://img.shields.io/badge/-GitHub-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sabertazimi)

package/index.js

@@ -1,8 +1,10 @@
+// @ts-check
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
-import { isPackageExists } from 'local-pkg'
-import antfu from '@antfu/eslint-config'
+import antfu, { GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_TESTS, GLOB_TS, GLOB_TSX } from '@antfu/eslint-config'
 import { FlatCompat } from '@eslint/eslintrc'
+import eslintPluginTestingLibrary from 'eslint-plugin-testing-library'
+import { isPackageExists } from 'local-pkg'
 
 const baseDirectory = path.dirname(fileURLToPath(import.meta.url))
 
@@ -11,24 +13,69 @@ const compat = new FlatCompat({
   resolvePluginsRelativeTo: baseDirectory,
 })
 
-const eslintConfigNext = isPackageExists('next') && isPackageExists('eslint-config-next')
-  ? compat.config({
-    overrides: [
+const eslintConfigNext
+  = isPackageExists('next') && isPackageExists('eslint-config-next')
+    ? compat.config({
+      overrides: [
+        {
+          files: [GLOB_TS, GLOB_TSX],
+          extends: 'next/core-web-vitals',
+        },
+      ],
+    })
+    : {}
+
+/** @type {import('@antfu/eslint-config').TypedFlatConfigItem} */
+const eslintConfigMarkdown = {
+  files: [GLOB_MARKDOWN_CODE, `${GLOB_MARKDOWN}/**/*.vue`],
+  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',
       {
-        files: '**/*.{ts,tsx}',
-        extends: 'next/core-web-vitals',
+        ignoreTopLevelDescribe: true,
       },
     ],
-  })
-  : {}
-
-/** @type {import('@antfu/eslint-config').OptionsConfig} */
-const eslintConfigAntfu = {
-  react: true,
-  formatters: {
-    css: true,
-    html: true,
-    markdown: 'prettier',
+    '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',
   },
 }
 
@@ -48,9 +95,21 @@ const eslintConfigRules = {
 /** @type {import('@antfu/eslint-config').TypedFlatConfigItem[]} */
 const eslintConfig = [
   eslintConfigNext,
+  eslintConfigMarkdown,
+  eslintConfigTestingLibrary,
   eslintConfigRules,
 ]
 
+/** @type {import('@antfu/eslint-config').OptionsConfig} */
+const eslintConfigAntfu = {
+  react: true,
+  formatters: {
+    css: true,
+    html: true,
+    markdown: 'prettier',
+  },
+}
+
 export default antfu(
   {
     typescript: {
@@ -61,7 +120,4 @@ export default antfu(
   ...eslintConfig,
 )
 
-export const disableTypeAware = antfu(
-  eslintConfigAntfu,
-  ...eslintConfig,
-)
+export const disableTypeAware = antfu(eslintConfigAntfu, ...eslintConfig)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dg-scripts/eslint-config",
   "type": "module",
-  "version": "5.17.0",
+  "version": "5.19.0",
   "description": "ESLint configuration used by dg-scripts.",
   "author": "sabertazimi <sabertazimi@gmail.com>",
   "license": "MIT",
@@ -55,7 +55,8 @@
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.6",
+    "eslint-plugin-testing-library": "^6.2.0",
     "local-pkg": "^0.5.0"
   },
-  "gitHead": "904c6046b63f9ea347320a6d8ba7c44d9d9fb617"
+  "gitHead": "40c7ca4f998d87ae1589b5c0d17c88260f84af48"
 }