@malikasadjaved/readme-ai 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 (137) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +309 -0
  3. package/dist/analyzers/badge-generator.d.ts +12 -0
  4. package/dist/analyzers/badge-generator.d.ts.map +1 -0
  5. package/dist/analyzers/badge-generator.js +139 -0
  6. package/dist/analyzers/badge-generator.js.map +1 -0
  7. package/dist/analyzers/code-analyzer.d.ts +34 -0
  8. package/dist/analyzers/code-analyzer.d.ts.map +1 -0
  9. package/dist/analyzers/code-analyzer.js +210 -0
  10. package/dist/analyzers/code-analyzer.js.map +1 -0
  11. package/dist/analyzers/dependency-analyzer.d.ts +16 -0
  12. package/dist/analyzers/dependency-analyzer.d.ts.map +1 -0
  13. package/dist/analyzers/dependency-analyzer.js +169 -0
  14. package/dist/analyzers/dependency-analyzer.js.map +1 -0
  15. package/dist/analyzers/diagram-builder.d.ts +11 -0
  16. package/dist/analyzers/diagram-builder.d.ts.map +1 -0
  17. package/dist/analyzers/diagram-builder.js +163 -0
  18. package/dist/analyzers/diagram-builder.js.map +1 -0
  19. package/dist/analyzers/file-scanner.d.ts +17 -0
  20. package/dist/analyzers/file-scanner.d.ts.map +1 -0
  21. package/dist/analyzers/file-scanner.js +103 -0
  22. package/dist/analyzers/file-scanner.js.map +1 -0
  23. package/dist/analyzers/index.d.ts +7 -0
  24. package/dist/analyzers/index.d.ts.map +1 -0
  25. package/dist/analyzers/index.js +7 -0
  26. package/dist/analyzers/index.js.map +1 -0
  27. package/dist/analyzers/repo-fetcher.d.ts +22 -0
  28. package/dist/analyzers/repo-fetcher.d.ts.map +1 -0
  29. package/dist/analyzers/repo-fetcher.js +134 -0
  30. package/dist/analyzers/repo-fetcher.js.map +1 -0
  31. package/dist/cli.d.ts +2 -0
  32. package/dist/cli.d.ts.map +1 -0
  33. package/dist/cli.js +54 -0
  34. package/dist/cli.js.map +1 -0
  35. package/dist/commands/generate.d.ts +17 -0
  36. package/dist/commands/generate.d.ts.map +1 -0
  37. package/dist/commands/generate.js +189 -0
  38. package/dist/commands/generate.js.map +1 -0
  39. package/dist/config.d.ts +17 -0
  40. package/dist/config.d.ts.map +1 -0
  41. package/dist/config.js +28 -0
  42. package/dist/config.js.map +1 -0
  43. package/dist/generators/changelog.d.ts +7 -0
  44. package/dist/generators/changelog.d.ts.map +1 -0
  45. package/dist/generators/changelog.js +15 -0
  46. package/dist/generators/changelog.js.map +1 -0
  47. package/dist/generators/contributing.d.ts +5 -0
  48. package/dist/generators/contributing.d.ts.map +1 -0
  49. package/dist/generators/contributing.js +28 -0
  50. package/dist/generators/contributing.js.map +1 -0
  51. package/dist/generators/index.d.ts +6 -0
  52. package/dist/generators/index.d.ts.map +1 -0
  53. package/dist/generators/index.js +6 -0
  54. package/dist/generators/index.js.map +1 -0
  55. package/dist/generators/install.d.ts +14 -0
  56. package/dist/generators/install.d.ts.map +1 -0
  57. package/dist/generators/install.js +95 -0
  58. package/dist/generators/install.js.map +1 -0
  59. package/dist/generators/overview.d.ts +20 -0
  60. package/dist/generators/overview.d.ts.map +1 -0
  61. package/dist/generators/overview.js +87 -0
  62. package/dist/generators/overview.js.map +1 -0
  63. package/dist/generators/usage.d.ts +33 -0
  64. package/dist/generators/usage.d.ts.map +1 -0
  65. package/dist/generators/usage.js +130 -0
  66. package/dist/generators/usage.js.map +1 -0
  67. package/dist/index.d.ts +3 -0
  68. package/dist/index.d.ts.map +1 -0
  69. package/dist/index.js +47 -0
  70. package/dist/index.js.map +1 -0
  71. package/dist/providers/anthropic.d.ts +3 -0
  72. package/dist/providers/anthropic.d.ts.map +1 -0
  73. package/dist/providers/anthropic.js +47 -0
  74. package/dist/providers/anthropic.js.map +1 -0
  75. package/dist/providers/gemini.d.ts +3 -0
  76. package/dist/providers/gemini.d.ts.map +1 -0
  77. package/dist/providers/gemini.js +28 -0
  78. package/dist/providers/gemini.js.map +1 -0
  79. package/dist/providers/index.d.ts +8 -0
  80. package/dist/providers/index.d.ts.map +1 -0
  81. package/dist/providers/index.js +24 -0
  82. package/dist/providers/index.js.map +1 -0
  83. package/dist/providers/ollama.d.ts +3 -0
  84. package/dist/providers/ollama.d.ts.map +1 -0
  85. package/dist/providers/ollama.js +46 -0
  86. package/dist/providers/ollama.js.map +1 -0
  87. package/dist/providers/openai.d.ts +3 -0
  88. package/dist/providers/openai.d.ts.map +1 -0
  89. package/dist/providers/openai.js +40 -0
  90. package/dist/providers/openai.js.map +1 -0
  91. package/dist/themes/academic.d.ts +3 -0
  92. package/dist/themes/academic.d.ts.map +1 -0
  93. package/dist/themes/academic.js +113 -0
  94. package/dist/themes/academic.js.map +1 -0
  95. package/dist/themes/default.d.ts +3 -0
  96. package/dist/themes/default.d.ts.map +1 -0
  97. package/dist/themes/default.js +114 -0
  98. package/dist/themes/default.js.map +1 -0
  99. package/dist/themes/hacker.d.ts +3 -0
  100. package/dist/themes/hacker.d.ts.map +1 -0
  101. package/dist/themes/hacker.js +100 -0
  102. package/dist/themes/hacker.js.map +1 -0
  103. package/dist/themes/index.d.ts +26 -0
  104. package/dist/themes/index.d.ts.map +1 -0
  105. package/dist/themes/index.js +23 -0
  106. package/dist/themes/index.js.map +1 -0
  107. package/dist/themes/minimal.d.ts +3 -0
  108. package/dist/themes/minimal.d.ts.map +1 -0
  109. package/dist/themes/minimal.js +85 -0
  110. package/dist/themes/minimal.js.map +1 -0
  111. package/dist/themes/modern.d.ts +3 -0
  112. package/dist/themes/modern.d.ts.map +1 -0
  113. package/dist/themes/modern.js +114 -0
  114. package/dist/themes/modern.js.map +1 -0
  115. package/dist/utils/file-utils.d.ts +9 -0
  116. package/dist/utils/file-utils.d.ts.map +1 -0
  117. package/dist/utils/file-utils.js +93 -0
  118. package/dist/utils/file-utils.js.map +1 -0
  119. package/dist/utils/github-api.d.ts +27 -0
  120. package/dist/utils/github-api.d.ts.map +1 -0
  121. package/dist/utils/github-api.js +68 -0
  122. package/dist/utils/github-api.js.map +1 -0
  123. package/dist/utils/language-detector.d.ts +18 -0
  124. package/dist/utils/language-detector.d.ts.map +1 -0
  125. package/dist/utils/language-detector.js +139 -0
  126. package/dist/utils/language-detector.js.map +1 -0
  127. package/dist/utils/markdown-writer.d.ts +5 -0
  128. package/dist/utils/markdown-writer.d.ts.map +1 -0
  129. package/dist/utils/markdown-writer.js +19 -0
  130. package/dist/utils/markdown-writer.js.map +1 -0
  131. package/dist/utils/template-engine.d.ts +9 -0
  132. package/dist/utils/template-engine.d.ts.map +1 -0
  133. package/dist/utils/template-engine.js +29 -0
  134. package/dist/utils/template-engine.js.map +1 -0
  135. package/package.json +60 -0
  136. package/templates/.readmeaiignore.example +41 -0
  137. package/templates/github-action.yml +35 -0
