@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.
Files changed (96) hide show
  1. package/README.md +131 -41
  2. package/dist/analyzers/badge-generator.js +27 -27
  3. package/dist/analyzers/badge-generator.js.map +1 -1
  4. package/dist/analyzers/code-analyzer.js +37 -2
  5. package/dist/analyzers/code-analyzer.js.map +1 -1
  6. package/dist/analyzers/dependency-analyzer.d.ts.map +1 -1
  7. package/dist/analyzers/dependency-analyzer.js +203 -26
  8. package/dist/analyzers/dependency-analyzer.js.map +1 -1
  9. package/dist/analyzers/diagram-builder.js +19 -18
  10. package/dist/analyzers/diagram-builder.js.map +1 -1
  11. package/dist/analyzers/file-scanner.d.ts.map +1 -1
  12. package/dist/analyzers/file-scanner.js +13 -13
  13. package/dist/analyzers/file-scanner.js.map +1 -1
  14. package/dist/analyzers/index.d.ts +1 -1
  15. package/dist/analyzers/index.d.ts.map +1 -1
  16. package/dist/analyzers/index.js +1 -1
  17. package/dist/analyzers/index.js.map +1 -1
  18. package/dist/analyzers/repo-fetcher.d.ts.map +1 -1
  19. package/dist/analyzers/repo-fetcher.js +40 -13
  20. package/dist/analyzers/repo-fetcher.js.map +1 -1
  21. package/dist/cli.js +1 -1
  22. package/dist/cli.js.map +1 -1
  23. package/dist/commands/generate.d.ts.map +1 -1
  24. package/dist/commands/generate.js +58 -6
  25. package/dist/commands/generate.js.map +1 -1
  26. package/dist/config.d.ts +14 -0
  27. package/dist/config.d.ts.map +1 -1
  28. package/dist/config.js +24 -0
  29. package/dist/config.js.map +1 -1
  30. package/dist/generators/contributing.js +3 -3
  31. package/dist/generators/contributing.js.map +1 -1
  32. package/dist/generators/index.d.ts +1 -1
  33. package/dist/generators/index.d.ts.map +1 -1
  34. package/dist/generators/index.js +1 -1
  35. package/dist/generators/index.js.map +1 -1
  36. package/dist/generators/install.d.ts.map +1 -1
  37. package/dist/generators/install.js.map +1 -1
  38. package/dist/generators/overview.d.ts.map +1 -1
  39. package/dist/generators/overview.js +12 -5
  40. package/dist/generators/overview.js.map +1 -1
  41. package/dist/generators/usage.d.ts.map +1 -1
  42. package/dist/generators/usage.js +15 -9
  43. package/dist/generators/usage.js.map +1 -1
  44. package/dist/index.js.map +1 -1
  45. package/dist/plugins/index.d.ts +49 -0
  46. package/dist/plugins/index.d.ts.map +1 -0
  47. package/dist/plugins/index.js +113 -0
  48. package/dist/plugins/index.js.map +1 -0
  49. package/dist/providers/anthropic.d.ts.map +1 -1
  50. package/dist/providers/anthropic.js +4 -1
  51. package/dist/providers/anthropic.js.map +1 -1
  52. package/dist/providers/gemini.d.ts.map +1 -1
  53. package/dist/providers/gemini.js +5 -1
  54. package/dist/providers/gemini.js.map +1 -1
  55. package/dist/providers/index.d.ts +1 -0
  56. package/dist/providers/index.d.ts.map +1 -1
  57. package/dist/providers/index.js +31 -2
  58. package/dist/providers/index.js.map +1 -1
  59. package/dist/providers/ollama.d.ts.map +1 -1
  60. package/dist/providers/ollama.js +6 -3
  61. package/dist/providers/ollama.js.map +1 -1
  62. package/dist/providers/openai.d.ts.map +1 -1
  63. package/dist/providers/openai.js.map +1 -1
  64. package/dist/themes/academic.js +2 -2
  65. package/dist/themes/academic.js.map +1 -1
  66. package/dist/themes/default.js +2 -2
  67. package/dist/themes/default.js.map +1 -1
  68. package/dist/themes/hacker.js +4 -4
  69. package/dist/themes/hacker.js.map +1 -1
  70. package/dist/themes/index.d.ts.map +1 -1
  71. package/dist/themes/index.js +7 -2
  72. package/dist/themes/index.js.map +1 -1
  73. package/dist/themes/minimal.js +3 -3
  74. package/dist/themes/minimal.js.map +1 -1
  75. package/dist/themes/modern.js +2 -2
  76. package/dist/themes/modern.js.map +1 -1
  77. package/dist/utils/cache.d.ts +4 -0
  78. package/dist/utils/cache.d.ts.map +1 -0
  79. package/dist/utils/cache.js +48 -0
  80. package/dist/utils/cache.js.map +1 -0
  81. package/dist/utils/file-utils.d.ts.map +1 -1
  82. package/dist/utils/file-utils.js +45 -13
  83. package/dist/utils/file-utils.js.map +1 -1
  84. package/dist/utils/github-api.d.ts.map +1 -1
  85. package/dist/utils/github-api.js +2 -2
  86. package/dist/utils/github-api.js.map +1 -1
  87. package/dist/utils/language-detector.d.ts.map +1 -1
  88. package/dist/utils/language-detector.js +56 -30
  89. package/dist/utils/language-detector.js.map +1 -1
  90. package/dist/utils/markdown-writer.d.ts.map +1 -1
  91. package/dist/utils/markdown-writer.js +1 -3
  92. package/dist/utils/markdown-writer.js.map +1 -1
  93. package/dist/utils/template-engine.d.ts.map +1 -1
  94. package/dist/utils/template-engine.js +6 -3
  95. package/dist/utils/template-engine.js.map +1 -1
  96. package/package.json +76 -8
