ultra-dex 1.1.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -0
- package/bin/ultra-dex.js +45 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -40,11 +40,25 @@ Shows links to fully filled Ultra-Dex examples:
|
|
|
40
40
|
- InvoiceFlow (Invoicing)
|
|
41
41
|
- HabitStack (Habit Tracking)
|
|
42
42
|
|
|
43
|
+
### Audit your project
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npx ultra-dex audit
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Checks your project for completeness:
|
|
50
|
+
- Required files (QUICK-START.md, CONTEXT.md, etc.)
|
|
51
|
+
- Key sections (idea, problem, MVP, tech stack)
|
|
52
|
+
- Implementation details (database, API, auth)
|
|
53
|
+
|
|
54
|
+
Outputs a score and grade (A-F) with suggestions.
|
|
55
|
+
|
|
43
56
|
## Commands
|
|
44
57
|
|
|
45
58
|
| Command | Description |
|
|
46
59
|
|---------|-------------|
|
|
47
60
|
| `ultra-dex init` | Initialize a new project |
|
|
61
|
+
| `ultra-dex audit` | Audit project for completeness |
|
|
48
62
|
| `ultra-dex examples` | List available examples |
|
|
49
63
|
| `ultra-dex --help` | Show help |
|
|
50
64
|
| `ultra-dex --version` | Show version |
|
|
@@ -58,6 +72,12 @@ Shows links to fully filled Ultra-Dex examples:
|
|
|
58
72
|
| `-n, --name <name>` | Project name (skips prompt) |
|
|
59
73
|
| `-d, --dir <directory>` | Output directory (default: current) |
|
|
60
74
|
|
|
75
|
+
### audit
|
|
76
|
+
|
|
77
|
+
| Option | Description |
|
|
78
|
+
|--------|-------------|
|
|
79
|
+
| `-d, --dir <directory>` | Directory to audit (default: current) |
|
|
80
|
+
|
|
61
81
|
## Example
|
|
62
82
|
|
|
63
83
|
```bash
|
package/bin/ultra-dex.js
CHANGED
|
@@ -109,7 +109,7 @@ Setting up the implementation plan.
|
|
|
109
109
|
program
|
|
110
110
|
.name('ultra-dex')
|
|
111
111
|
.description('CLI for Ultra-Dex SaaS Implementation Framework')
|
|
112
|
-
.version('1.
|
|
112
|
+
.version('1.2.1');
|
|
113
113
|
|
|
114
114
|
program
|
|
115
115
|
.command('init')
|
|
@@ -201,6 +201,18 @@ program
|
|
|
201
201
|
message: 'Include cursor-rules for AI assistants? (Cursor, Copilot)',
|
|
202
202
|
default: true,
|
|
203
203
|
},
|
|
204
|
+
{
|
|
205
|
+
type: 'confirm',
|
|
206
|
+
name: 'includeFullTemplate',
|
|
207
|
+
message: 'Copy full 34-section template locally?',
|
|
208
|
+
default: false,
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
type: 'confirm',
|
|
212
|
+
name: 'includeDocs',
|
|
213
|
+
message: 'Copy VERIFICATION.md & AGENT-INSTRUCTIONS.md to docs/?',
|
|
214
|
+
default: true,
|
|
215
|
+
},
|
|
204
216
|
]);
|
|
205
217
|
|
|
206
218
|
const spinner = ora('Creating project files...').start();
|
|
@@ -289,6 +301,30 @@ ${answers.ideaWhat} for ${answers.ideaFor}.
|
|
|
289
301
|
}
|
|
290
302
|
}
|
|
291
303
|
|
|
304
|
+
// Copy full template if requested
|
|
305
|
+
if (answers.includeFullTemplate) {
|
|
306
|
+
const templatePath = path.resolve(__dirname, '../../@ Ultra DeX/Saas plan/04-Imp-Template.md');
|
|
307
|
+
try {
|
|
308
|
+
await fs.copyFile(templatePath, path.join(outputDir, 'docs', 'MASTER-PLAN.md'));
|
|
309
|
+
} catch (err) {
|
|
310
|
+
console.log(chalk.yellow('\n Note: Full template not bundled. Download from GitHub:'));
|
|
311
|
+
console.log(chalk.blue(' https://github.com/Srujan0798/Ultra-Dex/blob/main/%40%20Ultra%20DeX/Saas%20plan/04-Imp-Template.md'));
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
// Copy docs if requested
|
|
316
|
+
if (answers.includeDocs) {
|
|
317
|
+
const verificationPath = path.resolve(__dirname, '../../VERIFICATION.md');
|
|
318
|
+
const agentPath = path.resolve(__dirname, '../../AGENT-INSTRUCTIONS.md');
|
|
319
|
+
try {
|
|
320
|
+
await fs.copyFile(verificationPath, path.join(outputDir, 'docs', 'CHECKLIST.md'));
|
|
321
|
+
await fs.copyFile(agentPath, path.join(outputDir, 'docs', 'AI-PROMPTS.md'));
|
|
322
|
+
} catch (err) {
|
|
323
|
+
console.log(chalk.yellow('\n Note: Docs not bundled. Download from GitHub:'));
|
|
324
|
+
console.log(chalk.blue(' https://github.com/Srujan0798/Ultra-Dex'));
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
|
|
292
328
|
spinner.succeed(chalk.green('Project created successfully!'));
|
|
293
329
|
|
|
294
330
|
console.log('\n' + chalk.bold('Files created:'));
|
|
@@ -296,6 +332,13 @@ ${answers.ideaWhat} for ${answers.ideaFor}.
|
|
|
296
332
|
console.log(chalk.gray(' ├── QUICK-START.md'));
|
|
297
333
|
console.log(chalk.gray(' ├── CONTEXT.md'));
|
|
298
334
|
console.log(chalk.gray(' ├── IMPLEMENTATION-PLAN.md'));
|
|
335
|
+
if (answers.includeFullTemplate) {
|
|
336
|
+
console.log(chalk.gray(' ├── docs/MASTER-PLAN.md (34 sections)'));
|
|
337
|
+
}
|
|
338
|
+
if (answers.includeDocs) {
|
|
339
|
+
console.log(chalk.gray(' ├── docs/CHECKLIST.md'));
|
|
340
|
+
console.log(chalk.gray(' ├── docs/AI-PROMPTS.md'));
|
|
341
|
+
}
|
|
299
342
|
if (answers.includeCursorRules) {
|
|
300
343
|
console.log(chalk.gray(' └── .cursor/rules/ (11 AI rule files)'));
|
|
301
344
|
}
|
|
@@ -305,7 +348,7 @@ ${answers.ideaWhat} for ${answers.ideaFor}.
|
|
|
305
348
|
console.log(chalk.cyan(' 2. Open QUICK-START.md and complete it'));
|
|
306
349
|
console.log(chalk.cyan(' 3. Start building! 🚀'));
|
|
307
350
|
|
|
308
|
-
console.log('\n' + chalk.gray('
|
|
351
|
+
console.log('\n' + chalk.gray('Full Ultra-Dex repo:'));
|
|
309
352
|
console.log(chalk.blue(' https://github.com/Srujan0798/Ultra-Dex'));
|
|
310
353
|
|
|
311
354
|
} catch (error) {
|