eslint-plugin-ai-rules 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -45,6 +45,7 @@ interface IProjectDefinition {
     preset?: TProjectPreset;
     structure?: IProjectStructure;
     relations?: IRelationsConfig;
+    rules?: Linter.RulesRecord;
 }
 interface IProjectPreset {
     structure: IProjectStructure;
@@ -69,14 +70,14 @@ declare function projects(definitions: IProjectDefinition[]): Linter.Config[];
 declare const plugin: {
     readonly meta: {
         readonly name: "eslint-plugin-ai-rules";
-        readonly version: "0.3.0";
+        readonly version: string;
     };
     readonly rules: {
-        readonly 'filename-pascal-case': eslint.Rule.RuleModule;
-        readonly 'no-multiline-imports': eslint.Rule.RuleModule;
-        readonly 'project-setup': eslint.Rule.RuleModule;
-        readonly 'project-structure': eslint.Rule.RuleModule;
-        readonly 'sort-imports': eslint.Rule.RuleModule;
+        readonly "filename-pascal-case": eslint.Rule.RuleModule;
+        readonly "no-multiline-imports": eslint.Rule.RuleModule;
+        readonly "project-setup": eslint.Rule.RuleModule;
+        readonly "project-structure": eslint.Rule.RuleModule;
+        readonly "sort-imports": eslint.Rule.RuleModule;
     };
 };
 

package/dist/index.js

@@ -3,22 +3,50 @@ import { createNodeResolver, importX } from "eslint-plugin-import-x";
 import stylistic from "@stylistic/eslint-plugin";
 import tseslint from "typescript-eslint";
 
+// src/rules/constants.ts
+var RULE_NAMES = {
+  filenamePascalCase: "filename-pascal-case",
+  noMultilineImports: "no-multiline-imports",
+  projectSetup: "project-setup",
+  projectStructure: "project-structure",
+  sortImports: "sort-imports"
+};
+var RULE_IDS = {
+  filenamePascalCase: `ai-rules/${RULE_NAMES.filenamePascalCase}`,
+  noMultilineImports: `ai-rules/${RULE_NAMES.noMultilineImports}`,
+  projectSetup: `ai-rules/${RULE_NAMES.projectSetup}`,
+  projectStructure: `ai-rules/${RULE_NAMES.projectStructure}`,
+  sortImports: `ai-rules/${RULE_NAMES.sortImports}`
+};
+
 // src/rules/FilenamePascalCase.ts
 import path from "path";
 var filenamePascalCase = {
   meta: {
     type: "suggestion",
-    docs: { description: "Enforce PascalCase for file names" },
+    docs: {
+      description: "Enforce PascalCase for file names",
+      recommended: true,
+      url: "https://github.com/lvsouza/eslint-ai-guard/blob/main/README.md#ai-rulesfilename-pascal-case"
+    },
     schema: [
       {
         type: "object",
         properties: {
-          ignore: { type: "array", items: { type: "string" } },
-          ignoreMiddleExtensions: { type: "boolean" }
+          ignore: {
+            type: "array",
+            items: { type: "string" },
+            description: "Regex strings matched against the file name and relative path."
+          },
+          ignoreMiddleExtensions: {
+            type: "boolean",
+            description: "Allow middle extensions such as .test in file names."
+          }
         },
         additionalProperties: false
       }
     ],
+    defaultOptions: [{ ignore: [], ignoreMiddleExtensions: true }],
     messages: {
       invalid: 'File name "{{basename}}" must be in PascalCase. Rename to "{{expected}}".'
     }
@@ -76,10 +104,12 @@ var filenamePascalCase = {
 var noMultilineImports = {
   meta: {
     type: "layout",
-    fixable: "code",
     docs: {
-      description: "Disallow multiline imports"
+      description: "Disallow multiline imports",
+      recommended: true,
+      url: "https://github.com/lvsouza/eslint-ai-guard/blob/main/README.md#ai-rulesno-multiline-imports"
     },
+    fixable: "code",
     schema: [],
     messages: {
       multilineImport: "Imports must be written on a single line."
@@ -341,7 +371,9 @@ var projectStructure = {
   meta: {
     type: "problem",
     docs: {
-      description: "Enforce the configured project folder and file structure"
+      description: "Enforce the configured project folder and file structure",
+      recommended: false,
+      url: "https://github.com/lvsouza/eslint-ai-guard/blob/main/README.md#ai-rulesproject-structure"
     },
     schema: [],
     messages: {
@@ -415,7 +447,7 @@ function hasStructureRules(structure) {
 }
 
 // src/rules/ProjectSetup.ts
-var hasWarned = false;
+var hasReported = false;
 function isConfiguredProject(project) {
   if (project.relations) return true;
   if (project.preset === "frontend" || project.preset === "backend" || project.preset === "other") {
@@ -423,36 +455,38 @@ function isConfiguredProject(project) {
   }
   return Boolean(project.structure && hasStructureRules(project.structure));
 }
-function warnOnce() {
-  if (hasWarned) return;
+function shouldReportOnce() {
+  if (hasReported) return false;
   if (process.env.AI_RULES_SILENT === "1" || process.env.AI_RULES_SILENT === "true") {
-    return;
+    return false;
   }
-  hasWarned = true;
-  console.warn(
-    [
-      "[eslint-plugin-ai-rules] Project structure validation is not configured.",
-      "Configure it with aiRules.configs.projects([{ rootFolder: '.', preset: 'frontend' | 'backend' }]).",
-      "If this project is not a frontend/backend, use preset: 'other' to disable this warning."
-    ].join("\n")
-  );
+  hasReported = true;
+  return true;
 }
 var projectSetup = {
   meta: {
     type: "suggestion",
     docs: {
-      description: "Warn when the project structure validation is not configured"
+      description: "Require project structure validation to be configured",
+      recommended: true,
+      url: "https://github.com/lvsouza/eslint-ai-guard/blob/main/README.md#ai-rulesproject-setup"
     },
     schema: [],
-    messages: {}
+    messages: {
+      notConfigured: 'Project structure validation is not configured. Configure it with aiRules.configs.projects([{ rootFolder: ".", preset: "frontend" | "backend" }]). If this project is not a frontend/backend, use preset: "other" to disable this warning.'
+    }
   },
   create(context) {
     return {
-      Program() {
+      Program(node) {
         const settings = context.settings["ai-rules"];
         const projects2 = settings?.projects ?? (settings?.project ? [settings.project] : []);
         if (projects2.some(isConfiguredProject)) return;
-        warnOnce();
+        if (!shouldReportOnce()) return;
+        context.report({
+          node,
+          messageId: "notConfigured"
+        });
       }
     };
   }
@@ -463,12 +497,14 @@ var sortImports = {
   meta: {
     type: "layout",
     docs: {
-      description: "Sort imports by group and line length descending, collapsing multiline imports"
+      description: "Enforce sorted imports by group and line length descending, collapsing multiline imports",
+      recommended: true,
+      url: "https://github.com/lvsouza/eslint-ai-guard/blob/main/README.md#ai-rulessort-imports"
     },
     fixable: "code",
     schema: [],
     messages: {
-      sortRequired: "As importa\xE7\xF5es devem estar ordenadas por grupo e tamanho da linha, ocupando uma \xFAnica linha."
+      sortRequired: "Imports must be sorted by group and line length, each on a single line."
     }
   },
   create(context) {
@@ -586,14 +622,14 @@ function getSortedContent(content) {
 var plugin = {
   meta: {
     name: "eslint-plugin-ai-rules",
-    version: "0.3.0"
+    version: "0.4.0"
   },
   rules: {
-    "filename-pascal-case": filenamePascalCase,
-    "no-multiline-imports": noMultilineImports,
-    "project-setup": projectSetup,
-    "project-structure": projectStructure,
-    "sort-imports": sortImports
+    [RULE_NAMES.filenamePascalCase]: filenamePascalCase,
+    [RULE_NAMES.noMultilineImports]: noMultilineImports,
+    [RULE_NAMES.projectSetup]: projectSetup,
+    [RULE_NAMES.projectStructure]: projectStructure,
+    [RULE_NAMES.sortImports]: sortImports
   }
 };
 
@@ -614,10 +650,10 @@ var recommended = [
       ]
     },
     rules: {
-      "ai-rules/sort-imports": "error",
-      "ai-rules/no-multiline-imports": "error",
-      "ai-rules/filename-pascal-case": "error",
-      "ai-rules/project-setup": "warn",
+      [RULE_IDS.sortImports]: "error",
+      [RULE_IDS.noMultilineImports]: "error",
+      [RULE_IDS.filenamePascalCase]: "error",
+      [RULE_IDS.projectSetup]: "warn",
       "max-len": "off",
       "import-x/no-duplicates": "error",
       "import-x/no-default-export": "off",
@@ -1178,15 +1214,15 @@ var frontendRelations = {
     pageContext: "src/pages/*/contexts",
     pageHelper: "src/pages/*/helpers",
     page: "src/pages/*",
-    components: "src/components",
-    hooks: "src/hooks",
-    contexts: "src/contexts",
-    generated: "src/services/generated",
-    services: "src/services",
-    utils: "src/utils",
-    helpers: "src/helpers",
-    constants: "src/constants",
-    env: "src/env"
+    components: "src/shared/components",
+    hooks: "src/shared/hooks",
+    contexts: "src/shared/contexts",
+    generated: "src/shared/services/generated",
+    services: "src/shared/services",
+    utils: "src/shared/utils",
+    helpers: "src/shared/helpers",
+    constants: "src/shared/constants",
+    env: "src/shared/env"
   },
   scope: {
     capture: "page",
@@ -1395,34 +1431,49 @@ var frontendPreset = {
           "vite-env.d.ts"
         ],
         folders: {
-          components: {
-            files: [pascalTsx],
+          shared: {
             folders: {
-              ui: {
-                files: [pascalTsOrTsx]
+              components: {
+                files: [pascalTsx],
+                folders: {
+                  ui: {
+                    files: [pascalTsOrTsx]
+                  }
+                }
+              },
+              constants: {
+                files: [pascalTs]
+              },
+              contexts: {
+                files: [
+                  {
+                    case: "PascalCase",
+                    extensions: [".tsx"]
+                  }
+                ]
+              },
+              env: {
+                files: ["index.ts"]
+              },
+              helpers: {
+                files: [pascalTs]
+              },
+              hooks: {
+                files: [pascalTs]
+              },
+              services: {
+                folders: {
+                  generated: { ignore: true },
+                  utils: {
+                    files: [pascalTs]
+                  }
+                }
+              },
+              utils: {
+                files: [pascalTs]
               }
             }
           },
-          constants: {
-            files: [pascalTs]
-          },
-          contexts: {
-            files: [
-              {
-                case: "PascalCase",
-                extensions: [".tsx"]
-              }
-            ]
-          },
-          env: {
-            files: ["index.ts"]
-          },
-          hooks: {
-            files: [pascalTs]
-          },
-          helpers: {
-            files: [pascalTs]
-          },
           pages: {
             files: [pascalTsx],
             folders: {
@@ -1485,17 +1536,6 @@ var frontendPreset = {
                 }
               }
             }
-          },
-          services: {
-            folders: {
-              generated: { ignore: true },
-              utils: {
-                files: [pascalTs]
-              }
-            }
-          },
-          utils: {
-            files: [pascalTs]
           }
         }
       },
@@ -1533,7 +1573,7 @@ var frontendPreset = {
       ...commonIgnoredPaths,
       "playwright-report/**",
       "test-results/**",
-      "src/services/generated/**",
+      "src/shared/services/generated/**",
       "scripts/types/**"
     ]
   },
@@ -1830,6 +1870,11 @@ function validateDefinition(definition, index) {
       });
     }
   }
+  if (definition.rules !== void 0 && (typeof definition.rules !== "object" || definition.rules === null || Array.isArray(definition.rules))) {
+    throw new Error(
+      `Invalid project at index ${index}: rules must be an object.`
+    );
+  }
 }
 function resolveStructure(definition, preset) {
   return mergeStructure(preset?.structure, definition.structure);
@@ -1884,15 +1929,16 @@ function projects(definitions) {
     ]));
     const rules = {
       ...baseConfig.rules,
-      ...preset?.rules ?? {},
-      "ai-rules/project-structure": structureEnabled ? "error" : "off",
-      "ai-rules/filename-pascal-case": structureEnabled ? "off" : baseConfig.rules?.["ai-rules/filename-pascal-case"] ?? "error",
+      [RULE_IDS.projectStructure]: structureEnabled ? "error" : "off",
+      [RULE_IDS.filenamePascalCase]: structureEnabled ? "off" : baseConfig.rules?.[RULE_IDS.filenamePascalCase] ?? "error",
       ...relations ? {
         "boundaries/dependencies": [
           "error",
           buildRelationsRuleOptions(relations)
         ]
-      } : {}
+      } : {},
+      ...preset?.rules ?? {},
+      ...definition.rules ?? {}
     };
     return {
       ...baseConfig,