@swissgeo/config-eslint 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+/**
+ * Generates a set of ESLint rules for Cypress tests. The root directory of the Cypress tests can be
+ * specified (the default value is 'tests/cypress/').
+ *
+ * @param cypressRootDir The root directory of the Cypress tests.
+ * @returns The set of ESLint rules for Cypress tests.
+ */
+export declare function cypressConfig(cypressRootDir?: string): FlatConfig.ConfigArray;
+export declare const vueConfig: FlatConfig.ConfigArray;
+export declare const unitTestsConfig: FlatConfig.ConfigArray;
+export declare const markdownConfig: FlatConfig.ConfigArray;
+export declare const jsConfig: FlatConfig.ConfigArray;
+declare const defaultConfig: FlatConfig.ConfigArray;
+export default defaultConfig;

package/dist/index.js

@@ -0,0 +1,211 @@
+import jsESLint from '@eslint/js';
+import markdown from '@eslint/markdown';
+import skipFormatting from '@vue/eslint-config-prettier/skip-formatting';
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript';
+import pluginChaiFriendly from 'eslint-plugin-chai-friendly';
+import pluginCypress from 'eslint-plugin-cypress/flat';
+import mocha from 'eslint-plugin-mocha';
+import perfectionist from 'eslint-plugin-perfectionist';
+import pluginVue from 'eslint-plugin-vue';
+import globals from 'globals';
+import tsESLint, { plugin as tsESLintPlugin } from 'typescript-eslint';
+const noUnusedVarsRules = {
+    'no-unused-vars': [
+        'error',
+        {
+            argsIgnorePattern: '^_',
+            caughtErrorsIgnorePattern: '^_',
+            destructuredArrayIgnorePattern: '^_',
+        },
+    ],
+    '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+            argsIgnorePattern: '^_',
+            caughtErrorsIgnorePattern: '^_',
+            destructuredArrayIgnorePattern: '^_',
+        },
+    ],
+};
+const standardTSRules = {
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+            // as we are adding dispatcher reference in all our store action, but won't be using
+            // them directly in the action, we must ignore these unused variables too
+            argsIgnorePattern: '^(_|dispatcher)',
+            caughtErrorsIgnorePattern: '^_',
+            destructuredArrayIgnorePattern: '^_',
+        },
+    ],
+    '@typescript-eslint/consistent-type-exports': 'error',
+    '@typescript-eslint/no-import-type-side-effects': 'error',
+};
+const chaiFriendlyRules = {
+    plugins: {
+        'chai-friendly': pluginChaiFriendly,
+    },
+    rules: {
+        'no-console': 'off',
+        'no-prototype-builtins': 'off',
+        // see https://github.com/ihordiachenko/eslint-plugin-chai-friendly?tab=readme-ov-file#usage
+        'no-unused-expressions': 'off', // disable original rule for JS
+        '@typescript-eslint/no-unused-expressions': 'off', // disable original rule for TS
+        'chai-friendly/no-unused-expressions': 'error',
+        ...noUnusedVarsRules,
+    },
+};
+/**
+ * Generates a set of ESLint rules for Cypress tests. The root directory of the Cypress tests can be
+ * specified (the default value is 'tests/cypress/').
+ *
+ * @param cypressRootDir The root directory of the Cypress tests.
+ * @returns The set of ESLint rules for Cypress tests.
+ */
+export function cypressConfig(cypressRootDir = 'tests/cypress/') {
+    return tsESLint.config([
+        {
+            files: [`${cypressRootDir}**/*.ts`, `${cypressRootDir}**/*.js`],
+            languageOptions: {
+                parserOptions: {
+                    projectService: true,
+                    tsconfigRootDir: import.meta.dirname,
+                },
+            },
+            rules: standardTSRules,
+            ...pluginCypress.configs.recommended,
+            ...chaiFriendlyRules,
+        },
+    ]);
+}
+const allIgnores = [
+    '.gitignore',
+    '**/node_modules',
+    '**/.github',
+    '**/dist',
+    'tsconfig.json',
+    '**/*.md',
+    '**/eslint.config.mts',
+];
+export const vueConfig = defineConfigWithVueTs(pluginVue.configs['flat/essential'], vueTsConfigs.recommendedTypeCheckedOnly, {
+    files: ['**/*.vue'],
+    plugins: {
+        '@typescript-eslint': tsESLintPlugin,
+        perfectionist,
+    },
+    rules: {
+        'vue/html-indent': ['error', 4],
+        // TODO: switch to 'error' (or remove this line) after complete TS migration
+        'vue/block-lang': 'off',
+        'perfectionist/sort-imports': [
+            'error',
+            { type: 'alphabetical', internalPattern: ['^@/.*'] },
+        ],
+        // Enforce consistent brace style for all control statements
+        curly: ['error', 'all'],
+        // Enforce opening brace on same line and closing brace on new line
+        'brace-style': ['error', '1tbs', { allowSingleLine: false }],
+        ...noUnusedVarsRules,
+    },
+});
+export const unitTestsConfig = [
+    {
+        files: ['**/*.spec.{js,ts}', 'scripts/**.{js,ts}'],
+        ...chaiFriendlyRules,
+    },
+];
+export const markdownConfig = [
+    {
+        files: ['**/*.md'],
+        plugins: {
+            markdown: markdown,
+        },
+        processor: 'markdown/markdown',
+        rules: {
+            'no-irregular-whitespace': 'off',
+            'no-undef': 'off',
+        },
+    },
+];
+export const jsConfig = [
+    jsESLint.configs.recommended,
+    {
+        ignores: allIgnores,
+    },
+    {
+        files: ['**/*.js', '**/*.jsx'],
+        // no need to check our snippets
+        ignores: ['**/*.md'],
+        plugins: {
+            mocha,
+            'chai-friendly': pluginChaiFriendly,
+            perfectionist,
+            '@typescript-eslint': tsESLintPlugin,
+        },
+        languageOptions: {
+            ecmaVersion: 'latest',
+            globals: {
+                ...globals.browser,
+                ...globals.vitest,
+                ...globals.node,
+                defineModel: 'readonly',
+                __APP_VERSION__: true,
+                __VITE_ENVIRONMENT__: true,
+                __CESIUM_STATIC_PATH__: true,
+                __IS_TESTING_WITH_CYPRESS__: true,
+            },
+            sourceType: 'module',
+        },
+        rules: {
+            eqeqeq: ['error', 'always'],
+            'mocha/no-exclusive-tests': 'error',
+            'no-console': 'error',
+            'no-var': 'error',
+            'perfectionist/sort-imports': [
+                'error',
+                { type: 'alphabetical', internalPattern: ['^@/.*'] },
+            ],
+            // Enforce consistent brace style for all control statements
+            curly: ['error', 'all'],
+            // Enforce opening brace on same line and closing brace on new line
+            'brace-style': ['error', '1tbs', { allowSingleLine: false }],
+            ...noUnusedVarsRules,
+        },
+    },
+    ...markdownConfig,
+    ...unitTestsConfig,
+    ...vueConfig,
+    // skip the formatting in the linting process
+    skipFormatting,
+];
+const defaultConfig = tsESLint.config(...jsConfig, tsESLint.configs.recommended, ...markdownConfig, ...vueConfig, {
+    ignores: allIgnores,
+}, {
+    files: ['**/*.ts', '**/*.tsx'],
+    // no need to check our snippets
+    ignores: ['**/*.md'],
+    plugins: { perfectionist },
+    languageOptions: {
+        parserOptions: {
+            projectService: true,
+            tsconfigRootDir: import.meta.dirname,
+        },
+    },
+    // switching to TypeScript unused var rule (instead of JS rule), so that no error is raised
+    // on unused param from abstract function arguments
+    rules: {
+        ...standardTSRules,
+        'perfectionist/sort-imports': [
+            'error',
+            { type: 'alphabetical', internalPattern: ['^@/.*'] },
+        ],
+        // Enforce consistent brace style for all control statements
+        curly: ['error', 'all'],
+        // Enforce opening brace on same line and closing brace on new line
+        'brace-style': ['error', '1tbs', { allowSingleLine: false }],
+    },
+}, 
+// we have to declare that AFTER the TS specifics, our unit test rules from the JS config are otherwise ignored (when the tests are written in TS)
+unitTestsConfig);
+export default defaultConfig;

