@malikasadjaved/readme-ai 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 +131 -41
- package/dist/analyzers/badge-generator.js +27 -27
- package/dist/analyzers/badge-generator.js.map +1 -1
- package/dist/analyzers/code-analyzer.js +37 -2
- package/dist/analyzers/code-analyzer.js.map +1 -1
- package/dist/analyzers/dependency-analyzer.d.ts.map +1 -1
- package/dist/analyzers/dependency-analyzer.js +203 -26
- package/dist/analyzers/dependency-analyzer.js.map +1 -1
- package/dist/analyzers/diagram-builder.js +19 -18
- package/dist/analyzers/diagram-builder.js.map +1 -1
- package/dist/analyzers/file-scanner.d.ts.map +1 -1
- package/dist/analyzers/file-scanner.js +13 -13
- package/dist/analyzers/file-scanner.js.map +1 -1
- package/dist/analyzers/index.d.ts +1 -1
- package/dist/analyzers/index.d.ts.map +1 -1
- package/dist/analyzers/index.js +1 -1
- package/dist/analyzers/index.js.map +1 -1
- package/dist/analyzers/repo-fetcher.d.ts.map +1 -1
- package/dist/analyzers/repo-fetcher.js +40 -13
- package/dist/analyzers/repo-fetcher.js.map +1 -1
- package/dist/cli.js +1 -1
- package/dist/cli.js.map +1 -1
- package/dist/commands/generate.d.ts.map +1 -1
- package/dist/commands/generate.js +58 -6
- package/dist/commands/generate.js.map +1 -1
- package/dist/config.d.ts +14 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +24 -0
- package/dist/config.js.map +1 -1
- package/dist/generators/contributing.js +3 -3
- package/dist/generators/contributing.js.map +1 -1
- package/dist/generators/index.d.ts +1 -1
- package/dist/generators/index.d.ts.map +1 -1
- package/dist/generators/index.js +1 -1
- package/dist/generators/index.js.map +1 -1
- package/dist/generators/install.d.ts.map +1 -1
- package/dist/generators/install.js.map +1 -1
- package/dist/generators/overview.d.ts.map +1 -1
- package/dist/generators/overview.js +12 -5
- package/dist/generators/overview.js.map +1 -1
- package/dist/generators/usage.d.ts.map +1 -1
- package/dist/generators/usage.js +15 -9
- package/dist/generators/usage.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/plugins/index.d.ts +49 -0
- package/dist/plugins/index.d.ts.map +1 -0
- package/dist/plugins/index.js +113 -0
- package/dist/plugins/index.js.map +1 -0
- package/dist/providers/anthropic.d.ts.map +1 -1
- package/dist/providers/anthropic.js +4 -1
- package/dist/providers/anthropic.js.map +1 -1
- package/dist/providers/gemini.d.ts.map +1 -1
- package/dist/providers/gemini.js +5 -1
- package/dist/providers/gemini.js.map +1 -1
- package/dist/providers/index.d.ts +1 -0
- package/dist/providers/index.d.ts.map +1 -1
- package/dist/providers/index.js +31 -2
- package/dist/providers/index.js.map +1 -1
- package/dist/providers/ollama.d.ts.map +1 -1
- package/dist/providers/ollama.js +6 -3
- package/dist/providers/ollama.js.map +1 -1
- package/dist/providers/openai.d.ts.map +1 -1
- package/dist/providers/openai.js.map +1 -1
- package/dist/themes/academic.js +2 -2
- package/dist/themes/academic.js.map +1 -1
- package/dist/themes/default.js +2 -2
- package/dist/themes/default.js.map +1 -1
- package/dist/themes/hacker.js +4 -4
- package/dist/themes/hacker.js.map +1 -1
- package/dist/themes/index.d.ts.map +1 -1
- package/dist/themes/index.js +7 -2
- package/dist/themes/index.js.map +1 -1
- package/dist/themes/minimal.js +3 -3
- package/dist/themes/minimal.js.map +1 -1
- package/dist/themes/modern.js +2 -2
- package/dist/themes/modern.js.map +1 -1
- package/dist/utils/cache.d.ts +4 -0
- package/dist/utils/cache.d.ts.map +1 -0
- package/dist/utils/cache.js +48 -0
- package/dist/utils/cache.js.map +1 -0
- package/dist/utils/file-utils.d.ts.map +1 -1
- package/dist/utils/file-utils.js +45 -13
- package/dist/utils/file-utils.js.map +1 -1
- package/dist/utils/github-api.d.ts.map +1 -1
- package/dist/utils/github-api.js +2 -2
- package/dist/utils/github-api.js.map +1 -1
- package/dist/utils/language-detector.d.ts.map +1 -1
- package/dist/utils/language-detector.js +56 -30
- package/dist/utils/language-detector.js.map +1 -1
- package/dist/utils/markdown-writer.d.ts.map +1 -1
- package/dist/utils/markdown-writer.js +1 -3
- package/dist/utils/markdown-writer.js.map +1 -1
- package/dist/utils/template-engine.d.ts.map +1 -1
- package/dist/utils/template-engine.js +6 -3
- package/dist/utils/template-engine.js.map +1 -1
- package/package.json +76 -8
|
@@ -6,11 +6,34 @@ import { globFiles, loadIgnorePatterns, readFileContent, fileExists, getFileExte
|
|
|
6
6
|
import { detectLanguage, isConfigFile, isTestFile, isEntryPoint, } from '../utils/language-detector.js';
|
|
7
7
|
const MAX_REMOTE_FILES = 100;
|
|
8
8
|
const SOURCE_EXTENSIONS = new Set([
|
|
9
|
-
'ts',
|
|
10
|
-
'
|
|
11
|
-
'
|
|
12
|
-
'
|
|
13
|
-
'
|
|
9
|
+
'ts',
|
|
10
|
+
'tsx',
|
|
11
|
+
'js',
|
|
12
|
+
'jsx',
|
|
13
|
+
'mjs',
|
|
14
|
+
'cjs',
|
|
15
|
+
'py',
|
|
16
|
+
'rs',
|
|
17
|
+
'go',
|
|
18
|
+
'java',
|
|
19
|
+
'kt',
|
|
20
|
+
'swift',
|
|
21
|
+
'rb',
|
|
22
|
+
'php',
|
|
23
|
+
'cs',
|
|
24
|
+
'cpp',
|
|
25
|
+
'c',
|
|
26
|
+
'h',
|
|
27
|
+
'vue',
|
|
28
|
+
'svelte',
|
|
29
|
+
'dart',
|
|
30
|
+
'ex',
|
|
31
|
+
'exs',
|
|
32
|
+
'scala',
|
|
33
|
+
'lua',
|
|
34
|
+
'r',
|
|
35
|
+
'zig',
|
|
36
|
+
'sh',
|
|
14
37
|
]);
|
|
15
38
|
export async function fetchRepo(input) {
|
|
16
39
|
const github = parseGitHubURL(input);
|
|
@@ -26,7 +49,7 @@ async function fetchLocalRepo(repoPath) {
|
|
|
26
49
|
}
|
|
27
50
|
const ignores = await loadIgnorePatterns(repoPath);
|
|
28
51
|
const relativePaths = await globFiles(repoPath, ignores);
|
|
29
|
-
const files = relativePaths.map(relPath => {
|
|
52
|
+
const files = relativePaths.map((relPath) => {
|
|
30
53
|
const absPath = path.join(repoPath, relPath);
|
|
31
54
|
return {
|
|
32
55
|
path: relPath,
|
|
@@ -44,7 +67,9 @@ async function fetchLocalRepo(repoPath) {
|
|
|
44
67
|
try {
|
|
45
68
|
result.packageJson = JSON.parse(await readFileContent(pkgPath));
|
|
46
69
|
}
|
|
47
|
-
catch {
|
|
70
|
+
catch {
|
|
71
|
+
/* ignore parse errors */
|
|
72
|
+
}
|
|
48
73
|
}
|
|
49
74
|
const reqPath = path.join(repoPath, 'requirements.txt');
|
|
50
75
|
if (await fileExists(reqPath)) {
|
|
@@ -67,17 +92,17 @@ async function fetchRemoteRepo(owner, repo, branch) {
|
|
|
67
92
|
await fs.mkdir(tmpDir, { recursive: true });
|
|
68
93
|
// Filter to source files and important configs, limit count
|
|
69
94
|
const prioritized = treeEntries
|
|
70
|
-
.filter(entry => {
|
|
95
|
+
.filter((entry) => {
|
|
71
96
|
const ext = getFileExtension(entry.path);
|
|
72
97
|
const name = entry.path.split('/').pop() || '';
|
|
73
|
-
return SOURCE_EXTENSIONS.has(ext) ||
|
|
98
|
+
return (SOURCE_EXTENSIONS.has(ext) ||
|
|
74
99
|
name === 'package.json' ||
|
|
75
100
|
name === 'requirements.txt' ||
|
|
76
101
|
name === 'Cargo.toml' ||
|
|
77
102
|
name === 'go.mod' ||
|
|
78
103
|
name === 'pyproject.toml' ||
|
|
79
104
|
name === 'Dockerfile' ||
|
|
80
|
-
name === 'Makefile';
|
|
105
|
+
name === 'Makefile');
|
|
81
106
|
})
|
|
82
107
|
.sort((a, b) => {
|
|
83
108
|
// Prioritize entry points and configs
|
|
@@ -105,7 +130,7 @@ async function fetchRemoteRepo(owner, repo, branch) {
|
|
|
105
130
|
}
|
|
106
131
|
}));
|
|
107
132
|
}
|
|
108
|
-
const files = prioritized.map(entry => ({
|
|
133
|
+
const files = prioritized.map((entry) => ({
|
|
109
134
|
path: entry.path,
|
|
110
135
|
absolutePath: path.join(tmpDir, entry.path),
|
|
111
136
|
language: detectLanguage(entry.path),
|
|
@@ -121,13 +146,15 @@ async function fetchRemoteRepo(owner, repo, branch) {
|
|
|
121
146
|
githubMeta,
|
|
122
147
|
};
|
|
123
148
|
// Parse package.json if downloaded
|
|
124
|
-
const pkgFile = files.find(f => f.path === 'package.json');
|
|
149
|
+
const pkgFile = files.find((f) => f.path === 'package.json');
|
|
125
150
|
if (pkgFile) {
|
|
126
151
|
try {
|
|
127
152
|
const content = await readFileContent(pkgFile.absolutePath);
|
|
128
153
|
result.packageJson = JSON.parse(content);
|
|
129
154
|
}
|
|
130
|
-
catch {
|
|
155
|
+
catch {
|
|
156
|
+
/* ignore */
|
|
157
|
+
}
|
|
131
158
|
}
|
|
132
159
|
return result;
|
|
133
160
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"repo-fetcher.js","sourceRoot":"","sources":["../../src/analyzers/repo-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,sBAAsB,GAEvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,SAAS,EACT,kBAAkB,EAClB,eAAe,EACf,UAAU,EACV,gBAAgB,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,cAAc,EACd,YAAY,EACZ,UAAU,EACV,YAAY,GACb,MAAM,+BAA+B,CAAC;AAuBvC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,IAAI,
|
|
1
|
+
{"version":3,"file":"repo-fetcher.js","sourceRoot":"","sources":["../../src/analyzers/repo-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,sBAAsB,GAEvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,SAAS,EACT,kBAAkB,EAClB,eAAe,EACf,UAAU,EACV,gBAAgB,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,cAAc,EACd,YAAY,EACZ,UAAU,EACV,YAAY,GACb,MAAM,+BAA+B,CAAC;AAuBvC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,KAAK;IACL,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,MAAM;IACN,IAAI;IACJ,OAAO;IACP,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,GAAG;IACH,GAAG;IACH,KAAK;IACL,QAAQ;IACR,MAAM;IACN,IAAI;IACJ,KAAK;IACL,OAAO;IACP,KAAK;IACL,GAAG;IACH,KAAK;IACL,IAAI;CACL,CAAC,CAAC;AAEH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,KAAa;IAC3C,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,QAAgB;IAC5C,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACnD,MAAM,aAAa,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEzD,MAAM,KAAK,GAAgB,aAAa,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACvD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC7C,OAAO;YACL,IAAI,EAAE,OAAO;YACb,YAAY,EAAE,OAAO;YACrB,QAAQ,EAAE,cAAc,CAAC,OAAO,CAAC;YACjC,IAAI,EAAE,CAAC;YACP,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC;YACnC,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC;YAC/B,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC;SAC5B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IAEvE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IACpD,IAAI,MAAM,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,IAAI,CAAC;YACH,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACP,yBAAyB;QAC3B,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;IACxD,IAAI,MAAM,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,kBAAkB,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IACpD,IAAI,MAAM,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,MAAM,CAAC,SAAS,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAChD,IAAI,MAAM,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,MAAM,CAAC,KAAK,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,KAAa,EAAE,IAAY,EAAE,MAAe;IACzE,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,aAAa,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5C,4DAA4D;IAC5D,MAAM,WAAW,GAAG,WAAW;SAC5B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,MAAM,GAAG,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QAC/C,OAAO,CACL,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC;YAC1B,IAAI,KAAK,cAAc;YACvB,IAAI,KAAK,kBAAkB;YAC3B,IAAI,KAAK,YAAY;YACrB,IAAI,KAAK,QAAQ;YACjB,IAAI,KAAK,gBAAgB;YACzB,IAAI,KAAK,YAAY;YACrB,IAAI,KAAK,UAAU,CACpB,CAAC;IACJ,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACb,sCAAsC;QACtC,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,IAAI,MAAM,KAAK,MAAM;YAAE,OAAO,MAAM,GAAG,MAAM,CAAC;QAC9C,uCAAuC;QACvC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7D,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;IAE9B,qCAAqC;IACrC,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC;QACvD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC;QAClD,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACxB,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,sBAAsB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC9E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC/C,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5D,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACjD,CAAC;YAAC,MAAM,CAAC;gBACP,mCAAmC;YACrC,CAAC;QACH,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAgB,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACrD,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;QAC3C,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC;QACpC,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC;QACtC,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC;KAC/B,CAAC,CAAC,CAAC;IAEJ,MAAM,MAAM,GAAgB;QAC1B,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,KAAK;QACL,UAAU;KACX,CAAC;IAEF,mCAAmC;IACnC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;IAC7D,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC5D,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC;QAAC,MAAM,CAAC;YACP,YAAY;QACd,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/dist/cli.js
CHANGED
|
@@ -2,7 +2,7 @@ import chalk from 'chalk';
|
|
|
2
2
|
import { input, select, checkbox } from '@inquirer/prompts';
|
|
3
3
|
import { runGenerate } from './commands/generate.js';
|
|
4
4
|
export async function runCLI() {
|
|
5
|
-
console.log(chalk.cyan.bold(
|
|
5
|
+
console.log(chalk.cyan.bold("\n✨ readme-ai — Let's generate your README\n"));
|
|
6
6
|
const repoPath = await input({
|
|
7
7
|
message: 'Path to your project (or GitHub URL):',
|
|
8
8
|
default: '.',
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC,CAAC;IAE7E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC;QAC3B,OAAO,EAAE,uCAAuC;QAChD,OAAO,EAAE,GAAG;KACb,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC;QAC5B,OAAO,EAAE,0BAA0B;QACnC,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,qCAAqC,EAAE,KAAK,EAAE,WAAW,EAAE;YACnE,EAAE,IAAI,EAAE,yBAAyB,EAAE,KAAK,EAAE,QAAQ,EAAE;YACpD,EAAE,IAAI,EAAE,0BAA0B,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrD,EAAE,IAAI,EAAE,6BAA6B,EAAE,KAAK,EAAE,QAAQ,EAAE;SACzD;KACF,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC;QACzB,OAAO,EAAE,sBAAsB;QAC/B,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,mCAAmC,EAAE,KAAK,EAAE,SAAS,EAAE;YAC/D,EAAE,IAAI,EAAE,4CAA4C,EAAE,KAAK,EAAE,QAAQ,EAAE;YACvE,EAAE,IAAI,EAAE,2CAA2C,EAAE,KAAK,EAAE,QAAQ,EAAE;YACtE,EAAE,IAAI,EAAE,uCAAuC,EAAE,KAAK,EAAE,SAAS,EAAE;YACnE,EAAE,IAAI,EAAE,sCAAsC,EAAE,KAAK,EAAE,UAAU,EAAE;SACpE;KACF,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC;QAC7B,OAAO,EAAE,kBAAkB;QAC3B,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,qCAAqC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;YAChF,EAAE,IAAI,EAAE,4BAA4B,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;YACtE,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;YACjE,EAAE,IAAI,EAAE,mCAAmC,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE;SAC/E;KACF,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC;QAC1B,OAAO,EAAE,gDAAgD;QACzD,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAEpC,MAAM,WAAW,CAAC;QAChB,IAAI,EAAE,QAAQ;QACd,QAAQ;QACR,KAAK;QACL,OAAO,EAAE,OAAO,IAAI,SAAS;QAC7B,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC;QAClC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC;QAChC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC;QAClC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC;KACjC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"AAqBA,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,eAAe,iBA6LtD"}
|
|
@@ -9,17 +9,42 @@ import { analyzeDependencies } from '../analyzers/dependency-analyzer.js';
|
|
|
9
9
|
import { analyzeCode } from '../analyzers/code-analyzer.js';
|
|
10
10
|
import { generateBadges, formatBadgeRow } from '../analyzers/badge-generator.js';
|
|
11
11
|
import { buildDiagram } from '../analyzers/diagram-builder.js';
|
|
12
|
-
import {
|
|
12
|
+
import { createCachedProvider } from '../providers/index.js';
|
|
13
13
|
import { generateOverview } from '../generators/overview.js';
|
|
14
14
|
import { generateInstallSection } from '../generators/install.js';
|
|
15
15
|
import { generateUsageSection, generateAPIDocs } from '../generators/usage.js';
|
|
16
16
|
import { generateContributing, getLicense } from '../generators/contributing.js';
|
|
17
17
|
import { getTheme } from '../themes/index.js';
|
|
18
18
|
import { fileExists } from '../utils/file-utils.js';
|
|
19
|
+
import { loadProjectConfig } from '../config.js';
|
|
20
|
+
import { loadPlugins, runAnalyzerPlugins } from '../plugins/index.js';
|
|
19
21
|
export async function runGenerate(opts) {
|
|
20
22
|
const spinner = ora();
|
|
21
23
|
const startTime = Date.now();
|
|
22
24
|
try {
|
|
25
|
+
// ─── PHASE 0: LOAD PROJECT CONFIG ────────────────────────────────
|
|
26
|
+
const projectConfig = await loadProjectConfig(path.resolve(opts.repo || '.'));
|
|
27
|
+
// CLI flags override project config; project config overrides defaults
|
|
28
|
+
if (projectConfig.provider && !opts.provider)
|
|
29
|
+
opts.provider = projectConfig.provider;
|
|
30
|
+
if (projectConfig.model && !opts.model)
|
|
31
|
+
opts.model = projectConfig.model;
|
|
32
|
+
if (projectConfig.theme && !opts.theme)
|
|
33
|
+
opts.theme = projectConfig.theme;
|
|
34
|
+
if (projectConfig.output && !opts.output)
|
|
35
|
+
opts.output = projectConfig.output;
|
|
36
|
+
if (projectConfig.context && !opts.context)
|
|
37
|
+
opts.context = projectConfig.context;
|
|
38
|
+
if (projectConfig.diagram === false && opts.diagram === undefined)
|
|
39
|
+
opts.diagram = false;
|
|
40
|
+
if (projectConfig.badges === false && opts.badges === undefined)
|
|
41
|
+
opts.badges = false;
|
|
42
|
+
if (projectConfig.apiDocs === false && opts.apiDocs === undefined)
|
|
43
|
+
opts.apiDocs = false;
|
|
44
|
+
if (projectConfig.action === true && !opts.action)
|
|
45
|
+
opts.action = true;
|
|
46
|
+
// ─── PHASE 0b: LOAD PLUGINS ────────────────────────────────────────
|
|
47
|
+
await loadPlugins(path.resolve(opts.repo || '.'));
|
|
23
48
|
// ─── PHASE 1: FETCH ──────────────────────────────────────────────
|
|
24
49
|
spinner.start('Fetching repository...');
|
|
25
50
|
const repoContent = await fetchRepo(opts.repo);
|
|
@@ -37,8 +62,16 @@ export async function runGenerate(opts) {
|
|
|
37
62
|
spinner.start('Analyzing dependencies...');
|
|
38
63
|
const deps = await analyzeDependencies(repoContent);
|
|
39
64
|
spinner.succeed(`Package manager: ${deps.packageManager || 'None detected'}`);
|
|
65
|
+
// Run analyzer plugins
|
|
66
|
+
let pluginResults = [];
|
|
67
|
+
const pluginAnalyzers = (await import('../plugins/index.js')).getAnalyzerPlugins();
|
|
68
|
+
if (pluginAnalyzers.length > 0) {
|
|
69
|
+
spinner.start('Running analyzer plugins...');
|
|
70
|
+
pluginResults = await runAnalyzerPlugins({ scan, codeAnalysis, deps });
|
|
71
|
+
spinner.succeed(`${pluginAnalyzers.length} analyzer plugin(s) executed`);
|
|
72
|
+
}
|
|
40
73
|
// ─── PHASE 3: GENERATE WITH AI ───────────────────────────────────
|
|
41
|
-
const provider = await
|
|
74
|
+
const provider = await createCachedProvider(opts.provider || 'anthropic', opts.model);
|
|
42
75
|
spinner.start('Generating project overview with AI...');
|
|
43
76
|
const existingDescription = repoContent.packageJson
|
|
44
77
|
? repoContent.packageJson.description
|
|
@@ -75,6 +108,18 @@ export async function runGenerate(opts) {
|
|
|
75
108
|
if (opts.badges !== false) {
|
|
76
109
|
spinner.start('Generating badges...');
|
|
77
110
|
const badges = generateBadges(scan, deps, repoContent.githubMeta);
|
|
111
|
+
// Append badges from analyzer plugins
|
|
112
|
+
for (const result of pluginResults) {
|
|
113
|
+
if (result.badges) {
|
|
114
|
+
for (const b of result.badges) {
|
|
115
|
+
const badgeUrl = `https://img.shields.io/badge/${encodeURIComponent(b.label)}-${encodeURIComponent(b.message)}-${b.color}`;
|
|
116
|
+
const markdown = b.url
|
|
117
|
+
? `[](${b.url})`
|
|
118
|
+
: ``;
|
|
119
|
+
badges.push({ label: b.label, url: badgeUrl, markdown, category: 'meta' });
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
}
|
|
78
123
|
badgeRow = formatBadgeRow(badges);
|
|
79
124
|
spinner.succeed(`${badges.length} badges generated`);
|
|
80
125
|
}
|
|
@@ -97,15 +142,22 @@ export async function runGenerate(opts) {
|
|
|
97
142
|
license: getLicense(scan),
|
|
98
143
|
directoryTree: scan.directoryTree,
|
|
99
144
|
});
|
|
145
|
+
// Append plugin sections
|
|
146
|
+
const pluginSections = pluginResults
|
|
147
|
+
.filter((r) => r.sections)
|
|
148
|
+
.flatMap((r) => Object.entries(r.sections))
|
|
149
|
+
.map(([heading, content]) => `## ${heading}\n\n${content}`)
|
|
150
|
+
.join('\n\n');
|
|
151
|
+
const readmeWithPlugins = pluginSections ? `${readme}\n\n${pluginSections}` : readme;
|
|
100
152
|
spinner.succeed('README rendered');
|
|
101
153
|
// ─── PHASE 5: OUTPUT ─────────────────────────────────────────────
|
|
102
154
|
if (opts.dryRun) {
|
|
103
|
-
console.log('\n' +
|
|
155
|
+
console.log('\n' + readmeWithPlugins);
|
|
104
156
|
return;
|
|
105
157
|
}
|
|
106
158
|
const outputFile = opts.output || 'README.md';
|
|
107
159
|
const outputPath = path.resolve(repoContent.isRemote ? '.' : repoContent.path, outputFile);
|
|
108
|
-
if (await fileExists(outputPath) && !opts.overwrite) {
|
|
160
|
+
if ((await fileExists(outputPath)) && !opts.overwrite) {
|
|
109
161
|
const shouldOverwrite = await confirm({
|
|
110
162
|
message: `${outputFile} already exists. Overwrite?`,
|
|
111
163
|
});
|
|
@@ -114,9 +166,9 @@ export async function runGenerate(opts) {
|
|
|
114
166
|
return;
|
|
115
167
|
}
|
|
116
168
|
}
|
|
117
|
-
await fs.writeFile(outputPath,
|
|
169
|
+
await fs.writeFile(outputPath, readmeWithPlugins, 'utf-8');
|
|
118
170
|
const elapsed = ((Date.now() - startTime) / 1000).toFixed(1);
|
|
119
|
-
const sizeKB = (Buffer.byteLength(
|
|
171
|
+
const sizeKB = (Buffer.byteLength(readmeWithPlugins) / 1024).toFixed(1);
|
|
120
172
|
console.log(`
|
|
121
173
|
${chalk.green('✓')} README generated successfully!
|
|
122
174
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAsB,MAAM,iCAAiC,CAAC;AACnF,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAsB,MAAM,iCAAiC,CAAC;AACnF,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAsB,MAAM,wBAAwB,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAuB,MAAM,qBAAqB,CAAC;AAkB3F,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAqB;IACrD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC;IACtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAE7B,IAAI,CAAC;QACH,oEAAoE;QACpE,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;QAC9E,uEAAuE;QACvE,IAAI,aAAa,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QACrF,IAAI,aAAa,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;QACzE,IAAI,aAAa,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;QACzE,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;QAC7E,IAAI,aAAa,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;QACjF,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;YAAE,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACxF,IAAI,aAAa,CAAC,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACrF,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;YAAE,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACxF,IAAI,aAAa,CAAC,MAAM,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtE,sEAAsE;QACtE,MAAM,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;QAElD,oEAAoE;QACpE,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,CAAC,OAAO,CAAC,sBAAsB,WAAW,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,CAAC;QAExE,oEAAoE;QACpE,OAAO,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,OAAO,CAAC,OAAO,CAAC,aAAa,QAAQ,WAAW,MAAM,EAAE,CAAC,CAAC;QAE1D,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACnC,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,CAAC,OAAO,CACb,SAAS,YAAY,CAAC,YAAY,CAAC,MAAM,cAAc;YACrD,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,gBAAgB,CACvD,CAAC;QAEF,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,OAAO,CAAC,oBAAoB,IAAI,CAAC,cAAc,IAAI,eAAe,EAAE,CAAC,CAAC;QAE9E,uBAAuB;QACvB,IAAI,aAAa,GAAqB,EAAE,CAAC;QACzC,MAAM,eAAe,GAAG,CAAC,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;QACnF,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;YAC7C,aAAa,GAAG,MAAM,kBAAkB,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,OAAO,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,MAAM,8BAA8B,CAAC,CAAC;QAC3E,CAAC;QAED,oEAAoE;QACpE,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,QAAQ,IAAI,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAEtF,OAAO,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACxD,MAAM,mBAAmB,GAAG,WAAW,CAAC,WAAW;YACjD,CAAC,CAAG,WAAW,CAAC,WAAuC,CAAC,WAAkC;YAC1F,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,IAAI,SAAS,CAAC;QACrD,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC;YACtC,IAAI;YACJ,IAAI;YACJ,YAAY;YACZ,QAAQ;YACR,mBAAmB;YACnB,WAAW,EAAE,IAAI,CAAC,OAAO;SAC1B,CAAC,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAEtC,IAAI,OAAO,GAAyB,IAAI,CAAC;QACzC,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC3B,OAAO,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;YAClD,OAAO,GAAG,MAAM,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YACjE,OAAO,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QACzD,MAAM,cAAc,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1D,OAAO,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAE9C,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC9C,MAAM,YAAY,GAAG,MAAM,oBAAoB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxF,OAAO,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,2BAA2B,CAAC,CAAC;QAE5E,IAAI,OAAO,GAAyB,IAAI,CAAC;QACzC,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,YAAY,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9D,OAAO,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;YACjD,OAAO,GAAG,MAAM,eAAe,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC5D,OAAO,CAAC,OAAO,CAAC,0BAA0B,OAAO,CAAC,OAAO,CAAC,MAAM,UAAU,CAAC,CAAC;QAC9E,CAAC;QAED,oEAAoE;QACpE,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAC1B,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YACtC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;YAElE,sCAAsC;YACtC,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;gBACnC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;oBAClB,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;wBAC9B,MAAM,QAAQ,GAAG,gCAAgC,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;wBAC3H,MAAM,QAAQ,GAAG,CAAC,CAAC,GAAG;4BACpB,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,KAAK,QAAQ,MAAM,CAAC,CAAC,GAAG,GAAG;4BAC1C,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK,QAAQ,GAAG,CAAC;wBACjC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;oBAC7E,CAAC;gBACH,CAAC;YACH,CAAC;YAED,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YAClC,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,mBAAmB,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,IAAI,SAAS,CAAC;QAC1C,OAAO,CAAC,KAAK,CAAC,aAAa,SAAS,WAAW,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;QAElC,MAAM,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YAC1B,WAAW;YACX,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,QAAQ;YACR,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,OAAO;YACP,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,cAAc;YACd,YAAY;YACZ,OAAO;YACP,mBAAmB,EAAE,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC;YACrD,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;YACzB,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAC;QACH,yBAAyB;QACzB,MAAM,cAAc,GAAG,aAAa;aACjC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACzB,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAS,CAAC,CAAC;aAC3C,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,MAAM,OAAO,OAAO,OAAO,EAAE,CAAC;aAC1D,IAAI,CAAC,MAAM,CAAC,CAAC;QAChB,MAAM,iBAAiB,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,MAAM,OAAO,cAAc,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QAErF,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAEnC,oEAAoE;QACpE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,iBAAiB,CAAC,CAAC;YACtC,OAAO;QACT,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAE3F,IAAI,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACtD,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC;gBACpC,OAAO,EAAE,GAAG,UAAU,6BAA6B;aACpD,CAAC,CAAC;YACH,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;gBACtC,OAAO;YACT,CAAC;QACH,CAAC;QAED,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAExE,OAAO,CAAC,GAAG,CAAC;EACd,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;;IAEd,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,UAAU;IACpC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,SAAS;IACnC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,MAAM;IAChC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,OAAO;;IAEjC,KAAK,CAAC,GAAG,CAAC,0CAA0C,CAAC;CACxD,CAAC,CAAC;QAEC,oCAAoC;QACpC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,oBAAoB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAC1E,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,IAIvB;IACC,IAAI,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IACjD,IAAI,IAAI,CAAC,WAAW,EAAE,IAAI;QAAE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAc,CAAC;IACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,QAAgB;IAClD,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmCvB,CAAC;IAEA,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IAC9D,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;AACxF,CAAC"}
|
package/dist/config.d.ts
CHANGED
|
@@ -10,8 +10,22 @@ export interface ReadmeAIConfig {
|
|
|
10
10
|
default_theme?: string;
|
|
11
11
|
default_output?: string;
|
|
12
12
|
}
|
|
13
|
+
export interface ProjectConfig {
|
|
14
|
+
provider?: string;
|
|
15
|
+
model?: string;
|
|
16
|
+
theme?: string;
|
|
17
|
+
output?: string;
|
|
18
|
+
diagram?: boolean;
|
|
19
|
+
badges?: boolean;
|
|
20
|
+
apiDocs?: boolean;
|
|
21
|
+
action?: boolean;
|
|
22
|
+
context?: string;
|
|
23
|
+
ignore?: string[];
|
|
24
|
+
plugins?: string[];
|
|
25
|
+
}
|
|
13
26
|
export declare const config: Conf<ReadmeAIConfig>;
|
|
14
27
|
export declare function getAPIKey(provider: string): string | undefined;
|
|
15
28
|
export declare function getGitHubToken(): string | undefined;
|
|
16
29
|
export declare function getOllamaURL(): string;
|
|
30
|
+
export declare function loadProjectConfig(repoPath: string): Promise<ProjectConfig>;
|
|
17
31
|
//# sourceMappingURL=config.d.ts.map
|
package/dist/config.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAKxB,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,eAAO,MAAM,MAAM,sBAOjB,CAAC;AAEH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAW9D;AAED,wBAAgB,cAAc,IAAI,MAAM,GAAG,SAAS,CAEnD;AAED,wBAAgB,YAAY,IAAI,MAAM,CAErC;AAID,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAqBhF"}
|
package/dist/config.js
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import Conf from 'conf';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import { pathToFileURL } from 'node:url';
|
|
4
|
+
import fs from 'node:fs/promises';
|
|
2
5
|
export const config = new Conf({
|
|
3
6
|
projectName: 'readme-ai',
|
|
4
7
|
defaults: {
|
|
@@ -25,4 +28,25 @@ export function getGitHubToken() {
|
|
|
25
28
|
export function getOllamaURL() {
|
|
26
29
|
return process.env.OLLAMA_BASE_URL || config.get('ollama_url') || 'http://localhost:11434';
|
|
27
30
|
}
|
|
31
|
+
const CONFIG_FILES = ['readme-ai.config.js', 'readme-ai.config.mjs', '.readmeairc.json'];
|
|
32
|
+
export async function loadProjectConfig(repoPath) {
|
|
33
|
+
for (const filename of CONFIG_FILES) {
|
|
34
|
+
const filePath = path.join(repoPath, filename);
|
|
35
|
+
try {
|
|
36
|
+
await fs.access(filePath);
|
|
37
|
+
}
|
|
38
|
+
catch {
|
|
39
|
+
continue;
|
|
40
|
+
}
|
|
41
|
+
if (filename.endsWith('.json')) {
|
|
42
|
+
const content = await fs.readFile(filePath, 'utf-8');
|
|
43
|
+
return JSON.parse(content);
|
|
44
|
+
}
|
|
45
|
+
// JS/MJS config — dynamic import
|
|
46
|
+
const fileUrl = pathToFileURL(path.resolve(filePath)).href;
|
|
47
|
+
const mod = await import(fileUrl);
|
|
48
|
+
return (mod.default || mod);
|
|
49
|
+
}
|
|
50
|
+
return {};
|
|
51
|
+
}
|
|
28
52
|
//# sourceMappingURL=config.js.map
|
package/dist/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,kBAAkB,CAAC;AA4BlC,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,IAAI,CAAiB;IAC7C,WAAW,EAAE,WAAW;IACxB,QAAQ,EAAE;QACR,QAAQ,EAAE,WAAW;QACrB,aAAa,EAAE,SAAS;QACxB,cAAc,EAAE,WAAW;KAC5B;CACF,CAAC,CAAC;AAEH,MAAM,UAAU,SAAS,CAAC,QAAgB;IACxC,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,WAAW;YACd,OAAO,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAC1E,KAAK,QAAQ;YACX,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpE,KAAK,QAAQ;YACX,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpE;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,wBAAwB,CAAC;AAC7F,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,qBAAqB,EAAE,sBAAsB,EAAE,kBAAkB,CAAC,CAAC;AAEzF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,QAAgB;IACtD,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAkB,CAAC;QAC9C,CAAC;QAED,iCAAiC;QACjC,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3D,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAkB,CAAC;IAC/C,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export function generateContributing(scan, deps) {
|
|
2
2
|
const lines = [];
|
|
3
|
-
lines.push(
|
|
3
|
+
lines.push("Contributions are welcome! Here's how to get started:");
|
|
4
4
|
lines.push('');
|
|
5
5
|
lines.push('1. Fork the repository');
|
|
6
6
|
lines.push('2. Create a feature branch (`git checkout -b feature/amazing-feature`)');
|
|
@@ -8,12 +8,12 @@ export function generateContributing(scan, deps) {
|
|
|
8
8
|
if (scan.hasTests) {
|
|
9
9
|
const testCmd = deps?.testCommand || 'npm test';
|
|
10
10
|
lines.push(`4. Run the tests (\`${testCmd}\`)`);
|
|
11
|
-
lines.push(
|
|
11
|
+
lines.push("5. Commit your changes (`git commit -m 'Add amazing feature'`)");
|
|
12
12
|
lines.push('6. Push to the branch (`git push origin feature/amazing-feature`)');
|
|
13
13
|
lines.push('7. Open a Pull Request');
|
|
14
14
|
}
|
|
15
15
|
else {
|
|
16
|
-
lines.push(
|
|
16
|
+
lines.push("4. Commit your changes (`git commit -m 'Add amazing feature'`)");
|
|
17
17
|
lines.push('5. Push to the branch (`git push origin feature/amazing-feature`)');
|
|
18
18
|
lines.push('6. Open a Pull Request');
|
|
19
19
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contributing.js","sourceRoot":"","sources":["../../src/generators/contributing.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,oBAAoB,CAAC,IAAgB,EAAE,IAAyB;IAC9E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"contributing.js","sourceRoot":"","sources":["../../src/generators/contributing.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,oBAAoB,CAAC,IAAgB,EAAE,IAAyB;IAC9E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;IACpE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,KAAK,CAAC,IAAI,CAAC,wEAAwE,CAAC,CAAC;IACrF,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAEnC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,IAAI,EAAE,WAAW,IAAI,UAAU,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,uBAAuB,OAAO,KAAK,CAAC,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAC7E,KAAK,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QAChF,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAC7E,KAAK,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QAChF,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAgB;IACzC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO,sCAAsC,IAAI,CAAC,UAAU,yDAAyD,CAAC;IACxH,CAAC;IACD,OAAO,8CAA8C,CAAC;AACxD,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { generateOverview, type OverviewResult } from './overview.js';
|
|
2
2
|
export { generateInstallSection, type InstallResult, type InstallStep } from './install.js';
|
|
3
|
-
export { generateUsageSection, generateAPIDocs, type UsageResult, type UsageExample, type APIDocsResult, type APIDocEntry } from './usage.js';
|
|
3
|
+
export { generateUsageSection, generateAPIDocs, type UsageResult, type UsageExample, type APIDocsResult, type APIDocEntry, } from './usage.js';
|
|
4
4
|
export { generateContributing, getLicense } from './contributing.js';
|
|
5
5
|
export { generateChangelogSection, type ChangelogEntry } from './changelog.js';
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,WAAW,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC"}
|
package/dist/generators/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { generateOverview } from './overview.js';
|
|
2
2
|
export { generateInstallSection } from './install.js';
|
|
3
|
-
export { generateUsageSection, generateAPIDocs } from './usage.js';
|
|
3
|
+
export { generateUsageSection, generateAPIDocs, } from './usage.js';
|
|
4
4
|
export { generateContributing, getLicense } from './contributing.js';
|
|
5
5
|
export { generateChangelogSection } from './changelog.js';
|
|
6
6
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAuB,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAwC,MAAM,cAAc,CAAC;AAC5F,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAuB,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAwC,MAAM,cAAc,CAAC;AAC5F,OAAO,EACL,oBAAoB,EACpB,eAAe,GAKhB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAuB,MAAM,gBAAgB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../src/generators/install.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,GAAG,aAAa,
|
|
1
|
+
{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../src/generators/install.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,GAAG,aAAa,CAuGhG"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"install.js","sourceRoot":"","sources":["../../src/generators/install.ts"],"names":[],"mappings":"AAeA,MAAM,UAAU,sBAAsB,CAAC,IAAwB,EAAE,IAAgB;IAC/E,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,YAAY,GAAkB,EAAE,CAAC;IACvC,MAAM,aAAa,GAAkB,EAAE,CAAC;IACxC,IAAI,aAAiC,CAAC;IAEtC,aAAa;IACb,YAAY,CAAC,IAAI,CAAC;QAChB,KAAK,EAAE,sBAAsB;QAC7B,OAAO,EAAE,+CAA+C;KACzD,CAAC,CAAC;IAEH,QAAQ,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,KAAK,KAAK,CAAC;QACX,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACT,aAAa,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,IAAI,OAAO,EAAE,CAAC,CAAC;YAC7D,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;gBAClC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC1C,CAAC;YACD,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,YAAY,CAAC,IAAI,CAAC;oBAChB,KAAK,EAAE,mBAAmB;oBAC1B,OAAO,EAAE,IAAI,CAAC,YAAY;iBAC3B,CAAC,CAAC;YACL,CAAC;YACD,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER,KAAK,KAAK;YACR,aAAa,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,aAAa,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC/D,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,8BAA8B;gBACrC,OAAO,
|
|
1
|
+
{"version":3,"file":"install.js","sourceRoot":"","sources":["../../src/generators/install.ts"],"names":[],"mappings":"AAeA,MAAM,UAAU,sBAAsB,CAAC,IAAwB,EAAE,IAAgB;IAC/E,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,YAAY,GAAkB,EAAE,CAAC;IACvC,MAAM,aAAa,GAAkB,EAAE,CAAC;IACxC,IAAI,aAAiC,CAAC;IAEtC,aAAa;IACb,YAAY,CAAC,IAAI,CAAC;QAChB,KAAK,EAAE,sBAAsB;QAC7B,OAAO,EAAE,+CAA+C;KACzD,CAAC,CAAC;IAEH,QAAQ,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,KAAK,KAAK,CAAC;QACX,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACT,aAAa,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,IAAI,OAAO,EAAE,CAAC,CAAC;YAC7D,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;gBAClC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC1C,CAAC;YACD,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,YAAY,CAAC,IAAI,CAAC;oBAChB,KAAK,EAAE,mBAAmB;oBAC1B,OAAO,EAAE,IAAI,CAAC,YAAY;iBAC3B,CAAC,CAAC;YACL,CAAC;YACD,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER,KAAK,KAAK;YACR,aAAa,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,aAAa,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC/D,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,8BAA8B;gBACrC,OAAO,EACL,sFAAsF;aACzF,CAAC,CAAC;YACH,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER,KAAK,OAAO;YACV,aAAa,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAC3C,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,mBAAmB;gBAC1B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER,KAAK,IAAI;YACP,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,uBAAuB;gBAC9B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,YAAY,CAAC,IAAI,CAAC;oBAChB,KAAK,EAAE,mBAAmB;oBAC1B,OAAO,EAAE,IAAI,CAAC,YAAY;iBAC3B,CAAC,CAAC;YACL,CAAC;YACD,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER;YACE,gCAAgC;YAChC,MAAM;IACV,CAAC;IAED,oBAAoB;IACpB,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,aAAa,CAAC,IAAI,CAAC;YACjB,KAAK,EAAE,mCAAmC;YAC1C,OAAO,EAAE,sBAAsB;SAChC,CAAC,CAAC;QACH,aAAa,CAAC,IAAI,CAAC;YACjB,KAAK,EAAE,mCAAmC;YAC1C,OAAO,EAAE,6CAA6C;SACvD,CAAC,CAAC;IACL,CAAC;IAED,sBAAsB;IACtB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,YAAY,CAAC,IAAI,CAAC;YAChB,KAAK,EAAE,oBAAoB;YAC3B,OAAO,EAAE,2BAA2B;SACrC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,aAAa;QACb,YAAY;QACZ,aAAa,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;QACnE,aAAa;KACd,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"overview.d.ts","sourceRoot":"","sources":["../../src/generators/overview.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,kBAAkB,CAAC;IACzB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,UAAU,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC,cAAc,CAAC,
|
|
1
|
+
{"version":3,"file":"overview.d.ts","sourceRoot":"","sources":["../../src/generators/overview.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,kBAAkB,CAAC;IACzB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,UAAU,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC,cAAc,CAAC,CA2D1B"}
|
|
@@ -4,7 +4,10 @@ export async function generateOverview(params) {
|
|
|
4
4
|
|
|
5
5
|
PROJECT INFO:
|
|
6
6
|
- Primary language: ${scan.languages[0]?.name || 'Unknown'} (${scan.languages[0]?.percentage || 0}%)
|
|
7
|
-
- Other languages: ${scan.languages
|
|
7
|
+
- Other languages: ${scan.languages
|
|
8
|
+
.slice(1, 4)
|
|
9
|
+
.map((l) => l.name)
|
|
10
|
+
.join(', ') || 'None'}
|
|
8
11
|
- Frameworks: ${scan.frameworks.join(', ') || 'None detected'}
|
|
9
12
|
- Package manager: ${deps.packageManager || 'None detected'}
|
|
10
13
|
- Has tests: ${scan.hasTests}
|
|
@@ -23,9 +26,12 @@ ENTRY POINTS:
|
|
|
23
26
|
${scan.entryPoints.join(', ') || 'None found'}
|
|
24
27
|
|
|
25
28
|
KEY CODE PATTERNS DETECTED:
|
|
26
|
-
- API Endpoints: ${codeAnalysis.apiEndpoints.map(e => `${e.method} ${e.path}`).join(', ') || 'None'}
|
|
27
|
-
- CLI Commands: ${codeAnalysis.cliCommands.map(c => c.name).join(', ') || 'None'}
|
|
28
|
-
- Main exports: ${codeAnalysis.exports
|
|
29
|
+
- API Endpoints: ${codeAnalysis.apiEndpoints.map((e) => `${e.method} ${e.path}`).join(', ') || 'None'}
|
|
30
|
+
- CLI Commands: ${codeAnalysis.cliCommands.map((c) => c.name).join(', ') || 'None'}
|
|
31
|
+
- Main exports: ${codeAnalysis.exports
|
|
32
|
+
.slice(0, 10)
|
|
33
|
+
.map((e) => e.name)
|
|
34
|
+
.join(', ') || 'None'}
|
|
29
35
|
- Environment variables: ${codeAnalysis.envVariables.join(', ') || 'None'}
|
|
30
36
|
|
|
31
37
|
${existingDescription ? `EXISTING DESCRIPTION: ${existingDescription}` : ''}
|
|
@@ -50,7 +56,8 @@ Generate a JSON response with these fields:
|
|
|
50
56
|
function buildFallbackOverview(scan, deps, code, existingDescription) {
|
|
51
57
|
const lang = scan.languages[0]?.name || 'Unknown';
|
|
52
58
|
const frameworks = scan.frameworks;
|
|
53
|
-
const tagline = existingDescription ||
|
|
59
|
+
const tagline = existingDescription ||
|
|
60
|
+
`A ${lang} project${frameworks.length ? ` built with ${frameworks[0]}` : ''}`;
|
|
54
61
|
const parts = [];
|
|
55
62
|
parts.push(`This project is built with ${lang}${frameworks.length ? ` using ${frameworks.join(', ')}` : ''}.`);
|
|
56
63
|
if (code.apiEndpoints.length > 0) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"overview.js","sourceRoot":"","sources":["../../src/generators/overview.ts"],"names":[],"mappings":"AAaA,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAOtC;IACC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,mBAAmB,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAExF,MAAM,MAAM,GAAG;;;sBAGK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"overview.js","sourceRoot":"","sources":["../../src/generators/overview.ts"],"names":[],"mappings":"AAaA,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAOtC;IACC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,mBAAmB,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAExF,MAAM,MAAM,GAAG;;;sBAGK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,IAAI,CAAC;qBAE7F,IAAI,CAAC,SAAS;SACX,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAClB,IAAI,CAAC,IAAI,CAAC,IAAI,MACnB;gBACc,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,eAAe;qBACxC,IAAI,CAAC,cAAc,IAAI,eAAe;eAC5C,IAAI,CAAC,QAAQ;gBACZ,IAAI,CAAC,SAAS;eACf,IAAI,CAAC,OAAO;aACd,IAAI,CAAC,UAAU,IAAI,SAAS;iBACxB,IAAI,CAAC,UAAU;;;EAG9B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;;;EAGvD,IAAI,CAAC,aAAa;;;EAGlB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY;;;mBAG1B,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;kBACnF,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;kBAE9E,YAAY,CAAC,OAAO;SACjB,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;SACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAClB,IAAI,CAAC,IAAI,CAAC,IAAI,MACnB;2BACyB,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;;EAEvE,mBAAmB,CAAC,CAAC,CAAC,yBAAyB,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE;EACzE,WAAW,CAAC,CAAC,CAAC,0BAA0B,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;;;;;;;;;EAS1D,CAAC;IAED,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,YAAY,CAAiB,MAAM,CAAC,CAAC;IAC7D,CAAC;IAAC,MAAM,CAAC;QACP,yCAAyC;QACzC,OAAO,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAC5B,IAAgB,EAChB,IAAwB,EACxB,IAAkB,EAClB,mBAA4B;IAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS,CAAC;IAClD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IAEnC,MAAM,OAAO,GACX,mBAAmB;QACnB,KAAK,IAAI,WAAW,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAEhF,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CACR,8BAA8B,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CACnG,CAAC;IACF,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CACR,cAAc,IAAI,CAAC,YAAY,CAAC,MAAM,gBAAgB,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CACjG,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CACR,eAAe,IAAI,CAAC,WAAW,CAAC,MAAM,eAAe,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAC/F,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IACpE,IAAI,IAAI,CAAC,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;IAE3F,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,UAAU,CAAC,MAAM;QAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5E,IAAI,IAAI,CAAC,QAAQ;QAAE,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACxD,IAAI,IAAI,CAAC,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACpD,IAAI,IAAI,CAAC,OAAO;QAAE,QAAQ,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC7D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,gBAAgB,CAAC,CAAC;IAC7F,IAAI,IAAI,CAAC,gBAAgB;QAAE,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAEjE,OAAO;QACL,OAAO;QACP,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QAC5B,WAAW,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,EAAE,CAAC;QACpE,QAAQ,EAAE,CAAC,YAAY,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,aAAa,EAAE,CAAC;QAChE,cAAc,EAAE,2BAA2B,IAAI,EAAE;KAClD,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/generators/usage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,wBAAsB,oBAAoB,CAAC,MAAM,EAAE;IACjD,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,UAAU,CAAC;CACtB,GAAG,OAAO,CAAC,WAAW,CAAC,
|
|
1
|
+
{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/generators/usage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,wBAAsB,oBAAoB,CAAC,MAAM,EAAE;IACjD,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,UAAU,CAAC;CACtB,GAAG,OAAO,CAAC,WAAW,CAAC,CAgFvB;AAkCD,wBAAsB,eAAe,CAAC,MAAM,EAAE;IAC5C,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,UAAU,CAAC;CACtB,GAAG,OAAO,CAAC,aAAa,CAAC,CAwCzB"}
|