@theglitchking/hit-em-with-the-docs 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/.claude-plugin/marketplace.json +46 -0
- package/.claude-plugin/plugin.json +114 -0
- package/LICENSE +21 -0
- package/MIGRATION.md +255 -0
- package/README.backup.md +714 -0
- package/README.md +869 -0
- package/action.yml +56 -0
- package/dist/action/action/index.d.ts +2 -0
- package/dist/action/action/index.d.ts.map +1 -0
- package/dist/action/cli/index.d.ts +3 -0
- package/dist/action/cli/index.d.ts.map +1 -0
- package/dist/action/core/audit/auditor.d.ts +43 -0
- package/dist/action/core/audit/auditor.d.ts.map +1 -0
- package/dist/action/core/audit/rules.d.ts +37 -0
- package/dist/action/core/audit/rules.d.ts.map +1 -0
- package/dist/action/core/discover/antipatterns.d.ts +24 -0
- package/dist/action/core/discover/antipatterns.d.ts.map +1 -0
- package/dist/action/core/discover/dependencies.d.ts +57 -0
- package/dist/action/core/discover/dependencies.d.ts.map +1 -0
- package/dist/action/core/discover/patterns.d.ts +38 -0
- package/dist/action/core/discover/patterns.d.ts.map +1 -0
- package/dist/action/core/discover/standards.d.ts +58 -0
- package/dist/action/core/discover/standards.d.ts.map +1 -0
- package/dist/action/core/domains/classifier.d.ts +41 -0
- package/dist/action/core/domains/classifier.d.ts.map +1 -0
- package/dist/action/core/domains/constants.d.ts +40 -0
- package/dist/action/core/domains/constants.d.ts.map +1 -0
- package/dist/action/core/domains/detector.d.ts +35 -0
- package/dist/action/core/domains/detector.d.ts.map +1 -0
- package/dist/action/core/integrate/integrator.d.ts +35 -0
- package/dist/action/core/integrate/integrator.d.ts.map +1 -0
- package/dist/action/core/links/checker.d.ts +64 -0
- package/dist/action/core/links/checker.d.ts.map +1 -0
- package/dist/action/core/links/tracker.d.ts +69 -0
- package/dist/action/core/links/tracker.d.ts.map +1 -0
- package/dist/action/core/maintain/orchestrator.d.ts +39 -0
- package/dist/action/core/maintain/orchestrator.d.ts.map +1 -0
- package/dist/action/core/metadata/generator.d.ts +26 -0
- package/dist/action/core/metadata/generator.d.ts.map +1 -0
- package/dist/action/core/metadata/schema.d.ts +201 -0
- package/dist/action/core/metadata/schema.d.ts.map +1 -0
- package/dist/action/core/metadata/sync.d.ts +36 -0
- package/dist/action/core/metadata/sync.d.ts.map +1 -0
- package/dist/action/generators/index-generator.d.ts +19 -0
- package/dist/action/generators/index-generator.d.ts.map +1 -0
- package/dist/action/generators/registry-generator.d.ts +11 -0
- package/dist/action/generators/registry-generator.d.ts.map +1 -0
- package/dist/action/generators/scaffold.d.ts +30 -0
- package/dist/action/generators/scaffold.d.ts.map +1 -0
- package/dist/action/generators/templates/document.d.ts +14 -0
- package/dist/action/generators/templates/document.d.ts.map +1 -0
- package/dist/action/generators/templates/domain-index.d.ts +6 -0
- package/dist/action/generators/templates/domain-index.d.ts.map +1 -0
- package/dist/action/generators/templates/domain-registry.d.ts +6 -0
- package/dist/action/generators/templates/domain-registry.d.ts.map +1 -0
- package/dist/action/index.d.ts +31 -0
- package/dist/action/index.d.ts.map +1 -0
- package/dist/action/index.js +17 -0
- package/dist/action/index.js.map +1 -0
- package/dist/action/package.json +3 -0
- package/dist/action/reports/audit-report.d.ts +15 -0
- package/dist/action/reports/audit-report.d.ts.map +1 -0
- package/dist/action/reports/health-report.d.ts +15 -0
- package/dist/action/reports/health-report.d.ts.map +1 -0
- package/dist/action/reports/link-report.d.ts +15 -0
- package/dist/action/reports/link-report.d.ts.map +1 -0
- package/dist/action/utils/frontmatter.d.ts +50 -0
- package/dist/action/utils/frontmatter.d.ts.map +1 -0
- package/dist/action/utils/glob.d.ts +63 -0
- package/dist/action/utils/glob.d.ts.map +1 -0
- package/dist/action/utils/logger.d.ts +42 -0
- package/dist/action/utils/logger.d.ts.map +1 -0
- package/dist/action/utils/markdown.d.ts +89 -0
- package/dist/action/utils/markdown.d.ts.map +1 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +287 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/core/audit/auditor.d.ts +43 -0
- package/dist/core/audit/auditor.d.ts.map +1 -0
- package/dist/core/audit/auditor.js +273 -0
- package/dist/core/audit/auditor.js.map +1 -0
- package/dist/core/audit/rules.d.ts +37 -0
- package/dist/core/audit/rules.d.ts.map +1 -0
- package/dist/core/audit/rules.js +223 -0
- package/dist/core/audit/rules.js.map +1 -0
- package/dist/core/discover/antipatterns.d.ts +24 -0
- package/dist/core/discover/antipatterns.d.ts.map +1 -0
- package/dist/core/discover/antipatterns.js +354 -0
- package/dist/core/discover/antipatterns.js.map +1 -0
- package/dist/core/discover/dependencies.d.ts +57 -0
- package/dist/core/discover/dependencies.d.ts.map +1 -0
- package/dist/core/discover/dependencies.js +311 -0
- package/dist/core/discover/dependencies.js.map +1 -0
- package/dist/core/discover/patterns.d.ts +38 -0
- package/dist/core/discover/patterns.d.ts.map +1 -0
- package/dist/core/discover/patterns.js +371 -0
- package/dist/core/discover/patterns.js.map +1 -0
- package/dist/core/discover/standards.d.ts +58 -0
- package/dist/core/discover/standards.d.ts.map +1 -0
- package/dist/core/discover/standards.js +359 -0
- package/dist/core/discover/standards.js.map +1 -0
- package/dist/core/domains/classifier.d.ts +41 -0
- package/dist/core/domains/classifier.d.ts.map +1 -0
- package/dist/core/domains/classifier.js +208 -0
- package/dist/core/domains/classifier.js.map +1 -0
- package/dist/core/domains/constants.d.ts +40 -0
- package/dist/core/domains/constants.d.ts.map +1 -0
- package/dist/core/domains/constants.js +252 -0
- package/dist/core/domains/constants.js.map +1 -0
- package/dist/core/domains/detector.d.ts +35 -0
- package/dist/core/domains/detector.d.ts.map +1 -0
- package/dist/core/domains/detector.js +176 -0
- package/dist/core/domains/detector.js.map +1 -0
- package/dist/core/integrate/integrator.d.ts +35 -0
- package/dist/core/integrate/integrator.d.ts.map +1 -0
- package/dist/core/integrate/integrator.js +216 -0
- package/dist/core/integrate/integrator.js.map +1 -0
- package/dist/core/links/checker.d.ts +64 -0
- package/dist/core/links/checker.d.ts.map +1 -0
- package/dist/core/links/checker.js +190 -0
- package/dist/core/links/checker.js.map +1 -0
- package/dist/core/links/tracker.d.ts +69 -0
- package/dist/core/links/tracker.d.ts.map +1 -0
- package/dist/core/links/tracker.js +184 -0
- package/dist/core/links/tracker.js.map +1 -0
- package/dist/core/maintain/orchestrator.d.ts +39 -0
- package/dist/core/maintain/orchestrator.d.ts.map +1 -0
- package/dist/core/maintain/orchestrator.js +372 -0
- package/dist/core/maintain/orchestrator.js.map +1 -0
- package/dist/core/metadata/generator.d.ts +26 -0
- package/dist/core/metadata/generator.d.ts.map +1 -0
- package/dist/core/metadata/generator.js +221 -0
- package/dist/core/metadata/generator.js.map +1 -0
- package/dist/core/metadata/schema.d.ts +201 -0
- package/dist/core/metadata/schema.d.ts.map +1 -0
- package/dist/core/metadata/schema.js +184 -0
- package/dist/core/metadata/schema.js.map +1 -0
- package/dist/core/metadata/sync.d.ts +36 -0
- package/dist/core/metadata/sync.d.ts.map +1 -0
- package/dist/core/metadata/sync.js +195 -0
- package/dist/core/metadata/sync.js.map +1 -0
- package/dist/generators/index-generator.d.ts +19 -0
- package/dist/generators/index-generator.d.ts.map +1 -0
- package/dist/generators/index-generator.js +191 -0
- package/dist/generators/index-generator.js.map +1 -0
- package/dist/generators/registry-generator.d.ts +11 -0
- package/dist/generators/registry-generator.d.ts.map +1 -0
- package/dist/generators/registry-generator.js +156 -0
- package/dist/generators/registry-generator.js.map +1 -0
- package/dist/generators/scaffold.d.ts +30 -0
- package/dist/generators/scaffold.d.ts.map +1 -0
- package/dist/generators/scaffold.js +213 -0
- package/dist/generators/scaffold.js.map +1 -0
- package/dist/generators/templates/document.d.ts +14 -0
- package/dist/generators/templates/document.d.ts.map +1 -0
- package/dist/generators/templates/document.js +305 -0
- package/dist/generators/templates/document.js.map +1 -0
- package/dist/generators/templates/domain-index.d.ts +6 -0
- package/dist/generators/templates/domain-index.d.ts.map +1 -0
- package/dist/generators/templates/domain-index.js +68 -0
- package/dist/generators/templates/domain-index.js.map +1 -0
- package/dist/generators/templates/domain-registry.d.ts +6 -0
- package/dist/generators/templates/domain-registry.d.ts.map +1 -0
- package/dist/generators/templates/domain-registry.js +59 -0
- package/dist/generators/templates/domain-registry.js.map +1 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +39 -0
- package/dist/index.js.map +1 -0
- package/dist/reports/audit-report.d.ts +15 -0
- package/dist/reports/audit-report.d.ts.map +1 -0
- package/dist/reports/audit-report.js +150 -0
- package/dist/reports/audit-report.js.map +1 -0
- package/dist/reports/health-report.d.ts +15 -0
- package/dist/reports/health-report.d.ts.map +1 -0
- package/dist/reports/health-report.js +175 -0
- package/dist/reports/health-report.js.map +1 -0
- package/dist/reports/link-report.d.ts +15 -0
- package/dist/reports/link-report.d.ts.map +1 -0
- package/dist/reports/link-report.js +165 -0
- package/dist/reports/link-report.js.map +1 -0
- package/dist/utils/frontmatter.d.ts +50 -0
- package/dist/utils/frontmatter.d.ts.map +1 -0
- package/dist/utils/frontmatter.js +93 -0
- package/dist/utils/frontmatter.js.map +1 -0
- package/dist/utils/glob.d.ts +63 -0
- package/dist/utils/glob.d.ts.map +1 -0
- package/dist/utils/glob.js +128 -0
- package/dist/utils/glob.js.map +1 -0
- package/dist/utils/logger.d.ts +42 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +118 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/markdown.d.ts +89 -0
- package/dist/utils/markdown.d.ts.map +1 -0
- package/dist/utils/markdown.js +192 -0
- package/dist/utils/markdown.js.map +1 -0
- package/package.json +100 -0
- package/templates/claude/CLAUDE.md +204 -0
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "hit-em-with-the-docs-marketplace",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "TheGlitchKing",
|
|
5
|
+
"email": "contact@theglitchking.dev"
|
|
6
|
+
},
|
|
7
|
+
"metadata": {
|
|
8
|
+
"description": "Official marketplace for hit-em-with-the-docs - Self-managing documentation system",
|
|
9
|
+
"version": "2.0.0"
|
|
10
|
+
},
|
|
11
|
+
"plugins": [
|
|
12
|
+
{
|
|
13
|
+
"name": "hit-em-with-the-docs",
|
|
14
|
+
"description": "Self-managing documentation system with hierarchical structure, intelligent automation, pattern discovery, and agent orchestration",
|
|
15
|
+
"version": "2.0.0",
|
|
16
|
+
"author": {
|
|
17
|
+
"name": "TheGlitchKing"
|
|
18
|
+
},
|
|
19
|
+
"homepage": "https://github.com/TheGlitchKing/hit-em-with-the-docs",
|
|
20
|
+
"repository": "https://github.com/TheGlitchKing/hit-em-with-the-docs.git",
|
|
21
|
+
"license": "MIT",
|
|
22
|
+
"keywords": [
|
|
23
|
+
"documentation",
|
|
24
|
+
"automation",
|
|
25
|
+
"hierarchical",
|
|
26
|
+
"pattern-discovery",
|
|
27
|
+
"metadata",
|
|
28
|
+
"link-checking",
|
|
29
|
+
"self-managing",
|
|
30
|
+
"claude-code"
|
|
31
|
+
],
|
|
32
|
+
"category": "productivity",
|
|
33
|
+
"tags": [
|
|
34
|
+
"documentation",
|
|
35
|
+
"automation",
|
|
36
|
+
"maintenance",
|
|
37
|
+
"discovery"
|
|
38
|
+
],
|
|
39
|
+
"source": {
|
|
40
|
+
"source": "npm",
|
|
41
|
+
"package": "@theglitchking/hit-em-with-the-docs"
|
|
42
|
+
},
|
|
43
|
+
"strict": true
|
|
44
|
+
}
|
|
45
|
+
]
|
|
46
|
+
}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "hit-em-with-the-docs",
|
|
3
|
+
"displayName": "Hit 'Em With The Docs",
|
|
4
|
+
"version": "2.0.0",
|
|
5
|
+
"description": "Self-managing documentation system with hierarchical structure, intelligent automation, pattern discovery, and agent orchestration",
|
|
6
|
+
"author": "TheGlitchKing",
|
|
7
|
+
"license": "MIT",
|
|
8
|
+
"repository": "https://github.com/TheGlitchKing/hit-em-with-the-docs",
|
|
9
|
+
"homepage": "https://github.com/TheGlitchKing/hit-em-with-the-docs#readme",
|
|
10
|
+
"bugs": "https://github.com/TheGlitchKing/hit-em-with-the-docs/issues",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"documentation",
|
|
13
|
+
"automation",
|
|
14
|
+
"hierarchical",
|
|
15
|
+
"pattern-discovery",
|
|
16
|
+
"metadata",
|
|
17
|
+
"link-checking",
|
|
18
|
+
"self-managing"
|
|
19
|
+
],
|
|
20
|
+
"claudePlugin": {
|
|
21
|
+
"templatePath": "templates/claude/CLAUDE.md",
|
|
22
|
+
"commands": [
|
|
23
|
+
{
|
|
24
|
+
"name": "/docs",
|
|
25
|
+
"description": "Documentation management commands for the hierarchical documentation system",
|
|
26
|
+
"subcommands": [
|
|
27
|
+
{
|
|
28
|
+
"name": "load",
|
|
29
|
+
"description": "Load documentation for a specific domain",
|
|
30
|
+
"usage": "/docs load <domain>"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "list",
|
|
34
|
+
"description": "List all 15 documentation domains with descriptions",
|
|
35
|
+
"usage": "/docs list"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"name": "search",
|
|
39
|
+
"description": "Search across all documentation for a query term",
|
|
40
|
+
"usage": "/docs search <query>"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"name": "stats",
|
|
44
|
+
"description": "Show documentation health statistics",
|
|
45
|
+
"usage": "/docs stats"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "maintain",
|
|
49
|
+
"description": "Run documentation maintenance",
|
|
50
|
+
"usage": "/docs maintain"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "integrate",
|
|
54
|
+
"description": "Integrate a document into the system",
|
|
55
|
+
"usage": "/docs integrate <file>"
|
|
56
|
+
}
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "/discover",
|
|
61
|
+
"description": "Pattern discovery commands for extracting patterns from the codebase",
|
|
62
|
+
"subcommands": [
|
|
63
|
+
{
|
|
64
|
+
"name": "patterns",
|
|
65
|
+
"description": "Discover coding patterns in the codebase",
|
|
66
|
+
"usage": "/discover patterns"
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "anti-patterns",
|
|
70
|
+
"description": "Detect anti-patterns and code smells",
|
|
71
|
+
"usage": "/discover anti-patterns"
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "standards",
|
|
75
|
+
"description": "Extract implicit coding standards",
|
|
76
|
+
"usage": "/discover standards"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "dependencies",
|
|
80
|
+
"description": "Analyze project dependencies",
|
|
81
|
+
"usage": "/discover dependencies"
|
|
82
|
+
}
|
|
83
|
+
]
|
|
84
|
+
}
|
|
85
|
+
]
|
|
86
|
+
},
|
|
87
|
+
"installation": {
|
|
88
|
+
"methods": [
|
|
89
|
+
{
|
|
90
|
+
"type": "npm-global",
|
|
91
|
+
"command": "npm install -g @theglitchking/hit-em-with-the-docs",
|
|
92
|
+
"description": "Install globally via NPM"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"type": "npm-local",
|
|
96
|
+
"command": "npm install --save-dev @theglitchking/hit-em-with-the-docs",
|
|
97
|
+
"description": "Install as dev dependency"
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"type": "npx",
|
|
101
|
+
"command": "npx @theglitchking/hit-em-with-the-docs",
|
|
102
|
+
"description": "Run without installing"
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"type": "github-action",
|
|
106
|
+
"command": "uses: TheGlitchKing/hit-em-with-the-docs@v2",
|
|
107
|
+
"description": "Use as GitHub Action"
|
|
108
|
+
}
|
|
109
|
+
],
|
|
110
|
+
"requirements": {
|
|
111
|
+
"node": ">=20.0.0"
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 hit-em-with-the-docs
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/MIGRATION.md
ADDED
|
@@ -0,0 +1,255 @@
|
|
|
1
|
+
# Migration Guide: v1.x to v2.0.0
|
|
2
|
+
|
|
3
|
+
This guide helps you migrate from the unscoped `hit-em-with-the-docs` v1.x package to the scoped `@theglitchking/hit-em-with-the-docs` v2.0.0 package.
|
|
4
|
+
|
|
5
|
+
## What Changed?
|
|
6
|
+
|
|
7
|
+
### Package Name (Breaking Change)
|
|
8
|
+
|
|
9
|
+
The package has been renamed to use the `@theglitchking/` scope:
|
|
10
|
+
|
|
11
|
+
- **Old**: `hit-em-with-the-docs`
|
|
12
|
+
- **New**: `@theglitchking/hit-em-with-the-docs`
|
|
13
|
+
|
|
14
|
+
### New Features in v2.0.0
|
|
15
|
+
|
|
16
|
+
- **Claude Code Plugin Support**: Now includes Claude Code plugin manifest for seamless integration
|
|
17
|
+
- **Enhanced Distribution**: Available via NPM and Claude Code marketplace
|
|
18
|
+
- **Improved Documentation**: Better organized with marketplace metadata
|
|
19
|
+
|
|
20
|
+
### What Stayed the Same
|
|
21
|
+
|
|
22
|
+
- All CLI commands remain identical
|
|
23
|
+
- All features and functionality are unchanged
|
|
24
|
+
- Configuration files and directory structure unchanged
|
|
25
|
+
- Templates and documentation structure unchanged
|
|
26
|
+
|
|
27
|
+
## Migration Steps
|
|
28
|
+
|
|
29
|
+
### 1. Uninstall Old Package
|
|
30
|
+
|
|
31
|
+
If you installed globally:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm uninstall -g hit-em-with-the-docs
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
If you installed as a dev dependency:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm uninstall hit-em-with-the-docs
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 2. Install New Scoped Package
|
|
44
|
+
|
|
45
|
+
Global installation (recommended for CLI use):
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npm install -g @theglitchking/hit-em-with-the-docs
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Dev dependency installation:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npm install --save-dev @theglitchking/hit-em-with-the-docs
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 3. Update package.json (if applicable)
|
|
58
|
+
|
|
59
|
+
If you have `hit-em-with-the-docs` in your `package.json`, update it:
|
|
60
|
+
|
|
61
|
+
```diff
|
|
62
|
+
{
|
|
63
|
+
"devDependencies": {
|
|
64
|
+
- "hit-em-with-the-docs": "^1.0.0"
|
|
65
|
+
+ "@theglitchking/hit-em-with-the-docs": "^2.0.0"
|
|
66
|
+
},
|
|
67
|
+
"scripts": {
|
|
68
|
+
- "docs:maintain": "hit-em-with-the-docs maintain"
|
|
69
|
+
+ "docs:maintain": "hewtd maintain"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### 4. Update GitHub Actions (if applicable)
|
|
75
|
+
|
|
76
|
+
If you use the GitHub Action, update to v2:
|
|
77
|
+
|
|
78
|
+
```diff
|
|
79
|
+
name: Documentation Maintenance
|
|
80
|
+
|
|
81
|
+
on:
|
|
82
|
+
push:
|
|
83
|
+
branches: [main]
|
|
84
|
+
pull_request:
|
|
85
|
+
branches: [main]
|
|
86
|
+
|
|
87
|
+
jobs:
|
|
88
|
+
docs:
|
|
89
|
+
runs-on: ubuntu-latest
|
|
90
|
+
steps:
|
|
91
|
+
- uses: actions/checkout@v4
|
|
92
|
+
- - uses: TheGlitchKing/hit-em-with-the-docs@v1
|
|
93
|
+
+ - uses: TheGlitchKing/hit-em-with-the-docs@v2
|
|
94
|
+
with:
|
|
95
|
+
mode: maintain
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### 5. Verify Installation
|
|
99
|
+
|
|
100
|
+
Test that the new package works:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# Check version
|
|
104
|
+
hewtd --version # Should show 2.0.0
|
|
105
|
+
|
|
106
|
+
# Run a simple command
|
|
107
|
+
hewtd list
|
|
108
|
+
|
|
109
|
+
# Test with npx
|
|
110
|
+
npx @theglitchking/hit-em-with-the-docs --version
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 6. Update CI/CD Scripts (if applicable)
|
|
114
|
+
|
|
115
|
+
Update any CI/CD scripts that reference the package:
|
|
116
|
+
|
|
117
|
+
```diff
|
|
118
|
+
# Before
|
|
119
|
+
- npm install -g hit-em-with-the-docs
|
|
120
|
+
- hit-em-with-the-docs maintain --quick
|
|
121
|
+
|
|
122
|
+
# After
|
|
123
|
+
+ npm install -g @theglitchking/hit-em-with-the-docs
|
|
124
|
+
+ hewtd maintain --quick
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## CLI Commands (Unchanged)
|
|
128
|
+
|
|
129
|
+
All commands remain the same. You can continue using:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
hewtd init
|
|
133
|
+
hewtd maintain
|
|
134
|
+
hewtd integrate <file>
|
|
135
|
+
hewtd audit
|
|
136
|
+
hewtd discover patterns
|
|
137
|
+
hewtd report health
|
|
138
|
+
# ... all other commands
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Compatibility Notes
|
|
142
|
+
|
|
143
|
+
### Node.js Version
|
|
144
|
+
|
|
145
|
+
v2.0.0 requires Node.js ≥20.0.0 (same as v1.0.0)
|
|
146
|
+
|
|
147
|
+
### Documentation Structure
|
|
148
|
+
|
|
149
|
+
Your existing `.documentation/` directory structure is fully compatible. No changes needed.
|
|
150
|
+
|
|
151
|
+
### Configuration Files
|
|
152
|
+
|
|
153
|
+
All configuration files remain compatible:
|
|
154
|
+
- `.hewtdrc`
|
|
155
|
+
- `hewtd.config.js`
|
|
156
|
+
- Templates in `.documentation/`
|
|
157
|
+
|
|
158
|
+
### Templates
|
|
159
|
+
|
|
160
|
+
All existing templates in the `templates/` directory are fully compatible.
|
|
161
|
+
|
|
162
|
+
## Troubleshooting
|
|
163
|
+
|
|
164
|
+
### Issue: Command not found after migration
|
|
165
|
+
|
|
166
|
+
**Solution**: Ensure you've uninstalled the old package and installed the new one globally:
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
npm uninstall -g hit-em-with-the-docs
|
|
170
|
+
npm install -g @theglitchking/hit-em-with-the-docs
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Issue: Wrong version showing
|
|
174
|
+
|
|
175
|
+
**Solution**: Clear npm cache and reinstall:
|
|
176
|
+
|
|
177
|
+
```bash
|
|
178
|
+
npm cache clean --force
|
|
179
|
+
npm uninstall -g @theglitchking/hit-em-with-the-docs
|
|
180
|
+
npm install -g @theglitchking/hit-em-with-the-docs
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Issue: Both old and new packages installed
|
|
184
|
+
|
|
185
|
+
**Solution**: Uninstall both and reinstall only the new one:
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
npm uninstall -g hit-em-with-the-docs
|
|
189
|
+
npm uninstall -g @theglitchking/hit-em-with-the-docs
|
|
190
|
+
npm install -g @theglitchking/hit-em-with-the-docs
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Issue: npx using old version
|
|
194
|
+
|
|
195
|
+
**Solution**: Clear npx cache:
|
|
196
|
+
|
|
197
|
+
```bash
|
|
198
|
+
npx clear-npx-cache
|
|
199
|
+
# Or
|
|
200
|
+
rm -rf ~/.npm/_npx
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Claude Code Plugin Integration (New in v2.0.0)
|
|
204
|
+
|
|
205
|
+
v2.0.0 adds support for Claude Code marketplace:
|
|
206
|
+
|
|
207
|
+
### Install via Claude Code
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
# In Claude Code CLI
|
|
211
|
+
/plugin install TheGlitchKing/hit-em-with-the-docs
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Available Commands in Claude Code
|
|
215
|
+
|
|
216
|
+
Once installed, you can use these commands in Claude Code:
|
|
217
|
+
|
|
218
|
+
- `/docs load <domain>` - Load documentation for a specific domain
|
|
219
|
+
- `/docs list` - List all documentation domains
|
|
220
|
+
- `/docs search <query>` - Search documentation
|
|
221
|
+
- `/docs stats` - Show documentation health
|
|
222
|
+
- `/discover patterns` - Discover coding patterns
|
|
223
|
+
- `/discover anti-patterns` - Detect anti-patterns
|
|
224
|
+
- `/discover standards` - Extract coding standards
|
|
225
|
+
- `/discover dependencies` - Analyze dependencies
|
|
226
|
+
|
|
227
|
+
## Support and Questions
|
|
228
|
+
|
|
229
|
+
If you encounter any issues during migration:
|
|
230
|
+
|
|
231
|
+
1. Check this guide first
|
|
232
|
+
2. Review the [README](README.md) for updated documentation
|
|
233
|
+
3. Open an issue: https://github.com/TheGlitchKing/hit-em-with-the-docs/issues
|
|
234
|
+
4. Check discussions: https://github.com/TheGlitchKing/hit-em-with-the-docs/discussions
|
|
235
|
+
|
|
236
|
+
## Timeline
|
|
237
|
+
|
|
238
|
+
- **v1.0.0**: Original unscoped package (deprecated)
|
|
239
|
+
- **v1.1.0**: Final unscoped release with deprecation warning (available for 6 months)
|
|
240
|
+
- **v2.0.0**: New scoped package with Claude Code support (current)
|
|
241
|
+
|
|
242
|
+
The old `hit-em-with-the-docs` package will remain available on NPM for 6 months but will show a deprecation warning. After that period, it may be unpublished.
|
|
243
|
+
|
|
244
|
+
## Summary Checklist
|
|
245
|
+
|
|
246
|
+
- [ ] Uninstalled old `hit-em-with-the-docs` package
|
|
247
|
+
- [ ] Installed new `@theglitchking/hit-em-with-the-docs` package
|
|
248
|
+
- [ ] Updated `package.json` (if applicable)
|
|
249
|
+
- [ ] Updated GitHub Actions workflow (if applicable)
|
|
250
|
+
- [ ] Updated CI/CD scripts (if applicable)
|
|
251
|
+
- [ ] Verified installation with `hewtd --version`
|
|
252
|
+
- [ ] Tested basic commands
|
|
253
|
+
- [ ] Updated team documentation
|
|
254
|
+
|
|
255
|
+
Welcome to v2.0.0!
|