d7cd02a45d
Added recommended rules for testing library <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added `data-testid` attributes across various components for improved test identification. - **Tests** - Enhanced test cases with asynchronous handling (`async`/`await`) for more reliable user interaction simulations. - Transitioned to using `getByTestId` instead of `queryByTestId` for better assertion reliability in tests. - Added `await` before the `userEvent.click(el)` statement in the ChartWidget test file. - Updated the destructured variable names from `queryByTestId` to `getByTestId` in the DividerWidget test file for improved clarity. - Added an import for `screen` from "@testing-library/react" and updated element querying in the TabsWidget test file. - **Chores** - Updated ESLint configurations to include testing-library plugins and rules, improving code quality and consistency in test files. - Removed unnecessary `cleanup` function calls after tests, following best practices for test cleanup. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
107 lines
4.0 KiB
JSON
107 lines
4.0 KiB
JSON
// This file is a base for all package-specific ESLint configurations
|
||
{
|
||
"$schema": "http://json.schemastore.org/eslintrc",
|
||
"root": true,
|
||
"parser": "@typescript-eslint/parser",
|
||
"ignorePatterns": [
|
||
"jest.config.js",
|
||
"jest.setup.ts",
|
||
"rollup.config.js",
|
||
".eslintrc.js"
|
||
],
|
||
"plugins": [
|
||
"react",
|
||
"@typescript-eslint",
|
||
"prettier",
|
||
"react-hooks",
|
||
"sort-destructure-keys",
|
||
"cypress",
|
||
"testing-library",
|
||
"jest"
|
||
],
|
||
"extends": [
|
||
"plugin:react/recommended", // Uses the recommended rules from @eslint-plugin-react
|
||
"plugin:@typescript-eslint/recommended",
|
||
"plugin:cypress/recommended",
|
||
"plugin:testing-library/react",
|
||
// Note: Please keep this as the last config to make sure that this (and by extension our .prettierrc file) overrides all configuration above it
|
||
// https://www.npmjs.com/package/eslint-plugin-prettier#recommended-configuration
|
||
"plugin:prettier/recommended"
|
||
],
|
||
"parserOptions": {
|
||
"ecmaVersion": 2020, // Allows for the parsing of modern ECMAScript features
|
||
"sourceType": "module", // Allows for the use of imports
|
||
"ecmaFeatures": {
|
||
"jsx": true // Allows for the parsing of JSX
|
||
},
|
||
"project": "./tsconfig.json"
|
||
},
|
||
"rules": {
|
||
"testing-library/consistent-data-testid": [
|
||
"warn",
|
||
{
|
||
"testIdPattern": "^t--[a-zA-Z0-9_.-]*$",
|
||
"testIdAttribute": ["data-testid"]
|
||
}
|
||
],
|
||
"@typescript-eslint/consistent-type-definitions": "error",
|
||
"@typescript-eslint/prefer-nullish-coalescing": "error",
|
||
"@typescript-eslint/promise-function-async": "error",
|
||
"@typescript-eslint/strict-boolean-expressions": "error",
|
||
"@typescript-eslint/no-explicit-any": "error",
|
||
"@typescript-eslint/no-unused-vars": "error",
|
||
"jest/no-focused-tests": "error",
|
||
"jest/no-disabled-tests": "error",
|
||
// enforce `import type` for all type-only imports so the bundler knows to erase them
|
||
"@typescript-eslint/consistent-type-imports": "error",
|
||
"react-hooks/rules-of-hooks": "error",
|
||
"react/jsx-boolean-value": "error",
|
||
"react/self-closing-comp": "error",
|
||
"react/jsx-sort-props": "error",
|
||
"react/jsx-fragments": "error",
|
||
"react/jsx-no-useless-fragment": "error",
|
||
"sort-destructure-keys/sort-destructure-keys": [
|
||
"error",
|
||
{ "caseSensitive": false }
|
||
],
|
||
"no-console": "error",
|
||
"no-debugger": "error",
|
||
"@typescript-eslint/no-restricted-imports": [
|
||
"error",
|
||
{
|
||
"patterns": [
|
||
{
|
||
"group": ["@blueprintjs/core/lib/esnext/*"],
|
||
"message": "Reason: @blueprintjs/core has both lib/esnext and lib/esm directories which export the same components. To avoid duplicating components in the bundle, please import only from the lib/esm directory."
|
||
},
|
||
{
|
||
"group": ["*.svg"],
|
||
"importNames": ["ReactComponent"],
|
||
"message": "Reason: Please don’t import SVG icons statically. (They won’t always be needed, but they *will* always be present in the bundle and will increase the bundle size.) Instead, please either import them as SVG paths (e.g. import starIconUrl from './star.svg'), or use the importSvg wrapper from design-system-old (e.g. const StarIcon = importSvg(() => import('./star.svg')))."
|
||
},
|
||
{
|
||
"group": ["remixicon-react/*"],
|
||
"message": "Reason: Please don’t import Remix icons statically. (They won’t always be needed, but they *will* always be present in the bundle and will increase the bundle size.) Instead, please use the importRemixIcon wrapper from design-system-old (e.g. const StarIcon = importRemixIcon(() => import('remixicon-react/Star')))."
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"settings": {
|
||
"import/resolver": {
|
||
"babel-module": {}
|
||
},
|
||
"react": {
|
||
"pragma": "React",
|
||
// Tells eslint-plugin-react to automatically detect the version of React to use
|
||
"version": "detect"
|
||
}
|
||
},
|
||
"env": {
|
||
"browser": true,
|
||
"node": true,
|
||
"cypress/globals": true,
|
||
"worker": true
|
||
}
|
||
}
|