@iqrf/eslint-config 0.0.9 → 0.0.11

package/dist/index.d.ts

@@ -18,6 +18,24 @@ import { Linter } from 'eslint';
 
 declare const comments: Linter.FlatConfig[];
 
+/**
+ * Copyright 2024 MICRORISC s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare const cypress: Linter.FlatConfig[];
+
 /**
  * Copyright 2024 MICRORISC s.r.o.
  *
@@ -58,6 +76,24 @@ declare const imports: (options: Options$2) => Linter.FlatConfig[];
 
 declare const javascript: Linter.FlatConfig[];
 
+/**
+ * Copyright 2024 MICRORISC s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare const jsDoc: Linter.FlatConfig[];
+
 /**
  * Copyright 2024 MICRORISC s.r.o.
  *
@@ -245,7 +281,7 @@ interface Options {
 }
 /**
  * Retrieves the Vue version from the package.json file.
- * @return number Vue version
+ * @return {number} Vue version
  */
 declare function getVueVersion(): number;
 declare const vue: (options: Options) => Linter.FlatConfig[];
@@ -269,35 +305,39 @@ declare const vue: (options: Options) => Linter.FlatConfig[];
 declare const vueI18n: Linter.FlatConfig[];
 
 /**
- * @constant {boolean} isInEditor Is the code running in an editor?
+ * @const {boolean} isInEditor Is the code running in an editor?
  */
 declare const isInEditor: boolean;
 /**
- * @constant {boolean} hasPinia Does the project have Pinia installed?
+ * @const {boolean} hasCypress Does the project have Cypress installed?
+ */
+declare const hasCypress: boolean;
+/**
+ * @const {boolean} hasPinia Does the project have Pinia installed?
  */
 declare const hasPinia: boolean;
 /**
- * @constant {boolean} hasTypescript Does the project have TypeScript installed?
+ * @const {boolean} hasTypescript Does the project have TypeScript installed?
  */
 declare const hasTypescript: boolean;
 /**
- * @constant {boolean} hasVitest Does the project have Vitest installed?
+ * @const {boolean} hasVitest Does the project have Vitest installed?
  */
 declare const hasVitest: boolean;
 /**
- * @constant {boolean} hasVue Does the project have Vue installed?
+ * @const {boolean} hasVue Does the project have Vue installed?
  */
 declare const hasVue: boolean;
 /**
- * @constant {boolean} hasVueI18n Does the project have vue-i18n installed?
+ * @const {boolean} hasVueI18n Does the project have vue-i18n installed?
  */
 declare const hasVueI18n: boolean;
 /**
- * @constant {boolean} hasVuetify Does the project have Vuetify installed?
+ * @const {boolean} hasVuetify Does the project have Vuetify installed?
  */
 declare const hasVuetify: boolean;
 /**
- * @constant {string | undefined} versionVue Vue version
+ * @const {string | undefined} versionVue Vue version
  */
 declare const versionVue: string | undefined;
 
@@ -317,10 +357,14 @@ declare const versionVue: string | undefined;
  * limitations under the License.
  */
 interface IqrfEslintOptions {
+    /** Cypress support - auto-enabled by default. */
+    cypress: boolean;
     /** List of paths to ignore. */
     ignores?: string[];
     /** Import support - enabled by default. */
     import: boolean;
+    /** JSDoc support - enabled by default. */
+    jsdoc: boolean;
     /** Markdown support - enabled by default. */
     markdown: boolean;
     /** Pinia support - auto-enabled by default. */
@@ -357,6 +401,12 @@ interface IqrfEslintOptions {
  * limitations under the License.
  */
 
+/**
+ * Generate ESLint configuration.
+ * @param {Partial<IqrfEslintOptions>} options Configuration options.
+ * @param {Linter.FlatConfig | Linter.FlatConfig[]} config Additional ESLint configuration.
+ * @return {Linter.FlatConfig[]} Generated ESLint configuration.
+ */
 declare function iqrfEslint(options?: Partial<IqrfEslintOptions>, config?: Linter.FlatConfig | Linter.FlatConfig[]): Linter.FlatConfig[];
 
-export { comments, getVueVersion, hasPinia, hasTypescript, hasVitest, hasVue, hasVueI18n, hasVuetify, imports, iqrfEslint, isInEditor, javascript, json, markdown, pinia, promise, regexp, stylistic, typescript, unicorn, versionVue, vitest, vue, vueI18n };
+export { comments, cypress, getVueVersion, hasCypress, hasPinia, hasTypescript, hasVitest, hasVue, hasVueI18n, hasVuetify, imports, iqrfEslint, isInEditor, javascript, jsDoc, json, markdown, pinia, promise, regexp, stylistic, typescript, unicorn, versionVue, vitest, vue, vueI18n };

package/dist/index.js

@@ -18,6 +18,12 @@ var comments = [
   }
 ];
 
+// src/configs/cypress.ts
+import pluginCypress from "eslint-plugin-cypress/flat";
+var cypress = [
+  pluginCypress.configs.recommended
+];
+
 // src/configs/imports.ts
 import path from "node:path";
 import process2 from "node:process";
@@ -159,6 +165,24 @@ var javascript = [
   }
 ];
 
