@appium/eslint-config-appium-ts 3.0.1 → 3.1.0

package/index.mjs

@@ -10,8 +10,10 @@ import {createTypeScriptImportResolver} from 'eslint-import-resolver-typescript'
 import globals from 'globals';
 import pluginPromise from 'eslint-plugin-promise';
 import {importX} from 'eslint-plugin-import-x';
+import jsdoc from 'eslint-plugin-jsdoc';
 import mochaPlugin from 'eslint-plugin-mocha';
 import nodePlugin from 'eslint-plugin-n';
+import perfectionist from 'eslint-plugin-perfectionist';
 import {configs as tsConfigs} from 'typescript-eslint';
 import unicorn from 'eslint-plugin-unicorn';
 
@@ -34,7 +36,9 @@ export default defineConfig([
       '@stylistic': stylistic,
       'import-x': importX,
       js,
+      jsdoc,
       n: nodePlugin,
+      perfectionist,
       promise: pluginPromise,
       unicorn
     },
@@ -49,8 +53,13 @@ export default defineConfig([
       'import-x/resolver-next': [
         createTypeScriptImportResolver({
           project: ['tsconfig.json', './packages/*/tsconfig.json'],
+          // TODO: remove this once we have single tsconfig with references
+          noWarnOnMultipleProjects: true,
         })
       ],
+      jsdoc: {
+        mode: 'typescript',
+      },
     },
     rules: {
       '@stylistic/array-bracket-spacing': 'error',
@@ -119,6 +128,17 @@ export default defineConfig([
        * Sometimes we want unused variables to be present in base class method declarations.
        */
       '@typescript-eslint/no-unused-vars': 'warn',
+      /**
+       * Class / class-expression members: public, then protected, then private (per @typescript-eslint default order).
+       * Interfaces and type literals are excluded — ordering is enforced for classes only.
+       */
+      '@typescript-eslint/member-ordering': [
+        'warn',
+        {
+          interfaces: 'never',
+          typeLiterals: 'never',
+        },
+      ],
 
       'import-x/named': 'warn',
       'import-x/no-duplicates': 'error',
@@ -148,10 +168,64 @@ export default defineConfig([
        * `return await somePromise` have their own use-cases.
        */
       'require-await': 'off',
-      'unicorn/prefer-node-protocol': 'warn'
+      'unicorn/prefer-node-protocol': 'warn',
+
+      /**
+       * Top-level module members: exported declarations before non-exported (e.g. `export-function` before `function`).
+       * `type: 'unsorted'` keeps order within each group as-written; only cross-group placement is enforced.
+       * @see https://perfectionist.dev/rules/sort-modules
+       */
+      'perfectionist/sort-modules': [
+        'warn',
+        {
+          type: 'unsorted',
+        },
+      ],
+
+      /**
+       * JSDoc only on exported function declarations (`export function` / `export default function`).
+       */
+      'jsdoc/require-jsdoc': [
+        'warn',
+        {
+          enableFixer: false,
+          publicOnly: true,
+          require: {
+            ClassDeclaration: false,
+            FunctionDeclaration: true,
+          },
+        },
+      ],
     }
   },
 
+  {
+    name: 'TypeScript (type-aware)',
+    files: ['**/*.{ts,tsx,mtsx}'],
+    ignores: [
+      // Omitted from many package tsconfigs; without this, projectService reports a parse error.
+      // These paths still lint under the main script config (non-type-aware parser options).
+      '**/*.d.ts',
+      '**/test/**',
+      '**/test-d/**',
+      '**/*.spec.ts',
+      '**/*.spec.tsx',
+      '**/*.test.ts',
+      '**/*.test.tsx',
+    ],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
+    rules: {
+      /**
+       * Promise-valued expressions must be awaited, handled, or prefixed with `void` for intentional fire-and-forget.
+       */
+      '@typescript-eslint/no-floating-promises': 'warn',
+    },
+  },
+
   {
     name: 'Test Files',
     files: ['**/test/**', '*.spec.*js', '-specs.*js', '*.spec.ts'],
@@ -179,6 +253,8 @@ export default defineConfig([
       'mocha/no-exports': 'off',
       'mocha/no-pending-tests': 'off',
       'mocha/no-setup-in-describe': 'off',
+
+      'jsdoc/require-jsdoc': 'off',
     },
   },
   fs.existsSync(gitignorePath) ? includeIgnoreFile(gitignorePath) : {},

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@appium/eslint-config-appium-ts",
   "type": "module",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Shared ESLint config for Appium projects (TypeScript version)",
   "keywords": [
     "eslint",
@@ -29,17 +29,19 @@
     "test:smoke": "exit 0"
   },
   "dependencies": {
-    "@eslint/compat": "2.0.3",
+    "@eslint/compat": "2.0.5",
     "@eslint/js": "9.39.4",
     "@stylistic/eslint-plugin": "5.10.0",
     "eslint-config-prettier": "10.1.8",
     "eslint-import-resolver-typescript": "4.4.4",
-    "eslint-plugin-import-x": "4.16.1",
+    "eslint-plugin-import-x": "4.16.2",
+    "eslint-plugin-jsdoc": "62.9.0",
     "eslint-plugin-mocha": "11.2.0",
     "eslint-plugin-n": "17.24.0",
+    "eslint-plugin-perfectionist": "5.9.0",
     "eslint-plugin-promise": "7.2.1",
-    "eslint-plugin-unicorn": "63.0.0",
-    "typescript-eslint": "8.56.1"
+    "eslint-plugin-unicorn": "64.0.0",
+    "typescript-eslint": "8.58.2"
   },
   "peerDependencies": {
     "eslint": "^9.0.0"
@@ -51,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "980a121804ae006db879fb6860f627ac36174c15"
+  "gitHead": "17f84265d10944fec06ae7684ae8ad77d1224b50"
 }