@pepshlr/pepdoc 0.2.0 → 0.2.2

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.
@@ -1,11 +1,14 @@
1
1
  #!/usr/bin/env node
2
2
  /**
3
3
  * PepsDoc - Post-install onboarding message
4
- * Shows a welcome message after npm install
4
+ * Uses stderr so npm always shows it (stdout is suppressed for dependency scripts)
5
5
  */
6
6
  declare const PURPLE = "\u001B[35m";
7
- declare const CYAN = "\u001B[36m";
7
+ declare const GREEN = "\u001B[32m";
8
+ declare const YELLOW = "\u001B[33m";
8
9
  declare const DIM = "\u001B[2m";
9
10
  declare const RESET = "\u001B[0m";
10
11
  declare const BOLD = "\u001B[1m";
12
+ declare const line: string;
13
+ declare const lines: string[];
11
14
  //# sourceMappingURL=postinstall.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"postinstall.d.ts","sourceRoot":"","sources":["../../src/bin/postinstall.ts"],"names":[],"mappings":";AAEA;;;GAGG;AAEH,QAAA,MAAM,MAAM,eAAa,CAAC;AAC1B,QAAA,MAAM,IAAI,eAAa,CAAC;AACxB,QAAA,MAAM,GAAG,cAAY,CAAC;AACtB,QAAA,MAAM,KAAK,cAAY,CAAC;AACxB,QAAA,MAAM,IAAI,cAAY,CAAC"}
1
+ {"version":3,"file":"postinstall.d.ts","sourceRoot":"","sources":["../../src/bin/postinstall.ts"],"names":[],"mappings":";AAEA;;;GAGG;AAEH,QAAA,MAAM,MAAM,eAAa,CAAC;AAC1B,QAAA,MAAM,KAAK,eAAa,CAAC;AACzB,QAAA,MAAM,MAAM,eAAa,CAAC;AAC1B,QAAA,MAAM,GAAG,cAAY,CAAC;AACtB,QAAA,MAAM,KAAK,cAAY,CAAC;AACxB,QAAA,MAAM,IAAI,cAAY,CAAC;AAEvB,QAAA,MAAM,IAAI,QAAiB,CAAC;AAE5B,QAAA,MAAM,KAAK,UAyBV,CAAC"}
@@ -2,22 +2,40 @@
2
2
  "use strict";
3
3
  /**
4
4
  * PepsDoc - Post-install onboarding message
5
- * Shows a welcome message after npm install
5
+ * Uses stderr so npm always shows it (stdout is suppressed for dependency scripts)
6
6
  */
7
7
  const PURPLE = '\x1b[35m';
8
- const CYAN = '\x1b[36m';
8
+ const GREEN = '\x1b[32m';
9
+ const YELLOW = '\x1b[33m';
9
10
  const DIM = '\x1b[2m';
10
11
  const RESET = '\x1b[0m';
11
12
  const BOLD = '\x1b[1m';
