Skip to content

Commit f62ad5a

Browse files
committed
fix: update postchangelog script to remove unnecessary lines from CHANGELOG.md
docs: format rules and roadmap documentation for consistency
1 parent e78adb3 commit f62ad5a

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

.versionrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,6 @@
5757
"issuePrefixes": ["#"],
5858
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"],
5959
"scripts": {
60-
"postchangelog": "sed -i '' -e '/^### \\[[^]]*\\]([^)]*) ([^)]*)$/d' -e '/./,$!d' CHANGELOG.md && echo '✓ Cleaned up changelog format'"
60+
"postchangelog": "sed -i '' -e '/^### \\[[^]]*\\]([^)]*) ([^)]*)$/d' -e '/^# Changelog$/d' -e '/^All notable changes to this project will be documented in this file\\./d' -e '/^See \\[standard-version\\]/d' -e '/./,$!d' CHANGELOG.md && echo '✓ Cleaned up changelog format'"
6161
}
6262
}

docs/roadmap.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ This document outlines the current status and planned development of rules for e
66

77
### Implemented Rules
88

9-
| Rule | Status | Description |
10-
| ----------------------------------------- | ------------ | ------------------------------------------------------------------------------------ |
11-
| `vue-modular/no-cross-feature-imports` | **Released** | Prevents direct imports from deep inside feature folders |
12-
| `vue-modular/no-cross-module-imports` | **Released** | Prevents deep imports between modules; prefer module public API |
13-
| `vue-modular/enforce-import-boundaries` | **Released** | Enforces proper import paths and module/feature boundaries across the project |
14-
| `vue-modular/enforce-src-structure` | **Released** | Enforces allowed top-level folders/files in the `src/` folder |
15-
| `vue-modular/enforce-app-structure` | **Released** | Validates `src/app` contains the expected entries (router, stores, layouts, App.vue) |
16-
| `vue-modular/enforce-module-exports` | **Released** | Ensures each `src/modules/*` exposes a public API index file |
17-
| `vue-modular/enforce-feature-exports` | **Released** | Ensures each `src/features/*` exposes a public API index file |
9+
| Rule | Status | Description |
10+
| --------------------------------------- | ------------ | ------------------------------------------------------------------------------------ |
11+
| `vue-modular/no-cross-feature-imports` | **Released** | Prevents direct imports from deep inside feature folders |
12+
| `vue-modular/no-cross-module-imports` | **Released** | Prevents deep imports between modules; prefer module public API |
13+
| `vue-modular/enforce-import-boundaries` | **Released** | Enforces proper import paths and module/feature boundaries across the project |
14+
| `vue-modular/enforce-src-structure` | **Released** | Enforces allowed top-level folders/files in the `src/` folder |
15+
| `vue-modular/enforce-app-structure` | **Released** | Validates `src/app` contains the expected entries (router, stores, layouts, App.vue) |
16+
| `vue-modular/enforce-module-exports` | **Released** | Ensures each `src/modules/*` exposes a public API index file |
17+
| `vue-modular/enforce-feature-exports` | **Released** | Ensures each `src/features/*` exposes a public API index file |
1818
| `vue-modular/enforce-naming-convention` | **Released** | Enforce consistent naming patterns for Vue components |
1919

2020
---

docs/rules.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This plugin provides rules to enforce modular architecture boundaries in Vue.js
44

55
## Available Rules
66

7-
| Rule | Description | Type | Recommended | Fixable |
8-
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ---------- | ----------- | ------- |
9-
| [`vue-modular/no-cross-feature-imports`](./rules/no-cross-feature-imports.md) | Prevents direct imports from deep inside feature folders | Problem |||
10-
| [`vue-modular/no-cross-module-imports`](./rules/no-cross-module-imports.md) | Prevents imports between different modules | Problem |||
11-
| [`vue-modular/enforce-import-boundaries`](./rules/enforce-import-boundaries.md) | Consolidated import-boundary enforcement | Problem |||
12-
| [`vue-modular/enforce-src-structure`](./rules/enforce-src-structure.md) | Enforces allowed top-level folders/files in source directory | Problem |||
13-
| [`vue-modular/enforce-app-structure`](./rules/enforce-app-structure.md) | Enforces presence of application infrastructure under `src/app` | Problem |||
14-
| [`vue-modular/enforce-module-exports`](./rules/enforce-module-exports.md) | Ensures modules expose a public API via index.ts/index.js | Problem |||
15-
| [`vue-modular/enforce-feature-exports`](./rules/enforce-feature-exports.md) | Ensures global features expose a public API via index.ts/index.js | Problem |||
7+
| Rule | Description | Type | Recommended | Fixable |
8+
| ------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ---------- | ----------- | ------- |
9+
| [`vue-modular/no-cross-feature-imports`](./rules/no-cross-feature-imports.md) | Prevents direct imports from deep inside feature folders | Problem |||
10+
| [`vue-modular/no-cross-module-imports`](./rules/no-cross-module-imports.md) | Prevents imports between different modules | Problem |||
11+
| [`vue-modular/enforce-import-boundaries`](./rules/enforce-import-boundaries.md) | Consolidated import-boundary enforcement | Problem |||
12+
| [`vue-modular/enforce-src-structure`](./rules/enforce-src-structure.md) | Enforces allowed top-level folders/files in source directory | Problem |||
13+
| [`vue-modular/enforce-app-structure`](./rules/enforce-app-structure.md) | Enforces presence of application infrastructure under `src/app` | Problem |||
14+
| [`vue-modular/enforce-module-exports`](./rules/enforce-module-exports.md) | Ensures modules expose a public API via index.ts/index.js | Problem |||
15+
| [`vue-modular/enforce-feature-exports`](./rules/enforce-feature-exports.md) | Ensures global features expose a public API via index.ts/index.js | Problem |||
1616
| [`vue-modular/enforce-naming-convention`](./rules/enforce-naming-convention.md) | Enforce consistent naming patterns for Vue components | Suggestion |||
1717

1818
## Rule Categories

0 commit comments

Comments
 (0)