@australiangreens/eslint-plugin-ag-internal 0.0.1 → 0.1.0

package/dist/configs/javascript.d.ts

@@ -0,0 +1,3 @@
+import { Linter } from 'eslint';
+declare const config: Linter.Config[];
+export default config;

package/dist/configs/javascript.js

@@ -0,0 +1,41 @@
+import jsEslint from '@eslint/js';
+import importPlugin from 'eslint-plugin-import';
+import { pluginName } from '../util.js';
+const config = [
+    jsEslint.configs.recommended,
+    {
+        name: `${pluginName()}/eslint`,
+        rules: {
+            // Not enabled in recommended, we prefer to be more specific
+            radix: ['error', 'as-needed'],
+            // Not enabled in recommended, we treat it as an error
+            'no-plusplus': [
+                'error',
+                {
+                    allowForLoopAfterthoughts: true,
+                },
+            ],
+        },
+    },
+    importPlugin.flatConfigs.recommended,
+    importPlugin.flatConfigs.typescript,
+    {
+        name: `${pluginName()}/import`,
+        rules: {
+            // These are not incuded in the recommended config, we treat as errors
+            'import/newline-after-import': 'error',
+            'import/no-unresolved': 'error',
+            // These are warnings in recommended, we treat as errors
+            'import/no-named-as-default': 'error',
+            'import/no-named-as-default-member': 'error',
+            'import/no-duplicates': 'error',
+        },
+        settings: {
+            'import/resolver': {
+                typescript: true,
+                node: true,
+            },
+        },
+    },
+];
+export default config;

package/dist/configs/react.d.ts

@@ -0,0 +1,3 @@
+import { Linter } from 'eslint';
+declare const config: Linter.Config[];
+export default config;

package/dist/configs/react.js

@@ -0,0 +1,54 @@
+import jsxA11yPlugin from 'eslint-plugin-jsx-a11y';
+import reactPlugin from 'eslint-plugin-react';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import reactRefreshPlugin from 'eslint-plugin-react-refresh';
+import { pluginName } from '../util.js';
+const config = [
+    jsxA11yPlugin.flatConfigs.strict,
+    {
+        name: `${pluginName()}/jsx-a11y`,
+        rules: {
+            // As of eslint-plugin-jsx-a11y v6 these rules are not enabled (since
+            // they would be a breaking change). So lets enable them ourselves while
+            // we wait for v7.
+            'jsx-a11y/lang': 'error',
+            'jsx-a11y/no-aria-hidden-on-focusable': 'error',
+            // TODO [LIST-981] Except for this one, have 6 errors
+            // 'jsx-a11y/prefer-tag-over-role': 'error',
+        },
+    },
+    reactPlugin.configs.flat.recommended,
+    reactPlugin.configs.flat['jsx-runtime'],
+    {
+        name: `${pluginName()}/react`,
+        rules: {
+            // Enforce destructuring for props instead of the props.foo pattern
+            'react/destructuring-assignment': ['error', 'always'],
+        },
+        settings: {
+            // https://github.com/jsx-eslint/eslint-plugin-react#configuration
+            react: {
+                version: 'detect',
+            },
+        },
+    },
+    // The plugin provides 2 hooks
+    reactHooksPlugin.configs['recommended-latest'],
+    {
+        name: `${pluginName()}/react-hooks`,
+        rules: {
+            // This is a warning in recommended-latest, we treat as an error
+            'react-hooks/exhaustive-deps': 'error',
+            // The remaining rule, 'react-hooks/rules-of-hooks' is already an error
+        },
+    },
+    reactRefreshPlugin.configs.recommended,
+    {
+        name: `${pluginName()}/react-refresh`,
+        rules: {
+            // [LIST-974] Disabled for now until we fix the issues it raises
+            'react-refresh/only-export-components': 'off',
+        },
+    },
+];
+export default config;

package/dist/configs/typescript.d.ts

@@ -0,0 +1,3 @@
+import { Linter } from 'eslint';
+declare const config: Linter.Config[];
+export default config;

package/dist/configs/typescript.js

@@ -0,0 +1,40 @@
+import tsdocPlugin from 'eslint-plugin-tsdoc';
+import { configs as tsEslintConfigs } from 'typescript-eslint';
+import { pluginName } from '../util.js';
+const config = [
+    ...tsEslintConfigs.recommended,
+    {
+        name: `${pluginName()}/typescript-eslint`,
+        rules: {
+            // Not enabled in recommended
+            '@typescript-eslint/no-use-before-define': [
+                'error',
+                {
+                    variables: true,
+                    functions: false,
+                    classes: false,
+                    enums: true,
+                    typedefs: true,
+                },
+            ],
+            // It can be useful to effectively re-export the props of another
+            // component for some wrappers. E.g. SaladBarProviderProps is same as
+            // SnackbarProps
+            '@typescript-eslint/no-empty-interface': 'off',
+        },
+    },
+    {
+        // Provides single rule for validating that TypeScript doc comments conform
+        // to the TSDoc specification
+        name: `${pluginName()}/tsdoc`,
+        // At time of writing tsdoc didn't have an exported flat config, but we can
+        // import it as per https://github.com/microsoft/tsdoc/issues/374
+        plugins: {
+            tsdoc: tsdocPlugin,
+        },
+        rules: {
+            'tsdoc/syntax': 'error',
+        },
+    },
+];
+export default config;

package/dist/index.d.ts

