@santi020k/eslint-config-santi020k 3.1.3 → 3.2.0

package/README.md

@@ -127,12 +127,28 @@ Additionally, there are some optional parameters that add support to other techn
         OptionalOption.Mdx,
         // Markdown
         OptionalOption.Markdown,
+        // Stencil
+        OptionalOption.Stencil
       ]
     }),
     // Your custom config
   ];
 ```
 
+### Setting Usage (experimental)
+
+```js
+  import { eslintConfig, SettingOption } from '@santi020k/eslint-config-santi020k';
+
+  export default [
+    ...eslintConfig({
+      // Adds support for .gitignore file, eslint will ignore files in the .gitignore file
+      settings: [SettingOption.Gitignore]
+    }),
+    // Your custom config
+  ];
+```
+
 ## Opinionated but Flexible
 
 This ESLint configuration is based on my personal preferences and practices. As such, it may evolve over time. I recommend using a fixed version to avoid unexpected changes. If a rule is too strict, consider changing it from an error to a warning to allow for more flexibility during development.

package/dist/index.d.ts

@@ -19,7 +19,14 @@ declare enum OptionalOption {
     Vitest = "vitest",
     I18next = "i18next",
     Mdx = "mdx",
-    Markdown = "markdown"
+    Markdown = "markdown",
+    Stencil = "stencil"
+}
+/**
+ * Enum for settings options in ESLint
+ */
+declare enum SettingOption {
+    Gitignore = "gitignore"
 }
 /**
  * Array of configurations that require React
@@ -31,6 +38,7 @@ declare const ReactConfigs: ConfigOption[];
 interface EslintConfig {
     config?: ConfigOption[];
     optionals?: OptionalOption[];
+    settings?: SettingOption[];
 }
 /**
  * Generates the ESLint configuration array, applying configurations
@@ -39,6 +47,6 @@ interface EslintConfig {
  * @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;
+declare const eslintConfig: ({ config, optionals, settings }?: EslintConfig) => TSESLint.FlatConfig.ConfigArray;
 
-export { ConfigOption, OptionalOption, ReactConfigs, eslintConfig };
+export { ConfigOption, OptionalOption, ReactConfigs, SettingOption, eslintConfig };

package/dist/index.js

@@ -259,12 +259,7 @@ var jsConfig = [
     name: "custom-js",
     languageOptions,
     files: ["**/*.{js,jsx,mjs,cjs}"],
-    ignores: ["node_modules/*"],
     rules
-  },
-  {
-    name: "ignore-node-modules-js",
-    ignores: ["node_modules/*"]
   }
 ];
 
@@ -437,17 +432,13 @@ var tsConfig = [
     files: ["**/*.{ts,tsx,mts,cts}"],
     rules: rules5,
     languageOptions: {
+      parser: tsParser,
       parserOptions: {
-        parser: tsParser
+        project: true
       },
       ecmaVersion: "latest"
     }
   }
-  // TODO: Temporal
-  // {
-  //   name: 'ignore-node-modules-ts',
-  //   ignores: ['node_modules/*']
-  // }
 ];
 
 // src/configs/expo/rules.ts
@@ -493,12 +484,10 @@ var i18next = [
 // src/optionals/markdown.ts
 import pluginMarkdown from "@eslint/markdown";
 var markdown = [
+  ...pluginMarkdown.configs.recommended,
   {
     name: "markdown",
     files: ["**/*.md"],
-    plugins: {
-      markdown: pluginMarkdown
-    },
     language: "markdown/commonmark",
     rules: {
       "markdown/fenced-code-language": "error",
@@ -511,27 +500,83 @@ var markdown = [
       // Disable js/ts Eslint rules, markdown issues
       indent: "off",
       "no-irregular-whitespace": "off",
-      "@stylistic/indent": "off"
+      "@stylistic/indent": "off",
+      "no-unused-vars": "off",
+      "@stylistic/jsx-closing-bracket-location": "off",
+      "no-multi-spaces": "off",
+      "@stylistic/no-multi-spaces": "off",
+      "comma-dangle": "off",
+      "@stylistic/jsx-tag-spacing": "off"
     }
   }
 ];
 
 // src/optionals/mdx.ts
+import eslintMdx from "eslint-mdx";
 import pluginMdx from "eslint-plugin-mdx";
 var mdx = [
   {
-    name: "mdx-flat",
-    ...pluginMdx.flat
-  },
+    files: ["**/*.mdx"],
+    languageOptions: {
+      sourceType: "module",
+      ecmaVersion: "latest",
+      parser: eslintMdx,
+      globals: {
+        React: false
+      }
+    },
+    plugins: {
+      mdx: pluginMdx
+    },
+    rules: {
+      "mdx/remark": "warn",
+      "react/react-in-jsx-scope": 0
+    }
+  }
+];
+
+// src/optionals/stencil.ts
+import { fixupPluginRules } from "@eslint/compat";
+import stencilPlugin from "@stencil-community/eslint-plugin";
+var stencil = [
   {
-    name: "mdx-blocks",
-    ...pluginMdx.flatCodeBlocks,
+    name: "stencil-community",
+    files: ["**/*.{tsx,ts}"],
+    plugins: {
+      "@stencil-community": fixupPluginRules({
+        rules: stencilPlugin.rules
+      })
+    },
     rules: {
-      ...pluginMdx.flatCodeBlocks.rules,
-      // Disable js/ts Eslint rules, markdown issues
-      indent: "off",
-      "no-irregular-whitespace": "off",
-      "@stylistic/indent": "off"
+      "@stencil-community/async-methods": "error",
+      "@stencil-community/ban-prefix": ["error", ["stencil", "stnl", "st"]],
+      "@stencil-community/decorators-context": "error",
+      "@stencil-community/decorators-style": [
+        "error",
+        {
+          prop: "inline",
+          state: "inline",
+          element: "inline",
+          event: "inline",
+          method: "multiline",
+          watch: "multiline",
+          listen: "multiline"
+        }
+      ],
+      "@stencil-community/element-type": "error",
+      "@stencil-community/host-data-deprecated": "error",
+      "@stencil-community/methods-must-be-public": "error",
+      "@stencil-community/no-unused-watch": "error",
+      "@stencil-community/own-methods-must-be-private": "error",
+      "@stencil-community/own-props-must-be-private": "error",
+      "@stencil-community/prefer-vdom-listener": "error",
+      "@stencil-community/props-must-be-public": "error",
+      "@stencil-community/props-must-be-readonly": "error",
+      "@stencil-community/render-returns-host": "error",
+      "@stencil-community/required-jsdoc": "error",
+      "@stencil-community/reserved-member-names": "error",
+      "@stencil-community/single-export": "error",
+      "@stencil-community/strict-mutable": "error"
     }
   }
 ];
@@ -541,16 +586,19 @@ import pluginTailwind from "eslint-plugin-tailwindcss";
 var tailwind = [...pluginTailwind.configs["flat/recommended"]];
 
 // src/optionals/vitest.ts
+import testingLibrary from "eslint-plugin-testing-library";
 import pluginVitest from "eslint-plugin-vitest";
-import { fixupConfigRules as fixupConfigRules5 } from "@eslint/compat";
+import { fixupPluginRules as fixupPluginRules2 } from "@eslint/compat";
 var vitest = [
-  ...fixupConfigRules5(flatCompat.extends("plugin:testing-library/react")),
   {
     name: "vitest",
-    files: ["tests/**"],
+    files: ["tests/**", "**/__tests__/**", "**/__mocks__/**", "**/test/**", "**/spec/**", "**/__spec__/**", "**/*.test.{js,ts,jsx,tsx}"],
     // or any other pattern
     plugins: {
-      vitest: pluginVitest
+      vitest: pluginVitest,
+      "testing-library": fixupPluginRules2({
+        rules: testingLibrary.rules
+      })
     },
     rules: {
       ...pluginVitest.configs.recommended.rules,
@@ -567,6 +615,12 @@ var vitest = [
   }
 ];
 
+// src/settings/gitignore.ts
+import { includeIgnoreFile } from "@eslint/compat";
+var gitignore = [
+  includeIgnoreFile(`${process.cwd()}/.gitignore`)
+];
+
 // src/index.ts
 var ConfigOption2 = /* @__PURE__ */ ((ConfigOption3) => {
   ConfigOption3["Ts"] = "ts";
@@ -583,8 +637,13 @@ var OptionalOption = /* @__PURE__ */ ((OptionalOption2) => {
   OptionalOption2["I18next"] = "i18next";
   OptionalOption2["Mdx"] = "mdx";
   OptionalOption2["Markdown"] = "markdown";
+  OptionalOption2["Stencil"] = "stencil";
   return OptionalOption2;
 })(OptionalOption || {});
+var SettingOption = /* @__PURE__ */ ((SettingOption2) => {
+  SettingOption2["Gitignore"] = "gitignore";
+  return SettingOption2;
+})(SettingOption || {});
 var ReactConfigs = [
   "react" /* React */,
   "astro" /* Astro */,
@@ -593,10 +652,12 @@ var ReactConfigs = [
 ];
 var eslintConfig = ({
   config = [],
-  optionals = []
+  optionals = [],
+  settings = []
 } = {}) => {
   const hasReact = hasReactConfig(config);
   return [
+    ...settings.includes("gitignore" /* Gitignore */) ? gitignore : [],
     ...jsConfig,
     ...hasReact ? reactConfig : [],
     ...applyConfigIfOptionPresent(config, "ts" /* Ts */, tsConfig),
@@ -607,6 +668,7 @@ var eslintConfig = ({
     ...optionals.includes("tailwind" /* Tailwind */) ? tailwind : [],
     ...optionals.includes("vitest" /* Vitest */) ? vitest : [],
     ...optionals.includes("i18next" /* I18next */) ? i18next : [],
+    ...optionals.includes("stencil" /* Stencil */) ? stencil : [],
     ...optionals.includes("mdx" /* Mdx */) ? mdx : [],
     ...optionals.includes("markdown" /* Markdown */) ? markdown : []
   ];
@@ -615,5 +677,6 @@ export {
   ConfigOption2 as ConfigOption,
   OptionalOption,
   ReactConfigs,
+  SettingOption,
   eslintConfig
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@santi020k/eslint-config-santi020k",
-  "version": "3.1.3",
+  "version": "3.2.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",