markdown-codec 1.2.2 → 1.2.4
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 +13 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,6 +12,7 @@ graph TD
|
|
|
12
12
|
ooxml("ooxml.js")
|
|
13
13
|
odf("odf.js")
|
|
14
14
|
pdfcodec("pdf-codec")
|
|
15
|
+
bytecodec("byte-codec")
|
|
15
16
|
mdcodec("markdown-codec")
|
|
16
17
|
documents("documents.js")
|
|
17
18
|
mcp("document-mcp")
|
|
@@ -20,11 +21,14 @@ graph TD
|
|
|
20
21
|
schema --> ooxml
|
|
21
22
|
schema --> odf
|
|
22
23
|
schema --> pdfcodec
|
|
24
|
+
schema --> bytecodec
|
|
23
25
|
schema --> mdcodec
|
|
24
26
|
schema --> documents
|
|
27
|
+
bytecodec --> pdfcodec
|
|
25
28
|
ooxml --> documents
|
|
26
29
|
odf --> documents
|
|
27
30
|
pdfcodec --> documents
|
|
31
|
+
bytecodec --> documents
|
|
28
32
|
mdcodec --> documents
|
|
29
33
|
documents --> mcp
|
|
30
34
|
pdfcodec --> mcp
|
|
@@ -36,6 +40,7 @@ graph TD
|
|
|
36
40
|
click ooxml "https://github.com/ExaDev/ooxml.js" "ooxml.js"
|
|
37
41
|
click odf "https://github.com/ExaDev/odf.js" "odf.js"
|
|
38
42
|
click pdfcodec "https://github.com/ExaDev/pdf-codec" "pdf-codec"
|
|
43
|
+
click bytecodec "https://github.com/ExaDev/byte-codec" "byte-codec"
|
|
39
44
|
click mdcodec "https://github.com/ExaDev/markdown-codec" "markdown-codec"
|
|
40
45
|
click documents "https://github.com/ExaDev/documents.js" "documents.js"
|
|
41
46
|
click mcp "https://github.com/ExaDev/document-mcp" "document-mcp"
|
|
@@ -131,14 +136,15 @@ Modelled on `pdf-codec`'s own layering (generic primitives outward to the two co
|
|
|
131
136
|
## Build, test, and lint
|
|
132
137
|
|
|
133
138
|
```sh
|
|
134
|
-
pnpm build # tsdown -> dist
|
|
135
|
-
pnpm typecheck # tsc --
|
|
136
|
-
pnpm lint # eslint . --fix --cache --max-warnings 0
|
|
137
|
-
pnpm test # vitest run --project unit
|
|
139
|
+
pnpm build # turbo run _build (tsdown -> dist/, ESM + CJS + .d.ts)
|
|
140
|
+
pnpm typecheck # turbo run _typecheck _typecheck:node (tsc -p tsconfig.json && tsc -p tsconfig.node.json -- dual tsconfig)
|
|
141
|
+
pnpm lint # turbo run _lint (eslint . --fix --cache --max-warnings 0)
|
|
142
|
+
pnpm test # turbo run _test (vitest run --project unit, includes the CommonMark/GFM conformance suites)
|
|
143
|
+
pnpm test:workers # turbo run _test:workers (vitest run --config vitest.workers.config.ts -- the unit suite re-run under the real Cloudflare Workers/workerd runtime, turning markdown-codec's isomorphic design into a runtime-checked fact)
|
|
138
144
|
pnpm test:watch # vitest --project unit
|
|
139
|
-
pnpm test:coverage # vitest run --project unit --coverage
|
|
140
|
-
pnpm test:smoke # rebuilds dist/, then verifies ESM/CJS export parity and runs a real readMarkdown/writeMarkdown/markdownCodec round trip against each built bundle independently
|
|
141
|
-
pnpm test:corpus # optional, gitignored real-world CommonMark/GFM sanity check -- see Fidelity below
|
|
145
|
+
pnpm test:coverage # turbo run _test:coverage (vitest run --project unit --coverage)
|
|
146
|
+
pnpm test:smoke # turbo run _test:smoke (rebuilds dist/, then verifies ESM/CJS export parity and runs a real readMarkdown/writeMarkdown/markdownCodec round trip against each built bundle independently)
|
|
147
|
+
pnpm test:corpus # turbo run _test:corpus (optional, gitignored real-world CommonMark/GFM sanity check -- see Fidelity below)
|
|
142
148
|
```
|
|
143
149
|
|
|
144
150
|
To run a single test file: `pnpm vitest run src/path/to/file.test.ts`.
|