create-claude-context 1.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.
Files changed (88) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +146 -0
  3. package/bin/create-claude-context.js +61 -0
  4. package/lib/detector.js +373 -0
  5. package/lib/index.js +170 -0
  6. package/lib/installer.js +362 -0
  7. package/lib/placeholder.js +208 -0
  8. package/lib/prompts.js +287 -0
  9. package/lib/spinner.js +60 -0
  10. package/lib/validate.js +147 -0
  11. package/package.json +59 -0
  12. package/templates/CLAUDE.md.template +235 -0
  13. package/templates/base/README.md +257 -0
  14. package/templates/base/RPI_WORKFLOW_PLAN.md +320 -0
  15. package/templates/base/agents/api-developer.md +76 -0
  16. package/templates/base/agents/context-engineer.md +525 -0
  17. package/templates/base/agents/core-architect.md +76 -0
  18. package/templates/base/agents/database-ops.md +76 -0
  19. package/templates/base/agents/deployment-ops.md +76 -0
  20. package/templates/base/agents/integration-hub.md +76 -0
  21. package/templates/base/analytics/README.md +114 -0
  22. package/templates/base/ci-templates/README.md +108 -0
  23. package/templates/base/ci-templates/github-actions/context-check.yml +144 -0
  24. package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -0
  25. package/templates/base/commands/analytics.md +238 -0
  26. package/templates/base/commands/collab.md +194 -0
  27. package/templates/base/commands/help.md +450 -0
  28. package/templates/base/commands/rpi-implement.md +115 -0
  29. package/templates/base/commands/rpi-plan.md +93 -0
  30. package/templates/base/commands/rpi-research.md +88 -0
  31. package/templates/base/commands/validate-all.md +77 -0
  32. package/templates/base/commands/verify-docs-current.md +86 -0
  33. package/templates/base/config/base.json +57 -0
  34. package/templates/base/config/environments/development.json +13 -0
  35. package/templates/base/config/environments/production.json +17 -0
  36. package/templates/base/config/environments/staging.json +13 -0
  37. package/templates/base/config/local.json.example +21 -0
  38. package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -0
  39. package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -0
  40. package/templates/base/context/KNOWN_GOTCHAS.md +195 -0
  41. package/templates/base/context/WORKFLOW_INDEX.md +129 -0
  42. package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -0
  43. package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -0
  44. package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -0
  45. package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -0
  46. package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -0
  47. package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -0
  48. package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -0
  49. package/templates/base/knowledge/README.md +98 -0
  50. package/templates/base/knowledge/sessions/README.md +88 -0
  51. package/templates/base/knowledge/sessions/TEMPLATE.md +150 -0
  52. package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -0
  53. package/templates/base/knowledge/shared/decisions/README.md +49 -0
  54. package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -0
  55. package/templates/base/knowledge/shared/patterns/README.md +62 -0
  56. package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -0
  57. package/templates/base/plans/PLAN_TEMPLATE.md +250 -0
  58. package/templates/base/plans/active/.gitkeep +0 -0
  59. package/templates/base/plans/completed/.gitkeep +0 -0
  60. package/templates/base/research/RESEARCH_TEMPLATE.md +153 -0
  61. package/templates/base/research/active/.gitkeep +0 -0
  62. package/templates/base/research/completed/.gitkeep +0 -0
  63. package/templates/base/schemas/agent.schema.json +141 -0
  64. package/templates/base/schemas/command.schema.json +134 -0
  65. package/templates/base/schemas/manifest.schema.json +117 -0
  66. package/templates/base/schemas/plan.schema.json +136 -0
  67. package/templates/base/schemas/research.schema.json +115 -0
  68. package/templates/base/schemas/settings.schema.json +244 -0
  69. package/templates/base/schemas/workflow.schema.json +126 -0
  70. package/templates/base/settings.json +57 -0
  71. package/templates/base/standards/COMPATIBILITY.md +219 -0
  72. package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -0
  73. package/templates/base/standards/QUALITY_CHECKLIST.md +211 -0
  74. package/templates/base/standards/README.md +66 -0
  75. package/templates/base/team/README.md +168 -0
  76. package/templates/base/team/config.json +79 -0
  77. package/templates/base/team/roles.json +145 -0
  78. package/templates/base/tools/bin/claude-context.js +151 -0
  79. package/templates/base/tools/lib/config-loader.js +363 -0
  80. package/templates/base/tools/lib/detector.js +350 -0
  81. package/templates/base/tools/lib/diagnose.js +206 -0
  82. package/templates/base/tools/lib/errors.js +199 -0
  83. package/templates/base/tools/lib/index.js +24 -0
  84. package/templates/base/tools/lib/init.js +192 -0
  85. package/templates/base/tools/lib/logger.js +230 -0
  86. package/templates/base/tools/lib/placeholder.js +201 -0
  87. package/templates/base/tools/lib/validate.js +521 -0
  88. package/templates/base/tools/package.json +49 -0
