@santi020k/eslint-config-santi020k 3.0.0 → 3.1.0

package/README.md

@@ -123,6 +123,10 @@ Additionally, there are some optional parameters that add support to other techn
         OptionalOption.Vitest,
         // I18next
         OptionalOption.I18next
+        // Mdx
+        OptionalOption.Mdx
+        // Markdown
+        OptionalOption.Markdown
       ]
     }),
     // Your custom config

package/dist/index.d.ts

@@ -1,5 +1,8 @@
 import { TSESLint } from '@typescript-eslint/utils';
 
+/**
+ * Enum for configuration options in ESLint
+ */
 declare enum ConfigOption {
     Ts = "ts",
     React = "react",
@@ -7,21 +10,34 @@ declare enum ConfigOption {
     Expo = "expo",
     Astro = "astro"
 }
+/**
+ * Enum for optional features that can be included in ESLint
+ */
 declare enum OptionalOption {
     Cspell = "cspell",
     Tailwind = "tailwind",
     Vitest = "vitest",
     I18next = "i18next",
-    Mdx = "mdx"
+    Mdx = "mdx",
+    Markdown = "markdown"
 }
+/**
+ * Array of configurations that require React
+ */
 declare const ReactConfigs: ConfigOption[];
+/**
+ * ESLint configuration interface
+ */
 interface EslintConfig {
     config?: ConfigOption[];
     optionals?: OptionalOption[];
 }
 /**
- * Main function to generate ESLint configuration array.
- * !important: The array order is important, the lower the more important
+ * Generates the ESLint configuration array, applying configurations
+ * and optional settings based on the input configuration.
+ *
+ * @param {EslintConfig} options - Configuration and optional settings
+ * @returns {TSESLint.FlatConfig.ConfigArray} The final ESLint configuration array
  */
 declare const eslintConfig: ({ config, optionals }?: EslintConfig) => TSESLint.FlatConfig.ConfigArray;
 

package/dist/index.js

@@ -488,16 +488,48 @@ var i18next = [
   ...fixupConfigRules4(flatCompat.plugins("i18next"))
 ];
 
+// src/optionals/markdown.ts
+import pluginMarkdown from "@eslint/markdown";
+var markdown = [
+  {
+    name: "markdown",
+    files: ["**/*.md"],
+    plugins: {
+      markdown: pluginMarkdown
+    },
+    language: "markdown/commonmark",
+    rules: {
+      "markdown/fenced-code-language": "error",
+      "markdown/heading-increment": "error",
+      "markdown/no-duplicate-headings": "off",
+      "markdown/no-empty-links": "error",
+      "markdown/no-html": "off",
+      "markdown/no-invalid-label-refs": "error",
+      "markdown/no-missing-label-refs": "off",
+      // Disable js/ts Eslint rules, markdown issues
+      indent: "off",
+      "no-irregular-whitespace": "off",
+      "@stylistic/indent": "off"
+    }
+  }
+];
+
 // src/optionals/mdx.ts
 import pluginMdx from "eslint-plugin-mdx";
 var mdx = [
   {
+    name: "mdx-flat",
     ...pluginMdx.flat
   },
   {
+    name: "mdx-blocks",
     ...pluginMdx.flatCodeBlocks,
     rules: {
-      ...pluginMdx.flatCodeBlocks.rules
+      ...pluginMdx.flatCodeBlocks.rules,
+      // Disable js/ts Eslint rules, markdown issues
+      indent: "off",
+      "no-irregular-whitespace": "off",
+      "@stylistic/indent": "off"
     }
   }
 ];
@@ -548,6 +580,7 @@ var OptionalOption = /* @__PURE__ */ ((OptionalOption2) => {
   OptionalOption2["Vitest"] = "vitest";
   OptionalOption2["I18next"] = "i18next";
   OptionalOption2["Mdx"] = "mdx";
+  OptionalOption2["Markdown"] = "markdown";
   return OptionalOption2;
 })(OptionalOption || {});
 var ReactConfigs = [
@@ -556,7 +589,10 @@ var ReactConfigs = [
   "next" /* Next */,
   "expo" /* Expo */
 ];
-var eslintConfig = ({ config = [], optionals = [] } = {}) => {
+var eslintConfig = ({
+  config = [],
+  optionals = []
+} = {}) => {
   const hasReact = hasReactConfig(config);
   return [
     ...jsConfig,
@@ -569,7 +605,8 @@ var eslintConfig = ({ config = [], optionals = [] } = {}) => {
     ...optionals.includes("tailwind" /* Tailwind */) ? tailwind : [],
     ...optionals.includes("vitest" /* Vitest */) ? vitest : [],
     ...optionals.includes("i18next" /* I18next */) ? i18next : [],
-    ...optionals.includes("mdx" /* Mdx */) ? mdx : []
+    ...optionals.includes("mdx" /* Mdx */) ? mdx : [],
+    ...optionals.includes("markdown" /* Markdown */) ? markdown : []
   ];
 };
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@santi020k/eslint-config-santi020k",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A comprehensive ESLint configuration package for JavaScript, TypeScript, and React projects, including popular plugins and custom rules for consistent coding style.",
   "type": "module",
   "main": "./dist/index.js",
@@ -61,50 +61,51 @@
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   },
   "devDependencies": {
-    "@eslint/config-inspector": "^0.5.4",
+    "@eslint/config-inspector": "^0.5.6",
     "@types/eslint__eslintrc": "^2.1.2",
-    "@types/node": "^22.7.5",
+    "@types/node": "^22.9.0",
     "cz-conventional-changelog": "^3.3.0",
     "esbuild": "^0.24.0",
     "husky": "^9.1.6",
     "lint-staged": "^15.2.10",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "tslib": "^2.7.0",
-    "tsup": "^8.3.0",
+    "tslib": "^2.8.1",
+    "tsup": "^8.3.5",
     "typescript": "^5.6.3",
     "yalc": "^1.0.0-pre.53"
   },
   "dependencies": {
-    "eslint": "^9.12.0",
-    "@cspell/eslint-plugin": "^8.14.4",
-    "@eslint/compat": "^1.2.0",
-    "@eslint/js": "^9.12.0",
-    "@next/eslint-plugin-next": "^14.2.15",
-    "@stylistic/eslint-plugin": "^2.9.0",
+    "eslint": "^9.14.0",
+    "@eslint/markdown": "^6.2.1",
+    "@cspell/eslint-plugin": "^8.16.0",
+    "@eslint/compat": "^1.2.2",
+    "@eslint/js": "^9.14.0",
+    "@next/eslint-plugin-next": "^15.0.3",
+    "@stylistic/eslint-plugin": "^2.10.1",
     "@types/eslint__js": "^8.42.3",
-    "@typescript-eslint/eslint-plugin": "^8.8.1",
-    "@typescript-eslint/type-utils": "^8.8.1",
+    "@typescript-eslint/eslint-plugin": "^8.13.0",
+    "@typescript-eslint/type-utils": "^8.13.0",
     "cross-dirname": "^0.1.0",
     "eslint-config-expo": "^7.1.2",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-astro": "^1.2.4",
+    "eslint-plugin-astro": "^1.3.1",
     "eslint-plugin-i18next": "^6.1.0",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsx-a11y": "^6.10.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-mdx": "^3.1.5",
-    "eslint-plugin-n": "^17.11.1",
+    "eslint-plugin-n": "^17.13.1",
     "eslint-plugin-promise": "^7.1.0",
-    "eslint-plugin-react": "^7.37.1",
-    "eslint-plugin-react-hooks": "^4.6.2",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-sonarjs": "^2.0.3",
+    "eslint-plugin-sonarjs": "^2.0.4",
     "eslint-plugin-tailwindcss": "^3.17.5",
-    "eslint-plugin-testing-library": "^6.3.0",
+    "eslint-plugin-testing-library": "^6.4.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "eslint-plugin-vitest": "^0.5.4",
-    "globals": "^15.11.0",
-    "typescript-eslint": "^8.8.1"
+    "globals": "^15.12.0",
+    "typescript-eslint": "^8.13.0"
   },
   "overrides": {
     "eslint-config-standard": "$eslint-config-standard",