egehan 0.0.0-stage → 0.1.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 (85) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +79 -2
  3. package/assets/dictionary/narratives.en.json +660 -0
  4. package/assets/dictionary/narratives.tr.json +660 -0
  5. package/assets/schema/egehan-report.schema.json +354 -0
  6. package/assets/spec/rules.json +272 -0
  7. package/assets/templates/egehan-book.html +2027 -0
  8. package/assets/templates/hook.sh +41 -0
  9. package/dist/artifacts.d.ts +21 -0
  10. package/dist/artifacts.js +32 -0
  11. package/dist/capsule/capsule.d.ts +35 -0
  12. package/dist/capsule/capsule.js +123 -0
  13. package/dist/capsule/storage.d.ts +15 -0
  14. package/dist/capsule/storage.js +52 -0
  15. package/dist/cli/commands/capsule.d.ts +20 -0
  16. package/dist/cli/commands/capsule.js +94 -0
  17. package/dist/cli/commands/generate.d.ts +23 -0
  18. package/dist/cli/commands/generate.js +47 -0
  19. package/dist/cli/commands/hook.d.ts +14 -0
  20. package/dist/cli/commands/hook.js +120 -0
  21. package/dist/cli/commands/init.d.ts +16 -0
  22. package/dist/cli/commands/init.js +92 -0
  23. package/dist/cli/commands/stats.d.ts +14 -0
  24. package/dist/cli/commands/stats.js +112 -0
  25. package/dist/cli/main.d.ts +3 -0
  26. package/dist/cli/main.js +167 -0
  27. package/dist/cli/output.d.ts +26 -0
  28. package/dist/cli/output.js +87 -0
  29. package/dist/cli/prompt.d.ts +21 -0
  30. package/dist/cli/prompt.js +63 -0
  31. package/dist/config/config.d.ts +51 -0
  32. package/dist/config/config.js +160 -0
  33. package/dist/detect/projectType.d.ts +34 -0
  34. package/dist/detect/projectType.js +95 -0
  35. package/dist/engine/buildReport.d.ts +32 -0
  36. package/dist/engine/buildReport.js +188 -0
  37. package/dist/engine/chapters.d.ts +20 -0
  38. package/dist/engine/chapters.js +33 -0
  39. package/dist/engine/classifier.d.ts +21 -0
  40. package/dist/engine/classifier.js +119 -0
  41. package/dist/engine/conventional.d.ts +15 -0
  42. package/dist/engine/conventional.js +137 -0
  43. package/dist/engine/datetime.d.ts +47 -0
  44. package/dist/engine/datetime.js +100 -0
  45. package/dist/engine/milestones.d.ts +6 -0
  46. package/dist/engine/milestones.js +109 -0
  47. package/dist/engine/narrator.d.ts +71 -0
  48. package/dist/engine/narrator.js +189 -0
  49. package/dist/engine/prepare.d.ts +36 -0
  50. package/dist/engine/prepare.js +46 -0
  51. package/dist/engine/privacy.d.ts +45 -0
  52. package/dist/engine/privacy.js +110 -0
  53. package/dist/engine/pulse.d.ts +17 -0
  54. package/dist/engine/pulse.js +205 -0
  55. package/dist/engine/templating.d.ts +40 -0
  56. package/dist/engine/templating.js +64 -0
  57. package/dist/engine/types.d.ts +205 -0
  58. package/dist/engine/types.js +9 -0
  59. package/dist/git/logReader.d.ts +37 -0
  60. package/dist/git/logReader.js +133 -0
  61. package/dist/git/repository.d.ts +14 -0
  62. package/dist/git/repository.js +61 -0
  63. package/dist/git/runGit.d.ts +21 -0
  64. package/dist/git/runGit.js +74 -0
  65. package/dist/hooks/block.d.ts +27 -0
  66. package/dist/hooks/block.js +62 -0
  67. package/dist/hooks/manager.d.ts +47 -0
  68. package/dist/hooks/manager.js +153 -0
  69. package/dist/index.d.ts +34 -0
  70. package/dist/index.js +26 -0
  71. package/dist/pipeline.d.ts +35 -0
  72. package/dist/pipeline.js +80 -0
  73. package/dist/renderers/html.d.ts +6 -0
  74. package/dist/renderers/html.js +117 -0
  75. package/dist/renderers/markdown.d.ts +4 -0
  76. package/dist/renderers/markdown.js +168 -0
  77. package/dist/spec/assets.d.ts +14 -0
  78. package/dist/spec/assets.js +98 -0
  79. package/dist/spec/dictionary.d.ts +100 -0
  80. package/dist/spec/dictionary.js +39 -0
  81. package/dist/spec/rules.d.ts +191 -0
  82. package/dist/spec/rules.js +15 -0
  83. package/dist/version.d.ts +2 -0
  84. package/dist/version.js +20 -0
  85. package/package.json +55 -4
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Bedirhan Gurler
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,80 @@
1
- # Temporary Holding Version
1
+ # egehan
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ **Turn a project's `git log` into a living chronicle — offline, deterministic, no API key.**
4
+
5
+ [![npm](https://img.shields.io/npm/v/egehan.svg)](https://www.npmjs.com/package/egehan)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://github.com/BedirhanGurler/egehan/blob/main/LICENSE)
7
+
8
+ Every repository already contains a story: the night a race condition was finally cornered, the
9
+ week everything broke at once, the commit that deleted a thousand lines and made the project
10
+ better. `git log` records all of it and tells none of it.
11
+
12
+ Egehan reads that history and writes the story down — as a Markdown chronicle you can commit, and
13
+ an interactive single-file HTML timeline you can open anywhere.
14
+
15
+ ```bash
16
+ npx egehan
17
+ ```
18
+
19
+ ## What you get
20
+
21
+ **A narrated history.** Every commit is placed in one of six chapters — birth, first steps,
22
+ growing pains, midnight oil, milestone, evolution — and narrated in one of three tones
23
+ (`poetic`, `minimalist`, `humorous`) in Turkish or English.
24
+
25
+ ```text
26
+ Raw: fix: token refresh race condition (2026-03-14 03:18, 4 files, +85/-42)
27
+
28
+ Poetic: 14 Mart gecesi saat 03:18 sularında, herkes uyurken 4 dosyada titiz bir
29
+ çalışma yapıldı; «token refresh race condition» ile sistemin nefesi düzeltildi.
30
+ ```
31
+
32
+ **A Developer Pulse.** Your coding chronotype, most productive day and hour, the ratio of code
33
+ created to code refined, and your longest unbroken commit streak.
34
+
35
+ **A living chronicle.** One `egehan hook install` and every later commit quietly updates it.
36
+
37
+ ## Why no AI
38
+
39
+ A keepsake should still work in ten years, on a plane, in a repository nobody is allowed to upload
40
+ anywhere. The narration is a rule engine over commit metadata, not a model:
41
+
42
+ - **Deterministic.** The chosen sentence is `parseInt(sha[0..8], 16) % variants.length`. Running
43
+ it again never rewrites history, so the generated files produce clean, reviewable diffs.
44
+ - **Offline.** No requests, ever. Nothing about your repository leaves your machine.
45
+ - **Private by default.** Author e-mail addresses are redacted before anyone can publish them.
46
+
47
+ ## Commands
48
+
49
+ ```bash
50
+ egehan init # interactive setup, writes .egehanrc.json
51
+ egehan generate --format both # EGEHAN.md + egehan-chronicle.html
52
+ egehan generate --since v1.0.0 --output docs # a chapter of its own
53
+ egehan hook install # keep it updating on every commit
54
+ egehan stats # the Developer Pulse, in the terminal
55
+ egehan capsule --unlock-date 2044-02-01 # a passphrase-sealed letter to the future
56
+ ```
57
+
58
+ Node 20.12 or newer, and `git` on your PATH. One runtime dependency: `commander`.
59
+
60
+ ## The rest of the toolchain
61
+
62
+ The same engine, the same output, three places:
63
+
64
+ | | |
65
+ | ------- | ----------------------------------- |
66
+ | npm | `npx egehan` — this package |
67
+ | NuGet | `dotnet tool install -g Egehan.Cli` |
68
+ | VS Code | `Egehan — Living Code Chronicle` |
69
+
70
+ The Node and .NET engines are held to the same conformance fixtures, and a test asserts they
71
+ produce `EGEHAN.md` byte for byte alike.
72
+
73
+ ## Documentation
74
+
75
+ - [Full README and screenshots](https://github.com/BedirhanGurler/egehan#readme)
76
+ - [Türkçe](https://github.com/BedirhanGurler/egehan/blob/main/README.tr.md)
77
+ - [Architecture and the decisions behind it](https://github.com/BedirhanGurler/egehan/blob/main/docs/ARCHITECTURE.md)
78
+ - [Adding your language](https://github.com/BedirhanGurler/egehan/blob/main/CONTRIBUTING.md)
79
+
80
+ MIT.