Skip to content

Commit 2880ecd

Browse files
committed
docs: update README for clarity and organization, refactor rules section, and adjust links
1 parent a0e150a commit 2880ecd

File tree

1 file changed

+5
-34
lines changed

1 file changed

+5
-34
lines changed

README.md

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# eslint-plugin-vue-modular
22

33
[![Build Status](https://img.shields.io/github/actions/workflow/status/andrewmolyuk/eslint-plugin-vue-modular/release.yml)](https://github.com/andrewmolyuk/eslint-plugin-vue-modular/actions/workflows/release.yml)
4-
[![semantic-release: conventional](https://img.shields.io/badge/semantic--release-conventional-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
54
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/819ccf509a694fcc8204bca4a78c634d)](https://app.codacy.com/gh/andrewmolyuk/eslint-plugin-vue-modular/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
65
[![Issues](https://img.shields.io/github/issues/andrewmolyuk/eslint-plugin-vue-modular)](https://github.com/andrewmolyuk/eslint-plugin-vue-modular/issues)
7-
[![NPM](https://img.shields.io/npm/v/eslint-plugin-vue-modular.svg?style=flat)](https://www.npmjs.com/package/eslint-plugin-vue-modular)
86
[![NPM downloads](https://img.shields.io/npm/dw/eslint-plugin-vue-modular.svg?style=flat)](https://www.npmjs.com/package/eslint-plugin-vue-modular)
9-
[![License](https://img.shields.io/npm/l/eslint-plugin-vue-modular.svg)](LICENSE)
7+
[![semantic-release: conventional](https://img.shields.io/badge/semantic--release-conventional-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
108

119
A custom ESLint plugin for enforcing modular patterns in Vue projects.
1210

@@ -115,7 +113,7 @@ module.exports = {
115113

116114
This plugin provides rules to enforce modular architecture boundaries in Vue.js applications.
117115

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.
119117

120118
| Rule | Description |
121119
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
@@ -132,7 +130,7 @@ This plugin provides rules to enforce modular architecture boundaries in Vue.js
132130
| [no-deep-nesting](./docs/rules/no-deep-nesting.md) | Prevent excessive folder nesting in modules and features |
133131
| [enforce-naming-convention](./docs/rules/enforce-naming-convention.md) | Enforce consistent naming patterns for Vue components |
134132

135-
### Modular Architecture in Vue
133+
## Modular Architecture in Vue
136134

137135
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.
138136

@@ -143,40 +141,13 @@ With modular architecture, you can:
143141
- Enable teams to work independently on different modules.
144142
- Simplify onboarding by making the project structure more intuitive.
145143

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.
147145

148146
The `eslint-plugin-vue-modular` plugin helps enforce these boundaries, ensuring that your Vue project remains modular as it grows.
149147

150-
## Recommended VS Code Extensions
151-
152-
See `.vscode/extensions.json` for a list of recommended extensions to
153-
improve your development experience.
154-
155148
## Contributing
156149

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.
180151

181152
## License
182153

0 commit comments

Comments
 (0)