spec-feature 1.0.6 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -113,16 +113,16 @@ To create a feature specification, use the `spec/feature.md` template with any A
113
113
 
114
114
  ### 📝 Input parameter format
115
115
 
116
- Pass parameters in one line in the format `@<feature>@ <context>`:
116
+ Pass parameters in one line in the format `#<feature># <context>`:
117
117
 
118
- - the value between the first two `@` symbols is used as **FEATURE** and determines the feature folder (`@payments@` → `spec/features/payments`);
119
- - everything following the second `@` is **CONTEXT**. It can span multiple lines, include lists, links, and additional clarifications.
118
+ - the value between the first two `#` symbols is used as **FEATURE** and determines the feature folder (`#payments#` → `spec/features/payments`);
119
+ - everything following the second `#` is **CONTEXT**. It can span multiple lines, include lists, links, and additional clarifications.
120
120
 
121
121
  ### 🚀 Usage example
122
122
 
123
123
  ```
124
124
  Use the template from spec/feature.md.
125
- @user-auth@ Need to add user authentication via email and password. The user should be able to register, log in, and recover their password. Integration with the existing notification system is mandatory.
125
+ #user-auth# Need to add user authentication via email and password. The user should be able to register, log in, and recover their password. Integration with the existing notification system is mandatory.
126
126
  ```
127
127
 
128
128
  ### ✨ What happens next
@@ -181,7 +181,7 @@ To update an existing feature, reuse `spec/feature.md`, specifying the name of t
181
181
  **📝 Update example:**
182
182
  ```
183
183
  Use the template from spec/feature.md.
184
- @user-auth@ Add two-factor authentication (2FA) via SMS. The user should be able to enable/disable 2FA in profile settings. Integration with existing SMS provider.
184
+ #user-auth# Add two-factor authentication (2FA) via SMS. The user should be able to enable/disable 2FA in profile settings. Integration with existing SMS provider.
185
185
  ```
186
186
 
187
187
  The AI assistant will correctly overwrite `spec.md`, `plan.md`, and `tasks.md`, preserving the structure and updating the content for new requirements.
@@ -191,7 +191,7 @@ The AI assistant will correctly overwrite `spec.md`, `plan.md`, and `tasks.md`,
191
191
  ### 🚨 Common problems and solutions
192
192
 
193
193
  **❌ Problem:** AI assistant doesn't create feature folder
194
- - **✅ Solution:** Make sure you're using the correct format `@feature@ context` and that the assistant has file creation permissions
194
+ - **✅ Solution:** Make sure you're using the correct format `#feature# context` and that the assistant has file creation permissions
195
195
 
196
196
  **❌ Problem:** Tasks are executed in wrong order
197
197
  - **✅ Solution:** Check task numbering in `tasks.md` and reorder if necessary
@@ -203,4 +203,4 @@ The AI assistant will correctly overwrite `spec.md`, `plan.md`, and `tasks.md`,
203
203
  ```
204
204
 
205
205
  **❌ Problem:** Conflict when updating existing feature
206
- - **✅ Solution:** Create a backup of current files before updating or use git to track changes
206
+ - **✅ Solution:** Create a backup of current files before updating or use git to track changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "spec-feature",
3
- "version": "1.0.6",
3
+ "version": "1.0.7",
4
4
  "bin": {
5
5
  "spec-feature": "./bin/cli.js"
6
6
  },
@@ -4,8 +4,8 @@ Template automates feature maintenance after release: records hotfixes and synch
4
4
 
5
5
  **Parameters**
6
6
 
7
- - **FEATURE** — name of the folder with feature artifacts. Determined by the value between the first two `@` symbols (e.g., `@billing@` → `billing`).
8
- - **CONTEXT** — essence of the hotfix and expected result. This is everything passed after the second `@`; multi-line descriptions with links to incidents or PRs are allowed.
7
+ - **FEATURE** — name of the folder with feature artifacts. Determined by the value between the first two `#` symbols (e.g., `#billing#` → `billing`).
8
+ - **CONTEXT** — essence of the hotfix and expected result. This is everything passed after the second `#`; multi-line descriptions with links to incidents or PRs are allowed.
9
9
 
10
10
  **General rules**