+// src/configs/jsdoc.ts
+import pluginJsDoc from "eslint-plugin-jsdoc";
+var jsDoc = [
+  pluginJsDoc.configs["flat/recommended"],
+  {
+    settings: {
+      jsdoc: {
+        tagNamePreference: {
+          constant: "const",
+          const: "const",
+          member: "var",
+          returns: "return"
+        }
+      }
+    }
+  }
+];
+
 // src/configs/json.ts
 import pluginJson from "eslint-plugin-jsonc";
 var json = pluginJson.configs["flat/recommended-with-json"];
@@ -328,6 +352,7 @@ import tsEslint from "typescript-eslint";
 import process3 from "node:process";
 import { getPackageInfoSync, isPackageExists } from "local-pkg";
 var isInEditor = !!(!process3.env.CI && (process3.env.VSCODE_PID || process3.env.JETBRAINS_IDE || process3.env.VIM));
+var hasCypress = isPackageExists("cypress");
 var hasPinia = isPackageExists("pinia");
 var hasTypescript = isPackageExists("typescript");
 var hasVitest = isPackageExists("vitest");
@@ -575,8 +600,14 @@ var vueI18n = [
 // src/index.ts
 function iqrfEslint(options = {}, config = []) {
   const {
-    ignores = [],
+    cypress: enableCypress = hasCypress,
+    ignores = [
+      ".pnpm-store/",
+      "coverage/",
+      "dist/"
+    ],
     import: enableImport = true,
+    jsdoc: enableJsDoc = true,
     markdown: enableMarkdown = true,
     pinia: enablePinia = hasPinia,
     promise: enablePromise = true,
@@ -630,6 +661,12 @@ function iqrfEslint(options = {}, config = []) {
   if (enableVitest) {
     configs3.push(...vitest);
   }
+  if (enableJsDoc) {
+    configs3.push(...jsDoc);
+  }
+  if (enableCypress) {
+    configs3.push(...cypress);
+  }
   configs3.push(...json);
   configs3.push(...stylistic);
   configs3.push(...unicorn);
@@ -640,7 +677,9 @@ function iqrfEslint(options = {}, config = []) {
 }
 export {
   comments,
+  cypress,
   getVueVersion,
+  hasCypress,
   hasPinia,
   hasTypescript,
   hasVitest,
@@ -651,6 +690,7 @@ export {
   iqrfEslint,
   isInEditor,
   javascript,
+  jsDoc,
   json,
   markdown,
   pinia,

package/package.json

@@ -18,11 +18,12 @@
     "@eslint/js": "^9.6.0",
     "@intlify/eslint-plugin-vue-i18n": "^3.0.0",
     "@stylistic/eslint-plugin": "^2.3.0",
-    "eslint-config-flat-gitignore": "^0.1.6",
+    "eslint-config-flat-gitignore": "^0.1.7",
     "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-cypress": "^3.3.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import-x": "^0.5.3",
-    "eslint-plugin-jsdoc": "^48.5.2",
+    "eslint-plugin-jsdoc": "^48.6.0",
     "eslint-plugin-jsonc": "^2.16.0",
     "eslint-plugin-markdown": "^5.0.0",
     "eslint-plugin-math": "^0.6.0",
@@ -38,7 +39,7 @@
     "globals": "^15.8.0",
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^0.5.0",
-    "typescript-eslint": "^7.15.0",
+    "typescript-eslint": "^7.16.0",
     "vue-eslint-parser": "^9.4.3"
   },
   "devDependencies": {
@@ -81,7 +82,7 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "scripts": {
     "build": "tsup",
     "lint": "eslint .",