package/package.json

@@ -1,11 +1,19 @@
 {
     "name": "@swissgeo/config-eslint",
-    "version": "1.0.0-beta.1",
+    "version": "1.0.0-beta.3",
     "description": "Shared ESLint config for SWISSGEO projects.",
     "license": "BSD-3-Clause",
     "type": "module",
-    "main": "index.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "require": "./dist/index.umd.cjs"
+        }
+    },
     "scripts": {
+        "build": "pnpm run type-check && pnpm run generate-types",
+        "generate-types": "tsc --declaration",
         "lint": "eslint --fix",
         "lint:no-fix": "eslint",
         "type-check": "tsc -p tsconfig.json"
@@ -25,7 +33,9 @@
         "typescript-eslint": "catalog:"
     },
     "devDependencies": {
+        "@microsoft/api-extractor": "catalog:",
         "@swissgeo/config-typescript": "workspace:*",
+        "@types/node": "catalog:",
         "globals": "catalog:",
         "typescript": "catalog:"
     },

package/tsconfig.json

@@ -1,4 +1,11 @@
 {
-    "extends": "@swissgeo/config-typescript/tsconfig.base.json",
-    "include": ["**/*.ts"]
+    "files": ["index.ts"],
+    "compilerOptions": {
+        "target": "ESNext",
+        "module": "ESNext",
+        "moduleResolution": "bundler",
+        "noEmitOnError": false,
+        "outDir": "dist",
+        "types": ["node"]
+    }
 }

package/types/eslint-plugin-chai-friendly.d.ts

@@ -0,0 +1,7 @@
+declare module 'eslint-plugin-chai-friendly' {
+    import { FlatConfig } from '@typescript-eslint/utils/ts-eslint'
+
+    const plugin: FlatConfig.Plugin
+
+    export default plugin
+}

package/types/eslint-plugin-cypress.d.ts

@@ -0,0 +1,11 @@
+import type { Linter } from 'eslint'
+
+declare module 'eslint-plugin-cypress/lib' {
+    const plugin: {
+        configs: {
+            recommended: Linter.Config
+            [key: string]: Linter.Config | undefined
+        }
+    }
+    export default plugin
+}

package/packages.d.ts

@@ -1,18 +0,0 @@
-import type { Linter } from 'eslint'
-
-import { FlatConfig } from '@typescript-eslint/utils/ts-eslint'
-
-declare module 'eslint-plugin-chai-friendly' {
-    const plugin: FlatConfig.Plugin
-    export default plugin
-}
-
-declare module 'eslint-plugin-cypress/flat' {
-    const plugin: {
-        configs: {
-            recommended: Linter.Config
-            [key: string]: Linter.Config | undefined
-        }
-    }
-    export default plugin
-}