feat: enhance linting and documentation for modular rules

Author: andrewmolyuk

Makefile

@@ -5,7 +5,7 @@ install:
 
 lint:
 	npx eslint . --ext .js,.vue --fix
-	npx markdownlint README.md
+	npx markdownlint README.md docs/**/*.md --fix
 
 test: lint
 	CI=CI npx vitest

README.md

@@ -38,7 +38,7 @@ export default [
     rules: {
       'vue-modular/no-cross-feature-imports': 'error',
       'vue-modular/no-cross-module-imports': 'error',
-  'vue-modular/enforce-src-structure': 'error',
+      'vue-modular/enforce-src-structure': 'error',
       'vue-modular/enforce-module-exports': 'error',
     },
     languageOptions: {
@@ -70,7 +70,7 @@ module.exports = {
   rules: {
     'vue-modular/no-cross-feature-imports': 'error',
     'vue-modular/no-cross-module-imports': 'error',
-  'vue-modular/enforce-src-structure': 'error',
+    'vue-modular/enforce-src-structure': 'error',
   },
 }
 ```

docs/rules.md

@@ -8,7 +8,7 @@ This plugin provides rules to enforce modular architecture boundaries in Vue.js
 | ----------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------- | ----------- | ------- |
 | [`vue-modular/no-cross-feature-imports`](./rules/no-cross-feature-imports.md) | Prevents direct imports from deep inside feature folders          | Problem | ✅          | ❌      |
 | [`vue-modular/no-cross-module-imports`](./rules/no-cross-module-imports.md)   | Prevents imports between different modules                        | Problem | ✅          | ❌      |
-| [`vue-modular/enforce-src-structure`](./rules/enforce-src-structure.md)                       | Enforces allowed top-level folders/files in source directory      | Problem | ✅          | ❌      |
+| [`vue-modular/enforce-src-structure`](./rules/enforce-src-structure.md)       | Enforces allowed top-level folders/files in source directory      | Problem | ✅          | ❌      |
 | [`vue-modular/enforce-app-structure`](./rules/enforce-app-structure.md)       | Enforces presence of application infrastructure under `src/app`   | Problem | ✅          | ❌      |
 | [`vue-modular/enforce-module-exports`](./rules/enforce-module-exports.md)     | Ensures modules expose a public API via index.ts/index.js         | Problem | ✅          | ❌      |
 | [`vue-modular/enforce-feature-exports`](./rules/enforce-feature-exports.md)   | Ensures global features expose a public API via index.ts/index.js | Problem | ✅          | ❌      |

docs/rules/enforce-app-structure.md

@@ -1,5 +1,4 @@
-````markdown
-# vue-modular/enforce-app-structure
+# enforce-app-structure
 
 **Ensure the `src/app` folder contains the required application infrastructure.**
 
@@ -22,15 +21,15 @@ Correct structure (default required entries present):
 
 ```text
 src/
-	app/
-		router/
-			index.ts
-		stores/
-		layouts/
-		App.vue
-	components/
-	modules/
-	main.ts
+ app/
+  router/
+   index.ts
+  stores/
+  layouts/
+  App.vue
+ components/
+ modules/
+ main.ts
 ```
 
 Missing `App.vue` or `stores` will trigger a report.
@@ -106,4 +105,3 @@ Disable this rule if you prefer no enforcement of app-level scaffolding or if yo
 ## Further Reading
 
 - [Vue 3 Project Modules Blueprint](../vue3-project-modules-blueprint.md)
-````

docs/rules/enforce-feature-exports.md

@@ -1,5 +1,4 @@
-````markdown
-# vue-modular/enforce-feature-exports
+# enforce-feature-exports
 
 Ensure every global feature under `src/features` exposes a public API via an `index.ts` or `index.js` file. This enforces the blueprint requirement that global features export a stable public interface.
 
@@ -28,4 +27,3 @@ Incorrect (missing index in feature):
 ```text
 src/features/search/components/SearchInput.vue
 ```
-````

docs/rules/enforce-import-boundaries.md

@@ -1,4 +1,4 @@
-# `vue-modular/enforce-import-boundaries`
+# enforce-import-boundaries
 
 Enforce proper import paths based on the project modules/features blueprint. By default this rule prevents deep imports into other modules or features — imports between modules/features should go through the respective public API index files.
 

docs/rules/enforce-module-exports.md

@@ -1,5 +1,4 @@
-````markdown
-# vue-modular/enforce-module-exports
+# enforce-module-exports
 
 Ensure every module under `src/modules` exposes a public API via an `index.ts` or `index.js` file. This helps the `app/` layer and other modules import modules through a stable public interface.
 
@@ -32,4 +31,3 @@ Incorrect (missing index in module):
 ```text
 src/modules/auth/views/LoginView.vue
 ```
-````

docs/rules/enforce-src-structure.md

@@ -1,5 +1,4 @@
-````markdown
-# vue-modular/enforce-src-structure
+# enforce-src-structure
 
 Enforce allowed top-level folders and files in the `src` directory.
 
@@ -27,5 +26,3 @@ This rule ensures that the top-level entries inside your configured source direc
   }
 }
 ```
-
-````

docs/rules/no-cross-feature-imports.md

@@ -74,7 +74,7 @@ Notes:
 
 ## Project Structure
 
-```
+```text
 src/
 ├── features/
 │   ├── user/

src/rules/no-cross-feature-imports.js

@@ -33,8 +33,7 @@ export default {
       },
     ],
     messages: {
-      crossFeatureImport:
-        'Cannot import "{{importPath}}" from outside feature "{{featureName}}". Only imports from "{{allowedPath}}" are allowed.',
+      crossFeatureImport: 'Cannot import "{{importPath}}" from outside "{{name}}". Only imports from "{{allowedPath}}" are allowed.',
     },
   },
   create(context) {
@@ -58,7 +57,7 @@ export default {
             context.report({
               node: node.source,
               messageId: 'crossFeatureImport',
-              data: { importPath: source, featureName: modulePublicName, allowedPath: `@/${modulesDir}/${modulePublicName}` },
+              data: { importPath: source, name: modulePublicName, allowedPath: `@/${modulesDir}/${modulePublicName}` },
             })
             return
           }
@@ -71,7 +70,7 @@ export default {
           context.report({
             node: node.source,
             messageId: 'crossFeatureImport',
-            data: { importPath: source, featureName: featureInfo.featureName, allowedPath: featureInfo.allowedPath },
+            data: { importPath: source, name: featureInfo.featureName, allowedPath: featureInfo.allowedPath },
           })
         }
       },