package/package.json CHANGED
@@ -1,23 +1,71 @@
1
1
  {
2
2
  "name": "@malikasadjaved/readme-ai",
3
- "version": "1.1.0",
4
- "description": "Generate stunning, production-quality READMEs from any codebase in seconds",
3
+ "version": "1.2.1",
4
+ "description": "The #1 AI-powered README generator — generate stunning docs from any codebase in seconds. Supports Claude, GPT-4o, Gemini, Ollama. 5 themes, Mermaid diagrams, badges, plugin system.",
5
5
  "keywords": [
6
6
  "readme",
7
+ "readme-generator",
8
+ "readme-ai",
9
+ "ai-readme",
7
10
  "documentation",
8
- "ai",
9
- "generator",
11
+ "documentation-generator",
12
+ "ai-documentation",
13
+ "auto-documentation",
10
14
  "markdown",
15
+ "markdown-generator",
11
16
  "github",
17
+ "github-readme",
18
+ "github-action",
19
+ "developer-tools",
20
+ "devtools",
21
+ "cli",
22
+ "npx",
23
+ "ai",
24
+ "llm",
12
25
  "claude",
26
+ "anthropic",
13
27
  "openai",
28
+ "gpt",
29
+ "gpt-4",
30
+ "gpt-4o",
31
+ "gemini",
32
+ "google-ai",
33
+ "ollama",
34
+ "local-llm",
14
35
  "mermaid",
15
- "developer-tools"
36
+ "mermaid-diagrams",
37
+ "architecture-diagram",
38
+ "badges",
39
+ "shields-io",
40
+ "code-analysis",
41
+ "code-documentation",
42
+ "project-documentation",
43
+ "auto-readme",
44
+ "readme-maker",
45
+ "readme-template",
46
+ "typescript",
47
+ "nodejs",
48
+ "python",
49
+ "rust",
50
+ "golang",
51
+ "java",
52
+ "ruby",
53
+ "swift",
54
+ "dart",
55
+ "flutter",
56
+ "open-source",
57
+ "plugin-system",
58
+ "themes",
59
+ "api-docs",
60
+ "badge-generator",
61
+ "diagram-generator",
62
+ "contributing",
63
+ "changelog"
16
64
  ],
17
- "homepage": "https://github.com/malikasadjaved/readme-ai",
65
+ "homepage": "https://github.com/Malikasadjaved/readme-ai",
18
66
  "repository": {
19
67
  "type": "git",
20
- "url": "git+https://github.com/malikasadjaved/readme-ai.git"
68
+ "url": "git+https://github.com/Malikasadjaved/readme-ai.git"
21
69
  },
22
70
  "license": "MIT",
23
71
  "type": "module",
@@ -33,7 +81,13 @@
33
81
  "build": "tsc",
34
82
  "dev": "tsx src/index.ts",
35
83
  "test": "vitest run",
36
- "release": "npm run build && npm publish"
84
+ "test:coverage": "vitest run --coverage",
85
+ "lint": "eslint src/ tests/",
86
+ "lint:fix": "eslint src/ tests/ --fix",
87
+ "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
88
+ "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
89
+ "release": "npm run build && npm publish",
90
+ "prepare": "husky"
37
91
  },
38
92
  "dependencies": {
39
93
  "@anthropic-ai/sdk": "^0.28.0",
@@ -49,11 +103,25 @@
49
103
  "simple-git": "^3.27.0"
50
104
  },
51
105
  "devDependencies": {
106
+ "@eslint/js": "^10.0.1",
52
107
  "@types/node": "^22.0.0",
108
+ "@vitest/coverage-v8": "^2.1.9",
109
+ "eslint": "^10.2.0",
110
+ "eslint-config-prettier": "^10.1.8",
111
+ "husky": "^9.1.7",
112
+ "lint-staged": "^16.4.0",
113
+ "prettier": "^3.8.2",
53
114
  "tsx": "^4.19.0",
54
115
  "typescript": "^5.5.0",
116
+ "typescript-eslint": "^8.58.1",
55
117
  "vitest": "^2.0.0"
56
118
  },
119
+ "lint-staged": {
120
+ "*.ts": [
121
+ "eslint --fix",
122
+ "prettier --write"
123
+ ]
124
+ },
57
125
  "engines": {
58
126
  "node": ">=18"
59
127
  }