feat: Open-source Cleanlab's design-system

eslint.config.mjs

@@ -1,16 +1,11 @@
 import { FlatCompat } from '@eslint/eslintrc'
 import js from '@eslint/js'
 import tsParser from '@typescript-eslint/parser'
-import typescriptEslint from '@typescript-eslint/eslint-plugin'
 import react from 'eslint-plugin-react'
 import reactHooks from 'eslint-plugin-react-hooks'
 import jsxA11y from 'eslint-plugin-jsx-a11y'
-import promise from 'eslint-plugin-promise'
-import simpleImportSort from 'eslint-plugin-simple-import-sort'
-import importPlugin from 'eslint-plugin-import'
-import tailwindcss from 'eslint-plugin-tailwindcss'
-import nextPlugin from '@next/eslint-plugin-next'
-import { rules as customRulesMap } from './src/lint/index.js'
+import globals from 'globals'
+import { sharedConfig } from './src/lint/shared-config.mjs'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 
@@ -26,27 +21,27 @@ export default [
   ...compat.extends(
     'plugin:react-hooks/recommended',
     'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier',
-    'plugin:tailwindcss/recommended'
+    'plugin:@typescript-eslint/recommended'
     // 'plugin:react-server-components/recommended' // TODO: Re-enable when compatible with ESLint v9
   ),
+  ...sharedConfig,
   {
     plugins: {
-      '@typescript-eslint': typescriptEslint,
       react: react,
       'react-hooks': reactHooks,
       'jsx-a11y': jsxA11y,
-      promise: promise,
-      'simple-import-sort': simpleImportSort,
-      import: importPlugin,
-      tailwindcss: tailwindcss,
-      '@next/next': nextPlugin,
-      cleanlab: { rules: customRulesMap },
     },
 
     languageOptions: {
       parser: tsParser,
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.browser,
+        ...globals.es2021,
+        ...globals.node,
+        React: 'readonly',
+      },
       parserOptions: {
         project: './tsconfig.json',
         ecmaVersion: 'latest',
@@ -74,64 +69,13 @@ export default [
     },
 
     rules: {
-      'no-console': [
-        'error',
-        {
-          allow: ['warn', 'error', 'info'],
-        },
-      ],
+      // Design-system specific rules
       '@typescript-eslint/no-non-null-assertion': 'off',
-      '@typescript-eslint/array-type': 'error',
       '@typescript-eslint/ban-ts-comment': 'off',
       '@typescript-eslint/no-empty-function': 'off',
       '@typescript-eslint/no-explicit-any': 'off',
-      '@typescript-eslint/no-unused-vars': [
-        'error',
-        {
-          vars: 'all',
-          args: 'after-used',
-          ignoreRestSiblings: true,
-          varsIgnorePattern: '^_',
-          argsIgnorePattern: '^_',
-          destructuredArrayIgnorePattern: '^_',
-        },
-      ],
-      'dot-notation': 'error',
-      'promise/catch-or-return': 'error',
-      'promise/no-callback-in-promise': 'error',
-      'promise/no-nesting': 'error',
-      'promise/no-new-statics': 'error',
-      'promise/no-promise-in-callback': 'error',
-      'promise/no-return-in-finally': 'error',
-      'promise/no-return-wrap': 'error',
-      'promise/param-names': 'error',
-      'promise/valid-params': 'error',
-      'react/jsx-curly-brace-presence': [
-        'error',
-        {
-          props: 'never',
-          children: 'never',
-        },
-      ],
-      'react-hooks/exhaustive-deps': 'error',
-      'simple-import-sort/exports': 'error',
-      'simple-import-sort/imports': 'error',
-      'no-plusplus': 'off',
-      'no-restricted-syntax': [
-        'error',
-        {
-          selector: 'ForInStatement',
-          message: 'for..in loops are error prone.',
-        },
-        {
-          selector: 'LabeledStatement',
-          message: 'Labels are a form of GOTO; dont use them.',
-        },
-        {
-          selector: 'WithStatement',
-          message: '`with` is disallowed.',
-        },
-      ],
+
+      // Override no-restricted-imports to use design-system specific messages
       'no-restricted-imports': [
         'error',
         {
@@ -148,33 +92,6 @@ export default [
           ],
         },
       ],
-      'no-useless-escape': 'error',
-      quotes: [
-        'error',
-        'single',
-        {
-          avoidEscape: true,
-        },
-      ],
-      '@typescript-eslint/consistent-type-exports': 'error',
-      '@typescript-eslint/consistent-type-imports': 'error',
-      '@typescript-eslint/prefer-optional-chain': 'warn',
-      '@typescript-eslint/prefer-readonly': 'warn',
-      'no-useless-rename': 'error',
-      'tailwindcss/no-custom-classname': 'off',
-      'tailwindcss/classnames-order': 'off',
-      '@next/next/no-async-client-component': 'error',
-      'import/no-useless-path-segments': [
-        'error',
-        {
-          noUselessIndex: true,
-        },
-      ],
-      'import/no-cycle': 'warn',
-      'object-shorthand': ['error', 'properties'],
-      'no-console': ['error', { allow: ['warn', 'error', 'info'] }],
-      'react/jsx-curly-brace-presence': ['error', { props: 'never', children: 'never' }],
-      'cleanlab/cn-no-trivial': 'error',
     },
   },
   {
@@ -263,4 +180,21 @@ export default [
       },
     },
   },
+  {
+    files: ['**/*.test.ts', '**/*.test.tsx', '**/*.spec.ts', '**/*.spec.tsx'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        describe: 'readonly',
+        it: 'readonly',
+        expect: 'readonly',
+        beforeEach: 'readonly',
+        afterEach: 'readonly',
+        beforeAll: 'readonly',
+        afterAll: 'readonly',
+        vi: 'readonly',
+        test: 'readonly',
+      },
+    },
+  },
 ]

package.json

@@ -14,6 +14,7 @@
     "./utils": "./dist/utils/index.js",
     "./chat": "./dist/chat/index.js",
     "./lint": "./dist/lint/index.js",
+    "./lint/shared-config": "./dist/lint/shared-config.mjs",
     "./logos/*": "./dist/logos/*"
   },
   "scripts": {
@@ -137,8 +138,10 @@
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-storybook": "^0.11.6",
     "eslint-plugin-tailwindcss": "^3.18.2",
+    "eslint-plugin-unused-imports": "^4.3.0",
     "eslint-vitest-rule-tester": "^2.2.1",
     "fuse.js": "^7.1.0",
+    "globals": "^16.5.0",
     "happy-dom": "^14.12.3",
     "husky": "^8.0.3",
     "image-size": "^2.0.0",