You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A custom ESLint plugin for enforcing modular patterns in Vue projects.
12
10
@@ -115,7 +113,7 @@ module.exports = {
115
113
116
114
This plugin provides rules to enforce modular architecture boundaries in Vue.js applications.
117
115
118
-
### Included Rules
116
+
See the latest list of rules in the [Rules](./docs/rules.md) documentation. The legacy rules listed below are scheduled for refactoring and will be deprecated soon.
@@ -132,7 +130,7 @@ This plugin provides rules to enforce modular architecture boundaries in Vue.js
132
130
|[no-deep-nesting](./docs/rules/no-deep-nesting.md)| Prevent excessive folder nesting in modules and features |
133
131
|[enforce-naming-convention](./docs/rules/enforce-naming-convention.md)| Enforce consistent naming patterns for Vue components |
134
132
135
-
###Modular Architecture in Vue
133
+
## Modular Architecture in Vue
136
134
137
135
In Vue applications, modular architecture means organizing your codebase into self-contained feature modules. Each module typically contains its own components, composables, stores, and styles, grouped by feature rather than by file type. This approach improves maintainability, scalability, and testability by reducing coupling and clarifying dependencies.
138
136
@@ -143,40 +141,13 @@ With modular architecture, you can:
143
141
- Enable teams to work independently on different modules.
144
142
- Simplify onboarding by making the project structure more intuitive.
145
143
146
-
See the [Vue Project Modules Blueprint](./docs/vue-project-modules-blueprint.md) for more details and rationale behind modular structure.
144
+
See the [Vue Modular Architecture](./docs/vue-modular-architecture.md) for more details and rationale behind modular structure.
147
145
148
146
The `eslint-plugin-vue-modular` plugin helps enforce these boundaries, ensuring that your Vue project remains modular as it grows.
149
147
150
-
## Recommended VS Code Extensions
151
-
152
-
See `.vscode/extensions.json` for a list of recommended extensions to
153
-
improve your development experience.
154
-
155
148
## Contributing
156
149
157
-
Pull requests and issues are welcome! Please follow the code style and add
158
-
tests for new rules.
159
-
160
-
## Release Process
161
-
162
-
This project uses [semantic-release](https://semantic-release.gitbook.io/semantic-release/) for automated releases. Releases are triggered automatically when commits are pushed to the `main` branch.
163
-
164
-
### Commit Message Format
165
-
166
-
Use [conventional commit messages](https://www.conventionalcommits.org/) to trigger releases:
167
-
168
-
-`feat: description` → minor version bump (new features)
169
-
-`fix: description` → patch version bump (bug fixes)
170
-
-`BREAKING CHANGE: description` → major version bump (breaking changes)
171
-
-`docs:`, `style:`, `refactor:`, `test:`, `chore:` → no release
172
-
173
-
### Development Workflow
174
-
175
-
1. Create a feature branch: `git checkout -b feature/awesome-feature`
176
-
2. Make changes with conventional commits
177
-
3. Create a Pull Request to `main`
178
-
4. After PR approval and merge → automatic release is triggered
179
-
5. New version is published to NPM automatically
150
+
Pull requests and issues are welcome! Please follow the code style and add tests for new rules.
0 commit comments