@sppg2001/atomize 1.2.4 → 2.0.0

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/.env.example CHANGED
@@ -15,3 +15,6 @@
15
15
 
16
16
  # Winston log level: error, warn, info, debug (default: warn).
17
17
  # LOG_LEVEL=warn
18
+
19
+ # Update notifier mode: enabled or disabled.
20
+ # ATOMIZE_UPDATE_NOTIFIER=enabled
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # Atomize
2
2
 
3
3
  [![CI](https://github.com/Simao-Pereira-Gomes/atomize/actions/workflows/ci.yml/badge.svg)](https://github.com/Simao-Pereira-Gomes/atomize/actions/workflows/ci.yml)
4
- [![Code Quality](https://github.com/Simao-Pereira-Gomes/atomize/actions/workflows/code-quality.yml/badge.svg)](https://github.com/Simao-Pereira-Gomes/atomize/actions/workflows/code-quality.yml)
4
+ [![CodeQL](https://github.com/Simao-Pereira-Gomes/atomize/actions/workflows/codeql.yml/badge.svg)](https://github.com/Simao-Pereira-Gomes/atomize/actions/workflows/codeql.yml)
5
5
  [![NPM Version](https://img.shields.io/npm/v/@sppg2001/atomize)](https://www.npmjs.com/package/@sppg2001/atomize)
6
6
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
7
  [![Node Version](https://img.shields.io/node/v/@sppg2001/atomize)](https://nodejs.org)
@@ -71,10 +71,10 @@ You'll be prompted for your Organization URL, project, team, and a [Personal Acc
71
71
 
72
72
  ```bash
73
73
  # Use a preset template (dry-run by default — safe to try)
74
- atomize generate templates/backend-api.yaml
74
+ atomize generate template:backend-api
75
75
 
76
76
  # When ready to create tasks for real
77
- atomize generate templates/backend-api.yaml --execute
77
+ atomize generate template:backend-api --execute
78
78
 
79
79
  # Interactive mode (prompts for everything)
80
80
  atomize generate
@@ -83,8 +83,8 @@ atomize generate
83
83
  ### 3. Create Your First Template
84
84
 
85
85
  ```bash
86
- # From a preset
87
- atomize template create --preset backend-api
86
+ # From an existing template
87
+ atomize template create --from backend-api
88
88
 
89
89
  # Learn from multiple stories (better pattern detection)
90
90
  atomize template create --from-stories STORY-1,STORY-2,STORY-3
@@ -113,21 +113,21 @@ The `generate` command creates tasks in your work item management system based o
113
113
 
114
114
  ```bash
115
115
  # Basic usage
116
- atomize generate templates/backend-api.yaml
116
+ atomize generate template:backend-api
117
117
 
118
118
  # With options
119
- atomize generate templates/backend-api.yaml \
119
+ atomize generate template:backend-api \
120
120
  --platform azure-devops \
121
121
  --execute \
122
122
  --verbose
123
123
 
124
124
  # Dry run (default — no --execute needed)
125
- atomize generate templates/backend-api.yaml
125
+ atomize generate template:backend-api
126
126
 
127
127
  # CI/CD mode with JSON report
128
- atomize generate templates/backend-api.yaml \
128
+ atomize generate template:backend-api \
129
129
  --execute \
130
- --yes \
130
+ --auto-approve \
131
131
  --output report.json
132
132
  ```
133
133
 
@@ -135,15 +135,16 @@ atomize generate templates/backend-api.yaml \
135
135
  - `--platform <type>` - Platform: `azure-devops` or `mock`
136
136
  - `--profile <name>` - Named connection profile to use (see `atomize auth add`)
137
137
  - `--execute` - Actually create tasks (default is dry-run preview)
138
- - `-y, --yes` - Required with `--execute` in non-interactive mode to acknowledge live task creation
138
+ - `--auto-approve` - Required with `--execute` in non-interactive mode to acknowledge live task creation
139
139
  - `--continue-on-error` - Keep processing if errors occur
140
140
  - `--story-concurrency <n>` - Parallel story processing (default: 3, max: 10)
141
141
  - `--task-concurrency <n>` - Parallel task creation per story (default: 5, max: 20)
142
142
  - `--dependency-concurrency <n>` - Parallel dependency link creation (default: 5, max: 10)
143
143
  - `--verbose` - Show detailed output
144
144
  - `-o, --output <file>` - Write JSON report to file
145
+ - `--include-sensitive-report-data` - Include descriptions, custom fields, and platform-specific work item data in the JSON report
145
146
 
146
- In non-interactive mode, `--execute` now requires `--yes`. This prevents unattended task creation from wrapper scripts or CI jobs that did not explicitly acknowledge the mutation.
147
+ In non-interactive mode, `--execute` now requires `--auto-approve`. This prevents unattended task creation from wrapper scripts or CI jobs that did not explicitly acknowledge the mutation.
147
148
 
148
149
  **Example Output:**
149
150
  ```
@@ -163,29 +164,30 @@ Summary:
163
164
  #### Create a Template
164
165
 
165
166
  ```bash
166
- # From preset (fastest)
167
- atomize template create --preset frontend-feature
167
+ # From an existing template (fastest)
168
+ atomize template create --from feature
168
169
 
169
170
  # Learn from multiple stories (best pattern detection)
170
171
  atomize template create \
171
172
  --from-stories STORY-1,STORY-2,STORY-3 \
172
- --output my-templates/learned.yaml
173
+ --save-as learned-api-template
173
174
 
174
175
  # Interactive wizard (most control)
175
176
  atomize template create --scratch
176
177
  ```
177
178
 
178
- #### List Available Presets
179
+ #### List Available Templates
179
180
 
180
181
  ```bash
181
- atomize template presets
182
+ atomize template list
182
183
  ```
183
184
 
184
- **Available Presets:**
185
+ **Built-in Templates:**
185
186
  - `backend-api` - Backend API with database integration
186
- - `frontend-feature` - React/Vue UI component development
187
- - `bug-fix` - Bug investigation and resolution workflow
188
- - `fullstack` - Complete full-stack feature
187
+ - `feature` - General feature task workflow
188
+ - `bug` - Bug investigation and resolution workflow
189
+ - `custom` - Example template with custom fields
190
+ - `custom-saved-query` - Example template using an Azure DevOps saved query
189
191
 
190
192
  #### Validate a Template
191
193
 
@@ -193,7 +195,7 @@ atomize template presets
193
195
  atomize validate templates/my-template.yaml
194
196
 
195
197
  # Strict mode — warnings become errors (recommended for team/production templates)
196
- atomize validate templates/my-template.yaml --strict --verbose
198
+ atomize validate templates/my-template.yaml --strict
197
199
  ```
198
200
 
199
201
  ---
@@ -276,7 +278,10 @@ assignTo: "user@email.com" # Specific user
276
278
  ```yaml
277
279
  - title: "Security Review"
278
280
  estimationPercent: 10
279
- condition: '${story.tags} CONTAINS "security"'
281
+ condition:
282
+ field: "tags"
283
+ operator: "contains"
284
+ value: "security"
280
285
  ```
281
286
 
282
287
  #### Conditional Estimation (v1.1)
@@ -287,9 +292,15 @@ Adapt task percentage based on story properties. First matching rule wins; `esti
287
292
  - title: "Implementation"
288
293
  estimationPercent: 50 # Default
289
294
  estimationPercentCondition:
290
- - condition: '${story.tags} CONTAINS "critical"'
295
+ - condition:
296
+ field: "tags"
297
+ operator: "contains"
298
+ value: "critical"
291
299
  percent: 60 # More weight for critical stories
292
- - condition: "${story.estimation} >= 13"
300
+ - condition:
301
+ field: "estimation"
302
+ operator: "gte"
303
+ value: 13
293
304
  percent: 55 # More work for large stories
294
305
  ```
295
306
 
@@ -331,11 +342,11 @@ tasks:
331
342
  4. **Generate tasks**
332
343
  ```bash
333
344
  # Use the profile explicitly
334
- atomize generate templates/backend-api.yaml --profile work-ado
345
+ atomize generate template:backend-api --profile work-ado
335
346
 
336
347
  # Or set it as default once
337
348
  atomize auth use work-ado
338
- atomize generate templates/backend-api.yaml
349
+ atomize generate template:backend-api
339
350
  ```
340
351
 
341
352
  See `atomize auth --help` for all profile management commands (`list`, `remove`, `rotate`).
@@ -343,7 +354,7 @@ See `atomize auth --help` for all profile management commands (`list`, `remove`,
343
354
  ### Mock Platform (Testing)
344
355
 
345
356
  ```bash
346
- atomize generate templates/backend-api.yaml --platform mock
357
+ atomize generate template:backend-api --platform mock
347
358
  ```
348
359
 
349
360
  No configuration required. Includes 7 built-in sample stories.
@@ -398,13 +409,13 @@ validation:
398
409
  atomize template create \
399
410
  --from-stories STORY-100,STORY-115,STORY-132,STORY-148 \
400
411
  --platform azure-devops \
401
- --output team-templates/backend-standard.yaml
412
+ --save-as backend-standard
402
413
 
403
414
  # Validate the learned template
404
- atomize validate team-templates/backend-standard.yaml --strict
415
+ atomize validate template:backend-standard --strict
405
416
 
406
417
  # Apply it
407
- atomize generate team-templates/backend-standard.yaml --execute
418
+ atomize generate template:backend-standard --execute
408
419
  ```
409
420
 
410
421
  ---
@@ -415,7 +426,7 @@ atomize generate team-templates/backend-standard.yaml --execute
415
426
 
416
427
  ```yaml
417
428
  filter:
418
- team: "Backend Team" # Override team (replaces AZURE_DEVOPS_TEAM env var)
429
+ team: "Backend Team" # Override team from the selected profile
419
430
  workItemTypes: ["User Story", "Bug"]
420
431
  states: ["New", "Approved"]
421
432
  statesExclude: ["Done", "Removed"] # Exclude items in these states
@@ -505,10 +516,10 @@ If you prefer file-based configuration (e.g. in CI/CD), pass `--env-file` explic
505
516
 
506
517
  ```bash
507
518
  # macOS / Linux
508
- atomize --env-file ~/.config/atomize.env generate templates/backend-api.yaml
519
+ atomize --env-file ~/.config/atomize.env generate template:backend-api
509
520
 
510
521
  # Windows (PowerShell)
511
- atomize --env-file $env:USERPROFILE\.config\atomize.env generate templates/backend-api.yaml
522
+ atomize --env-file $env:USERPROFILE\.config\atomize.env generate template:backend-api
512
523
  ```
513
524
 
514
525
  Shell environment variables always take precedence over values in the file, so it is safe to use `--env-file` as a fallback without risk of overriding real environment config.
@@ -561,14 +572,14 @@ atomize auth add work-ado
561
572
  atomize auth test work-ado
562
573
 
563
574
  # Use it explicitly
564
- atomize generate templates/backend-api.yaml --profile work-ado
575
+ atomize generate template:backend-api --profile work-ado
565
576
  ```
566
577
 
567
578
  ### "Template validation failed"
568
579
 
569
580
  ```bash
570
581
  # Get detailed output
571
- atomize validate templates/my-template.yaml --verbose
582
+ atomize validate templates/my-template.yaml --strict
572
583
 
573
584
  # Common issues:
574
585
  # - Total estimation must equal 100%
@@ -583,6 +594,7 @@ atomize validate templates/my-template.yaml --verbose
583
594
  - [Getting Started](./docs/Getting-Started.md) - First steps and core concepts
584
595
  - [CLI Reference](./docs/Cli-Reference.md) - Complete command and flag reference
585
596
  - [Template Reference](./docs/Template-Reference.md) - Full template schema
597
+ - [Auth Guide](./docs/Auth-Guide.md) - Credential storage, profiles, and CI/CD setup
586
598
  - [Validation Modes](./docs/Validation-Modes.md) - Strict vs lenient explained
587
599
  - [Story Learner](./docs/Story-Learner.md) - Generate templates from existing stories
588
600
  - [Common Validation Errors](./docs/Common-Validation-Errors.md) - Fix validation failures