mikro-orm-markdown 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/README.ko.md +10 -1
- package/README.md +10 -1
- package/dist/cli.cjs +332 -197
- package/dist/cli.cjs.map +1 -1
- package/dist/cli.d.cts +5 -2
- package/dist/cli.d.ts +5 -2
- package/dist/cli.js +335 -200
- package/dist/cli.js.map +1 -1
- package/dist/index.cjs +248 -131
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +250 -133
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.1.2] - 2026-07-06
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
|
|
12
|
+
- Hidden STI parent entity names no longer leak into child entity captions when the parent is excluded with `@hidden`
|
|
13
|
+
- JSDoc extraction now includes getter accessors and constructor parameter properties, including rich inline JSDoc text such as `{@link ...}`
|
|
14
|
+
- Markdown escaping now treats underscore emphasis and link-like labels consistently while preserving identifier-style names such as `author_id`
|
|
15
|
+
- CLI TypeScript config loading now unregisters the temporary `tsx` loader when it is no longer needed
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
|
|
19
|
+
- Mermaid layout and theme CLI options now use Commander's built-in choice validation
|
|
20
|
+
- Diagram model construction was moved into the model layer so Mermaid rendering remains focused on output formatting
|
|
21
|
+
|
|
22
|
+
## [0.1.1] - 2026-07-03
|
|
23
|
+
|
|
24
|
+
### Fixed
|
|
25
|
+
|
|
26
|
+
- Scalar properties with `persist: false` (MikroORM shadow properties) are no longer rendered as if they were real database columns in the ERD or the Markdown column table; `@Formula` columns (also `persist: false` internally) are unaffected and continue to render
|
|
27
|
+
- A self-referencing owning 1:1 relation (e.g. `Node.twin: Node`) no longer renders a redundant self-loop relation edge in addition to the existing `"self-ref"` column comment — now matches the existing self-referencing m:1 behavior
|
|
28
|
+
|
|
8
29
|
## [0.1.0] - 2026-06-30
|
|
9
30
|
|
|
10
31
|
First stable release. All alpha features are considered production-ready.
|
package/README.ko.md
CHANGED
|
@@ -1,13 +1,22 @@
|
|
|
1
1
|
# mikro-orm-markdown
|
|
2
2
|
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="./assets/logo.png" alt="mikro-orm-markdown logo" width="400" />
|
|
5
|
+
</p>
|
|
6
|
+
|
|
3
7
|
[MikroORM](https://mikro-orm.io) 엔티티에서 **Mermaid ERD + Markdown 문서**를 자동으로 생성합니다.
|
|
4
8
|
|
|
5
|
-
[](https://www.npmjs.com/package/mikro-orm-markdown)
|
|
10
|
+
[](https://www.npmjs.com/package/mikro-orm-markdown)
|
|
6
11
|
[](https://github.com/iamkanguk97/mikro-orm-markdown/actions)
|
|
7
12
|
[](https://opensource.org/licenses/MIT)
|
|
8
13
|
|
|
9
14
|
[English](./README.md)
|
|
10
15
|
|
|
16
|
+
예시 출력은 [여기](./examples/ERD.md)에서 확인하실 수 있습니다.
|
|
17
|
+
|
|
18
|
+
Claude Code 또는 기타 Agent Skills 호환 도구를 사용한다면 `skills/mikro-orm-markdown/`의 선택적 Agent Skill로 MikroORM 프로젝트에 `mikro-orm-markdown`을 설정하고 문제를 진단할 수 있습니다. 이 Skill은 필요한 사용자가 저장소에서 가져가 쓰도록 제공되며, 일반적인 npm 사용에는 필요하지 않고 npm 패키지에는 포함되지 않습니다.
|
|
19
|
+
|
|
11
20
|
> [@samchon](https://github.com/samchon)의 [prisma-markdown](https://github.com/samchon/prisma-markdown)에서 큰 영감을 받았습니다. 좋은 아이디어에 감사드립니다.
|
|
12
21
|
|
|
13
22
|
## 주요 기능
|
package/README.md
CHANGED
|
@@ -1,13 +1,22 @@
|
|
|
1
1
|
# mikro-orm-markdown
|
|
2
2
|
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="./assets/logo.png" alt="mikro-orm-markdown logo" width="400" />
|
|
5
|
+
</p>
|
|
6
|
+
|
|
3
7
|
Generate **Mermaid ERD + Markdown documentation** from your [MikroORM](https://mikro-orm.io) entities.
|
|
4
8
|
|
|
5
|
-
[](https://www.npmjs.com/package/mikro-orm-markdown)
|
|
10
|
+
[](https://www.npmjs.com/package/mikro-orm-markdown)
|
|
6
11
|
[](https://github.com/iamkanguk97/mikro-orm-markdown/actions)
|
|
7
12
|
[](https://opensource.org/licenses/MIT)
|
|
8
13
|
|
|
9
14
|
[한국어 문서](./README.ko.md)
|
|
10
15
|
|
|
16
|
+
You can see the example output [here](./examples/ERD.md).
|
|
17
|
+
|
|
18
|
+
Agent users can also use the optional Agent Skill at `skills/mikro-orm-markdown/` with Claude Code or other Agent Skills-compatible tools to set up and troubleshoot `mikro-orm-markdown` in a MikroORM project. The skill is provided in this repository for users who want it; it is not required for normal npm usage and is not shipped in the npm package.
|
|
19
|
+
|
|
11
20
|
> Heavily inspired by [prisma-markdown](https://github.com/samchon/prisma-markdown) by [@samchon](https://github.com/samchon). Thank you for the great idea.
|
|
12
21
|
|
|
13
22
|
## Features
|