11
11
 
@@ -32,4 +32,4 @@ Template automates feature maintenance after release: records hotfixes and synch
32
32
  3. Update `tasks.md`: add or adjust tasks, set checkboxes based on actual execution, supplement with verification requirements.
33
33
  4. Ensure all modified documents are complete and ready for implementation.
34
34
 
35
- Write strictly in Markdown. Goal — automatically bring all feature artifacts up to date under the hotfix and synchronize checklists with actual state.
35
+ Write strictly in Markdown. Goal — automatically bring all feature artifacts up to date under the hotfix and synchronize checklists with actual state.
package/spec/core/plan.md CHANGED
@@ -4,8 +4,8 @@ Template helps format the feature implementation plan in the **spec-feature** pr
4
4
 
5
5
  **Parameters**
6
6
 
7
- - **FEATURE** — name of the folder where the plan will be saved. Taken from the value between the first two `@` symbols (e.g., `@payments@` → `payments`).
8
- - **CONTEXT** — main context for preparing the plan. Consider everything after the second `@` in the parameter line; context can span multiple lines and include additional clarifications.
7
+ - **FEATURE** — name of the folder where the plan will be saved. Taken from the value between the first two `#` symbols (e.g., `#payments#` → `payments`).
8
+ - **CONTEXT** — main context for preparing the plan. Consider everything after the second `#` in the parameter line; context can span multiple lines and include additional clarifications.
9
9
 
10
10
  **General rules**
11
11
 
@@ -52,4 +52,4 @@ Template helps format the feature implementation plan in the **spec-feature** pr
52
52
 
53
53
  ```
54
54
 
55
- Write strictly in Markdown and automatically create/update the plan file. **Goal** — create/update file `/spec/features/{FEATURE}/plan.md` describing HOW we implement the feature based on **CONTEXT**.
55
+ Write strictly in Markdown and automatically create/update the plan file. **Goal** — create/update file `/spec/features/{FEATURE}/plan.md` describing HOW we implement the feature based on **CONTEXT**.
package/spec/core/spec.md CHANGED
@@ -4,8 +4,8 @@ Template helps describe a feature before implementation in the **spec-feature**
4
4
 
5
5
  **Parameters**
6
6
 
7
- - **FEATURE** — name of the folder where the specification will be saved. Taken from the value between the first two `@` symbols (e.g., `@payments@` → `payments`).
8
- - **CONTEXT** — main context for describing the feature. Consider everything after the second `@` in the parameter line; context can span multiple lines and include additional clarifications.
7
+ - **FEATURE** — name of the folder where the specification will be saved. Taken from the value between the first two `#` symbols (e.g., `#payments#` → `payments`).
8
+ - **CONTEXT** — main context for describing the feature. Consider everything after the second `#` in the parameter line; context can span multiple lines and include additional clarifications.
9
9
 
10
10
  **General rules**
11
11
 
@@ -48,4 +48,4 @@ Template helps describe a feature before implementation in the **spec-feature**
48
48
 
49
49
  ```
50
50
 
51
- Write strictly in Markdown and automatically create/update the specification file. **Goal** — create/update file `/spec/features/{FEATURE}/spec.md` describing WHAT we do and WHY, based on **CONTEXT**.
51
+ Write strictly in Markdown and automatically create/update the specification file. **Goal** — create/update file `/spec/features/{FEATURE}/spec.md` describing WHAT we do and WHY, based on **CONTEXT**.
@@ -4,8 +4,8 @@ Template helps form a task list for feature implementation in the **spec-feature
4
4
 
5
5
  **Parameters**
6
6
 
7
- - **FEATURE** — name of the folder where the task list will be saved. Taken from the value between the first two `@` symbols (e.g., `@payments@` → `payments`).
8
- - **CONTEXT** — main context for preparing tasks. Consider everything after the second `@` in the parameter line; context can span multiple lines and include additional clarifications.
7
+ - **FEATURE** — name of the folder where the task list will be saved. Taken from the value between the first two `#` symbols (e.g., `#payments#` → `payments`).
8
+ - **CONTEXT** — main context for preparing tasks. Consider everything after the second `#` in the parameter line; context can span multiple lines and include additional clarifications.
9
9
 
