nizel-plugin-deflist 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.
package/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # nizel-plugin-deflist
2
+
3
+ Definition list support for [Nizel](https://npmjs.com/package/nizel).
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install nizel-plugin-deflist
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```ts
14
+ import { useNizel } from 'nizel';
15
+ import { deflistPlugin } from 'nizel-plugin-deflist';
16
+
17
+ const nizel = useNizel({
18
+ plugins: [deflistPlugin()],
19
+ });
20
+
21
+ const html = await nizel.html(`Term
22
+ : Definition`);
23
+ ```
24
+
25
+ ## Syntax
26
+
27
+ ```md
28
+ Term
29
+ : Definition
30
+
31
+ Other term
32
+ : First definition
33
+ : Second definition
34
+ ```
35
+
36
+ The plugin converts definition-list syntax into an internal Nizel custom block before parsing. It does not require disabling safe mode.
37
+
38
+ ## Options
39
+
40
+ | Option | Type | Default | Description |
41
+ | --- | --- | --- | --- |
42
+ | `className` | `string` | - | Optional CSS class on the generated `<dl>`. |
43
+
44
+ ## Output
45
+
46
+ ```html
47
+ <dl>
48
+ <dt>Term</dt>
49
+ <dd>Definition</dd>
50
+ </dl>
51
+ ```
52
+
53
+ ## License
54
+
55
+ MIT
@@ -0,0 +1,30 @@
1
+ import { type NizelPlugin } from 'nizel';
2
+ export type DefinitionEntry = {
3
+ term: string;
4
+ definitions: string[];
5
+ };
6
+ export type DeflistPluginOptions = {
7
+ className?: string;
8
+ };
9
+ /**
10
+ * Creates a definition list plugin for `Term` followed by `: Definition` lines.
11
+ */
12
+ export declare const deflistPlugin: (options?: DeflistPluginOptions) => NizelPlugin;
13
+ /**
14
+ * Converts definition-list source groups to safe inline HTML blocks.
15
+ */
16
+ export declare const transformDefinitionLists: (markdown: string, _options?: DeflistPluginOptions) => string;
17
+ /**
18
+ * Reads a contiguous definition list group from a line array.
19
+ */
20
+ export declare const readDefinitionList: (lines: string[], startIndex: number) => {
21
+ entries: DefinitionEntry[];
22
+ lines: string[];
23
+ nextIndex: number;
24
+ } | null;
25
+ /**
26
+ * Renders definition list entries to escaped HTML.
27
+ */
28
+ export declare const renderDefinitionList: (entries: DefinitionEntry[], options?: DeflistPluginOptions) => string;
29
+ export default deflistPlugin;
30
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,OAAO,CAAC;AAE5D,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAMF;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,UAAS,oBAAyB,KAAG,WAwBlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,UAAU,MAAM,EAAE,WAAU,oBAAyB,KAAG,MAkBhG,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC7B,OAAO,MAAM,EAAE,EACf,YAAY,MAAM,KACjB;IAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,IA+BvE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAC/B,SAAS,eAAe,EAAE,EAC1B,UAAS,oBAAyB,KACjC,MAYF,CAAC;AAkDF,eAAe,aAAa,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,141 @@
1
+ import { defineNizelPlugin } from 'nizel';
2
+ /**
3
+ * Creates a definition list plugin for `Term` followed by `: Definition` lines.
4
+ */
5
+ export const deflistPlugin = (options = {}) => {
6
+ return defineNizelPlugin({
7
+ name: 'deflist',
8
+ blocks: {
9
+ deflist: {
10
+ name: 'deflist',
11
+ parse({ content }) {
12
+ const parsed = readDefinitionList(content.split('\n'), 0);
13
+ return { entries: parsed?.entries ?? [] };
14
+ },
15
+ formats: {
16
+ html(node) {
17
+ if (node.type !== 'customBlock' || !isDeflistValue(node.value))
18
+ return '';
19
+ return renderDefinitionList(node.value.entries, options);
20
+ },
21
+ },
22
+ },
23
+ },
24
+ hooks: {
25
+ beforeParse(markdown) {
26
+ return transformDefinitionLists(markdown, options);
27
+ },
28
+ },
29
+ });
30
+ };
31
+ /**
32
+ * Converts definition-list source groups to safe inline HTML blocks.
33
+ */
34
+ export const transformDefinitionLists = (markdown, _options = {}) => {
35
+ const lines = markdown.split('\n');
36
+ const result = [];
37
+ let index = 0;
38
+ while (index < lines.length) {
39
+ const parsed = readDefinitionList(lines, index);
40
+ if (!parsed) {
41
+ result.push(lines[index]);
42
+ index += 1;
43
+ continue;
44
+ }
45
+ result.push(renderDefinitionBlockSource(parsed.lines));
46
+ index = parsed.nextIndex;
47
+ }
48
+ return result.join('\n');
49
+ };
50
+ /**
51
+ * Reads a contiguous definition list group from a line array.
52
+ */
53
+ export const readDefinitionList = (lines, startIndex) => {
54
+ if (!isDefinitionTermStart(lines, startIndex))
55
+ return null;
56
+ const entries = [];
57
+ const sourceLines = [];
58
+ let index = startIndex;
59
+ while (index < lines.length && isDefinitionTermStart(lines, index)) {
60
+ const term = lines[index].trim();
61
+ const definitions = [];
62
+ sourceLines.push(lines[index]);
63
+ index += 1;
64
+ while (index < lines.length && isDefinitionLine(lines[index])) {
65
+ definitions.push(lines[index].trimStart().slice(2).trim());
66
+ sourceLines.push(lines[index]);
67
+ index += 1;
68
+ }
69
+ entries.push({ term, definitions });
70
+ const next = nextNonBlankLine(lines, index);
71
+ if (next === -1 || !isDefinitionTermStart(lines, next))
72
+ break;
73
+ while (index < next) {
74
+ sourceLines.push(lines[index]);
75
+ index += 1;
76
+ }
77
+ index = next;
78
+ }
79
+ return { entries, lines: sourceLines, nextIndex: index };
80
+ };
81
+ /**
82
+ * Renders definition list entries to escaped HTML.
83
+ */
84
+ export const renderDefinitionList = (entries, options = {}) => {
85
+ const classAttribute = options.className ? ` class="${escapeHtml(options.className)}"` : '';
86
+ const body = entries
87
+ .map((entry) => {
88
+ const definitions = entry.definitions
89
+ .map((definition) => ` <dd>${escapeHtml(definition)}</dd>`)
90
+ .join('\n');
91
+ return ` <dt>${escapeHtml(entry.term)}</dt>\n${definitions}`;
92
+ })
93
+ .join('\n');
94
+ return `<dl${classAttribute}>\n${body}\n</dl>`;
95
+ };
96
+ /**
97
+ * Checks whether a line begins a definition list term.
98
+ */
99
+ const isDefinitionTermStart = (lines, index) => {
100
+ return Boolean(lines[index]?.trim() && !isDefinitionLine(lines[index]) && isDefinitionLine(lines[index + 1] ?? ''));
101
+ };
102
+ /**
103
+ * Checks whether a line is a definition item line.
104
+ */
105
+ const isDefinitionLine = (line) => line.trimStart().startsWith(': ');
106
+ /**
107
+ * Finds the next non-blank line index.
108
+ */
109
+ const nextNonBlankLine = (lines, startIndex) => {
110
+ let index = startIndex;
111
+ while (index < lines.length && !lines[index].trim())
112
+ index += 1;
113
+ return index < lines.length ? index : -1;
114
+ };
115
+ /**
116
+ * Escapes HTML-sensitive characters in definition list content.
117
+ */
118
+ const escapeHtml = (value) => {
119
+ return value
120
+ .replace(/&/g, '&amp;')
121
+ .replace(/</g, '&lt;')
122
+ .replace(/>/g, '&gt;')
123
+ .replace(/"/g, '&quot;');
124
+ };
125
+ /**
126
+ * Renders definition list source into an internal custom block.
127
+ */
128
+ const renderDefinitionBlockSource = (lines) => {
129
+ return ['::deflist', ...lines, '::'].join('\n');
130
+ };
131
+ /**
132
+ * Checks that a custom block value was produced by the deflist parser.
133
+ */
134
+ const isDeflistValue = (value) => {
135
+ if (!value || typeof value !== 'object')
136
+ return false;
137
+ const candidate = value;
138
+ return Array.isArray(candidate.entries);
139
+ };
140
+ export default deflistPlugin;
141
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAoB,MAAM,OAAO,CAAC;AAe5D;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,UAAgC,EAAE,EAAe,EAAE;IAC/E,OAAO,iBAAiB,CAAC;QACvB,IAAI,EAAE,SAAS;QACf,MAAM,EAAE;YACN,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS;gBACf,KAAK,CAAC,EAAE,OAAO,EAAE;oBACf,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,IAAI,EAAE,EAAE,CAAC;gBAC5C,CAAC;gBACD,OAAO,EAAE;oBACP,IAAI,CAAC,IAAI;wBACP,IAAI,IAAI,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC;4BAAE,OAAO,EAAE,CAAC;wBAC1E,OAAO,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAC3D,CAAC;iBACF;aACF;SACF;QACD,KAAK,EAAE;YACL,WAAW,CAAC,QAAQ;gBAClB,OAAO,wBAAwB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC;SACF;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAE,WAAiC,EAAE,EAAU,EAAE;IACxG,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1B,KAAK,IAAI,CAAC,CAAC;YACX,SAAS;QACX,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACvD,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC;IAC3B,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAe,EACf,UAAkB,EACyD,EAAE;IAC7E,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IAE3D,MAAM,OAAO,GAAsB,EAAE,CAAC;IACtC,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,IAAI,KAAK,GAAG,UAAU,CAAC;IAEvB,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,IAAI,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;QACjC,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/B,KAAK,IAAI,CAAC,CAAC;QAEX,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC9D,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3D,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/B,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QAEpC,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5C,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC;YAAE,MAAM;QAC9D,OAAO,KAAK,GAAG,IAAI,EAAE,CAAC;YACpB,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/B,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;QACD,KAAK,GAAG,IAAI,CAAC;IACf,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,OAA0B,EAC1B,UAAgC,EAAE,EAC1B,EAAE;IACV,MAAM,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,MAAM,IAAI,GAAG,OAAO;SACjB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW;aAClC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,SAAS,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;aAC3D,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,SAAS,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,WAAW,EAAE,CAAC;IAChE,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO,MAAM,cAAc,MAAM,IAAI,SAAS,CAAC;AACjD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAAC,KAAe,EAAE,KAAa,EAAW,EAAE;IACxE,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AACtH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAEtF;;GAEG;AACH,MAAM,gBAAgB,GAAG,CAAC,KAAe,EAAE,UAAkB,EAAU,EAAE;IACvE,IAAI,KAAK,GAAG,UAAU,CAAC;IACvB,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE;QAAE,KAAK,IAAI,CAAC,CAAC;IAChE,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,KAAa,EAAU,EAAE;IAC3C,OAAO,KAAK;SACT,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;SACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,2BAA2B,GAAG,CAAC,KAAe,EAAU,EAAE;IAC9D,OAAO,CAAC,WAAW,EAAE,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,cAAc,GAAG,CAAC,KAAc,EAAyB,EAAE;IAC/D,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACtD,MAAM,SAAS,GAAG,KAA8B,CAAC;IACjD,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}
package/package.json ADDED
@@ -0,0 +1,31 @@
1
+ {
2
+ "name": "nizel-plugin-deflist",
3
+ "version": "0.1.0",
4
+ "description": "Definition list support plugin for Nizel.",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.js"
12
+ }
13
+ },
14
+ "files": [
15
+ "dist",
16
+ "README.md"
17
+ ],
18
+ "scripts": {
19
+ "build": "tsc -p tsconfig.json",
20
+ "typecheck": "tsc -p tsconfig.json --noEmit",
21
+ "test": "npm run build && vitest run test/*.mjs",
22
+ "test:watch": "npm run build && vitest test/*.mjs"
23
+ },
24
+ "peerDependencies": {
25
+ "nizel": "^0.1.0"
26
+ },
27
+ "publishConfig": {
28
+ "access": "public",
29
+ "provenance": true
30
+ }
31
+ }