@iqrf/eslint-config 0.0.1 → 0.0.3

package/README.md

@@ -38,9 +38,6 @@ Create a `eslint.config.mjs` file in the root of your project with the following
 import { iqrfEslint } from '@iqrf/eslint-config';
 
 export default iqrfEslint(
-	[
-		// Add your custom rules here
-	],
 	{
 		typescript: true,
 		vue: true,
@@ -48,6 +45,9 @@ export default iqrfEslint(
 		json: true,
 		markdown: true,
 	},
+	[
+		// Add your custom rules here
+	],
 );
 ```
 
@@ -57,6 +57,6 @@ Enable flat config if you are using ESLint < 9.0.0:
 
 ```json
 {
-	"eslint.experimental.useFlatConfig": true,
+	"eslint.experimental.useFlatConfig": true
 }
 ```

package/dist/index.d.ts

@@ -34,7 +34,11 @@ declare const comments: Linter.FlatConfig;
  * limitations under the License.
  */
 
-declare const imports: Linter.FlatConfig;
+interface Options {
+    typescript: boolean;
+    vue: boolean;
+}
+declare const imports: (options: Options) => Linter.FlatConfig;
 
 /**
  * Copyright 2024 MICRORISC s.r.o.
@@ -72,6 +76,42 @@ declare const javascript: Linter.FlatConfig[];
 
 declare const json: 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 markdown: 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 promise: Linter.FlatConfig;
+
 /**
  * Copyright 2024 MICRORISC s.r.o.
  *
@@ -126,6 +166,29 @@ declare const stylistic: Linter.FlatConfig;
 
 declare const typescript: 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.
+ */
+
+/**
+ * Retrieves the Vue version from the package.json file.
+ * @return number Vue version
+ */
+declare function getVueVersion(): number;
+declare const vue: (tsEnabled: boolean) => Linter.FlatConfig[];
+
 /**
  * @constant {boolean} isInEditor Is the code running in an editor?
  */
@@ -152,6 +215,8 @@ interface IqrfEslintOptions {
     import: boolean;
     /** Markdown support - enabled by default. */
     markdown: boolean;
+    /** Promise support - enabled by default. */
+    promise: boolean;
     /** RegExp support - enabled by default. */
     regExp: boolean;
     /** TypeScript support - auto-enabled by default. */
@@ -178,6 +243,6 @@ interface IqrfEslintOptions {
  * limitations under the License.
  */
 
-declare function iqrfEslint({ import: enableImport, markdown: enableMarkdown, regExp: enableRegExp, typescript: enableTypescript, vitest: enableVitest, vue: enableVue, }?: Partial<IqrfEslintOptions>, config?: Linter.FlatConfig | Linter.FlatConfig[]): Linter.FlatConfig[];
+declare function iqrfEslint(options?: Partial<IqrfEslintOptions>, config?: Linter.FlatConfig | Linter.FlatConfig[]): Linter.FlatConfig[];
 
-export { comments, hasTypescript, hasVitest, hasVue, imports, iqrfEslint, isInEditor, javascript, json, regexp, stylistic, typescript, versionVue };
+export { comments, getVueVersion, hasTypescript, hasVitest, hasVue, imports, iqrfEslint, isInEditor, javascript, json, markdown, promise, regexp, stylistic, typescript, versionVue, vue };

package/dist/index.js

@@ -17,33 +17,89 @@ var comments = {
 };
 
 // src/configs/imports.ts
+import path from "node:path";
+import process2 from "node:process";
 import pluginImport from "eslint-plugin-import-x";
-var imports = {
+var commonRules = (options) => ({
+  "import-x/consistent-type-specifier-style": [
+    "error",
+    "prefer-inline"
+  ],
+  "import-x/order": [
+    "error",
+    {
+      "alphabetize": {
+        "order": "asc",
+        "caseInsensitive": true
+      },
+      "pathGroups": [
+        {
+          "pattern": "@/**",
+          "group": "internal"
+        }
+      ],
+      "groups": [
+        "builtin",
+        "external",
+        "internal",
+        "parent",
+        "sibling",
+        "index",
+        "object",
+        "type"
+      ],
+      "newlines-between": "always"
+    }
+  ],
+  "import-x/no-unresolved": [
+    "warn",
+    options.vue ? {
+      ignore: ["^virtual:"]
+    } : {}
+  ]
+});
+var imports = (options) => options.typescript ? {
+  languageOptions: {
+    ecmaVersion: 2022,
+    parserOptions: {
+      ecmaVersion: 2022,
+      sourceType: "module"
+    }
+  },
   plugins: {
     "import-x": pluginImport
   },
   rules: {
-    "import-x/consistent-type-specifier-style": [
-      "error",
-      "prefer-inline"
-    ],
-    "import-x/order": [
-      "error",
-      {
-        "alphabetize": {
-          "order": "asc",
-          "caseInsensitive": true
-        },
-        "pathGroups": [
-          {
-            "pattern": "@/**",
-            "group": "internal"
-          }
-        ],
-        "groups": ["builtin", "external", "internal", "parent", "sibling", "index", "object", "type"],
-        "newlines-between": "always"
+    ...pluginImport.configs.recommended.rules,
+    ...pluginImport.configs.typescript.rules,
+    ...commonRules(options)
+  },
+  settings: {
+    ...pluginImport.configs.typescript.settings,
+    "import-x/resolver": {
+      "node": {
+        extensions: [".ts", ".tsx", ".js", ".jsx"]
+      },
+      "typescript": {
+        "alwaysTryTypes": true,
+        "project": path.join(process2.cwd(), "tsconfig.json")
       }
-    ]
+    }
+  }
+} : {
+  languageOptions: {
+    ecmaVersion: 2022,
+    parserOptions: {
+      ecmaVersion: 2022,
+      sourceType: "module"
+    }
+  },
+  plugins: {
+    "import-x": pluginImport
+  },
+  rules: {
+    ...pluginImport.configs.recommended.rules,
+    ...commonRules(options)
   }
 };
 
@@ -104,6 +160,29 @@ var javascript = [
 import pluginJson from "eslint-plugin-jsonc";
 var json = pluginJson.configs["flat/recommended-with-json"];
 
+// src/configs/markdown.ts
+import pluginMarkdown from "eslint-plugin-markdown";
+var markdown = {
+  files: ["**/*.md"],
+  plugins: {
+    markdown: pluginMarkdown
+  },
+  processor: "markdown/markdown",
+  rules: {
+    ...pluginMarkdown.configs.recommended.rules
+  }
+};
+
+// src/configs/promise.ts
+import pluginPromise from "eslint-plugin-promise";
+var promise = {
+  ...pluginPromise.configs["flat/recommended"],
+  rules: {
+    ...pluginPromise.configs["flat/recommended"].rules,
+    "promise/always-return": "warn"
+  }
+};
+
 // src/configs/regexp.ts
 import pluginRegexp from "eslint-plugin-regexp";
 var regexp = {
@@ -176,6 +255,8 @@ var stylistic = {
 };
 
 // src/configs/typescript.ts
+import path2 from "node:path";
+import process3 from "node:process";
 import tsEslint from "typescript-eslint";
 var typescript = tsEslint.config(
   {
@@ -188,7 +269,7 @@ var typescript = tsEslint.config(
       parser: tsEslint.parser,
       parserOptions: {
         sourceType: "module",
-        project: true
+        project: path2.join(process3.cwd(), "tsconfig.json")
       }
     },
     rules: {
@@ -201,6 +282,7 @@ var typescript = tsEslint.config(
         }
       ],
       "@typescript-eslint/explicit-member-accessibility": "error",
+      "@typescript-eslint/no-duplicate-enum-values": "warn",
       "@typescript-eslint/no-explicit-any": "warn",
       "@typescript-eslint/no-extraneous-class": "off",
       "@typescript-eslint/no-inferrable-types": "off"
@@ -208,26 +290,77 @@ var typescript = tsEslint.config(
   }
 );
 
+// src/configs/vue.ts
+import pluginVue from "eslint-plugin-vue";
+import { getPackageInfoSync } from "local-pkg";
+import tsEslint2 from "typescript-eslint";
+import parserVue from "vue-eslint-parser";
+function getVueVersion() {
+  const pkg = getPackageInfoSync("vue", { paths: [process.cwd()] });
+  if (pkg && typeof pkg.version === "string" && !Number.isNaN(+pkg.version[0])) {
+    return +pkg.version[0];
+  }
+  return 3;
+}
+var config = getVueVersion() === 3 ? pluginVue.configs["flat/recommended"] : pluginVue.configs["flat/vue2-recommended"];
+var vue = (tsEnabled) => [
+  {
+    ...config,
+    files: ["**/*.vue"],
+    plugins: {
+      vue: pluginVue
+    },
+    languageOptions: {
+      parser: parserVue,
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true
+        },
+        extraFileExtensions: [".vue"],
+        parser: tsEnabled ? tsEslint2.parser : null,
+        sourceType: "module"
+      }
+    },
+    rules: {
+      ...config.rules,
+      "vue/html-indent": [
+        "warn",
+        "tab"
+      ],
+      "vue/html-quotes": [
+        "warn",
+        "single"
+      ],
+      "vue/max-attributes-per-line": [
+        "warn",
+        { singleline: 3 }
+      ],
+      "vue/multi-word-component-names": "off"
+    }
+  }
+];
+
 // src/env.ts
-import process from "node:process";
-import { getPackageInfoSync, isPackageExists } from "local-pkg";
-var isInEditor = !!(!process.env.CI && (process.env.VSCODE_PID || process.env.JETBRAINS_IDE || process.env.VIM));
+import process4 from "node:process";
+import { getPackageInfoSync as getPackageInfoSync2, isPackageExists } from "local-pkg";
+var isInEditor = !!(!process4.env.CI && (process4.env.VSCODE_PID || process4.env.JETBRAINS_IDE || process4.env.VIM));
 var hasTypescript = isPackageExists("typescript");
 var hasVitest = isPackageExists("vitest");
 var hasVue = isPackageExists("nuxt") || isPackageExists("vitepress") || isPackageExists("vue") || isPackageExists("vuepress");
-var versionVue = getPackageInfoSync("vue")?.version;
+var versionVue = getPackageInfoSync2("vue")?.version;
 
 // src/index.ts
-function iqrfEslint({
-  import: enableImport = true,
-  markdown: enableMarkdown = true,
-  regExp: enableRegExp = true,
-  typescript: enableTypescript = hasTypescript,
-  vitest: enableVitest = hasVitest,
-  vue: enableVue = hasVue
-} = {}, config = []) {
+function iqrfEslint(options = {}, config2 = []) {
+  const {
+    import: enableImport = true,
+    markdown: enableMarkdown = true,
+    promise: enablePromise = true,
+    regExp: enableRegExp = true,
+    typescript: enableTypescript = hasTypescript,
+    vue: enableVue = hasVue
+  } = options;
   const configs = [];
-  const ignoreFiles = [".gitignore", ".eslintignore"].filter((path) => fs.existsSync(path));
+  const ignoreFiles = [".gitignore", ".eslintignore"].filter((path3) => fs.existsSync(path3));
   if (ignoreFiles.length > 0) {
     configs.push(configGitignore({
       files: ignoreFiles
@@ -236,23 +369,33 @@ function iqrfEslint({
   configs.push(...javascript);
   configs.push(comments);
   if (enableImport) {
-    configs.push(imports);
+    configs.push(imports({ typescript: enableTypescript, vue: enableVue }));
   }
   if (enableTypescript) {
     configs.push(...typescript);
   }
+  if (enablePromise) {
+    configs.push(promise);
+  }
   configs.push(...json);
   configs.push(stylistic);
   if (enableRegExp) {
     configs.push(regexp);
   }
-  if (Object.keys(config).length > 0) {
-    configs.push(...Array.isArray(config) ? config : [config]);
+  if (enableMarkdown) {
+    configs.push(markdown);
+  }
+  if (enableVue) {
+    configs.push(...vue(enableTypescript));
+  }
+  if (Object.keys(config2).length > 0) {
+    configs.push(...Array.isArray(config2) ? config2 : [config2]);
   }
   return configs;
 }
 export {
   comments,
+  getVueVersion,
   hasTypescript,
   hasVitest,
   hasVue,
@@ -261,8 +404,11 @@ export {
   isInEditor,
   javascript,
   json,
+  markdown,
+  promise,
   regexp,
   stylistic,
   typescript,
-  versionVue
+  versionVue,
+  vue
 };

package/package.json

@@ -18,6 +18,7 @@
     "@eslint/js": "^9.6.0",
     "@stylistic/eslint-plugin": "^2.3.0",
     "eslint-config-flat-gitignore": "^0.1.5",
+    "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import-x": "^0.5.3",
     "eslint-plugin-jsdoc": "^48.5.0",
@@ -42,6 +43,7 @@
   },
   "devDependencies": {
     "@types/eslint": "^8.56.10",
+    "@types/eslint-plugin-markdown": "^2.0.2",
     "@types/eslint__js": "^8.42.3",
     "@types/node": "^20.14.9",
     "bumpp": "^9.4.1",
@@ -79,7 +81,7 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "scripts": {
     "build": "tsup",
     "lint": "eslint .",