10
10
  **General rules**
11
11
 
@@ -56,4 +56,4 @@ Template helps form a task list for feature implementation in the **spec-feature
56
56
 
57
57
  ```
58
58
 
59
- Write strictly in Markdown and automatically create/update the task list file. Do not proceed to task execution without a separate request. **Goal** — create/update file `/spec/features/{FEATURE}/tasks.md` with a list of WHAT we do and how we verify the result, based on **CONTEXT** and prepared materials.
59
+ Write strictly in Markdown and automatically create/update the task list file. Do not proceed to task execution without a separate request. **Goal** — create/update file `/spec/features/{FEATURE}/tasks.md` with a list of WHAT we do and how we verify the result, based on **CONTEXT** and prepared materials.
@@ -4,8 +4,8 @@ Template helps format the results of automatic task execution verification and m
4
4
 
5
5
  **Parameters**
6
6
 
7
- - **FEATURE** — name of the folder where the verification report will be saved. Taken from the value between the first two `@` symbols (e.g., `@payments@` → `payments`).
8
- - **CONTEXT** — main context and verification purpose. Consider everything after the second `@` in the parameter line; context can span multiple lines and include additional clarifications.
7
+ - **FEATURE** — name of the folder where the verification report will be saved. Taken from the value between the first two `#` symbols (e.g., `#payments#` → `payments`).
8
+ - **CONTEXT** — main context and verification purpose. Consider everything after the second `#` in the parameter line; context can span multiple lines and include additional clarifications.
9
9
 
10
10
  **General rules**
11
11
 
@@ -77,4 +77,4 @@ Template helps format the results of automatic task execution verification and m
77
77
  - ❌ — not completed
78
78
  - ⚠️ — partially completed
79
79
 
80
- Write strictly in Markdown and add nothing outside the document. **Goal** — verify all tasks in `spec/features/{FEATURE}/tasks.md`, mark completed ones in the task file, create a detailed report `verify-report.md` with logs of all tasks and their statuses, or recommend moving the feature to `spec/archived/{FEATURE}` if all tasks passed.
80
+ Write strictly in Markdown and add nothing outside the document. **Goal** — verify all tasks in `spec/features/{FEATURE}/tasks.md`, mark completed ones in the task file, create a detailed report `verify-report.md` with logs of all tasks and their statuses, or recommend moving the feature to `spec/archived/{FEATURE}` if all tasks passed.
package/spec/feature.md CHANGED
@@ -4,10 +4,10 @@ Template allows creating a complete set of feature documents in one request duri
4
4
 
5
5
  **Parameters**
6
6
 
7
- - **FEATURE** — name of the folder where artifacts will be saved. Determined by the value between the first two `@` symbols (e.g., `@payments@` → `payments`).
8
- - **CONTEXT** — detailed feature description: goals, functional and non-functional requirements, constraints, implementation plan. Consider everything after the second `@` in the parameter line; text can span multiple lines and include lists.
7
+ - **FEATURE** — name of the folder where artifacts will be saved. Determined by the value between the first two `#` symbols (e.g., `#payments#` → `payments`).
8
+ - **CONTEXT** — detailed feature description: goals, functional and non-functional requirements, constraints, implementation plan. Consider everything after the second `#` in the parameter line; text can span multiple lines and include lists.
9
9
 
10
- Parameters are passed in one line in the format `@<feature>@ <context>` without XML-like tags.
10
+ Parameters are passed in one line in the format `#<feature># <context>` without XML-like tags.
11
11
 
12
12
  **General rules**
13
13
 
@@ -37,4 +37,4 @@ The process should automatically create/update the following files:
37
37
 
38
38
  Each document should be created with complete content based on the templates from `spec/core/` and the provided **CONTEXT**.
39
39
 
40
- Write strictly in Markdown and automatically create/update the three documents. **Goal** — create a complete set of feature materials (what we do, how we implement, and what tasks we perform) in one request based on **CONTEXT**, with automatic file creation and directory structure management.
40
+ Write strictly in Markdown and automatically create/update the three documents. **Goal** — create a complete set of feature materials (what we do, how we implement, and what tasks we perform) in one request based on **CONTEXT**, with automatic file creation and directory structure management.