@@ -0,0 +1,139 @@
1
+ import { getFileExtension } from './file-utils.js';
2
+ const EXTENSION_MAP = {
3
+ ts: { name: 'TypeScript', icon: '🦕' },
4
+ tsx: { name: 'TypeScript', icon: '🦕' },
5
+ js: { name: 'JavaScript', icon: '🟨' },
6
+ jsx: { name: 'JavaScript', icon: '🟨' },
7
+ mjs: { name: 'JavaScript', icon: '🟨' },
8
+ cjs: { name: 'JavaScript', icon: '🟨' },
9
+ py: { name: 'Python', icon: '🐍' },
10
+ rs: { name: 'Rust', icon: '🦀' },
11
+ go: { name: 'Go', icon: '🐹' },
12
+ java: { name: 'Java', icon: '☕' },
13
+ kt: { name: 'Kotlin', icon: '🟣' },
14
+ swift: { name: 'Swift', icon: '🍎' },
15
+ rb: { name: 'Ruby', icon: '💎' },
16
+ php: { name: 'PHP', icon: '🐘' },
17
+ cs: { name: 'C#', icon: '🟪' },
18
+ cpp: { name: 'C++', icon: '⚙️' },
19
+ c: { name: 'C', icon: '⚙️' },
20
+ h: { name: 'C/C++', icon: '⚙️' },
21
+ hpp: { name: 'C++', icon: '⚙️' },
22
+ scala: { name: 'Scala', icon: '🔴' },
23
+ dart: { name: 'Dart', icon: '🎯' },
24
+ lua: { name: 'Lua', icon: '🌙' },
25
+ r: { name: 'R', icon: '📊' },
26
+ ex: { name: 'Elixir', icon: '💜' },
27
+ exs: { name: 'Elixir', icon: '💜' },
28
+ erl: { name: 'Erlang', icon: '📞' },
29
+ zig: { name: 'Zig', icon: '⚡' },
30
+ vue: { name: 'Vue', icon: '💚' },
31
+ svelte: { name: 'Svelte', icon: '🔥' },
32
+ html: { name: 'HTML', icon: '🌐' },
33
+ css: { name: 'CSS', icon: '🎨' },
34
+ scss: { name: 'SCSS', icon: '🎨' },
35
+ less: { name: 'LESS', icon: '🎨' },
36
+ sql: { name: 'SQL', icon: '🗄️' },
37
+ sh: { name: 'Shell', icon: '🐚' },
38
+ bash: { name: 'Shell', icon: '🐚' },
39
+ zsh: { name: 'Shell', icon: '🐚' },
40
+ yml: { name: 'YAML', icon: '📋' },
41
+ yaml: { name: 'YAML', icon: '📋' },
42
+ json: { name: 'JSON', icon: '📦' },
43
+ toml: { name: 'TOML', icon: '📦' },
44
+ md: { name: 'Markdown', icon: '📝' },
45
+ mdx: { name: 'MDX', icon: '📝' },
46
+ };
47
+ const CONFIG_EXTENSIONS = new Set([
48
+ 'json', 'yaml', 'yml', 'toml', 'xml', 'ini', 'cfg', 'conf',
49
+ 'env', 'properties', 'md', 'mdx', 'txt', 'lock',
50
+ ]);
51
+ const TEST_PATTERNS = [
52
+ /\.test\.[^.]+$/,
53
+ /\.spec\.[^.]+$/,
54
+ /_test\.[^.]+$/,
55
+ /test_[^/]+\.[^.]+$/,
56
+ /tests?\//,
57
+ /__tests__\//,
58
+ ];
59
+ const ENTRY_POINT_NAMES = new Set([
60
+ 'index.ts', 'index.js', 'index.tsx', 'index.jsx',
61
+ 'main.ts', 'main.js', 'main.py', 'main.go', 'main.rs',
62
+ 'app.ts', 'app.js', 'app.py',
63
+ 'server.ts', 'server.js', 'server.py',
64
+ 'mod.rs', 'lib.rs',
65
+ 'cli.ts', 'cli.js', 'cli.py',
66
+ ]);
67
+ export function detectLanguage(filePath) {
68
+ const ext = getFileExtension(filePath);
69
+ return EXTENSION_MAP[ext]?.name || ext || 'unknown';
70
+ }
71
+ export function getLanguageIcon(filePath) {
72
+ const ext = getFileExtension(filePath);
73
+ return EXTENSION_MAP[ext]?.icon || '📄';
74
+ }
75
+ export function isConfigFile(filePath) {
76
+ const ext = getFileExtension(filePath);
77
+ const name = filePath.split('/').pop() || '';
78
+ return CONFIG_EXTENSIONS.has(ext) ||
79
+ name.startsWith('.') ||
80
+ name === 'Dockerfile' ||
81
+ name === 'Makefile' ||
82
+ name === 'Procfile';
83
+ }
84
+ export function isTestFile(filePath) {
85
+ return TEST_PATTERNS.some(p => p.test(filePath));
86
+ }
87
+ export function isEntryPoint(filePath) {
88
+ const name = filePath.split('/').pop() || '';
89
+ return ENTRY_POINT_NAMES.has(name);
90
+ }
91
+ export function calculateLanguageStats(files) {
92
+ const codeFiles = files.filter(f => !isConfigFile(f) && !isTestFile(f));
93
+ const counts = {};
94
+ for (const file of codeFiles) {
95
+ const ext = getFileExtension(file);
96
+ const info = EXTENSION_MAP[ext];
97
+ if (!info)
98
+ continue;
99
+ if (!counts[info.name]) {
100
+ counts[info.name] = { count: 0, icon: info.icon };
101
+ }
102
+ counts[info.name].count++;
103
+ }
104
+ const total = Object.values(counts).reduce((sum, c) => sum + c.count, 0);
105
+ if (total === 0)
106
+ return [];
107
+ return Object.entries(counts)
108
+ .map(([name, { count, icon }]) => ({
109
+ name,
110
+ files: count,
111
+ percentage: Math.round((count / total) * 100),
112
+ icon,
113
+ }))
114
+ .sort((a, b) => b.files - a.files);
115
+ }
116
+ export const FRAMEWORK_INDICATORS = {
117
+ 'React': { deps: ['react', 'react-dom'], imports: ['react'] },
118
+ 'Next.js': { deps: ['next'], files: ['next.config.js', 'next.config.ts', 'next.config.mjs'] },
119
+ 'Vue': { deps: ['vue'], imports: ['vue'] },
120
+ 'Nuxt': { deps: ['nuxt'], files: ['nuxt.config.ts', 'nuxt.config.js'] },
121
+ 'Svelte': { deps: ['svelte'], files: ['svelte.config.js'] },
122
+ 'Angular': { deps: ['@angular/core'], files: ['angular.json'] },
123
+ 'Express': { deps: ['express'], imports: ['express'] },
124
+ 'Fastify': { deps: ['fastify'], imports: ['fastify'] },
125
+ 'Koa': { deps: ['koa'], imports: ['koa'] },
126
+ 'NestJS': { deps: ['@nestjs/core'] },
127
+ 'FastAPI': { imports: ['fastapi'] },
128
+ 'Django': { imports: ['django'], files: ['manage.py'] },
129
+ 'Flask': { imports: ['flask'] },
130
+ 'Spring Boot': { files: ['pom.xml', 'build.gradle'] },
131
+ 'Prisma': { deps: ['prisma', '@prisma/client'], files: ['prisma/schema.prisma'] },
132
+ 'Drizzle': { deps: ['drizzle-orm'] },
133
+ 'TypeORM': { deps: ['typeorm'] },
134
+ 'Tailwind CSS': { deps: ['tailwindcss'], files: ['tailwind.config.js', 'tailwind.config.ts'] },
135
+ 'Vite': { deps: ['vite'], files: ['vite.config.ts', 'vite.config.js'] },
136
+ 'Webpack': { deps: ['webpack'], files: ['webpack.config.js'] },
137
+ 'Docker': { files: ['Dockerfile', 'docker-compose.yml', 'docker-compose.yaml'] },
138
+ };
139
+ //# sourceMappingURL=language-detector.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"language-detector.js","sourceRoot":"","sources":["../../src/utils/language-detector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AASnD,MAAM,aAAa,GAAmD;IACpE,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IACtC,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IACvC,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IACtC,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IACvC,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IACvC,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IACvC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;IAC9B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE;IACjC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IACpC,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;IAC9B,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE;IAC5B,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IACpC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE;IAC5B,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IACnC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IACnC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE;IAC/B,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IACtC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE;IACjC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IACnC,GAAG,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IACpC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;CACjC,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM;IAC1D,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM;CAChD,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG;IACpB,gBAAgB;IAChB,gBAAgB;IAChB,eAAe;IACf,oBAAoB;IACpB,UAAU;IACV,aAAa;CACd,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW;IAChD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,QAAQ,EAAE,QAAQ,EAAE,QAAQ;IAC5B,WAAW,EAAE,WAAW,EAAE,WAAW;IACrC,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ,EAAE,QAAQ;CAC7B,CAAC,CAAC;AAEH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,MAAM,GAAG,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACvC,OAAO,aAAa,CAAC,GAAG,CAAC,EAAE,IAAI,IAAI,GAAG,IAAI,SAAS,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,QAAgB;IAC9C,MAAM,GAAG,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACvC,OAAO,aAAa,CAAC,GAAG,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,QAAgB;IAC3C,MAAM,GAAG,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;IAC7C,OAAO,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC;QAC/B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QACpB,IAAI,KAAK,YAAY;QACrB,IAAI,KAAK,UAAU;QACnB,IAAI,KAAK,UAAU,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,QAAgB;IACzC,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,QAAgB;IAC3C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;IAC7C,OAAO,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAe;IACpD,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,MAAM,MAAM,GAAoD,EAAE,CAAC;IAEnE,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACpD,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACzE,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAE3B,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SAC1B,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACjC,IAAI;QACJ,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC;QAC7C,IAAI;KACL,CAAC,CAAC;SACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAA8E;IAC7G,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE;IAC7D,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,EAAE;IAC7F,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE;IAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAAE;IACvE,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,kBAAkB,CAAC,EAAE;IAC3D,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,CAAC,cAAc,CAAC,EAAE;IAC/D,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE;IACtD,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE;IACtD,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE;IAC1C,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE;IACpC,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE;IACnC,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,WAAW,CAAC,EAAE;IACvD,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE;IAC/B,aAAa,EAAE,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE;IACrD,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAC,sBAAsB,CAAC,EAAE;IACjF,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE;IACpC,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE;IAChC,cAAc,EAAE,EAAE,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,EAAE;IAC9F,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAAE;IACvE,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,mBAAmB,CAAC,EAAE;IAC9D,QAAQ,EAAE,EAAE,KAAK,EAAE,CAAC,YAAY,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,EAAE;CACjF,CAAC"}
@@ -0,0 +1,5 @@
1
+ export declare function writeMarkdown(outputPath: string, content: string): Promise<void>;
2
+ export declare function joinSections(sections: string[]): string;
3
+ export declare function sanitizeMarkdown(text: string): string;
4
+ export declare function escapeForTable(text: string): string;
5
+ //# sourceMappingURL=markdown-writer.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdown-writer.d.ts","sourceRoot":"","sources":["../../src/utils/markdown-writer.ts"],"names":[],"mappings":"AAGA,wBAAsB,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAItF;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAEvD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAIrD;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEnD"}
@@ -0,0 +1,19 @@
1
+ import fs from 'node:fs/promises';
2
+ import path from 'node:path';
3
+ export async function writeMarkdown(outputPath, content) {
4
+ const dir = path.dirname(outputPath);
5
+ await fs.mkdir(dir, { recursive: true });
6
+ await fs.writeFile(outputPath, content, 'utf-8');
7
+ }
8
+ export function joinSections(sections) {
9
+ return sections.filter(Boolean).join('\n\n---\n\n');
10
+ }
11
+ export function sanitizeMarkdown(text) {
12
+ return text
13
+ .replace(/</g, '&lt;')
14
+ .replace(/>/g, '&gt;');
15
+ }
16
+ export function escapeForTable(text) {
17
+ return text.replace(/\|/g, '\\|').replace(/\n/g, ' ');
18
+ }
19
+ //# sourceMappingURL=markdown-writer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdown-writer.js","sourceRoot":"","sources":["../../src/utils/markdown-writer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,UAAkB,EAAE,OAAe;IACrE,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,QAAkB;IAC7C,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAO,IAAI;SACR,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACxD,CAAC"}
@@ -0,0 +1,9 @@
1
+ export declare function fillTemplate(template: string, data: Record<string, string>): string;
2
+ export declare function indent(text: string, spaces: number): string;
3
+ export declare function wrapCodeBlock(code: string, language?: string): string;
4
+ export declare function heading(text: string, level: number): string;
5
+ export declare function bulletList(items: string[]): string;
6
+ export declare function numberedList(items: string[]): string;
7
+ export declare function table(headers: string[], rows: string[][]): string;
8
+ export declare function divCenter(content: string): string;
9
+ //# sourceMappingURL=template-engine.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"template-engine.d.ts","sourceRoot":"","sources":["../../src/utils/template-engine.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAEnF;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAG3D;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAW,GAAG,MAAM,CAEzE;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAElD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAEpD;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,CAKjE;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEjD"}
@@ -0,0 +1,29 @@
1
+ export function fillTemplate(template, data) {
2
+ return template.replace(/\{\{(\w+)\}\}/g, (_, key) => data[key] ?? '');
3
+ }
4
+ export function indent(text, spaces) {
5
+ const pad = ' '.repeat(spaces);
6
+ return text.split('\n').map(line => pad + line).join('\n');
7
+ }
8
+ export function wrapCodeBlock(code, language = '') {
9
+ return `\`\`\`${language}\n${code}\n\`\`\``;
10
+ }
11
+ export function heading(text, level) {
12
+ return `${'#'.repeat(level)} ${text}`;
13
+ }
14
+ export function bulletList(items) {
15
+ return items.map(item => `- ${item}`).join('\n');
16
+ }
17
+ export function numberedList(items) {
18
+ return items.map((item, i) => `${i + 1}. ${item}`).join('\n');
19
+ }
20
+ export function table(headers, rows) {
21
+ const headerRow = `| ${headers.join(' | ')} |`;
22
+ const separator = `| ${headers.map(() => '---').join(' | ')} |`;
23
+ const dataRows = rows.map(row => `| ${row.join(' | ')} |`).join('\n');
24
+ return `${headerRow}\n${separator}\n${dataRows}`;
25
+ }
26
+ export function divCenter(content) {
27
+ return `<div align="center">\n\n${content}\n\n</div>`;
28
+ }
29
+ //# sourceMappingURL=template-engine.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"template-engine.js","sourceRoot":"","sources":["../../src/utils/template-engine.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY,CAAC,QAAgB,EAAE,IAA4B;IACzE,OAAO,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,IAAY,EAAE,MAAc;IACjD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,WAAmB,EAAE;IAC/D,OAAO,SAAS,QAAQ,KAAK,IAAI,UAAU,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,IAAY,EAAE,KAAa;IACjD,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAe;IACxC,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAe;IAC1C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,OAAiB,EAAE,IAAgB;IACvD,MAAM,SAAS,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAC/C,MAAM,SAAS,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtE,OAAO,GAAG,SAAS,KAAK,SAAS,KAAK,QAAQ,EAAE,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAe;IACvC,OAAO,2BAA2B,OAAO,YAAY,CAAC;AACxD,CAAC"}
package/package.json ADDED
@@ -0,0 +1,60 @@
1
+ {
2
+ "name": "@malikasadjaved/readme-ai",
3
+ "version": "1.0.0",
4
+ "description": "Generate stunning, production-quality READMEs from any codebase in seconds",
5
+ "keywords": [
6
+ "readme",
7
+ "documentation",
8
+ "ai",
9
+ "generator",
10
+ "markdown",
11
+ "github",
12
+ "claude",
13
+ "openai",
14
+ "mermaid",
15
+ "developer-tools"
16
+ ],
17
+ "homepage": "https://github.com/malikasadjaved/readme-ai",
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "https://github.com/malikasadjaved/readme-ai"
21
+ },
22
+ "license": "MIT",
23
+ "type": "module",
24
+ "bin": {
25
+ "readme-ai": "./dist/index.js"
26
+ },
27
+ "main": "./dist/index.js",
28
+ "files": [
29
+ "dist",
30
+ "templates"
31
+ ],
32
+ "scripts": {
33
+ "build": "tsc",
34
+ "dev": "tsx src/index.ts",
35
+ "test": "vitest run",
36
+ "release": "npm run build && npm publish"
37
+ },
38
+ "dependencies": {
39
+ "@anthropic-ai/sdk": "^0.28.0",
40
+ "@google/generative-ai": "^0.19.0",
41
+ "@inquirer/prompts": "^6.0.0",
42
+ "@octokit/rest": "^21.0.0",
43
+ "chalk": "^5.3.0",
44
+ "commander": "^12.0.0",
45
+ "conf": "^13.0.0",
46
+ "fast-glob": "^3.3.2",
47
+ "openai": "^4.57.0",
48
+ "ora": "^8.1.0",
49
+ "simple-git": "^3.27.0"
50
+ },
51
+ "devDependencies": {
52
+ "@types/node": "^22.0.0",
53
+ "tsx": "^4.19.0",
54
+ "typescript": "^5.5.0",
55
+ "vitest": "^2.0.0"
56
+ },
57
+ "engines": {
58
+ "node": ">=18"
59
+ }
60
+ }
@@ -0,0 +1,41 @@
1
+ # .readmeaiignore
2
+ # Files and directories to exclude from readme-ai analysis
3
+ # Uses glob patterns (same syntax as .gitignore)
4
+
5
+ # Dependencies
6
+ node_modules/
7
+ vendor/
8
+ .venv/
9
+
10
+ # Build outputs
11
+ dist/
12
+ build/
13
+ out/
14
+ .next/
15
+
16
+ # Test fixtures and snapshots
17
+ **/__snapshots__/
18
+ **/fixtures/
19
+
20
+ # Generated files
21
+ *.min.js
22
+ *.bundle.js
23
+ *.map
24
+
25
+ # Large data files
26
+ *.csv
27
+ *.sql
28
+ *.sqlite
29
+
30
+ # Media files
31
+ *.png
32
+ *.jpg
33
+ *.gif
34
+ *.svg
35
+ *.mp4
36
+
37
+ # IDE and OS files
38
+ .idea/
39
+ .vscode/
40
+ .DS_Store
41
+ Thumbs.db
@@ -0,0 +1,35 @@
1
+ # .github/workflows/readme-update.yml
2
+ # Generated by readme-ai — https://github.com/malikasadjaved/readme-ai
3
+ # This action auto-regenerates your README on every push to main
4
+
5
+ name: Update README
6
+
7
+ on:
8
+ push:
9
+ branches: [main, master]
10
+ paths-ignore:
11
+ - 'README.md'
12
+
13
+ jobs:
14
+ update-readme:
15
+ runs-on: ubuntu-latest
16
+ permissions:
17
+ contents: write
18
+
19
+ steps:
20
+ - uses: actions/checkout@v4
21
+
22
+ - uses: actions/setup-node@v4
23
+ with:
24
+ node-version: '20'
25
+
26
+ - name: Generate README
27
+ run: npx readme-ai@latest --overwrite --no-interactive
28
+ env:
29
+ ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
30
+
31
+ - name: Commit updated README
32
+ uses: stefanzweifel/git-auto-commit-action@v5
33
+ with:
34
+ commit_message: 'docs: auto-update README [skip ci]'
35
+ file_pattern: README.md