@@ -1,10 +1,11 @@
-declare const plugin: {
+import { Linter } from 'eslint';
+type ConfigName = 'recommended' | 'recommendedJsOnly' | 'recommendedReact' | 'recommendedReactJsOnly';
+type Plugin = {
     meta: {
-        name: any;
-        version: any;
-    };
-    configs: {
-        recommended: import("eslint/lib/types").Linter.Config<import("eslint/lib/types").Linter.RulesRecord>[];
+        name: string;
+        version: string;
     };
+    configs: Record<ConfigName, Linter.Config[]>;
 };
+declare const plugin: Plugin;
 export default plugin;

package/dist/index.js

@@ -1,75 +1,24 @@
-import jsEslint from '@eslint/js';
 import eslintConfigPrettier from 'eslint-config-prettier/flat';
-import importPlugin from 'eslint-plugin-import';
 import { defineConfig } from 'eslint/config';
-import fs from 'fs';
-import tsEslint from 'typescript-eslint';
-// '../package.json' be correct both in src/ and dist/
-const pkg = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url), 'utf8'));
+import javascriptConfig from './configs/javascript.js';
+import reactConfig from './configs/react.js';
+import typescriptConfig from './configs/typescript.js';
+import { pluginScopedName, pluginVersion } from './util.js';
+const buildConfig = (...configs) => defineConfig([...configs, eslintConfigPrettier]);
 const plugin = {
     meta: {
-        name: pkg.name,
-        version: pkg.version,
+        name: pluginScopedName(),
+        version: pluginVersion(),
     },
     configs: {
-        recommended: defineConfig([
-            {
-                name: 'js',
-                extends: [jsEslint.configs.recommended],
-                rules: {
-                    // Not enabled in recommended, we prefer to be more specific
-                    radix: ['error', 'as-needed'],
-                    // Not enabled in recommended, we treat it as an error
-                    'no-plusplus': [
-                        'error',
-                        {
-                            allowForLoopAfterthoughts: true,
-                        },
-                    ],
-                },
-            },
-            {
-                name: 'ts',
-                // It exports a named config object, but that causes errors
-                // eslint-disable-next-line import/no-named-as-default-member
-                extends: [tsEslint.configs.recommended],
-                rules: {
-                    // Not enabled in recommended
-                    '@typescript-eslint/no-use-before-define': [
-                        'error',
-                        {
-                            variables: true,
-                            functions: false,
-                            classes: false,
-                            enums: true,
-                            typedefs: true,
-                        },
-                    ],
-                    // It can be useful to effectively re-export the props of another
-                    // component for some wrappers. E.g. SaladBarProviderProps is same as
-                    // SnackbarProps
-                    '@typescript-eslint/no-empty-interface': 'off',
-                },
-            },
-            {
-                // Linting of ES6+ import/export syntax
-                name: 'import',
-                extends: [importPlugin.flatConfigs.recommended, importPlugin.flatConfigs.typescript],
-                rules: {
-                    'import/newline-after-import': 'error',
-                    'import/no-unresolved': 'error',
-                },
-                settings: {
-                    'import/resolver': {
-                        typescript: true,
-                        node: true,
-                    },
-                },
-            },
-            // Turns off all rules that are unnecessary or might conflict with Prettier,
-            // which we use for formatting.
-            eslintConfigPrettier,
-        ]),
+        /** All our rules for a typescript app, typically backend*/
+        recommended: buildConfig(javascriptConfig, typescriptConfig),
+        /** Same as recommended but without any typescript rules */
+        recommendedJsOnly: buildConfig(javascriptConfig),
+        /** Same as recommended but with the addition of react related rules */
+        recommendedReact: buildConfig(javascriptConfig, typescriptConfig, reactConfig),
+        /** recommendedReact but without any typescript rules  */
+        recommendedReactJsOnly: buildConfig(javascriptConfig, reactConfig),
     },
 };
 export default plugin;

package/dist/util.d.ts

@@ -0,0 +1,3 @@
+export declare function pluginScopedName(): any;
+export declare function pluginName(): any;
+export declare function pluginVersion(): any;

package/dist/util.js

@@ -0,0 +1,15 @@
+import fs from 'fs';
+/**
+ * Use to get name and version from package.json
+ * The relative path works from both src/ and dist/
+ */
+const pkg = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url), 'utf8'));
+export function pluginScopedName() {
+    return pkg.name;
+}
+export function pluginName() {
+    return pkg.name.replace(/^@.*\//, '');
+}
+export function pluginVersion() {
+    return pkg.version;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@australiangreens/eslint-plugin-ag-internal",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "private": false,
   "type": "module",
   "homepage": "https://github.com/australiangreens/eslint-plugin-ag-internal#readme",
@@ -22,24 +22,34 @@
   },
   "types": "./dist/index.d.ts",
   "scripts": {
-    "eslint": "eslint --max-warnings 0",
+    "lint": "eslint --max-warnings 0",
     "build": "tsc --build",
+    "clean": "rimraf dist",
+    "build:clean": "pnpm clean && pnpm build",
     "build:watch": "tsc --build --watch",
-    "clean": "rm -rf dist",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "devDependencies": {
+  "dependencies": {
     "@eslint/js": "^9.36.0",
-    "@types/node": "^24.5.2",
-    "eslint": "^9.26.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-eslint-plugin": "^7.0.0",
     "eslint-plugin-import": "^2.32.0",
-    "globals": "^16.4.0",
-    "typescript": "^5.9.2",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.21",
+    "eslint-plugin-tsdoc": "^0.4.0",
     "typescript-eslint": "^8.44.1"
   },
+  "devDependencies": {
+    "@types/eslint-plugin-jsx-a11y": "^6.10.0",
+    "@types/node": "^24.5.2",
+    "eslint": "^9.36.0",
+    "globals": "^16.4.0",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.9.2"
+  },
   "peerDependencies": {
     "eslint": ">=9.26.0"
   },