heraspec 0.1.14 → 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/LICENSE +187 -0
- package/README.md +140 -107
- package/bin/heraspec.js +1491 -155
- 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 +44 -38
- package/dist/core/templates/skills/campaign-plan/skill.md +76 -0
- package/dist/core/templates/skills/campaign-plan/skill.vi.md +76 -0
- package/dist/core/templates/skills/campaign-plan-skill.md +76 -0
- package/dist/core/templates/skills/campaign-plan-skill.vi.md +76 -0
- package/dist/core/templates/skills/code-review/skill.md +70 -0
- package/dist/core/templates/skills/code-review/skill.vi.md +70 -0
- package/dist/core/templates/skills/code-review-skill.md +70 -0
- package/dist/core/templates/skills/code-review-skill.vi.md +70 -0
- package/dist/core/templates/skills/content-creation/skill.md +69 -0
- package/dist/core/templates/skills/content-creation/skill.vi.md +69 -0
- package/dist/core/templates/skills/content-creation-skill.md +69 -0
- package/dist/core/templates/skills/content-creation-skill.vi.md +69 -0
- package/dist/core/templates/skills/content-optimization/skill.md +104 -0
- package/dist/core/templates/skills/debug/skill.md +69 -0
- package/dist/core/templates/skills/debug/skill.vi.md +69 -0
- package/dist/core/templates/skills/debug-skill.md +69 -0
- package/dist/core/templates/skills/debug-skill.vi.md +69 -0
- package/dist/core/templates/skills/deploy-documentation/skill.md +408 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/airbnb/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/airtable/DESIGN.md +89 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/apple/DESIGN.md +313 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/bmw/DESIGN.md +180 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cal/DESIGN.md +259 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/claude/DESIGN.md +312 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/clay/DESIGN.md +304 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/clickhouse/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cohere/DESIGN.md +266 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/coinbase/DESIGN.md +129 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/composio/DESIGN.md +307 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cursor/DESIGN.md +309 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/elevenlabs/DESIGN.md +265 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/expo/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/figma/DESIGN.md +220 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/framer/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/hashicorp/DESIGN.md +278 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/ibm/DESIGN.md +332 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/index.json +72 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/intercom/DESIGN.md +146 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/kraken/DESIGN.md +125 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/linear.app/DESIGN.md +367 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/lovable/DESIGN.md +298 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/minimax/DESIGN.md +257 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mintlify/DESIGN.md +326 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/miro/DESIGN.md +108 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mistral.ai/DESIGN.md +261 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mongodb/DESIGN.md +266 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/notion/DESIGN.md +309 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/nvidia/DESIGN.md +293 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/ollama/DESIGN.md +267 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/opencode.ai/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/pinterest/DESIGN.md +230 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/posthog/DESIGN.md +256 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/raycast/DESIGN.md +268 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/replicate/DESIGN.md +261 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/resend/DESIGN.md +303 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/revolut/DESIGN.md +185 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/runwayml/DESIGN.md +244 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/sanity/DESIGN.md +357 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/sentry/DESIGN.md +262 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/spacex/DESIGN.md +194 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/spotify/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/stripe/DESIGN.md +322 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/supabase/DESIGN.md +255 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/superhuman/DESIGN.md +252 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/together.ai/DESIGN.md +263 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/uber/DESIGN.md +295 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/vercel/DESIGN.md +310 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/voltagent/DESIGN.md +323 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/warp/DESIGN.md +253 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/webflow/DESIGN.md +92 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/wise/DESIGN.md +173 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/x.ai/DESIGN.md +257 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/zapier/DESIGN.md +328 -0
- package/dist/core/templates/skills/design-system/skill.md +176 -0
- package/dist/core/templates/skills/documents/skill.md +104 -0
- package/dist/core/templates/skills/e2e-test/skill.md +119 -0
- package/dist/core/templates/skills/email-sequence/skill.md +68 -0
- package/dist/core/templates/skills/email-sequence/skill.vi.md +68 -0
- package/dist/core/templates/skills/email-sequence-skill.md +68 -0
- package/dist/core/templates/skills/email-sequence-skill.vi.md +68 -0
- package/dist/core/templates/skills/git-embed/skill.md +57 -0
- package/dist/core/templates/skills/integration-test/skill.md +118 -0
- package/dist/core/templates/skills/knowledge/README.md +63 -63
- package/dist/core/templates/skills/knowledge/design-systems/index.json +72 -72
- package/dist/core/templates/skills/knowledge/frameworks/php/codeigniter/rise-cms/profile.json +27 -27
- package/dist/core/templates/skills/knowledge/frameworks/php/codeigniter/rise-cms/structure.md +137 -137
- package/dist/core/templates/skills/knowledge/frameworks/php/laravel/botble/profile.json +39 -39
- package/dist/core/templates/skills/knowledge/frameworks/php/laravel/botble/structure.md +207 -207
- package/dist/core/templates/skills/knowledge/frameworks/php/wordpress/core/profile.json +51 -51
- package/dist/core/templates/skills/knowledge/frameworks/php/wordpress/core/structure.md +369 -369
- package/dist/core/templates/skills/knowledge/index.json +65 -65
- 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 -0
- 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/project-memory/skill.md +222 -0
- package/dist/core/templates/skills/project-memory/skill.vi.md +223 -0
- package/dist/core/templates/skills/seo-audit/skill.md +75 -0
- package/dist/core/templates/skills/seo-audit/skill.vi.md +75 -0
- package/dist/core/templates/skills/seo-audit-skill.md +75 -0
- package/dist/core/templates/skills/seo-audit-skill.vi.md +75 -0
- package/dist/core/templates/skills/smart-explore/skill.md +141 -0
- package/dist/core/templates/skills/sourcecode-analyzer/skill.md +210 -0
- package/dist/core/templates/skills/sourcecode-analyzer/skill.vi.md +210 -0
- package/dist/core/templates/skills/spec-writer/skill.md +61 -0
- package/dist/core/templates/skills/spec-writer/skill.vi.md +61 -0
- package/dist/core/templates/skills/spec-writer-skill.md +61 -0
- package/dist/core/templates/skills/spec-writer-skill.vi.md +61 -0
- package/dist/core/templates/skills/sql-queries/skill.md +67 -0
- package/dist/core/templates/skills/sql-queries/skill.vi.md +67 -0
- package/dist/core/templates/skills/sql-queries-skill.md +67 -0
- package/dist/core/templates/skills/sql-queries-skill.vi.md +67 -0
- package/dist/core/templates/skills/suggestion/skill.md +118 -0
- package/dist/core/templates/skills/system-design/skill.md +70 -0
- package/dist/core/templates/skills/system-design/skill.vi.md +70 -0
- package/dist/core/templates/skills/system-design-skill.md +70 -0
- package/dist/core/templates/skills/system-design-skill.vi.md +70 -0
- package/dist/core/templates/skills/tech-debt/skill.md +70 -0
- package/dist/core/templates/skills/tech-debt/skill.vi.md +70 -0
- package/dist/core/templates/skills/tech-debt-skill.md +70 -0
- package/dist/core/templates/skills/tech-debt-skill.vi.md +70 -0
- package/dist/core/templates/skills/ui-ux/data/charts.csv +26 -0
- package/dist/core/templates/skills/ui-ux/data/colors.csv +97 -0
- package/dist/core/templates/skills/ui-ux/data/design-systems.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/landing.csv +31 -0
- package/dist/core/templates/skills/ui-ux/data/pages-proposed.csv +22 -0
- package/dist/core/templates/skills/ui-ux/data/pages.csv +10 -0
- package/dist/core/templates/skills/ui-ux/data/products.csv +97 -0
- package/dist/core/templates/skills/ui-ux/data/prompts.csv +24 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/flutter.csv +53 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/html-tailwind.csv +56 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/nextjs.csv +53 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/react-native.csv +52 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/react.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/svelte.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/swiftui.csv +51 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/vue.csv +50 -0
- package/dist/core/templates/skills/ui-ux/data/styles.csv +59 -0
- package/dist/core/templates/skills/ui-ux/data/typography.csv +58 -0
- package/dist/core/templates/skills/ui-ux/data/ux-guidelines.csv +100 -0
- package/dist/core/templates/skills/ui-ux/scripts/CODE_EXPLANATION.md +394 -0
- package/dist/core/templates/skills/ui-ux/scripts/SEARCH_ALGORITHMS_COMPARISON.md +421 -0
- package/dist/core/templates/skills/ui-ux/scripts/SEARCH_MODES_GUIDE.md +238 -0
- package/dist/core/templates/skills/ui-ux/scripts/core.py +391 -0
- package/dist/core/templates/skills/ui-ux/scripts/search.py +73 -0
- package/dist/core/templates/skills/ui-ux/skill.md +595 -0
- package/dist/core/templates/skills/ui-ux/templates/accessibility-checklist.md +40 -0
- package/dist/core/templates/skills/ui-ux/templates/example-prompt-full-theme.md +333 -0
- package/dist/core/templates/skills/ui-ux/templates/page-types-guide.md +338 -0
- package/dist/core/templates/skills/ui-ux/templates/pages-proposed-summary.md +273 -0
- package/dist/core/templates/skills/ui-ux/templates/pre-delivery-checklist.md +42 -0
- package/dist/core/templates/skills/ui-ux/templates/prompt-template-full-theme.md +313 -0
- package/dist/core/templates/skills/ui-ux/templates/responsive-design.md +40 -0
- package/dist/core/templates/skills/unit-test/skill.md +111 -0
- package/dist/core/templates/skills/wordpress/plugin-check/skill.md +151 -0
- package/dist/core/templates/skills/wordpress/plugin-directory/skill.md +396 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/skill.md +100 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/admin-dashboard.php +47 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/admin-settings.php +60 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/assets/admin-css.css +22 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/assets/admin-js.js +15 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/plugin-main.php +169 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/readme.txt +41 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/uninstall.php +21 -0
- package/dist/core/templates/skills/wordpress/ux-element/skill.md +83 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Controller.php +50 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Shortcode.php +23 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Template.html +20 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Thumbnail.svg +8 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/View.php +21 -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 +350 -114
- 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
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
defined('BASEPATH') or exit('No direct script access allowed');
|
|
3
|
+
|
|
4
|
+
class {ModuleName}_model extends App_Model
|
|
5
|
+
{
|
|
6
|
+
protected $table;
|
|
7
|
+
|
|
8
|
+
public function __construct()
|
|
9
|
+
{
|
|
10
|
+
parent::__construct();
|
|
11
|
+
$this->table = db_prefix() . '{module_name}_items';
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Get all items with optional filters
|
|
16
|
+
*/
|
|
17
|
+
public function get_all($where = [])
|
|
18
|
+
{
|
|
19
|
+
if (!empty($where)) {
|
|
20
|
+
$this->db->where($where);
|
|
21
|
+
}
|
|
22
|
+
$this->db->order_by('date_created', 'DESC');
|
|
23
|
+
return $this->db->get($this->table)->result_array();
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Get single item by ID
|
|
28
|
+
*/
|
|
29
|
+
public function get($id)
|
|
30
|
+
{
|
|
31
|
+
$this->db->where('id', (int)$id);
|
|
32
|
+
return $this->db->get($this->table)->row_array();
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Add new item
|
|
37
|
+
*/
|
|
38
|
+
public function add($data)
|
|
39
|
+
{
|
|
40
|
+
$data['date_created'] = date('Y-m-d H:i:s');
|
|
41
|
+
$data['created_by'] = get_staff_user_id();
|
|
42
|
+
|
|
43
|
+
$this->db->insert($this->table, $data);
|
|
44
|
+
$insert_id = $this->db->insert_id();
|
|
45
|
+
|
|
46
|
+
if ($insert_id) {
|
|
47
|
+
log_activity('{ModuleName} Item Added [ID: ' . $insert_id . ']');
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
return $insert_id;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Update item by ID
|
|
55
|
+
*/
|
|
56
|
+
public function update($id, $data)
|
|
57
|
+
{
|
|
58
|
+
$this->db->where('id', (int)$id);
|
|
59
|
+
$this->db->update($this->table, $data);
|
|
60
|
+
|
|
61
|
+
return $this->db->affected_rows() > 0;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Delete item by ID
|
|
66
|
+
*/
|
|
67
|
+
public function delete($id)
|
|
68
|
+
{
|
|
69
|
+
$this->db->where('id', (int)$id);
|
|
70
|
+
$this->db->delete($this->table);
|
|
71
|
+
|
|
72
|
+
$deleted = $this->db->affected_rows() > 0;
|
|
73
|
+
if ($deleted) {
|
|
74
|
+
log_activity('{ModuleName} Item Deleted [ID: ' . (int)$id . ']');
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
return $deleted;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Search items using polymorphic composite index
|
|
82
|
+
*/
|
|
83
|
+
public function search($query, $limit = 20)
|
|
84
|
+
{
|
|
85
|
+
$this->db->select('id, rel_type, rel_id, title, status, date_created');
|
|
86
|
+
$this->db->from($this->table);
|
|
87
|
+
if (!empty($query)) {
|
|
88
|
+
$this->db->like('title', $query);
|
|
89
|
+
}
|
|
90
|
+
$this->db->where('status', 1);
|
|
91
|
+
$this->db->limit($limit);
|
|
92
|
+
return $this->db->get()->result_array();
|
|
93
|
+
}
|
|
94
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
defined('BASEPATH') or exit('No direct script access allowed');
|
|
3
|
+
|
|
4
|
+
/*
|
|
5
|
+
Module Name: {MODULE_FRIENDLY_NAME}
|
|
6
|
+
Description: {MODULE_DESCRIPTION}
|
|
7
|
+
Version: 1.0.0
|
|
8
|
+
Requires at least: 2.9.*
|
|
9
|
+
Author: PolyXGO
|
|
10
|
+
Author URI: https://codecanyon.net/user/polyxgo
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
define('{MODULE_UPPERCASE}_MODULE_NAME', '{module_name}');
|
|
14
|
+
define('{MODULE_UPPERCASE}_VERSION', '1.0.0');
|
|
15
|
+
|
|
16
|
+
// Register activation, deactivation, and uninstall hooks
|
|
17
|
+
register_activation_hook({MODULE_UPPERCASE}_MODULE_NAME, '{module_name}_activation_hook');
|
|
18
|
+
register_deactivation_hook({MODULE_UPPERCASE}_MODULE_NAME, '{module_name}_deactivation_hook');
|
|
19
|
+
register_uninstall_hook({MODULE_UPPERCASE}_MODULE_NAME, '{module_name}_uninstall_hook');
|
|
20
|
+
|
|
21
|
+
function {module_name}_activation_hook()
|
|
22
|
+
{
|
|
23
|
+
$CI = &get_instance();
|
|
24
|
+
require_once(__DIR__ . '/install.php');
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
function {module_name}_deactivation_hook()
|
|
28
|
+
{
|
|
29
|
+
// Clean up temporary session flags or cache if needed
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
function {module_name}_uninstall_hook()
|
|
33
|
+
{
|
|
34
|
+
require_once(__DIR__ . '/uninstall.php');
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
// Register language files
|
|
38
|
+
register_language_files({MODULE_UPPERCASE}_MODULE_NAME, [{MODULE_UPPERCASE}_MODULE_NAME]);
|
|
39
|
+
|
|
40
|
+
// Autoload helper
|
|
41
|
+
$CI = &get_instance();
|
|
42
|
+
$CI->load->helper({MODULE_UPPERCASE}_MODULE_NAME . '/{module_name}');
|
|
43
|
+
|
|
44
|
+
// Hook: Register Admin Menu Item
|
|
45
|
+
hooks()->add_action('admin_init', '{module_name}_init_menu_items');
|
|
46
|
+
|
|
47
|
+
function {module_name}_init_menu_items()
|
|
48
|
+
{
|
|
49
|
+
$CI = &get_instance();
|
|
50
|
+
if (has_permission('{module_name}', '', 'view')) {
|
|
51
|
+
$CI->app_menu->add_sidebar_menu_item('{module_name}-menu', [
|
|
52
|
+
'name' => _l('{module_name}_menu_title'),
|
|
53
|
+
'href' => admin_url('{module_name}'),
|
|
54
|
+
'icon' => 'fa-solid fa-cube',
|
|
55
|
+
'position' => 30,
|
|
56
|
+
]);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// Hook: Enqueue Admin Assets & Localization
|
|
61
|
+
hooks()->add_action('app_admin_head', '{module_name}_enqueue_admin_head');
|
|
62
|
+
hooks()->add_action('app_admin_footer', '{module_name}_enqueue_admin_footer');
|
|
63
|
+
|
|
64
|
+
function {module_name}_enqueue_admin_head()
|
|
65
|
+
{
|
|
66
|
+
// Centralized localization data - Zero inline script in views
|
|
67
|
+
$config = [
|
|
68
|
+
'moduleName' => {MODULE_UPPERCASE}_MODULE_NAME,
|
|
69
|
+
'version' => {MODULE_UPPERCASE}_VERSION,
|
|
70
|
+
'adminUrl' => admin_url('{module_name}/'),
|
|
71
|
+
'csrfToken' => get_instance()->security->get_csrf_hash(),
|
|
72
|
+
];
|
|
73
|
+
$lang = [
|
|
74
|
+
'confirmDelete' => _l('{module_name}_confirm_delete'),
|
|
75
|
+
'saveSuccess' => _l('{module_name}_saved_successfully'),
|
|
76
|
+
];
|
|
77
|
+
|
|
78
|
+
echo '<script>' . PHP_EOL;
|
|
79
|
+
echo 'window.' . '{MODULE_UPPERCASE}_CONFIG = ' . json_encode($config) . ';' . PHP_EOL;
|
|
80
|
+
echo 'window.' . '{MODULE_UPPERCASE}_LANG = ' . json_encode($lang) . ';' . PHP_EOL;
|
|
81
|
+
echo '</script>' . PHP_EOL;
|
|
82
|
+
|
|
83
|
+
// Load custom stylesheet with auto dist fallback and cache busting
|
|
84
|
+
echo {module_name}_helper::render_module_css('admin/{module_name}_admin');
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function {module_name}_enqueue_admin_footer()
|
|
88
|
+
{
|
|
89
|
+
// Load custom scripts with auto dist fallback and cache busting
|
|
90
|
+
echo {module_name}_helper::render_module_js('admin/{module_name}_admin');
|
|
91
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "{module_name}",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "{MODULE_DESCRIPTION}",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"build": "webpack --mode production",
|
|
8
|
+
"dev": "webpack --mode development",
|
|
9
|
+
"watch": "webpack --mode development --watch"
|
|
10
|
+
},
|
|
11
|
+
"keywords": [
|
|
12
|
+
"perfex",
|
|
13
|
+
"perfex-crm",
|
|
14
|
+
"module"
|
|
15
|
+
],
|
|
16
|
+
"author": "PolyXGO",
|
|
17
|
+
"license": "ISC",
|
|
18
|
+
"devDependencies": {
|
|
19
|
+
"@babel/core": "^7.24.7",
|
|
20
|
+
"@babel/preset-env": "^7.24.7",
|
|
21
|
+
"babel-loader": "^9.1.3",
|
|
22
|
+
"clean-css": "^5.3.3",
|
|
23
|
+
"clean-css-cli": "^5.6.3",
|
|
24
|
+
"fs-extra": "^11.2.0",
|
|
25
|
+
"glob": "^8.1.0",
|
|
26
|
+
"terser-webpack-plugin": "^5.3.10",
|
|
27
|
+
"webpack": "^5.92.0",
|
|
28
|
+
"webpack-cli": "^5.1.4"
|
|
29
|
+
}
|
|
30
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
defined('BASEPATH') or exit('No direct script access allowed');
|
|
3
|
+
|
|
4
|
+
$CI = &get_instance();
|
|
5
|
+
|
|
6
|
+
// Delete module registered options
|
|
7
|
+
delete_option('{module_name}_enabled');
|
|
8
|
+
delete_option('{module_name}_version');
|
|
9
|
+
|
|
10
|
+
// Optional: Drop database tables if complete cleanup is requested
|
|
11
|
+
// $CI->db->query('DROP TABLE IF EXISTS `' . db_prefix() . '{module_name}_items`');
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Webpack Configuration for Perfex CRM Module
|
|
3
|
+
*
|
|
4
|
+
* Compiles and minifies development assets from assets/ into dist/assets/
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
const is_console_remove = true;
|
|
8
|
+
const is_minimize = true;
|
|
9
|
+
const path = require("path");
|
|
10
|
+
const TerserPlugin = require("terser-webpack-plugin");
|
|
11
|
+
const glob = require("glob");
|
|
12
|
+
const fs = require("fs-extra");
|
|
13
|
+
const CleanCSS = require("clean-css");
|
|
14
|
+
|
|
15
|
+
// Plugin to delete the dist folder before compilation starts
|
|
16
|
+
class CleanDistFolderPlugin {
|
|
17
|
+
apply(compiler) {
|
|
18
|
+
compiler.hooks.beforeRun.tapAsync(
|
|
19
|
+
"CleanDistFolderPlugin",
|
|
20
|
+
(compilation, callback) => {
|
|
21
|
+
const distPath = path.resolve(__dirname, "dist");
|
|
22
|
+
if (fs.existsSync(distPath)) {
|
|
23
|
+
fs.removeSync(distPath);
|
|
24
|
+
}
|
|
25
|
+
callback();
|
|
26
|
+
}
|
|
27
|
+
);
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
// Plugin to copy library files directly to dist without mangling
|
|
32
|
+
class CopyLibFilesPlugin {
|
|
33
|
+
apply(compiler) {
|
|
34
|
+
compiler.hooks.afterEmit.tap("CopyLibFilesPlugin", () => {
|
|
35
|
+
const jsLibPath = path.resolve(__dirname, "./assets/js/lib");
|
|
36
|
+
const cssLibPath = path.resolve(__dirname, "./assets/css/lib");
|
|
37
|
+
const distJsLibPath = path.resolve(__dirname, "dist/assets/js/lib");
|
|
38
|
+
const distCssLibPath = path.resolve(__dirname, "dist/assets/css/lib");
|
|
39
|
+
|
|
40
|
+
if (fs.existsSync(jsLibPath)) {
|
|
41
|
+
fs.copySync(jsLibPath, distJsLibPath, { overwrite: true });
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
if (fs.existsSync(cssLibPath)) {
|
|
45
|
+
fs.copySync(cssLibPath, distCssLibPath, { overwrite: true });
|
|
46
|
+
}
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
// Plugin to minify custom CSS files using CleanCSS
|
|
52
|
+
class MinifyCssPlugin {
|
|
53
|
+
apply(compiler) {
|
|
54
|
+
compiler.hooks.afterEmit.tap("MinifyCssPlugin", () => {
|
|
55
|
+
const cssFiles = glob.sync("./assets/css/**/!(*.min).css", {
|
|
56
|
+
ignore: ["./assets/css/lib/**/*"],
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
const cleanCssInstance = new CleanCSS({
|
|
60
|
+
level: 1,
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
cssFiles.forEach((file) => {
|
|
64
|
+
const relativePath = path.relative("./assets", file);
|
|
65
|
+
const minifiedFile = path.resolve(
|
|
66
|
+
__dirname,
|
|
67
|
+
"dist/assets",
|
|
68
|
+
relativePath.replace(/\.css$/, ".min.css")
|
|
69
|
+
);
|
|
70
|
+
|
|
71
|
+
try {
|
|
72
|
+
const sourceContent = fs.readFileSync(file, "utf8");
|
|
73
|
+
const minifiedOutput = cleanCssInstance.minify(sourceContent);
|
|
74
|
+
if (minifiedOutput.styles) {
|
|
75
|
+
fs.outputFileSync(minifiedFile, minifiedOutput.styles);
|
|
76
|
+
}
|
|
77
|
+
} catch (err) {
|
|
78
|
+
console.error(`Error minifying ${file}:`, err);
|
|
79
|
+
}
|
|
80
|
+
});
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// Scan custom JS files excluding lib and .min.js
|
|
86
|
+
const jsFiles = glob.sync("./assets/js/**/*.js", {
|
|
87
|
+
ignore: [
|
|
88
|
+
"./assets/js/lib/**/*",
|
|
89
|
+
"./assets/js/**/*.min.js"
|
|
90
|
+
],
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
const jsEntry = jsFiles.reduce((entries, file) => {
|
|
94
|
+
const name = path
|
|
95
|
+
.relative("./assets", file)
|
|
96
|
+
.replace(/\\/g, "/")
|
|
97
|
+
.replace(/\.js$/, "");
|
|
98
|
+
entries[name] = `./${file}`;
|
|
99
|
+
return entries;
|
|
100
|
+
}, {});
|
|
101
|
+
|
|
102
|
+
module.exports = {
|
|
103
|
+
entry: jsEntry,
|
|
104
|
+
output: {
|
|
105
|
+
filename: (pathData) => {
|
|
106
|
+
const filePath = pathData.chunk.name.replace(/\\/g, "/");
|
|
107
|
+
return `${filePath}.min.js`;
|
|
108
|
+
},
|
|
109
|
+
path: path.resolve(__dirname, "dist/assets/"),
|
|
110
|
+
},
|
|
111
|
+
resolve: {
|
|
112
|
+
modules: [path.resolve(__dirname), "node_modules"],
|
|
113
|
+
extensions: [".js"],
|
|
114
|
+
},
|
|
115
|
+
optimization: {
|
|
116
|
+
minimize: is_minimize,
|
|
117
|
+
minimizer: [
|
|
118
|
+
new TerserPlugin({
|
|
119
|
+
test: /\.js$/,
|
|
120
|
+
exclude: /assets\/js\/lib\//,
|
|
121
|
+
extractComments: false,
|
|
122
|
+
terserOptions: {
|
|
123
|
+
compress: {
|
|
124
|
+
drop_console: is_console_remove,
|
|
125
|
+
dead_code: true,
|
|
126
|
+
drop_debugger: true,
|
|
127
|
+
},
|
|
128
|
+
mangle: {
|
|
129
|
+
keep_classnames: true,
|
|
130
|
+
keep_fnames: true,
|
|
131
|
+
},
|
|
132
|
+
output: {
|
|
133
|
+
comments: false,
|
|
134
|
+
},
|
|
135
|
+
},
|
|
136
|
+
}),
|
|
137
|
+
],
|
|
138
|
+
},
|
|
139
|
+
module: {
|
|
140
|
+
rules: [
|
|
141
|
+
{
|
|
142
|
+
test: /\.js$/,
|
|
143
|
+
exclude: [
|
|
144
|
+
/node_modules/,
|
|
145
|
+
/assets\/js\/lib\//,
|
|
146
|
+
],
|
|
147
|
+
use: {
|
|
148
|
+
loader: "babel-loader",
|
|
149
|
+
options: {
|
|
150
|
+
presets: ["@babel/preset-env"],
|
|
151
|
+
},
|
|
152
|
+
},
|
|
153
|
+
},
|
|
154
|
+
],
|
|
155
|
+
},
|
|
156
|
+
mode: "production",
|
|
157
|
+
plugins: [
|
|
158
|
+
new CleanDistFolderPlugin(),
|
|
159
|
+
new CopyLibFilesPlugin(),
|
|
160
|
+
new MinifyCssPlugin(),
|
|
161
|
+
],
|
|
162
|
+
devtool: false,
|
|
163
|
+
};
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: perfex-module
|
|
3
|
+
description: Comprehensive guideline and best practices for developing, refactoring, and delivering high-quality Perfex CRM modules following Clean Code standards, OWASP security, and production quality guidelines.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Perfex CRM Module Engineering & Quality Guidelines
|
|
7
|
+
|
|
8
|
+
This skill suite serves as the authoritative standard for developing, refactoring, packaging, and delivering production-ready, enterprise-grade Perfex CRM modules.
|
|
9
|
+
|
|
10
|
+
## Skill Suite Navigation
|
|
11
|
+
|
|
12
|
+
1. **[Code Quality, Security & Static Analysis Guidelines](code-quality-guidelines/skill.md)**
|
|
13
|
+
- Separation of Concerns: Zero Inline JS & CSS (runtime & documentation).
|
|
14
|
+
- AST & Scanner Neutrality: Professional naming conventions (`extend` instead of `inject`, `demo_data` instead of `seeder`, `allow` instead of `bypass`).
|
|
15
|
+
- Safe Dynamic Stylesheet Loading: TinyMCE & Iframe stylesheet synchronization (`editor.dom.loadCSS` and link element cloning).
|
|
16
|
+
- Admin JS Scoped Pattern: Conflict-proof JavaScript (`window.addEventListener('load')` + strict IIFE).
|
|
17
|
+
- Concurrency & Non-Blocking I/O: PHP Session lock prevention (`session_write_close()`).
|
|
18
|
+
- Clean Release Packaging: Exclude development tooling (`package.json`, `webpack.config.js`, `tests/`, `scratch/`).
|
|
19
|
+
- Defensive PHP Security: `BASEPATH` security check, CSRF tokens on all POST/AJAX, parameterized queries.
|
|
20
|
+
- DOM XSS Prevention: Safe element creation and HTMLPurifier configuration.
|
|
21
|
+
- Enterprise Internationalization: 100% multilingual parity (`_l('key')`) and zero emojis.
|
|
22
|
+
|
|
23
|
+
2. **[Module Codebase & Clean Architecture](module-codebase/skill.md)**
|
|
24
|
+
- Standard directory layout (MVC + Helpers + Libraries + Dist + Assets + Tests + Documentations).
|
|
25
|
+
- Thin Controllers, Rich Models (Separation of Concerns).
|
|
26
|
+
- High-performance composite indexing for polymorphic CRM tables (`db_prefix()`).
|
|
27
|
+
- Context isolation firewall for Client Portal safety (no internal staff/leads leakage).
|
|
28
|
+
- Asset enqueuing with automatic fallback from minified `dist/` to `assets/` and `?v=` cache busting.
|
|
29
|
+
- Production scaffolding templates in `templates/`.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Production Readiness & Quality Assurance Checklist
|
|
34
|
+
|
|
35
|
+
Before releasing or packaging a module:
|
|
36
|
+
|
|
37
|
+
- [ ] **1. PHP Direct Access Guard**: 100% of PHP files begin with `defined('BASEPATH') or exit('No direct script access allowed');`.
|
|
38
|
+
- [ ] **2. Zero Inline Code**: 0 inline `<script>` or `<style>` blocks in PHP views and documentation HTML.
|
|
39
|
+
- [ ] **3. Static Analysis Neutrality**: 0 occurrences of high-risk scanner triggers (`inject`, `seeder`, `bypass`, `eval`, `unserialize`).
|
|
40
|
+
- [ ] **4. Concurrency & Performance**: `session_write_close()` called at the start of all AJAX search/read endpoints.
|
|
41
|
+
- [ ] **5. Multilingual Parity**: 100% parity across language files (e.g. `language/english/` and `language/vietnamese/` with 0 missing keys).
|
|
42
|
+
- [ ] **6. Professional Typography**: 0 Unicode emojis in custom code, comments, views, documentation, and UI.
|
|
43
|
+
- [ ] **7. Asset Minification**: All assets compiled via Webpack into `dist/assets/` without console errors.
|
|
44
|
+
- [ ] **8. Automated Tests**: All test assertions pass 100% in `tests/Test_{ModuleName}.php`.
|
|
45
|
+
- [ ] **9. Clean Release Package**: Verify module zip strictly excludes `package.json`, `webpack.config.js`, `tests/`, `scratch/`, and `.git`.
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Reference Implementation
|
|
50
|
+
- **CrossTag for Perfex** (`modules/crosstag/`): Production benchmark with dual-engine autocompleter, composite database indexes, asset fallback pipeline, and 57/57 passing automated test assertions.
|
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: project-memory
|
|
3
|
+
description: Complementary project memory system for AI agents. Records observations, decisions, and session summaries to maintain context across development sessions. Prevents duplicate work, tracks architectural decisions, and enables token-efficient context retrieval.
|
|
4
|
+
projectType: all
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Project Memory Skill
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
|
|
11
|
+
Enable AI agents to maintain **persistent project context** across sessions using a complementary (non-intrusive) approach. The memory system records what was done, what was learned, and what decisions were made — so future sessions start with relevant context instead of re-reading the entire codebase.
|
|
12
|
+
|
|
13
|
+
## When to Use
|
|
14
|
+
|
|
15
|
+
- **Before implementing a new feature**: Search memory to check if similar work was done before
|
|
16
|
+
- **After completing a significant task**: Log an observation to record what was done
|
|
17
|
+
- **At the end of a session**: Summarize the session for future reference
|
|
18
|
+
- **When starting a complex session**: Read context to understand project history
|
|
19
|
+
|
|
20
|
+
## Complementary Approach
|
|
21
|
+
|
|
22
|
+
> **This skill is COMPLEMENTARY, not mandatory.** The AI agent uses memory WHEN USEFUL, not at every step.
|
|
23
|
+
>
|
|
24
|
+
> - Simple tasks (fix typo, format code): Skip memory entirely → 0 token overhead
|
|
25
|
+
> - Complex tasks (new feature, architecture change): Use memory → save 10-30x tokens vs re-reading code
|
|
26
|
+
|
|
27
|
+
## Available Commands
|
|
28
|
+
|
|
29
|
+
### 1. Log an Observation (Post-Task)
|
|
30
|
+
Record what was done after completing a significant task:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
heraspec memory log \
|
|
34
|
+
--type <decision|bugfix|feature|refactor|discovery|change> \
|
|
35
|
+
--title "Short descriptive title" \
|
|
36
|
+
--narrative "Detailed description of what was done and why" \
|
|
37
|
+
--concepts "tag1,tag2,tag3" \
|
|
38
|
+
--files-modified "src/file1.ts,src/file2.ts"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Observation types:**
|
|
42
|
+
| Type | Icon | When to Use |
|
|
43
|
+
|------|------|------------|
|
|
44
|
+
| `decision` | ⚖️ | Architecture or design decisions with rationale |
|
|
45
|
+
| `bugfix` | 🔴 | Bug fixes with root cause |
|
|
46
|
+
| `feature` | 🟢 | New feature implementations |
|
|
47
|
+
| `refactor` | 🔄 | Code restructuring or optimization |
|
|
48
|
+
| `discovery` | 🔵 | Important findings about codebase or behavior |
|
|
49
|
+
| `change` | ✅ | General code changes |
|
|
50
|
+
|
|
51
|
+
### 2. Search Memory (Pre-Implementation)
|
|
52
|
+
Check if related work exists before implementing something new:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
heraspec memory search "authentication middleware"
|
|
56
|
+
heraspec memory search --type feature --concepts "auth,login"
|
|
57
|
+
heraspec memory search --id 42 # Get full details of observation #42
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 3. Generate Context (Session Start)
|
|
61
|
+
Get a summary of recent project activity:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
heraspec memory context # Print to stdout
|
|
65
|
+
heraspec memory context --output file # Write to heraspec/memory/context.md
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### 4. Summarize Session (Session End)
|
|
69
|
+
Record what was accomplished in this session:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
heraspec memory summarize \
|
|
73
|
+
--request "What the user asked for" \
|
|
74
|
+
--completed "What was done" \
|
|
75
|
+
--learned "Key insights discovered" \
|
|
76
|
+
--next-steps "What remains to be done" \
|
|
77
|
+
--files-edited "src/file1.ts,src/file2.ts"
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 5. View Status
|
|
81
|
+
Check memory statistics:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
heraspec memory status # Observation count, top concepts, top files
|
|
85
|
+
heraspec memory timeline # Chronological view of activity
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### 6. Token Analytics Report
|
|
89
|
+
View detailed token usage vs savings comparison per project:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
heraspec memory analytics # Table + chart of token economics
|
|
93
|
+
heraspec memory analytics --history # Includes 13 latest database size changes
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Output includes:
|
|
97
|
+
- **Table**: Project name, Operations count, Tokens With Memory, Tokens Without Memory, Savings %, **DB Size**
|
|
98
|
+
- **Bar Chart**: Visual comparison of tokens avoided per project
|
|
99
|
+
- **Totals**: Aggregated savings across all projects
|
|
100
|
+
- **History (Optional)**: A chronological delta chart of how the `.db` file size has changed over time.
|
|
101
|
+
|
|
102
|
+
### 7. Maintenance
|
|
103
|
+
```bash
|
|
104
|
+
heraspec memory prune 90 # Delete observations older than 90 days
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Workflow for AI Agents
|
|
108
|
+
|
|
109
|
+
### When to Use Memory (Decision Tree)
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
Receive task from user
|
|
113
|
+
├── Is it a simple/trivial task? → Skip memory, just do it
|
|
114
|
+
├── Is it a new feature or significant change?
|
|
115
|
+
│ ├── Search memory: "heraspec memory search <relevant keywords>"
|
|
116
|
+
│ ├── Results found? → Read relevant observations, avoid duplicating work
|
|
117
|
+
│ └── No results? → Proceed normally
|
|
118
|
+
├── After completing the task:
|
|
119
|
+
│ ├── Was it significant? → Log observation
|
|
120
|
+
│ └── Was it trivial? → Skip logging
|
|
121
|
+
└── End of session?
|
|
122
|
+
└── Multiple tasks completed? → Create session summary
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Key Principles
|
|
126
|
+
|
|
127
|
+
1. **Don't force it**: Only use memory when it genuinely saves time or prevents mistakes
|
|
128
|
+
2. **Quality over quantity**: One detailed observation is better than ten shallow ones
|
|
129
|
+
3. **Concepts are crucial**: Good concept tags (`auth`, `database`, `api`, `ui`) make search effective
|
|
130
|
+
4. **Files matter**: Recording which files were modified helps future agents navigate
|
|
131
|
+
|
|
132
|
+
## Configuration
|
|
133
|
+
|
|
134
|
+
Memory configuration is stored in `heraspec/memory/config.json`:
|
|
135
|
+
|
|
136
|
+
```json
|
|
137
|
+
{
|
|
138
|
+
"totalObservationCount": 50,
|
|
139
|
+
"fullObservationCount": 5,
|
|
140
|
+
"sessionCount": 5,
|
|
141
|
+
"maxTokens": 6000,
|
|
142
|
+
"showLastSummary": true
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## Token Economics
|
|
147
|
+
|
|
148
|
+
| Action | Token Cost | Token Savings |
|
|
149
|
+
|--------|-----------|---------------|
|
|
150
|
+
| Read context | ~2,000-4,000 | vs ~50,000-120,000 re-reading codebase |
|
|
151
|
+
| Search memory | ~500-1,000 | vs ~5,000-15,000 duplicate implementation |
|
|
152
|
+
| Log observation | ~200-500 | Investment for future sessions |
|
|
153
|
+
| Smart explore (outline) | ~1,000-2,000 | vs ~12,000+ full file read |
|
|
154
|
+
|
|
155
|
+
To view a live analytics dashboard of token savings, run:
|
|
156
|
+
```bash
|
|
157
|
+
heraspec memory analytics
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Bootstrapping Existing Projects
|
|
161
|
+
|
|
162
|
+
If you are adding the `project-memory` skill to an older project that already has historical specs and changes (in `heraspec/specs/` and `heraspec/archives/`), you can bootstrap the memory system without writing any code.
|
|
163
|
+
|
|
164
|
+
Simply provide this prompt to the AI agent **once**:
|
|
165
|
+
|
|
166
|
+
```text
|
|
167
|
+
Use the project-memory skill.
|
|
168
|
+
Please bootstrap the project memory from all our existing specs and archives.
|
|
169
|
+
Open the folders: heraspec/specs/ and heraspec/archives/
|
|
170
|
+
For EVERY sub-folder/file inside, read it to understand the context, then run:
|
|
171
|
+
|
|
172
|
+
heraspec memory log \
|
|
173
|
+
--type feature \
|
|
174
|
+
--title "[Extract spec/change title]" \
|
|
175
|
+
--narrative "[Short summary of what was implemented]" \
|
|
176
|
+
--concepts "[Extract key tags/technologies]" \
|
|
177
|
+
--files-modified "[Extract affected files]"
|
|
178
|
+
|
|
179
|
+
Repeat this until all old specs are migrated into the memory system.
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Alternatively, use the built-in **CLI command** (faster, no AI tokens spent):
|
|
183
|
+
```bash
|
|
184
|
+
heraspec memory bootstrap # Interactive — prompts for confirmation
|
|
185
|
+
heraspec memory bootstrap --yes # Non-interactive — auto-confirm
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
This command will automatically scan `heraspec/specs/`, `heraspec/archives/`, and `heraspec/changes/`, extract title/narrative/files from each markdown spec, and insert them into the memory database.
|
|
189
|
+
|
|
190
|
+
> **Note:** Duplicate titles are automatically skipped, so running the command multiple times is safe.
|
|
191
|
+
|
|
192
|
+
## Agent-Triggered Reporting
|
|
193
|
+
|
|
194
|
+
When the user asks the AI agent to view memory reports, analytics, or token savings — the agent should run the CLI command and return the output:
|
|
195
|
+
|
|
196
|
+
```text
|
|
197
|
+
User: "Show me the memory analytics report"
|
|
198
|
+
User: "How many tokens has the memory system saved?"
|
|
199
|
+
User: "Give me a token usage report"
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
**Agent action:** Execute the following command and display the output to the user:
|
|
203
|
+
```bash
|
|
204
|
+
heraspec memory analytics
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
For a quick status check:
|
|
208
|
+
```bash
|
|
209
|
+
heraspec memory status
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
For a timeline view:
|
|
213
|
+
```bash
|
|
214
|
+
heraspec memory timeline
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## Limitations
|
|
218
|
+
|
|
219
|
+
- Memory is project-local (stored in `heraspec/memory/`)
|
|
220
|
+
- Requires `better-sqlite3` npm package
|
|
221
|
+
- FTS5 search is keyword-based, not semantic
|
|
222
|
+
- Agent must decide when to use memory (complementary approach)
|