12
- console.log('');
13
- console.log(` ${PURPLE}${BOLD}PepsDoc${RESET} installed successfully!`);
14
- console.log('');
15
- console.log(` ${CYAN}Quick start:${RESET}`);
16
- console.log(` 1. npx pepsdoc init`);
17
- console.log(` 2. Add endpoints to pepsdoc/data/v1/`);
18
- console.log(` 3. npx pepsdoc dev`);
19
- console.log('');
20
- console.log(` ${DIM}Or let AI do the work — copy the AI Skill from:${RESET}`);
21
- console.log(` ${DIM}node_modules/@pepshlr/pepdoc/templates/ai-skill.md${RESET}`);
22
- console.log('');
13
+ const line = '─'.repeat(58);
14
+ const lines = [
15
+ '',
16
+ ` ${PURPLE}${BOLD}✦ PepsDoc${RESET} installed!`,
17
+ '',
18
+ ` ${GREEN}${BOLD}Let AI document your entire API automatically.${RESET}`,
19
+ ` ${DIM}Copy the prompt below and paste it into your AI assistant:${RESET}`,
20
+ '',
21
+ ` ┌${line}┐`,
22
+ ` ${YELLOW}pepsdoc: integrate and document my entire API ${RESET} │`,
23
+ ` │ │`,
24
+ ` │ @pepshlr/pepdoc is already installed. Do the following: │`,
25
+ ` │ │`,
26
+ ` │ 1. Find my main server file and add the adapter: │`,
27
+ ` │ Express → pepsdoc(app, { title: '...' }) │`,
28
+ ` │ Fastify → fastifyAdapter(app, { title: '...' }) │`,
29
+ ` │ Hono → honoAdapter(app, { title: '...' }) │`,
30
+ ` │ │`,
31
+ ` │ 2. Read all route files in the project and generate │`,
32
+ ` │ JSON docs in pepsdoc/data/v1/ (one file per group). │`,
33
+ ` │ Schema: node_modules/@pepshlr/pepdoc/templates/ │`,
34
+ ` │ ai-skill.md │`,
35
+ ` │ │`,
36
+ ` │ 3. Start the server and tell me the docs URL. │`,
37
+ ` └${line}┘`,
38
+ '',
39
+ ];
40
+ process.stderr.write(lines.join('\n') + '\n');
23
41
  //# sourceMappingURL=postinstall.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"postinstall.js","sourceRoot":"","sources":["../../src/bin/postinstall.ts"],"names":[],"mappings":";;AAEA;;;GAGG;AAEH,MAAM,MAAM,GAAG,UAAU,CAAC;AAC1B,MAAM,IAAI,GAAG,UAAU,CAAC;AACxB,MAAM,GAAG,GAAG,SAAS,CAAC;AACtB,MAAM,KAAK,GAAG,SAAS,CAAC;AACxB,MAAM,IAAI,GAAG,SAAS,CAAC;AAEvB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAChB,OAAO,CAAC,GAAG,CAAC,KAAK,MAAM,GAAG,IAAI,UAAU,KAAK,0BAA0B,CAAC,CAAC;AACzE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAChB,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,eAAe,KAAK,EAAE,CAAC,CAAC;AAC7C,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AACvC,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;AACxD,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;AACtC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAChB,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,kDAAkD,KAAK,EAAE,CAAC,CAAC;AAC/E,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,qDAAqD,KAAK,EAAE,CAAC,CAAC;AAClF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC"}
1
+ {"version":3,"file":"postinstall.js","sourceRoot":"","sources":["../../src/bin/postinstall.ts"],"names":[],"mappings":";;AAEA;;;GAGG;AAEH,MAAM,MAAM,GAAG,UAAU,CAAC;AAC1B,MAAM,KAAK,GAAG,UAAU,CAAC;AACzB,MAAM,MAAM,GAAG,UAAU,CAAC;AAC1B,MAAM,GAAG,GAAG,SAAS,CAAC;AACtB,MAAM,KAAK,GAAG,SAAS,CAAC;AACxB,MAAM,IAAI,GAAG,SAAS,CAAC;AAEvB,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAE5B,MAAM,KAAK,GAAG;IACZ,EAAE;IACF,KAAK,MAAM,GAAG,IAAI,YAAY,KAAK,aAAa;IAChD,EAAE;IACF,KAAK,KAAK,GAAG,IAAI,iDAAiD,KAAK,EAAE;IACzE,KAAK,GAAG,6DAA6D,KAAK,EAAE;IAC5E,EAAE;IACF,MAAM,IAAI,GAAG;IACb,OAAO,MAAM,4DAA4D,KAAK,IAAI;IAClF,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,gEAAgE;IAChE,MAAM,IAAI,GAAG;IACb,EAAE;CACH,CAAC;AAEF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pepshlr/pepdoc",
3
- "version": "0.2.0",
3
+ "version": "0.2.2",
4
4
  "description": "API documentation, beautifully automated.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",