@pixpilot/scaffoldfy 0.5.1 → 0.5.4

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.
Files changed (2) hide show
  1. package/README.md +14 -49
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -51,7 +51,6 @@ scaffoldfy --force
51
51
  | `--tasks-ts <path>` | Path to TypeScript task file (default: `./template-tasks.ts`) |
52
52
  | `--dry-run` | Preview changes without applying them |
53
53
  | `--force` | Force re-initialization |
54
- | `--keep-tasks-file` | Keep task file after completion (default: remove) |
55
54
  | `-h, --help` | Show help message |
56
55
  | `-v, --version` | Show version |
57
56
 
@@ -67,8 +66,6 @@ await runWithTasks(tasks, {
67
66
  });
68
67
  ```
69
68
 
70
- ## Core Concepts
71
-
72
69
  ### Task Types
73
70
 
74
71
  9 built-in task types for common operations:
@@ -85,7 +82,7 @@ await runWithTasks(tasks, {
85
82
  | `git-init` | Initialize git repository |
86
83
  | `exec` | Execute shell commands |
87
84
 
88
- 📖 **[Complete Task Types Reference →](docs/TASK_TYPES.md)**
85
+ 📖 **[Complete Task Types Reference →](https://pixpilot.github.io/scaffoldfy/TASK_TYPES.html)**
89
86
 
90
87
  ### Interactive Prompts
91
88
 
@@ -122,7 +119,7 @@ Collect custom user input directly in your task definitions:
122
119
 
123
120
  **Global prompts:** Mark prompts with `"global": true` to share values across all tasks
124
121
 
125
- 💬 **[Full Prompts Guide →](docs/PROMPTS.md)** | 📋 **[Quick Reference →](docs/PROMPTS_QUICK_REFERENCE.md)**
122
+ 💬 **[Full Prompts Guide →](https://pixpilot.github.io/scaffoldfy/PROMPTS.html)** | 📋 **[Quick Reference →](https://pixpilot.github.io/scaffoldfy/PROMPTS_QUICK_REFERENCE.html)**
126
123
 
127
124
  ### Template Variables
128
125
 
@@ -195,7 +192,7 @@ Create powerful file templates with Handlebars support. Files with `.hbs` extens
195
192
  - **Loops:** `{{#each}}`, `{{#with}}`
196
193
  - **Comments:** `{{!-- This won't appear in output --}}`
197
194
 
198
- 📝 **[Complete Handlebars Guide →](docs/HANDLEBARS_TEMPLATES.md)**
195
+ 📝 **[Complete Handlebars Guide →](https://pixpilot.github.io/scaffoldfy/HANDLEBARS_TEMPLATES.html)**
199
196
 
200
197
  ### Template Inheritance
201
198
 
@@ -220,7 +217,7 @@ Extend base templates to promote code reuse:
220
217
 
221
218
  You can extend multiple templates, override tasks by ID, and merge dependencies automatically.
222
219
 
223
- 🧬 **[Complete Inheritance Guide →](docs/TEMPLATE_INHERITANCE.md)**
220
+ 🧬 **[Complete Inheritance Guide →](https://pixpilot.github.io/scaffoldfy/TEMPLATE_INHERITANCE.html)**
224
221
 
225
222
  ### Dry-Run Mode with Diff Preview
226
223
 
@@ -232,7 +229,7 @@ scaffoldfy --tasks-file ./tasks.json --dry-run
232
229
 
233
230
  See color-coded diffs for all file modifications, deletions, and additions.
234
231
 
235
- 🔍 **[Dry-Run Documentation →](docs/DRY_RUN.md)**
232
+ 🔍 **[Dry-Run Documentation →](https://pixpilot.github.io/scaffoldfy/DRY_RUN.html)**
236
233
 
237
234
  ### Plugin System
238
235
 
@@ -252,7 +249,7 @@ const myPlugin = createPlugin(
252
249
  registerPlugin(myPlugin);
253
250
  ```
254
251
 
255
- 🔌 **[Complete Plugin Guide →](docs/PLUGINS.md)**
252
+ 🔌 **[Complete Plugin Guide →](https://pixpilot.github.io/scaffoldfy/PLUGINS.html)**
256
253
 
257
254
  ### Task Dependencies
258
255
 
@@ -342,55 +339,23 @@ Control execution order:
342
339
 
343
340
  ## Documentation
344
341
 
345
- 📚 **[Complete Documentation](../../docs/README.md)** - Start here for comprehensive guides and references
342
+ 📚 **[Complete Documentation](https://pixpilot.github.io/scaffoldfy/)** - Comprehensive guides and references
346
343
 
347
344
  ### Quick Links
348
345
 
349
- - **[Getting Started](../../docs/GETTING_STARTED.md)** - Installation, CLI usage, and examples
350
- - **[Task Types Reference](../../docs/TASK_TYPES.md)** - All 9 built-in task types
351
- - **[Interactive Prompts](../../docs/PROMPTS.md)** - Collect user input
352
- - **[Advanced Features](../../docs/FEATURES.md)** - Conditional execution, global prompts, Handlebars
353
- - **[Template Inheritance](../../docs/TEMPLATE_INHERITANCE.md)** - Extend and compose templates
354
- - **[Plugin System](../../docs/PLUGINS.md)** - Create custom task types
355
- - **[Dry-Run Mode](../../docs/DRY_RUN.md)** - Preview changes safely
346
+ - **[Getting Started](https://pixpilot.github.io/scaffoldfy/GETTING_STARTED.html)** - Installation, CLI usage, and examples
347
+ - **[Task Types Reference](https://pixpilot.github.io/scaffoldfy/TASK_TYPES.html)** - All 9 built-in task types
348
+ - **[Interactive Prompts](https://pixpilot.github.io/scaffoldfy/PROMPTS.html)** - Collect user input
349
+ - **[Advanced Features](https://pixpilot.github.io/scaffoldfy/FEATURES.html)** - Conditional execution, global prompts, Handlebars
350
+ - **[Template Inheritance](https://pixpilot.github.io/scaffoldfy/TEMPLATE_INHERITANCE.html)** - Extend and compose templates
351
+ - **[Plugin System](https://pixpilot.github.io/scaffoldfy/PLUGINS.html)** - Create custom task types
352
+ - **[Dry-Run Mode](https://pixpilot.github.io/scaffoldfy/DRY_RUN.html)** - Preview changes safely
356
353
 
357
354
  ### Resources
358
355
 
359
356
  - **[JSON Schema](schema/tasks.schema.json)** - For IDE autocomplete and validation
360
357
  - **[Example Files](examples/)** - Sample task configurations
361
358
 
362
- ### 📁 Project Structure
363
-
364
- ```
365
- scaffoldfy (monorepo)/
366
- ├── docs/ # Complete documentation
367
- │ ├── README.md # Documentation index
368
- │ ├── GETTING_STARTED.md # Getting started guide
369
- │ ├── FEATURES.md # Advanced features
370
- │ ├── TASK_TYPES.md # Task types reference
371
- │ ├── PROMPTS.md # Prompts guide
372
- │ ├── PROMPTS_QUICK_REFERENCE.md # Quick reference
373
- │ ├── TEMPLATE_INHERITANCE.md # Inheritance guide
374
- │ ├── HANDLEBARS_TEMPLATES.md # Handlebars guide
375
- │ ├── PLUGINS.md # Plugin system
376
- │ ├── DRY_RUN.md # Dry-run mode
377
- │ └── EXECUTABLE_DEFAULTS_REFERENCE.md
378
- └── packages/
379
- └── scaffoldfy/ # Main package
380
- ├── src/
381
- │ ├── cli.ts # CLI entry point
382
- │ ├── types.ts # TypeScript definitions
383
- │ ├── config.ts # Configuration
384
- │ ├── prompts.ts # Prompt handling
385
- │ ├── task-executors.ts # Task execution
386
- │ ├── task-resolver.ts # Dependency resolution
387
- │ └── utils.ts # Utilities
388
- ├── schema/
389
- │ └── tasks.schema.json # JSON schema
390
- ├── examples/ # Example configurations
391
- └── test/ # Test files
392
- ```
393
-
394
359
  ## JSON Schema Support
395
360
 
396
361
  Enable autocomplete and validation in your IDE:
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pixpilot/scaffoldfy",
3
3
  "type": "module",
4
- "version": "0.5.1",
4
+ "version": "0.5.4",
5
5
  "author": "PixPilot <m.doaie@hotmail.com>",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -47,10 +47,10 @@
47
47
  "tsdown": "^0.15.8",
48
48
  "typescript": "^5.9.3",
49
49
  "@internal/eslint-config": "0.3.0",
50
+ "@internal/prettier-config": "0.0.1",
50
51
  "@internal/tsdown-config": "0.1.0",
51
- "@internal/vitest-config": "0.1.0",
52
52
  "@internal/tsconfig": "0.1.0",
53
- "@internal/prettier-config": "0.0.1"
53
+ "@internal/vitest-config": "0.1.0"
54
54
  },
55
55
  "prettier": "@internal/prettier-config",
56
56
  "scripts": {