heraspec 0.1.15 → 0.1.17
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 +109 -71
- package/bin/heraspec.js +1866 -89
- package/bin/heraspec.js.map +4 -4
- package/dist/cli/index.d.ts +2 -0
- package/dist/commands/audit.d.ts +37 -0
- package/dist/commands/create.d.ts +12 -0
- package/dist/commands/explore.d.ts +17 -0
- package/dist/commands/helper.d.ts +13 -0
- package/dist/commands/hotfix.d.ts +9 -0
- package/dist/commands/make-code.d.ts +14 -0
- package/dist/commands/make-docs.d.ts +36 -0
- package/dist/commands/make-test.d.ts +60 -0
- package/dist/commands/memory.d.ts +101 -0
- package/dist/commands/pack.d.ts +17 -0
- package/dist/commands/show.d.ts +8 -0
- package/dist/commands/skill.d.ts +8 -0
- package/dist/commands/suggest.d.ts +32 -0
- package/dist/commands/validate.d.ts +8 -0
- package/dist/core/archive.d.ts +14 -0
- package/dist/core/config.d.ts +33 -0
- package/dist/core/init.d.ts +101 -0
- package/dist/core/list.d.ts +7 -0
- package/dist/core/memory/config-advisor.d.ts +30 -0
- package/dist/core/memory/context-config.d.ts +14 -0
- package/dist/core/memory/context-generator.d.ts +19 -0
- package/dist/core/memory/index.d.ts +12 -0
- package/dist/core/memory/memory-schema.d.ts +34 -0
- package/dist/core/memory/memory-search.d.ts +45 -0
- package/dist/core/memory/memory-store.d.ts +71 -0
- package/dist/core/memory/memory-types.d.ts +159 -0
- package/dist/core/memory/memory-vector.d.ts +23 -0
- package/dist/core/parsers/code-parser.d.ts +53 -0
- package/dist/core/parsers/markdown-parser.d.ts +18 -0
- package/dist/core/restore.d.ts +9 -0
- package/dist/core/schemas/base.schema.d.ts +58 -0
- package/dist/core/schemas/change.schema.d.ts +35 -0
- package/dist/core/schemas/index.d.ts +7 -0
- package/dist/core/schemas/spec.schema.d.ts +52 -0
- package/dist/core/skills/index.d.ts +6 -0
- package/dist/core/skills/skill-manager.d.ts +28 -0
- package/dist/core/skills/skill-parser.d.ts +24 -0
- package/dist/core/sync.d.ts +6 -0
- package/dist/core/templates/index.d.ts +10 -0
- package/dist/core/templates/skills/README.md +4 -1
- package/dist/core/templates/skills/content-channel/content-compliance/skill.md +83 -0
- package/dist/core/templates/skills/content-channel/content-prompts/skill.md +74 -0
- package/dist/core/templates/skills/content-channel/content-scaffolding/skill.md +82 -0
- package/dist/core/templates/skills/content-channel/content-scripting/skill.md +147 -0
- package/dist/core/templates/skills/content-channel/content-strategy/skill.md +78 -0
- package/dist/core/templates/skills/content-channel/content-vault-sync/skill.md +74 -0
- package/dist/core/templates/skills/content-channel/content-voice-adapter/skill.md +143 -0
- package/dist/core/templates/skills/content-channel/skill.md +127 -0
- package/dist/core/templates/skills/perfex-module/code-quality-guidelines/skill.md +130 -0
- package/dist/core/templates/skills/perfex-module/envato-review-guidelines/skill.md +132 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/scripts/scaffold-module.js +151 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/skill.md +204 -110
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/Test_Module.php +79 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/controller-admin.php +71 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/controller-api.php +58 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/deploy.ps1 +97 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/helper.php +97 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/install.php +30 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/model-main.php +94 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/module-main.php +91 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/package.json +30 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/uninstall.php +11 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/webpack.config.js +163 -0
- package/dist/core/templates/skills/perfex-module/skill.md +50 -0
- package/dist/core/templates/skills-template-map.d.ts +29 -0
- package/dist/core/validation/validator.d.ts +26 -0
- package/dist/core/view.d.ts +4 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +383 -50
- package/dist/utils/file-system.d.ts +19 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/task-parser.d.ts +26 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -49,6 +49,8 @@ HeraSpec is a specification-based development framework that helps you:
|
|
|
49
49
|
Here are some products built partially or entirely using the HeraSpec framework:
|
|
50
50
|
|
|
51
51
|
<ul>
|
|
52
|
+
<li><a href="https://codecanyon.net/item/mtmedia-1-click-automated-web-recording-and-product-screenshot-suite-for-windows-and-macos/64976949" target="_blank">MTMedia | 1 Click Automated Web Recording and Product Screenshot Suite for Windows and macOS</a></li>
|
|
53
|
+
<li><a href="https://headrandom.com/mtxstudio" target="_blank">MTxStudio - AI Video Voiceover & Multi-Track Studio</a></li>
|
|
52
54
|
<li><a href="https://codecanyon.net/item/flexinote-for-perfex-crm/60590690" target="_blank">FlexNote for Perfex CRM</a> - Advanced note management with AI capabilities.</li>
|
|
53
55
|
<li><a href="https://codecanyon.net/item/polyutilities-for-perfex-crm-quick-access-menu-custom-js-css-and-more/49522529" target="_blank">PolyUtilities for Perfex CRM</a> - Essential toolkit for Perfex CRM customization.</li>
|
|
54
56
|
<li><a href="https://codecanyon.net/item/data-builder-for-perfex-crm/62297963" target="_blank">Data Builder — Visual Reporting, REST API & GraphQL for Perfex CRM</a> - Automated demo instance creator.</li>
|
|
@@ -80,85 +82,118 @@ Here are some products built partially or entirely using the HeraSpec framework:
|
|
|
80
82
|
<li><a href="https://wordpress.org/plugins/white-label-builder/" target="_blank">White Label Builder</a></li>
|
|
81
83
|
<li><a href="https://wordpress.org/plugins/poly-support/" target="_blank">Poly Support</a></li>
|
|
82
84
|
<li><a href="https://wordpress.org/plugins/team-manager-unified/" target="_blank">Team Manager Unified</a></li>
|
|
83
|
-
</ul>
|
|
84
|
-
|
|
85
|
-
<!-- HeraSpec Section -->
|
|
86
|
-
## HeraSpec Development
|
|
87
|
-
|
|
88
|
-
This project uses [HeraSpec](https://github.com/PolyXGO/HeraSpec) for spec-driven development.
|
|
89
|
-
|
|
90
|
-
### Quick Start
|
|
91
|
-
|
|
85
|
+
</ul>
|
|
86
|
+
|
|
87
|
+
<!-- HeraSpec Section -->
|
|
88
|
+
## HeraSpec Development
|
|
89
|
+
|
|
90
|
+
This project uses [HeraSpec](https://github.com/PolyXGO/HeraSpec) for spec-driven development.
|
|
91
|
+
|
|
92
|
+
### Quick Start
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
# Initialize HeraSpec (if not already done)
|
|
96
|
+
heraspec init
|
|
97
|
+
|
|
98
|
+
# List active changes
|
|
99
|
+
heraspec list
|
|
100
|
+
|
|
101
|
+
# View a change
|
|
102
|
+
heraspec show <change-name>
|
|
103
|
+
|
|
104
|
+
# Validate changes
|
|
105
|
+
heraspec validate <change-name>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Project Structure
|
|
109
|
+
|
|
110
|
+
- `heraspec/project.md` - Project overview and configuration
|
|
111
|
+
- `heraspec/specs/` - Source of truth specifications
|
|
112
|
+
- `heraspec/changes/` - Active changes in progress
|
|
113
|
+
- `heraspec/skills/` - Reusable skills for AI agents
|
|
114
|
+
- `AGENTS.heraspec.md` - AI agent instructions
|
|
115
|
+
|
|
116
|
+
### Working with Changes
|
|
117
|
+
|
|
118
|
+
1. **Create a change**: Ask AI to create a HeraSpec change, or create manually
|
|
119
|
+
2. **Refine specs**: Review and update delta specs in `heraspec/specs/<change-name>/`
|
|
120
|
+
3. **Implement**: Follow tasks in `heraspec/changes/<change-name>/tasks.md`
|
|
121
|
+
4. **Archive**: Run `heraspec archive <change-name> --yes` when complete
|
|
122
|
+
|
|
123
|
+
### Skills
|
|
124
|
+
|
|
125
|
+
Add skills to your project:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
# List available skills
|
|
129
|
+
heraspec skill list
|
|
130
|
+
|
|
131
|
+
# Add a skill
|
|
132
|
+
heraspec skill add ui-ux
|
|
133
|
+
heraspec skill add unit-test
|
|
134
|
+
|
|
135
|
+
# View skill details
|
|
136
|
+
heraspec skill show ui-ux
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
For more information, see the [HeraSpec documentation](https://github.com/PolyXGO/HeraSpec#readme).
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
*This section is automatically updated by `heraspec init`. Last updated: 2026-10-23*
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
## Installation & Building
|
|
147
|
+
|
|
148
|
+
### From NPM (Recommended)
|
|
92
149
|
```bash
|
|
93
|
-
|
|
94
|
-
heraspec init
|
|
95
|
-
|
|
96
|
-
# List active changes
|
|
97
|
-
heraspec list
|
|
98
|
-
|
|
99
|
-
# View a change
|
|
100
|
-
heraspec show <change-name>
|
|
101
|
-
|
|
102
|
-
# Validate changes
|
|
103
|
-
heraspec validate <change-name>
|
|
150
|
+
npm install -g heraspec@latest
|
|
104
151
|
```
|
|
105
152
|
|
|
106
|
-
###
|
|
107
|
-
|
|
108
|
-
- `heraspec/project.md` - Project overview and configuration
|
|
109
|
-
- `heraspec/specs/` - Source of truth specifications
|
|
110
|
-
- `heraspec/changes/` - Active changes in progress
|
|
111
|
-
- `heraspec/skills/` - Reusable skills for AI agents
|
|
112
|
-
- `AGENTS.heraspec.md` - AI agent instructions
|
|
113
|
-
|
|
114
|
-
### Working with Changes
|
|
115
|
-
|
|
116
|
-
1. **Create a change**: Ask AI to create a HeraSpec change, or create manually
|
|
117
|
-
2. **Refine specs**: Review and update delta specs in `heraspec/specs/<change-name>/`
|
|
118
|
-
3. **Implement**: Follow tasks in `heraspec/changes/<change-name>/tasks.md`
|
|
119
|
-
4. **Archive**: Run `heraspec archive <change-name> --yes` when complete
|
|
120
|
-
|
|
121
|
-
### Skills
|
|
122
|
-
|
|
123
|
-
Add skills to your project:
|
|
124
|
-
|
|
153
|
+
### From Source (Development)
|
|
125
154
|
```bash
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
heraspec skill add unit-test
|
|
132
|
-
|
|
133
|
-
# View skill details
|
|
134
|
-
heraspec skill show ui-ux
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
For more information, see the [HeraSpec documentation](https://github.com/your-org/heraspec/docs).
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
*This section is automatically updated by `heraspec init`. Last updated: 2026-05-21*
|
|
142
|
-
|
|
143
|
-
## Installation
|
|
144
|
-
|
|
145
|
-
```bash
|
|
146
|
-
npm install -g heraspec
|
|
155
|
+
git clone https://github.com/PolyXGO/HeraSpec.git
|
|
156
|
+
cd HeraSpec
|
|
157
|
+
npm install
|
|
158
|
+
npm run build
|
|
159
|
+
npm link
|
|
147
160
|
```
|
|
148
161
|
|
|
149
162
|
## Quick Start
|
|
150
163
|
|
|
151
164
|
```bash
|
|
152
|
-
#
|
|
165
|
+
# 1. Scaffold a new module or plugin with Clean Architecture
|
|
166
|
+
heraspec create my_module --type perfex-module
|
|
167
|
+
|
|
168
|
+
# 2. Or initialize HeraSpec in an existing codebase
|
|
169
|
+
cd my-project
|
|
153
170
|
heraspec init
|
|
154
171
|
|
|
155
|
-
#
|
|
156
|
-
heraspec
|
|
172
|
+
# 3. Audit codebase for code quality, security (OWASP) & clean standards
|
|
173
|
+
heraspec audit --fix
|
|
157
174
|
|
|
158
|
-
#
|
|
159
|
-
heraspec
|
|
175
|
+
# 4. Package clean production .zip release (strips dev bloat)
|
|
176
|
+
heraspec pack
|
|
160
177
|
```
|
|
161
178
|
|
|
179
|
+
## CLI Commands Overview
|
|
180
|
+
|
|
181
|
+
| Command | Description |
|
|
182
|
+
| :--- | :--- |
|
|
183
|
+
| `heraspec create <name> [--type <t>]` | Scaffold new module or plugin adhering to Clean Architecture standards |
|
|
184
|
+
| `heraspec audit [path] [--fix]` | Automated code quality, security, concurrency, and clean code auditor |
|
|
185
|
+
| `heraspec pack [path] [--out <dir>]` | Auto-compile assets and package production `.zip` release without dev bloat |
|
|
186
|
+
| `heraspec init [path]` | Initialize HeraSpec (with smart re-init and custom skill preservation) |
|
|
187
|
+
| `heraspec list [--specs]` | List active changes or specifications |
|
|
188
|
+
| `heraspec show <name>` | Display detailed change proposal or specification |
|
|
189
|
+
| `heraspec validate <name>` | Validate specification integrity and consistency |
|
|
190
|
+
| `heraspec archive <name> --yes` | Merge completed delta specs into source of truth |
|
|
191
|
+
| `heraspec sync <name>` | Sync change with source specs to resolve parallel merge conflicts |
|
|
192
|
+
| `heraspec skill list` | List all available built-in and project-specific skills |
|
|
193
|
+
| `heraspec skill add <name>` | Install a skill suite to the project |
|
|
194
|
+
| `heraspec memory context` | Generate token-efficient agent session context |
|
|
195
|
+
| `heraspec helper` | Interactive CLI usage guide and prompts |
|
|
196
|
+
|
|
162
197
|
## Documentation
|
|
163
198
|
|
|
164
199
|
- [User Guide](./docs/en/USER_GUIDE.md)
|
|
@@ -167,12 +202,15 @@ heraspec change start "add-user-authentication"
|
|
|
167
202
|
|
|
168
203
|
## Features
|
|
169
204
|
|
|
170
|
-
- ✅
|
|
171
|
-
- ✅
|
|
172
|
-
- ✅
|
|
173
|
-
- ✅
|
|
174
|
-
- ✅
|
|
175
|
-
- ✅
|
|
205
|
+
- ✅ **Enterprise Code Quality Auditor** (`heraspec audit` with 7 automated checks and safe auto-fix)
|
|
206
|
+
- ✅ **Clean Architecture Scaffolder** (`heraspec create` for Perfex CRM, WordPress plugins/themes)
|
|
207
|
+
- ✅ **Production Release Packager** (`heraspec pack` with cross-platform compression & strict bloat exclusion)
|
|
208
|
+
- ✅ **Custom Skill Preservation** (Existing projects safely retain custom skills on `heraspec init`)
|
|
209
|
+
- ✅ **Multi-project type support** (WordPress, Perfex CRM, Content Channels & Multi-Platform Video, Laravel, React, Vue, Node.js)
|
|
210
|
+
- ✅ **Multi-Channel Content Engineering** (7 content skills: strategy, scaffolding, scripting, voice-adapter, prompts, compliance, and MTxStudio vault sync)
|
|
211
|
+
- ✅ **Specification-driven development** with delta specs and conflict-free parallel merging
|
|
212
|
+
- ✅ **AI Integration Ready** (Cursor, Antigravity, Windsurf, Copilot, Claude Desktop)
|
|
213
|
+
- ✅ **Proactive Memory & Semantic Search** (Token savings & architecture tracking)
|
|
176
214
|
|
|
177
215
|
## AI Integration
|
|
178
216
|
|