heraspec 0.1.15 → 0.1.16
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 +46 -12
- package/bin/heraspec.js +1296 -75
- 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 +11 -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 +97 -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 +55 -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 +50 -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/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 +155 -35
- 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
|
@@ -140,25 +140,57 @@ For more information, see the [HeraSpec documentation](https://github.com/your-o
|
|
|
140
140
|
|
|
141
141
|
*This section is automatically updated by `heraspec init`. Last updated: 2026-05-21*
|
|
142
142
|
|
|
143
|
-
## Installation
|
|
143
|
+
## Installation & Building
|
|
144
144
|
|
|
145
|
+
### From NPM
|
|
145
146
|
```bash
|
|
146
147
|
npm install -g heraspec
|
|
147
148
|
```
|
|
148
149
|
|
|
150
|
+
### From Source (Development)
|
|
151
|
+
```bash
|
|
152
|
+
git clone https://github.com/PolyXGO/HeraSpec.git
|
|
153
|
+
cd HeraSpec
|
|
154
|
+
npm install
|
|
155
|
+
npm run build
|
|
156
|
+
npm link
|
|
157
|
+
```
|
|
158
|
+
|
|
149
159
|
## Quick Start
|
|
150
160
|
|
|
151
161
|
```bash
|
|
152
|
-
#
|
|
162
|
+
# 1. Scaffold a new module or plugin with Clean Architecture
|
|
163
|
+
heraspec create my_module --type perfex-module
|
|
164
|
+
|
|
165
|
+
# 2. Or initialize HeraSpec in an existing codebase
|
|
166
|
+
cd my-project
|
|
153
167
|
heraspec init
|
|
154
168
|
|
|
155
|
-
#
|
|
156
|
-
heraspec
|
|
169
|
+
# 3. Audit codebase for code quality, security (OWASP) & clean standards
|
|
170
|
+
heraspec audit --fix
|
|
157
171
|
|
|
158
|
-
#
|
|
159
|
-
heraspec
|
|
172
|
+
# 4. Package clean production .zip release (strips dev bloat)
|
|
173
|
+
heraspec pack
|
|
160
174
|
```
|
|
161
175
|
|
|
176
|
+
## CLI Commands Overview
|
|
177
|
+
|
|
178
|
+
| Command | Description |
|
|
179
|
+
| :--- | :--- |
|
|
180
|
+
| `heraspec create <name> [--type <t>]` | Scaffold new module or plugin adhering to Clean Architecture standards |
|
|
181
|
+
| `heraspec audit [path] [--fix]` | Automated code quality, security, concurrency, and clean code auditor |
|
|
182
|
+
| `heraspec pack [path] [--out <dir>]` | Auto-compile assets and package production `.zip` release without dev bloat |
|
|
183
|
+
| `heraspec init [path]` | Initialize HeraSpec (with smart re-init and custom skill preservation) |
|
|
184
|
+
| `heraspec list [--specs]` | List active changes or specifications |
|
|
185
|
+
| `heraspec show <name>` | Display detailed change proposal or specification |
|
|
186
|
+
| `heraspec validate <name>` | Validate specification integrity and consistency |
|
|
187
|
+
| `heraspec archive <name> --yes` | Merge completed delta specs into source of truth |
|
|
188
|
+
| `heraspec sync <name>` | Sync change with source specs to resolve parallel merge conflicts |
|
|
189
|
+
| `heraspec skill list` | List all available built-in and project-specific skills |
|
|
190
|
+
| `heraspec skill add <name>` | Install a skill suite to the project |
|
|
191
|
+
| `heraspec memory context` | Generate token-efficient agent session context |
|
|
192
|
+
| `heraspec helper` | Interactive CLI usage guide and prompts |
|
|
193
|
+
|
|
162
194
|
## Documentation
|
|
163
195
|
|
|
164
196
|
- [User Guide](./docs/en/USER_GUIDE.md)
|
|
@@ -167,12 +199,14 @@ heraspec change start "add-user-authentication"
|
|
|
167
199
|
|
|
168
200
|
## Features
|
|
169
201
|
|
|
170
|
-
- ✅
|
|
171
|
-
- ✅
|
|
172
|
-
- ✅
|
|
173
|
-
- ✅
|
|
174
|
-
- ✅
|
|
175
|
-
- ✅
|
|
202
|
+
- ✅ **Enterprise Code Quality Auditor** (`heraspec audit` with 7 automated checks and safe auto-fix)
|
|
203
|
+
- ✅ **Clean Architecture Scaffolder** (`heraspec create` for Perfex CRM, WordPress plugins/themes)
|
|
204
|
+
- ✅ **Production Release Packager** (`heraspec pack` with cross-platform compression & strict bloat exclusion)
|
|
205
|
+
- ✅ **Custom Skill Preservation** (Existing projects safely retain custom skills on `heraspec init`)
|
|
206
|
+
- ✅ **Multi-project type support** (WordPress, Perfex CRM, Laravel, React, Vue, Node.js)
|
|
207
|
+
- ✅ **Specification-driven development** with delta specs and conflict-free parallel merging
|
|
208
|
+
- ✅ **AI Integration Ready** (Cursor, Antigravity, Windsurf, Copilot, Claude Desktop)
|
|
209
|
+
- ✅ **Proactive Memory & Semantic Search** (Token savings & architecture tracking)
|
|
176
210
|
|
|
177
211
|
## AI Integration
|
|
178
212
|
|