@@ -0,0 +1,208 @@
1
+ /**
2
+ * Claude Context Engineering - Placeholder Replacement Engine
3
+ *
4
+ * Finds and replaces {{PLACEHOLDER}} patterns in template files.
5
+ */
6
+
7
+ const fs = require('fs');
8
+ const path = require('path');
9
+ const { glob } = require('glob');
10
+
11
+ /**
12
+ * Known placeholders with their descriptions
13
+ */
14
+ const KNOWN_PLACEHOLDERS = {
15
+ // Project identity
16
+ PROJECT_NAME: { description: 'Project name', example: 'my-awesome-app' },
17
+ PROJECT_DESCRIPTION: { description: 'Brief project description', example: 'A web application for...' },
18
+ TECH_STACK: { description: 'Technologies used', example: 'Python 3.11, FastAPI, PostgreSQL' },
19
+ PRODUCTION_URL: { description: 'Production URL', example: 'https://api.example.com' },
20
+ PROJECT_STATUS: { description: 'Project status', example: 'Production' },
21
+
22
+ // URLs
23
+ API_URL: { description: 'API base URL', example: 'https://api.example.com/v1' },
24
+ REPO_URL: { description: 'Repository URL', example: 'https://github.com/user/repo' },
25
+ DEPLOYMENT_PLATFORM: { description: 'Where deployed', example: 'AWS ECS' },
26
+
27
+ // Commands
28
+ INSTALL_COMMAND: { description: 'Install dependencies command', example: 'npm install' },
29
+ DEV_START_COMMAND: { description: 'Start dev server command', example: 'npm run dev' },
30
+ TEST_COMMAND: { description: 'Run tests command', example: 'npm test' },
31
+ TEST_E2E_COMMAND: { description: 'Run E2E tests command', example: 'npm run test:e2e' },
32
+ TEST_COVERAGE_COMMAND: { description: 'Run coverage command', example: 'npm run coverage' },
33
+ MIGRATION_CREATE_COMMAND: { description: 'Create migration command', example: 'npm run db:migrate:create' },
34
+ MIGRATION_RUN_COMMAND: { description: 'Run migrations command', example: 'npm run db:migrate' },
35
+ DEPLOY_COMMAND: { description: 'Deploy command', example: 'npm run deploy' },
36
+
37
+ // Paths
38
+ MODELS_PATH: { description: 'Models directory path', example: 'src/models/' },
39
+ MIGRATIONS_PATH: { description: 'Migrations directory path', example: 'src/migrations/' },
40
+ CORE_FILES_LIST: { description: 'List of core files', example: '- src/services/\n- src/models/' },
41
+
42
+ // Counts
43
+ WORKFLOWS_COUNT: { description: 'Number of workflows', example: '12' },
44
+ AGENTS_COUNT: { description: 'Number of agents', example: '6' },
45
+ COMMANDS_COUNT: { description: 'Number of commands', example: '8' },
46
+
47
+ // Meta
48
+ DATE: { description: 'Current date', example: '2025-01-24' },
49
+ AGENT_TABLE_ROWS: { description: 'Agent table rows', example: '| core-architect | System design |' },
50
+ };
51
+
52
+ /**
53
+ * Get default placeholder values based on config and tech stack
54
+ */
55
+ function getDefaultValues(config = {}, techStack = {}) {
56
+ const today = new Date().toISOString().split('T')[0];
57
+ const projectName = config.projectName || 'my-project';
58
+
59
+ // Determine commands based on tech stack
60
+ let commands = {
61
+ install: 'npm install',
62
+ dev: 'npm run dev',
63
+ test: 'npm test',
64
+ migrate: 'npm run migrate'
65
+ };
66
+
67
+ if (techStack.commands) {
68
+ commands = techStack.commands;
69
+ } else if (techStack.languages?.includes('python')) {
70
+ commands = {
71
+ install: 'pip install -r requirements.txt',
72
+ dev: 'python main.py',
73
+ test: 'pytest',
74
+ migrate: 'alembic upgrade head'
75
+ };
76
+ } else if (techStack.languages?.includes('go')) {
77
+ commands = {
78
+ install: 'go mod download',
79
+ dev: 'go run .',
80
+ test: 'go test ./...',
81
+ migrate: 'migrate -path migrations up'
82
+ };
83
+ } else if (techStack.languages?.includes('rust')) {
84
+ commands = {
85
+ install: 'cargo build',
86
+ dev: 'cargo run',
87
+ test: 'cargo test',
88
+ migrate: 'sqlx migrate run'
89
+ };
90
+ }
91
+
92
+ return {
93
+ PROJECT_NAME: projectName,
94
+ PROJECT_DESCRIPTION: `${projectName} application`,
95
+ TECH_STACK: techStack.summary || techStack.stack || 'Not detected',
96
+ PRODUCTION_URL: `https://${projectName}.example.com`,
97
+ PROJECT_STATUS: 'Development',
98
+ API_URL: `https://api.${projectName}.example.com`,
99
+ REPO_URL: `https://github.com/user/${projectName}`,
100
+ DEPLOYMENT_PLATFORM: 'Docker',
101
+ INSTALL_COMMAND: commands.install,
102
+ DEV_START_COMMAND: commands.dev,
103
+ TEST_COMMAND: commands.test,
104
+ TEST_E2E_COMMAND: `${commands.test} --e2e`,
105
+ TEST_COVERAGE_COMMAND: `${commands.test} --coverage`,
106
+ MIGRATION_CREATE_COMMAND: `${commands.migrate}:create`,
107
+ MIGRATION_RUN_COMMAND: commands.migrate,
108
+ DEPLOY_COMMAND: 'docker-compose up -d',
109
+ MODELS_PATH: 'src/models/',
110
+ MIGRATIONS_PATH: 'src/migrations/',
111
+ CORE_FILES_LIST: '- src/\n- config/',
112
+ WORKFLOWS_COUNT: '8',
113
+ AGENTS_COUNT: '6',
114
+ COMMANDS_COUNT: '8',
115
+ DATE: today,
116
+ AGENT_TABLE_ROWS: '',
117
+ };
118
+ }
119
+
120
+ /**
121
+ * Replace placeholders in all files in a directory
122
+ */
123
+ async function replacePlaceholders(targetDir, config = {}) {
124
+ const claudeDir = path.join(targetDir, '.claude');
125
+ const values = getDefaultValues(config, config.techStack || {});
126
+
127
+ // Find all markdown and JSON files
128
+ const files = await glob('**/*.{md,json}', {
129
+ cwd: claudeDir,
130
+ ignore: ['node_modules/**', '.git/**'],
131
+ nodir: true,
132
+ absolute: true
133
+ });
134
+
135
+ let totalReplaced = 0;
136
+
137
+ for (const filePath of files) {
138
+ try {
139
+ let content = fs.readFileSync(filePath, 'utf8');
140
+ const originalContent = content;
141
+
142
+ // Replace all placeholders
143
+ for (const [key, value] of Object.entries(values)) {
144
+ const pattern = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
145
+ content = content.replace(pattern, String(value));
146
+ }
147
+
148
+ if (content !== originalContent) {
149
+ fs.writeFileSync(filePath, content, 'utf8');
150
+ totalReplaced++;
151
+ }
152
+ } catch (error) {
153
+ // Skip files that can't be read
154
+ }
155
+ }
156
+
157
+ // Also replace in CLAUDE.md at root
158
+ const claudeMdPath = path.join(targetDir, 'CLAUDE.md');
159
+ if (fs.existsSync(claudeMdPath)) {
160
+ try {
161
+ let content = fs.readFileSync(claudeMdPath, 'utf8');
162
+ const originalContent = content;
163
+
164
+ for (const [key, value] of Object.entries(values)) {
165
+ const pattern = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
166
+ content = content.replace(pattern, String(value));
167
+ }
168
+
169
+ if (content !== originalContent) {
170
+ fs.writeFileSync(claudeMdPath, content, 'utf8');
171
+ totalReplaced++;
172
+ }
173
+ } catch (error) {
174
+ // Skip if can't read
175
+ }
176
+ }
177
+
178
+ return totalReplaced;
179
+ }
180
+
181
+ /**
182
+ * Find all placeholders in a file
183
+ */
184
+ function findPlaceholders(filePath) {
185
+ const content = fs.readFileSync(filePath, 'utf8');
186
+ const placeholderPattern = /\{\{([A-Z_]+)\}\}/g;
187
+
188
+ const found = [];
189
+ let match;
190
+
191
+ while ((match = placeholderPattern.exec(content)) !== null) {
192
+ found.push({
193
+ placeholder: match[0],
194
+ name: match[1],
195
+ index: match.index,
196
+ known: KNOWN_PLACEHOLDERS.hasOwnProperty(match[1]),
197
+ });
198
+ }
199
+
200
+ return found;
201
+ }
202
+
203
+ module.exports = {
204
+ replacePlaceholders,
205
+ findPlaceholders,
206
+ getDefaultValues,
207
+ KNOWN_PLACEHOLDERS,
208
+ };
package/lib/prompts.js ADDED
@@ -0,0 +1,287 @@
1
+ /**
2
+ * Interactive prompts for create-claude-context
3
+ *
4
+ * Uses enquirer for beautiful, user-friendly prompts
5
+ */
6
+
7
+ const { prompt } = require('enquirer');
8
+ const path = require('path');
9
+ const chalk = require('chalk');
10
+ const { detectTechStack } = require('./detector');
11
+
12
+ // Available tech stack presets
13
+ const PRESETS = {
14
+ 'python-fastapi': {
15
+ name: 'Python + FastAPI + PostgreSQL',
16
+ stack: 'Python, FastAPI, PostgreSQL',
17
+ commands: {
18
+ install: 'pip install -r requirements.txt',
19
+ dev: 'uvicorn main:app --reload',
20
+ test: 'pytest',
21
+ migrate: 'alembic upgrade head'
22
+ }
23
+ },
24
+ 'node-express': {
25
+ name: 'Node.js + Express + MongoDB',
26
+ stack: 'Node.js, Express, MongoDB',
27
+ commands: {
28
+ install: 'npm install',
29
+ dev: 'npm run dev',
30
+ test: 'npm test',
31
+ migrate: 'npm run migrate'
32
+ }
33
+ },
34
+ 'typescript-nextjs': {
35
+ name: 'TypeScript + Next.js + Prisma',
36
+ stack: 'TypeScript, Next.js, Prisma, PostgreSQL',
37
+ commands: {
38
+ install: 'npm install',
39
+ dev: 'npm run dev',
40
+ test: 'npm test',
41
+ migrate: 'npx prisma migrate dev'
42
+ }
43
+ },
44
+ 'go-gin': {
45
+ name: 'Go + Gin + PostgreSQL',
46
+ stack: 'Go, Gin, PostgreSQL',
47
+ commands: {
48
+ install: 'go mod download',
49
+ dev: 'go run main.go',
50
+ test: 'go test ./...',
51
+ migrate: 'migrate -path migrations -database $DATABASE_URL up'
52
+ }
53
+ },
54
+ 'rust-actix': {
55
+ name: 'Rust + Actix + SQLx',
56
+ stack: 'Rust, Actix-web, SQLx, PostgreSQL',
57
+ commands: {
58
+ install: 'cargo build',
59
+ dev: 'cargo run',
60
+ test: 'cargo test',
61
+ migrate: 'sqlx migrate run'
62
+ }
63
+ },
64
+ 'ruby-rails': {
65
+ name: 'Ruby + Rails + PostgreSQL',
66
+ stack: 'Ruby, Rails, PostgreSQL',
67
+ commands: {
68
+ install: 'bundle install',
69
+ dev: 'rails server',
70
+ test: 'rails test',
71
+ migrate: 'rails db:migrate'
72
+ }
73
+ },
74
+ 'python-django': {
75
+ name: 'Python + Django + PostgreSQL',
76
+ stack: 'Python, Django, PostgreSQL',
77
+ commands: {
78
+ install: 'pip install -r requirements.txt',
79
+ dev: 'python manage.py runserver',
80
+ test: 'python manage.py test',
81
+ migrate: 'python manage.py migrate'
82
+ }
83
+ },
84
+ 'node-nestjs': {
85
+ name: 'Node.js + NestJS + TypeORM',
86
+ stack: 'Node.js, NestJS, TypeORM, PostgreSQL',
87
+ commands: {
88
+ install: 'npm install',
89
+ dev: 'npm run start:dev',
90
+ test: 'npm run test',
91
+ migrate: 'npm run migration:run'
92
+ }
93
+ },
94
+ 'typescript-remix': {
95
+ name: 'TypeScript + Remix + Prisma',
96
+ stack: 'TypeScript, Remix, Prisma, PostgreSQL',
97
+ commands: {
98
+ install: 'npm install',
99
+ dev: 'npm run dev',
100
+ test: 'npm test',
101
+ migrate: 'npx prisma migrate dev'
102
+ }
103
+ },
104
+ 'java-spring': {
105
+ name: 'Java + Spring Boot + PostgreSQL',
106
+ stack: 'Java, Spring Boot, PostgreSQL',
107
+ commands: {
108
+ install: 'mvn install',
109
+ dev: 'mvn spring-boot:run',
110
+ test: 'mvn test',
111
+ migrate: 'mvn flyway:migrate'
112
+ }
113
+ },
114
+ 'csharp-dotnet': {
115
+ name: 'C# + .NET Core + Entity Framework',
116
+ stack: 'C#, .NET Core, Entity Framework, PostgreSQL',
117
+ commands: {
118
+ install: 'dotnet restore',
119
+ dev: 'dotnet run',
120
+ test: 'dotnet test',
121
+ migrate: 'dotnet ef database update'
122
+ }
123
+ },
124
+ 'php-laravel': {
125
+ name: 'PHP + Laravel + MySQL',
126
+ stack: 'PHP, Laravel, MySQL',
127
+ commands: {
128
+ install: 'composer install',
129
+ dev: 'php artisan serve',
130
+ test: 'php artisan test',
131
+ migrate: 'php artisan migrate'
132
+ }
133
+ }
134
+ };
135
+
136
+ /**
137
+ * Run interactive prompts
138
+ */
139
+ async function runPrompts(targetDir, presetName = null) {
140
+ // Detect tech stack for auto-suggestion
141
+ const detected = await detectTechStack(targetDir);
142
+
143
+ console.log(chalk.gray('\nLet\'s set up context engineering for your project.\n'));
144
+
145
+ const answers = await prompt([
146
+ {
147
+ type: 'input',
148
+ name: 'projectName',
149
+ message: 'Project name:',
150
+ initial: path.basename(targetDir),
151
+ validate: (value) => {
152
+ if (!value.trim()) return 'Project name is required';
153
+ if (!/^[a-zA-Z0-9_-]+$/.test(value)) {
154
+ return 'Project name can only contain letters, numbers, hyphens, and underscores';
155
+ }
156
+ return true;
157
+ }
158
+ },
159
+ {
160
+ type: 'select',
161
+ name: 'techStackChoice',
162
+ message: 'Technology stack:',
163
+ choices: [
164
+ {
165
+ name: 'auto',
166
+ message: detected.summary
167
+ ? `Confirm: ${detected.summary}`
168
+ : 'Auto-detect from project files'
169
+ },
170
+ { name: 'preset', message: 'Select from presets' },
171
+ { name: 'manual', message: 'Enter manually' },
172
+ { name: 'skip', message: 'Skip (use generic template)' }
173
+ ],
174
+ initial: 0
175
+ },
176
+ {
177
+ type: 'select',
178
+ name: 'preset',
179
+ message: 'Select a tech stack preset:',
180
+ choices: Object.entries(PRESETS).map(([key, value]) => ({
181
+ name: key,
182
+ message: value.name
183
+ })),
184
+ skip() {
185
+ return this.state.answers.techStackChoice !== 'preset';
186
+ }
187
+ },
188
+ {
189
+ type: 'input',
190
+ name: 'manualStack',
191
+ message: 'Enter your tech stack (e.g., "Python, Django, PostgreSQL"):',
192
+ skip() {
193
+ return this.state.answers.techStackChoice !== 'manual';
194
+ }
195
+ },
196
+ {
197
+ type: 'multiselect',
198
+ name: 'features',
199
+ message: 'Features to include:',
200
+ choices: [
201
+ { name: 'rpi', message: 'RPI Workflow (Research-Plan-Implement)', value: true },
202
+ { name: 'agents', message: 'Specialized Agents (6 agents)', value: true },
203
+ { name: 'validation', message: 'Validation Commands', value: true },
204
+ { name: 'ci', message: 'CI/CD Templates', value: false },
205
+ { name: 'team', message: 'Team Collaboration', value: false },
206
+ { name: 'analytics', message: 'Analytics Dashboard', value: false }
207
+ ],
208
+ initial: ['rpi', 'agents', 'validation']
209
+ },
210
+ {
211
+ type: 'confirm',
212
+ name: 'installPlugin',
213
+ message: 'Install Claude Code plugin for ongoing commands?',
214
+ initial: true
215
+ }
216
+ ]);
217
+
218
+ // Process tech stack choice
219
+ let techStack = detected;
220
+ if (answers.techStackChoice === 'preset' && answers.preset) {
221
+ const preset = PRESETS[answers.preset];
222
+ techStack = {
223
+ ...techStack,
224
+ summary: preset.stack,
225
+ preset: answers.preset,
226
+ commands: preset.commands
227
+ };
228
+ } else if (answers.techStackChoice === 'manual' && answers.manualStack) {
229
+ techStack = {
230
+ ...techStack,
231
+ summary: answers.manualStack,
232
+ preset: null
233
+ };
234
+ }
235
+
236
+ return {
237
+ projectName: answers.projectName,
238
+ techStack,
239
+ features: {
240
+ rpi: answers.features.includes('rpi'),
241
+ agents: answers.features.includes('agents'),
242
+ validation: answers.features.includes('validation'),
243
+ ci: answers.features.includes('ci'),
244
+ team: answers.features.includes('team'),
245
+ analytics: answers.features.includes('analytics')
246
+ },
247
+ installPlugin: answers.installPlugin
248
+ };
249
+ }
250
+
251
+ /**
252
+ * Get default configuration (for --yes flag)
253
+ */
254
+ async function getDefaults(targetDir, presetName = null) {
255
+ const detected = await detectTechStack(targetDir);
256
+
257
+ let techStack = detected;
258
+ if (presetName && PRESETS[presetName]) {
259
+ const preset = PRESETS[presetName];
260
+ techStack = {
261
+ ...techStack,
262
+ summary: preset.stack,
263
+ preset: presetName,
264
+ commands: preset.commands
265
+ };
266
+ }
267
+
268
+ return {
269
+ projectName: path.basename(targetDir),
270
+ techStack,
271
+ features: {
272
+ rpi: true,
273
+ agents: true,
274
+ validation: true,
275
+ ci: false,
276
+ team: false,
277
+ analytics: false
278
+ },
279
+ installPlugin: true
280
+ };
281
+ }
282
+
283
+ module.exports = {
284
+ runPrompts,
285
+ getDefaults,
286
+ PRESETS
287
+ };
package/lib/spinner.js ADDED
@@ -0,0 +1,60 @@
1
+ /**
2
+ * Spinner utilities for create-claude-context
3
+ *
4
+ * Provides consistent progress indicators using ora
5
+ */
6
+
7
+ const ora = require('ora');
8
+ const chalk = require('chalk');
9
+
10
+ /**
11
+ * Create a spinner instance with consistent styling
12
+ */
13
+ function createSpinner(text = '') {
14
+ return ora({
15
+ text,
16
+ color: 'cyan',
17
+ spinner: 'dots'
18
+ });
19
+ }
20
+
21
+ /**
22
+ * Run a task with spinner feedback
23
+ * @param {string} text - Text to display while running
24
+ * @param {Function} task - Async function to run
25
+ * @returns {Promise<any>} - Result of the task
26
+ */
27
+ async function withSpinner(text, task) {
28
+ const spinner = createSpinner(text);
29
+ spinner.start();
30
+
31
+ try {
32
+ const result = await task();
33
+ spinner.succeed();
34
+ return result;
35
+ } catch (error) {
36
+ spinner.fail(chalk.red(error.message));
37
+ throw error;
38
+ }
39
+ }
40
+
41
+ /**
42
+ * Display a progress list
43
+ * @param {Array<{text: string, task: Function}>} items - List of tasks
44
+ */
45
+ async function progressList(items) {
46
+ const results = [];
47
+
48
+ for (const item of items) {
49
+ const result = await withSpinner(item.text, item.task);
50
+ results.push(result);
51
+ }
52
+
53
+ return results;
54
+ }
55
+
56
+ module.exports = {
57
+ createSpinner,
58
+ withSpinner,
59
+ progressList
60
+ };
@@ -0,0 +1,147 @@
1
+ /**
2
+ * Claude Context Engineering - Installation Validator
3
+ *
4
+ * Validates the installation was successful.
5
+ */
6
+
7
+ const fs = require('fs');
8
+ const path = require('path');
9
+
10
+ /**
11
+ * Required files and directories for a valid installation
12
+ */
13
+ const REQUIRED_STRUCTURE = {
14
+ directories: [
15
+ '.claude',
16
+ '.claude/context',
17
+ '.claude/research',
18
+ '.claude/plans',
19
+ ],
20
+ files: [
21
+ 'CLAUDE.md',
22
+ '.claude/README.md',
23
+ '.claude/settings.json',
24
+ '.claude/context/WORKFLOW_INDEX.md',
25
+ ],
26
+ };
27
+
28
+ /**
29
+ * Validate the installation
30
+ */
31
+ async function validateInstallation(targetDir) {
32
+ const result = {
33
+ passed: true,
34
+ warnings: 0,
35
+ errors: 0,
36
+ checks: [],
37
+ };
38
+
39
+ // Check required directories
40
+ for (const dir of REQUIRED_STRUCTURE.directories) {
41
+ const fullPath = path.join(targetDir, dir);
42
+ const exists = fs.existsSync(fullPath);
43
+
44
+ result.checks.push({
45
+ type: 'directory',
46
+ path: dir,
47
+ status: exists ? 'PASS' : 'FAIL',
48
+ });
49
+
50
+ if (!exists) {
51
+ result.errors++;
52
+ result.passed = false;
53
+ }
54
+ }
55
+
56
+ // Check required files
57
+ for (const file of REQUIRED_STRUCTURE.files) {
58
+ const fullPath = path.join(targetDir, file);
59
+ const exists = fs.existsSync(fullPath);
60
+
61
+ result.checks.push({
62
+ type: 'file',
63
+ path: file,
64
+ status: exists ? 'PASS' : 'FAIL',
65
+ });
66
+
67
+ if (!exists) {
68
+ result.errors++;
69
+ result.passed = false;
70
+ }
71
+ }
72
+
73
+ // Check for remaining placeholders in key files
74
+ const filesToCheck = [
75
+ 'CLAUDE.md',
76
+ '.claude/README.md',
77
+ '.claude/settings.json',
78
+ ];
79
+
80
+ for (const file of filesToCheck) {
81
+ const fullPath = path.join(targetDir, file);
82
+ if (fs.existsSync(fullPath)) {
83
+ const content = fs.readFileSync(fullPath, 'utf8');
84
+ const placeholders = content.match(/\{\{[A-Z_]+\}\}/g) || [];
85
+
86
+ if (placeholders.length > 0) {
87
+ result.checks.push({
88
+ type: 'placeholders',
89
+ path: file,
90
+ status: 'WARN',
91
+ details: `${placeholders.length} placeholders remaining`,
92
+ });
93
+ result.warnings++;
94
+ }
95
+ }
96
+ }
97
+
98
+ // Validate settings.json is valid JSON
99
+ const settingsPath = path.join(targetDir, '.claude', 'settings.json');
100
+ if (fs.existsSync(settingsPath)) {
101
+ try {
102
+ JSON.parse(fs.readFileSync(settingsPath, 'utf8'));
103
+ result.checks.push({
104
+ type: 'json',
105
+ path: '.claude/settings.json',
106
+ status: 'PASS',
107
+ });
108
+ } catch (e) {
109
+ result.checks.push({
110
+ type: 'json',
111
+ path: '.claude/settings.json',
112
+ status: 'FAIL',
113
+ details: 'Invalid JSON',
114
+ });
115
+ result.errors++;
116
+ result.passed = false;
117
+ }
118
+ }
119
+
120
+ return result;
121
+ }
122
+
123
+ /**
124
+ * Count files in a directory
125
+ */
126
+ function countFiles(dir, pattern = '*') {
127
+ if (!fs.existsSync(dir)) return 0;
128
+
129
+ let count = 0;
130
+ const entries = fs.readdirSync(dir, { withFileTypes: true });
131
+
132
+ for (const entry of entries) {
133
+ if (entry.isFile()) {
134
+ count++;
135
+ } else if (entry.isDirectory()) {
136
+ count += countFiles(path.join(dir, entry.name), pattern);
137
+ }
138
+ }
139
+
140
+ return count;
141
+ }
142
+
143
+ module.exports = {
144
+ validateInstallation,
145
+ countFiles,
146
+ REQUIRED_STRUCTURE,
147
+ };