textlane 0.0.0 → 0.2.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 (42) hide show
  1. package/LICENSE.md +9 -0
  2. package/README.md +80 -2
  3. package/build/actions/addon/resolve.d.ts +7 -0
  4. package/build/actions/addon/resolve.js +22 -0
  5. package/build/actions/attacher/check.d.ts +3 -0
  6. package/build/actions/attacher/check.js +5 -0
  7. package/build/actions/host/call.d.ts +13 -0
  8. package/build/actions/host/call.js +47 -0
  9. package/build/actions/options/merge.d.ts +5 -0
  10. package/build/actions/options/merge.js +29 -0
  11. package/build/actions/pluggable/map.d.ts +8 -0
  12. package/build/actions/pluggable/map.js +29 -0
  13. package/build/actions/run/finish.d.ts +12 -0
  14. package/build/actions/run/finish.js +52 -0
  15. package/build/actions/transformer/check.d.ts +3 -0
  16. package/build/actions/transformer/check.js +5 -0
  17. package/build/generated/html.d.ts +260 -0
  18. package/build/generated/html.js +76 -0
  19. package/build/generated/md.d.ts +367 -0
  20. package/build/generated/md.js +100 -0
  21. package/build/generated/mdx.d.ts +28 -0
  22. package/build/generated/mdx.js +8 -0
  23. package/build/generated/nl.d.ts +99 -0
  24. package/build/generated/nl.js +62 -0
  25. package/build/index.d.ts +18 -0
  26. package/build/index.js +27 -0
  27. package/build/models/addon.d.ts +35 -0
  28. package/build/models/addon.js +2 -0
  29. package/build/models/file.d.ts +52 -0
  30. package/build/models/file.js +2 -0
  31. package/build/models/host.d.ts +7 -0
  32. package/build/models/host.js +2 -0
  33. package/build/models/plugin.d.ts +26 -0
  34. package/build/models/plugin.js +2 -0
  35. package/build/models/processor.d.ts +39 -0
  36. package/build/models/processor.js +154 -0
  37. package/build/models/vfile.d.ts +52 -0
  38. package/build/models/vfile.js +164 -0
  39. package/build/settings.d.ts +14 -0
  40. package/build/settings.js +17 -0
  41. package/package.json +36 -3
  42. package/skills/textlane-usage/SKILL.md +148 -0
@@ -0,0 +1,52 @@
1
+ import type { Message, MessageOptions, Place } from "./file.ts";
2
+ /**
3
+ * The file a JavaScript plugin gets, as a vfile: the document, its path, data and messages.
4
+ * Only what plugins report here reaches the result; native stages report there directly.
5
+ */
6
+ export declare class HostFile {
7
+ value: string | undefined;
8
+ data: Record<string, unknown>;
9
+ messages: HostMessage[];
10
+ history: string[];
11
+ cwd: string;
12
+ constructor(options: {
13
+ value?: string;
14
+ path?: string;
15
+ });
16
+ /** The current path; setting it adds to `history`. */
17
+ get path(): string | undefined;
18
+ set path(path: string | undefined);
19
+ get dirname(): string | undefined;
20
+ get basename(): string | undefined;
21
+ get extname(): string | undefined;
22
+ get stem(): string | undefined;
23
+ /** Report a warning against the file, as vfile's `message`; `origin` is `source:ruleId`. */
24
+ message(reason: string | Error, options?: MessageOptions | Place | null, origin?: string): HostMessage;
25
+ /** Report a note against the file, neither a warning nor an error. */
26
+ info(reason: string | Error, options?: MessageOptions | Place | null, origin?: string): HostMessage;
27
+ /** Report an error against the file and throw it. */
28
+ fail(reason: string | Error, options?: MessageOptions | Place | null, origin?: string): never;
29
+ toString(): string;
30
+ }
31
+ /** A diagnostic a JavaScript plugin reported, as vfile-message has it. */
32
+ export declare class HostMessage extends Error {
33
+ reason: string;
34
+ ruleId: string | null;
35
+ source: string | null;
36
+ place: Message["place"];
37
+ line: number | undefined;
38
+ column: number | undefined;
39
+ fatal: boolean | null | undefined;
40
+ file: string;
41
+ ancestors: unknown[] | undefined;
42
+ cause: unknown;
43
+ actual: string | undefined;
44
+ expected: string[] | undefined;
45
+ url: string | undefined;
46
+ note: string | undefined;
47
+ constructor(reason: string | Error, options?: MessageOptions | Place | null, origin?: string);
48
+ /** A message a native stage reported, as the file's other messages are. */
49
+ static fromMessage(message: Message, path: string | undefined): HostMessage;
50
+ /** The message as it crosses into the crate. */
51
+ toJSON(): Message;
52
+ }
@@ -0,0 +1,164 @@
1
+ import { basename, dirname, extname } from "node:path";
2
+ /**
3
+ * The file a JavaScript plugin gets, as a vfile: the document, its path, data and messages.
4
+ * Only what plugins report here reaches the result; native stages report there directly.
5
+ */
6
+ export class HostFile {
7
+ value;
8
+ data = {};
9
+ messages = [];
10
+ history = [];
11
+ cwd = process.cwd();
12
+ constructor(options) {
13
+ this.value = options.value;
14
+ if (options.path !== undefined)
15
+ this.history.push(options.path);
16
+ }
17
+ /** The current path; setting it adds to `history`. */
18
+ get path() {
19
+ return this.history.at(-1);
20
+ }
21
+ set path(path) {
22
+ if (path !== undefined && path !== this.path)
23
+ this.history.push(path);
24
+ }
25
+ get dirname() {
26
+ return this.path === undefined ? undefined : dirname(this.path);
27
+ }
28
+ get basename() {
29
+ return this.path === undefined ? undefined : basename(this.path);
30
+ }
31
+ get extname() {
32
+ return this.path === undefined ? undefined : extname(this.path);
33
+ }
34
+ get stem() {
35
+ return this.path === undefined ? undefined : basename(this.path, extname(this.path));
36
+ }
37
+ /** Report a warning against the file, as vfile's `message`; `origin` is `source:ruleId`. */
38
+ message(reason, options, origin) {
39
+ const message = new HostMessage(reason, options, origin);
40
+ message.file = this.path ?? "";
41
+ message.fatal = false;
42
+ this.messages.push(message);
43
+ return message;
44
+ }
45
+ /** Report a note against the file, neither a warning nor an error. */
46
+ info(reason, options, origin) {
47
+ const message = this.message(reason, options, origin);
48
+ message.fatal = null;
49
+ return message;
50
+ }
51
+ /** Report an error against the file and throw it. */
52
+ fail(reason, options, origin) {
53
+ const message = this.message(reason, options, origin);
54
+ message.fatal = true;
55
+ throw message;
56
+ }
57
+ toString() {
58
+ return this.value ?? "";
59
+ }
60
+ }
61
+ /** A diagnostic a JavaScript plugin reported, as vfile-message has it. */
62
+ export class HostMessage extends Error {
63
+ reason;
64
+ ruleId = null;
65
+ source = null;
66
+ place;
67
+ line;
68
+ column;
69
+ fatal;
70
+ file = "";
71
+ ancestors;
72
+ cause;
73
+ actual;
74
+ expected;
75
+ url;
76
+ note;
77
+ constructor(reason, options, origin) {
78
+ const text = typeof reason === "string" ? reason : reason.message;
79
+ super(text);
80
+ this.reason = text;
81
+ if (typeof reason !== "string")
82
+ this.cause = reason;
83
+ const settings = readSettings(options);
84
+ if (settings.cause !== undefined)
85
+ this.cause = settings.cause;
86
+ this.ancestors = settings.ancestors;
87
+ this.ruleId = settings.ruleId ?? null;
88
+ this.source = settings.source ?? null;
89
+ if (origin !== undefined) {
90
+ const index = origin.indexOf(":");
91
+ if (index === -1)
92
+ this.ruleId = origin;
93
+ else
94
+ [this.source, this.ruleId] = [origin.slice(0, index), origin.slice(index + 1)];
95
+ }
96
+ this.place = readPlace(settings.place ?? settings.ancestors?.at(-1));
97
+ this.line = this.place?.start.line;
98
+ this.column = this.place?.start.column;
99
+ this.name = writePlace(this.place);
100
+ }
101
+ /** A message a native stage reported, as the file's other messages are. */
102
+ static fromMessage(message, path) {
103
+ const options = {
104
+ place: message.place ?? undefined,
105
+ ruleId: message.ruleId ?? undefined,
106
+ source: message.source ?? undefined,
107
+ };
108
+ const created = new HostMessage(message.reason, options);
109
+ created.file = path ?? "";
110
+ created.fatal = false;
111
+ return created;
112
+ }
113
+ /** The message as it crosses into the crate. */
114
+ toJSON() {
115
+ return {
116
+ reason: this.reason,
117
+ ruleId: this.ruleId,
118
+ source: this.source,
119
+ place: this.place,
120
+ };
121
+ }
122
+ }
123
+ // vfile tells options from a place by their keys; anything else is the place itself
124
+ function readSettings(options) {
125
+ if (!options)
126
+ return {};
127
+ return isMessageOptions(options) ? options : { place: options };
128
+ }
129
+ function isMessageOptions(options) {
130
+ return ["ancestors", "cause", "place", "ruleId", "source"].some(key => key in options);
131
+ }
132
+ function readPlace(place) {
133
+ if (typeof place !== "object" || place === null)
134
+ return null;
135
+ if ("position" in place)
136
+ return readPlace(place.position);
137
+ if ("start" in place && "end" in place) {
138
+ const start = readPoint(place.start);
139
+ const end = readPoint(place.end);
140
+ return start && end ? { start, end } : null;
141
+ }
142
+ const point = readPoint(place);
143
+ return point ? { start: point, end: point } : null;
144
+ }
145
+ function readPoint(value) {
146
+ if (typeof value !== "object" || value === null)
147
+ return undefined;
148
+ if (!("line" in value && "column" in value))
149
+ return undefined;
150
+ const { line, column } = value;
151
+ if (typeof line !== "number" || typeof column !== "number")
152
+ return undefined;
153
+ const offset = "offset" in value && typeof value.offset === "number" ? value.offset : null;
154
+ return { line, column, offset };
155
+ }
156
+ // unist-util-stringify-position: `1:1-1:2`, or `1:1` for an unknown place
157
+ function writePlace(place) {
158
+ if (!place)
159
+ return "1:1";
160
+ const start = `${place.start.line}:${place.start.column}`;
161
+ const end = `${place.end.line}:${place.end.column}`;
162
+ return start === end ? start : `${start}-${end}`;
163
+ }
164
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"vfile.js","sourceRoot":"","sources":["../../models/vfile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAGtD;;;GAGG;AACH,MAAM,OAAO,QAAQ;IACnB,KAAK,CAAoB;IACzB,IAAI,GAA4B,EAAE,CAAA;IAClC,QAAQ,GAAkB,EAAE,CAAA;IAC5B,OAAO,GAAa,EAAE,CAAA;IACtB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;IAEnB,YAAY,OAA0C;QACpD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC1B,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACjE,CAAC;IAED,sDAAsD;IACtD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IAC5B,CAAC;IAED,IAAI,IAAI,CAAC,IAAwB;QAC/B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvE,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACjE,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClE,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACjE,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACtF,CAAC;IAED,4FAA4F;IAC5F,OAAO,CACL,MAAsB,EACtB,OAAuC,EACvC,MAAe;QAEf,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;QACxD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAA;QAC9B,OAAO,CAAC,KAAK,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC3B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,sEAAsE;IACtE,IAAI,CAAC,MAAsB,EAAE,OAAuC,EAAE,MAAe;QACnF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;QACrD,OAAO,CAAC,KAAK,GAAG,IAAI,CAAA;QACpB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,qDAAqD;IACrD,IAAI,CACF,MAAsB,EACtB,OAAuC,EACvC,MAAe;QAEf,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;QACrD,OAAO,CAAC,KAAK,GAAG,IAAI,CAAA;QACpB,MAAM,OAAO,CAAA;IACf,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,IAAI,EAAE,CAAA;IACzB,CAAC;CACF;AAED,0EAA0E;AAC1E,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,MAAM,CAAQ;IACd,MAAM,GAAkB,IAAI,CAAA;IAC5B,MAAM,GAAkB,IAAI,CAAA;IAC5B,KAAK,CAAkB;IACvB,IAAI,CAAoB;IACxB,MAAM,CAAoB;IAC1B,KAAK,CAA4B;IACjC,IAAI,GAAG,EAAE,CAAA;IACT,SAAS,CAAuB;IAChC,KAAK,CAAS;IACd,MAAM,CAAoB;IAC1B,QAAQ,CAAsB;IAC9B,GAAG,CAAoB;IACvB,IAAI,CAAoB;IAExB,YACE,MAAsB,EACtB,OAAuC,EACvC,MAAe;QAEf,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAA;QACjE,KAAK,CAAC,IAAI,CAAC,CAAA;QACX,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,OAAO,MAAM,KAAK,QAAQ;YAAE,IAAI,CAAC,KAAK,GAAG,MAAM,CAAA;QACnD,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;QACtC,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAA;QAC7D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;QACnC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAA;QACrC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAA;QACrC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YACjC,IAAI,KAAK,KAAK,CAAC,CAAC;gBAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;;gBACjC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAA;QACrF,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAA;QACtC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,WAAW,CAAC,OAAgB,EAAE,IAAwB;QAC3D,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,SAAS;YACjC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;YACnC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;SACpC,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACxD,OAAO,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACzB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAA;QACrB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,gDAAgD;IAChD,MAAM;QACJ,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAA;IACH,CAAC;CACF;AAED,oFAAoF;AACpF,SAAS,YAAY,CACnB,OAAkD;IAElD,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAA;IACvB,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAA;AACjE,CAAC;AAED,SAAS,gBAAgB,CAAC,OAA+B;IACvD,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,OAAO,CAAC,CAAA;AACxF,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAC5D,IAAI,UAAU,IAAI,KAAK;QAAE,OAAO,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IACzD,IAAI,OAAO,IAAI,KAAK,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACpC,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChC,OAAO,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;IAC7C,CAAC;IACD,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;IAC9B,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACpD,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAA;IACjE,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IAC7D,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IAC9B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAA;IAC5E,MAAM,MAAM,GACV,QAAQ,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;IAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;AACjC,CAAC;AAED,0EAA0E;AAC1E,SAAS,UAAU,CAAC,KAAuB;IACzC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAA;IACxB,MAAM,KAAK,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAA;IACzD,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAA;IACnD,OAAO,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,GAAG,EAAE,CAAA;AAClD,CAAC","sourcesContent":["import { basename, dirname, extname } from \"node:path\"\nimport type { Message, MessageOptions, Place, Point } from \"./file.ts\"\n\n/**\n * The file a JavaScript plugin gets, as a vfile: the document, its path, data and messages.\n * Only what plugins report here reaches the result; native stages report there directly.\n */\nexport class HostFile {\n  value: string | undefined\n  data: Record<string, unknown> = {}\n  messages: HostMessage[] = []\n  history: string[] = []\n  cwd = process.cwd()\n\n  constructor(options: { value?: string; path?: string }) {\n    this.value = options.value\n    if (options.path !== undefined) this.history.push(options.path)\n  }\n\n  /** The current path; setting it adds to `history`. */\n  get path() {\n    return this.history.at(-1)\n  }\n\n  set path(path: string | undefined) {\n    if (path !== undefined && path !== this.path) this.history.push(path)\n  }\n\n  get dirname() {\n    return this.path === undefined ? undefined : dirname(this.path)\n  }\n\n  get basename() {\n    return this.path === undefined ? undefined : basename(this.path)\n  }\n\n  get extname() {\n    return this.path === undefined ? undefined : extname(this.path)\n  }\n\n  get stem() {\n    return this.path === undefined ? undefined : basename(this.path, extname(this.path))\n  }\n\n  /** Report a warning against the file, as vfile's `message`; `origin` is `source:ruleId`. */\n  message(\n    reason: string | Error,\n    options?: MessageOptions | Place | null,\n    origin?: string,\n  ) {\n    const message = new HostMessage(reason, options, origin)\n    message.file = this.path ?? \"\"\n    message.fatal = false\n    this.messages.push(message)\n    return message\n  }\n\n  /** Report a note against the file, neither a warning nor an error. */\n  info(reason: string | Error, options?: MessageOptions | Place | null, origin?: string) {\n    const message = this.message(reason, options, origin)\n    message.fatal = null\n    return message\n  }\n\n  /** Report an error against the file and throw it. */\n  fail(\n    reason: string | Error,\n    options?: MessageOptions | Place | null,\n    origin?: string,\n  ): never {\n    const message = this.message(reason, options, origin)\n    message.fatal = true\n    throw message\n  }\n\n  toString() {\n    return this.value ?? \"\"\n  }\n}\n\n/** A diagnostic a JavaScript plugin reported, as vfile-message has it. */\nexport class HostMessage extends Error {\n  reason: string\n  ruleId: string | null = null\n  source: string | null = null\n  place: Message[\"place\"]\n  line: number | undefined\n  column: number | undefined\n  fatal: boolean | null | undefined\n  file = \"\"\n  ancestors: unknown[] | undefined\n  cause: unknown\n  actual: string | undefined\n  expected: string[] | undefined\n  url: string | undefined\n  note: string | undefined\n\n  constructor(\n    reason: string | Error,\n    options?: MessageOptions | Place | null,\n    origin?: string,\n  ) {\n    const text = typeof reason === \"string\" ? reason : reason.message\n    super(text)\n    this.reason = text\n    if (typeof reason !== \"string\") this.cause = reason\n    const settings = readSettings(options)\n    if (settings.cause !== undefined) this.cause = settings.cause\n    this.ancestors = settings.ancestors\n    this.ruleId = settings.ruleId ?? null\n    this.source = settings.source ?? null\n    if (origin !== undefined) {\n      const index = origin.indexOf(\":\")\n      if (index === -1) this.ruleId = origin\n      else [this.source, this.ruleId] = [origin.slice(0, index), origin.slice(index + 1)]\n    }\n    this.place = readPlace(settings.place ?? settings.ancestors?.at(-1))\n    this.line = this.place?.start.line\n    this.column = this.place?.start.column\n    this.name = writePlace(this.place)\n  }\n\n  /** A message a native stage reported, as the file's other messages are. */\n  static fromMessage(message: Message, path: string | undefined) {\n    const options = {\n      place: message.place ?? undefined,\n      ruleId: message.ruleId ?? undefined,\n      source: message.source ?? undefined,\n    }\n    const created = new HostMessage(message.reason, options)\n    created.file = path ?? \"\"\n    created.fatal = false\n    return created\n  }\n\n  /** The message as it crosses into the crate. */\n  toJSON(): Message {\n    return {\n      reason: this.reason,\n      ruleId: this.ruleId,\n      source: this.source,\n      place: this.place,\n    }\n  }\n}\n\n// vfile tells options from a place by their keys; anything else is the place itself\nfunction readSettings(\n  options: MessageOptions | Place | null | undefined,\n): MessageOptions {\n  if (!options) return {}\n  return isMessageOptions(options) ? options : { place: options }\n}\n\nfunction isMessageOptions(options: MessageOptions | Place): options is MessageOptions {\n  return [\"ancestors\", \"cause\", \"place\", \"ruleId\", \"source\"].some(key => key in options)\n}\n\nfunction readPlace(place: unknown): Message[\"place\"] {\n  if (typeof place !== \"object\" || place === null) return null\n  if (\"position\" in place) return readPlace(place.position)\n  if (\"start\" in place && \"end\" in place) {\n    const start = readPoint(place.start)\n    const end = readPoint(place.end)\n    return start && end ? { start, end } : null\n  }\n  const point = readPoint(place)\n  return point ? { start: point, end: point } : null\n}\n\nfunction readPoint(value: unknown): Point | undefined {\n  if (typeof value !== \"object\" || value === null) return undefined\n  if (!(\"line\" in value && \"column\" in value)) return undefined\n  const { line, column } = value\n  if (typeof line !== \"number\" || typeof column !== \"number\") return undefined\n  const offset =\n    \"offset\" in value && typeof value.offset === \"number\" ? value.offset : null\n  return { line, column, offset }\n}\n\n// unist-util-stringify-position: `1:1-1:2`, or `1:1` for an unknown place\nfunction writePlace(place: Message[\"place\"]) {\n  if (!place) return \"1:1\"\n  const start = `${place.start.line}:${place.start.column}`\n  const end = `${place.end.line}:${place.end.column}`\n  return start === end ? start : `${start}-${end}`\n}\n"]}
@@ -0,0 +1,14 @@
1
+ export interface Platform {
2
+ /** The npm package that carries this platform's addon. */
3
+ packageName: string;
4
+ /** The Rust target the addon is compiled for. */
5
+ target: string;
6
+ /** The addon's file name at the package's root. */
7
+ addon: string;
8
+ }
9
+ /** The npm package users install; it pulls in the one platform package that matches. */
10
+ export declare const PACKAGE_NAME = "textlane";
11
+ /** An environment variable that points at an addon to load instead of the installed one. */
12
+ export declare const ADDON_ENV = "TEXTLANE_ADDON";
13
+ /** Every published platform, keyed by `${process.platform}-${process.arch}`. */
14
+ export declare const PLATFORMS: Record<string, Platform>;
@@ -0,0 +1,17 @@
1
+ /** The npm package users install; it pulls in the one platform package that matches. */
2
+ export const PACKAGE_NAME = "textlane";
3
+ /** An environment variable that points at an addon to load instead of the installed one. */
4
+ export const ADDON_ENV = "TEXTLANE_ADDON";
5
+ /** Every published platform, keyed by `${process.platform}-${process.arch}`. */
6
+ export const PLATFORMS = {
7
+ "linux-x64": createPlatform("linux-x64", "x86_64-unknown-linux-gnu"),
8
+ "linux-arm64": createPlatform("linux-arm64", "aarch64-unknown-linux-gnu"),
9
+ "darwin-x64": createPlatform("darwin-x64", "x86_64-apple-darwin"),
10
+ "darwin-arm64": createPlatform("darwin-arm64", "aarch64-apple-darwin"),
11
+ "win32-x64": createPlatform("win32-x64", "x86_64-pc-windows-msvc"),
12
+ "win32-arm64": createPlatform("win32-arm64", "aarch64-pc-windows-msvc"),
13
+ };
14
+ function createPlatform(key, target) {
15
+ return { packageName: `@textlane/${key}`, target, addon: "textlane.node" };
16
+ }
17
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2V0dGluZ3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zZXR0aW5ncy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFTQSx3RkFBd0Y7QUFDeEYsTUFBTSxDQUFDLE1BQU0sWUFBWSxHQUFHLFVBQVUsQ0FBQTtBQUV0Qyw0RkFBNEY7QUFDNUYsTUFBTSxDQUFDLE1BQU0sU0FBUyxHQUFHLGdCQUFnQixDQUFBO0FBRXpDLGdGQUFnRjtBQUNoRixNQUFNLENBQUMsTUFBTSxTQUFTLEdBQTZCO0lBQ2pELFdBQVcsRUFBRSxjQUFjLENBQUMsV0FBVyxFQUFFLDBCQUEwQixDQUFDO0lBQ3BFLGFBQWEsRUFBRSxjQUFjLENBQUMsYUFBYSxFQUFFLDJCQUEyQixDQUFDO0lBQ3pFLFlBQVksRUFBRSxjQUFjLENBQUMsWUFBWSxFQUFFLHFCQUFxQixDQUFDO0lBQ2pFLGNBQWMsRUFBRSxjQUFjLENBQUMsY0FBYyxFQUFFLHNCQUFzQixDQUFDO0lBQ3RFLFdBQVcsRUFBRSxjQUFjLENBQUMsV0FBVyxFQUFFLHdCQUF3QixDQUFDO0lBQ2xFLGFBQWEsRUFBRSxjQUFjLENBQUMsYUFBYSxFQUFFLHlCQUF5QixDQUFDO0NBQ3hFLENBQUE7QUFFRCxTQUFTLGNBQWMsQ0FBQyxHQUFXLEVBQUUsTUFBYztJQUNqRCxPQUFPLEVBQUUsV0FBVyxFQUFFLGFBQWEsR0FBRyxFQUFFLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxlQUFlLEVBQUUsQ0FBQTtBQUM1RSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBQbGF0Zm9ybSB7XG4gIC8qKiBUaGUgbnBtIHBhY2thZ2UgdGhhdCBjYXJyaWVzIHRoaXMgcGxhdGZvcm0ncyBhZGRvbi4gKi9cbiAgcGFja2FnZU5hbWU6IHN0cmluZ1xuICAvKiogVGhlIFJ1c3QgdGFyZ2V0IHRoZSBhZGRvbiBpcyBjb21waWxlZCBmb3IuICovXG4gIHRhcmdldDogc3RyaW5nXG4gIC8qKiBUaGUgYWRkb24ncyBmaWxlIG5hbWUgYXQgdGhlIHBhY2thZ2UncyByb290LiAqL1xuICBhZGRvbjogc3RyaW5nXG59XG5cbi8qKiBUaGUgbnBtIHBhY2thZ2UgdXNlcnMgaW5zdGFsbDsgaXQgcHVsbHMgaW4gdGhlIG9uZSBwbGF0Zm9ybSBwYWNrYWdlIHRoYXQgbWF0Y2hlcy4gKi9cbmV4cG9ydCBjb25zdCBQQUNLQUdFX05BTUUgPSBcInRleHRsYW5lXCJcblxuLyoqIEFuIGVudmlyb25tZW50IHZhcmlhYmxlIHRoYXQgcG9pbnRzIGF0IGFuIGFkZG9uIHRvIGxvYWQgaW5zdGVhZCBvZiB0aGUgaW5zdGFsbGVkIG9uZS4gKi9cbmV4cG9ydCBjb25zdCBBRERPTl9FTlYgPSBcIlRFWFRMQU5FX0FERE9OXCJcblxuLyoqIEV2ZXJ5IHB1Ymxpc2hlZCBwbGF0Zm9ybSwga2V5ZWQgYnkgYCR7cHJvY2Vzcy5wbGF0Zm9ybX0tJHtwcm9jZXNzLmFyY2h9YC4gKi9cbmV4cG9ydCBjb25zdCBQTEFURk9STVM6IFJlY29yZDxzdHJpbmcsIFBsYXRmb3JtPiA9IHtcbiAgXCJsaW51eC14NjRcIjogY3JlYXRlUGxhdGZvcm0oXCJsaW51eC14NjRcIiwgXCJ4ODZfNjQtdW5rbm93bi1saW51eC1nbnVcIiksXG4gIFwibGludXgtYXJtNjRcIjogY3JlYXRlUGxhdGZvcm0oXCJsaW51eC1hcm02NFwiLCBcImFhcmNoNjQtdW5rbm93bi1saW51eC1nbnVcIiksXG4gIFwiZGFyd2luLXg2NFwiOiBjcmVhdGVQbGF0Zm9ybShcImRhcndpbi14NjRcIiwgXCJ4ODZfNjQtYXBwbGUtZGFyd2luXCIpLFxuICBcImRhcndpbi1hcm02NFwiOiBjcmVhdGVQbGF0Zm9ybShcImRhcndpbi1hcm02NFwiLCBcImFhcmNoNjQtYXBwbGUtZGFyd2luXCIpLFxuICBcIndpbjMyLXg2NFwiOiBjcmVhdGVQbGF0Zm9ybShcIndpbjMyLXg2NFwiLCBcIng4Nl82NC1wYy13aW5kb3dzLW1zdmNcIiksXG4gIFwid2luMzItYXJtNjRcIjogY3JlYXRlUGxhdGZvcm0oXCJ3aW4zMi1hcm02NFwiLCBcImFhcmNoNjQtcGMtd2luZG93cy1tc3ZjXCIpLFxufVxuXG5mdW5jdGlvbiBjcmVhdGVQbGF0Zm9ybShrZXk6IHN0cmluZywgdGFyZ2V0OiBzdHJpbmcpOiBQbGF0Zm9ybSB7XG4gIHJldHVybiB7IHBhY2thZ2VOYW1lOiBgQHRleHRsYW5lLyR7a2V5fWAsIHRhcmdldCwgYWRkb246IFwidGV4dGxhbmUubm9kZVwiIH1cbn1cbiJdfQ==
package/package.json CHANGED
@@ -1,12 +1,45 @@
1
1
  {
2
2
  "name": "textlane",
3
- "version": "0.0.0",
4
- "description": "Placeholder reserving the name; the first real release follows",
3
+ "version": "0.2.0",
4
+ "description": "Rust-native text processing pipeline — a unified replacement with native and JavaScript plugins",
5
+ "keywords": [
6
+ "ast",
7
+ "html",
8
+ "markdown",
9
+ "mdx",
10
+ "pipeline",
11
+ "unified"
12
+ ],
13
+ "homepage": "https://textlane.dev",
5
14
  "license": "MIT",
15
+ "author": "Evgeny Karev",
6
16
  "repository": {
7
17
  "type": "git",
8
18
  "url": "git+https://github.com/datisthq/textlane.git",
9
19
  "directory": "typescript"
10
20
  },
11
- "homepage": "https://textlane.dev"
21
+ "files": [
22
+ "build",
23
+ "skills"
24
+ ],
25
+ "type": "module",
26
+ "sideEffects": false,
27
+ "exports": {
28
+ ".": "./build/index.js",
29
+ "./md": "./build/generated/md.js",
30
+ "./html": "./build/generated/html.js",
31
+ "./mdx": "./build/generated/mdx.js",
32
+ "./nl": "./build/generated/nl.js"
33
+ },
34
+ "engines": {
35
+ "node": ">=20"
36
+ },
37
+ "optionalDependencies": {
38
+ "@textlane/linux-x64": "0.2.0",
39
+ "@textlane/linux-arm64": "0.2.0",
40
+ "@textlane/darwin-x64": "0.2.0",
41
+ "@textlane/darwin-arm64": "0.2.0",
42
+ "@textlane/win32-x64": "0.2.0",
43
+ "@textlane/win32-arm64": "0.2.0"
44
+ }
12
45
  }
@@ -0,0 +1,148 @@
1
+ ---
2
+ name: textlane-usage
3
+ description: Use when installing textlane or calling it from Rust, Node.js or Python — which package each language uses, how to build a pipeline of native plugins, the processor API and what it does not offer yet.
4
+ ---
5
+
6
+ # Textlane Usage
7
+
8
+ Textlane is a Rust-native text processing pipeline: a replacement for unified whose plugins run
9
+ natively, with Node.js and Python bindings over the same crate. It is pre-release.
10
+
11
+ ## When to use this skill
12
+
13
+ Invoke when the user asks to:
14
+
15
+ - Install textlane in a Rust, Node.js or Python project.
16
+ - Turn Markdown into HTML (or HTML into Markdown, MDX into JavaScript, natural language into checks) with
17
+ textlane, or port a unified, remark, rehype or retext pipeline to it.
18
+ - Check which textlane version is installed.
19
+
20
+ ## Install
21
+
22
+ | Language | Package | Install |
23
+ | -------- | ---------------------- | ---------------------- |
24
+ | Rust | `textlane` (crates.io) | `cargo add textlane` |
25
+ | Node.js | `textlane` (npm) | `npm install textlane` |
26
+ | Python | `textlane` (PyPI) | `pip install textlane` |
27
+
28
+ Every channel ships the same crate at the same version. npm installs one prebuilt addon for the
29
+ current platform as an optional dependency; never install with `--omit=optional`.
30
+
31
+ ## Plugins
32
+
33
+ Plugins are grouped by domain and named `<domain>.<name>`, the name unified's ecosystem uses
34
+ spelled out: `md.parse`, `md.gfm`, `md.toHtml`, `html.stringify`, `html.toMarkdown`,
35
+ `mdx.compile`, `nl.parse`, `nl.equality`. Options take the upstream plugin's camelCase
36
+ names (`allowDangerousHtml`, as remark-rehype). A pipeline has one parser and one compiler, and
37
+ bridges such as `md.toHtml` (remark-rehype) change the tree between them.
38
+
39
+ | Domain | Node.js | Python | Rust |
40
+ | ------ | --------------- | --------------- | ---------------- |
41
+ | `md` | `textlane/md` | `textlane.md` | `textlane::md` |
42
+ | `html` | `textlane/html` | `textlane.html` | `textlane::html` |
43
+ | `mdx` | `textlane/mdx` | `textlane.mdx` | `textlane::mdx` |
44
+ | `nl` | `textlane/nl` | `textlane.nl` | `textlane::nl` |
45
+
46
+ `pluginNames()` (Node.js) and `textlane.plugin_names()` (Python) list every plugin.
47
+
48
+ ## Node.js
49
+
50
+ ```js
51
+ import { textlane } from "textlane"
52
+ import * as html from "textlane/html"
53
+ import * as md from "textlane/md"
54
+
55
+ const file = await textlane()
56
+ .use(md.parse())
57
+ .use(md.gfm())
58
+ .use(md.toHtml({ allowDangerousHtml: true }))
59
+ .use(html.stringify({ allowDangerousHtml: true }))
60
+ .process("# hi")
61
+ file.value // "<h1>hi</h1>"
62
+ file.messages // [{ reason, ruleId, source, place }]
63
+ ```
64
+
65
+ A domain function returns a descriptor, `{ name: "md.toHtml", options }`, typed from the
66
+ crate. The processor follows unified: `use(plugin | [plugin, options] | preset | list)`,
67
+ `data(key?, value?)`, `freeze()`, `parse(text)`, `run(tree, file?)` (Promise),
68
+ `runSync(tree, file?)`, `stringify(tree)`, `process(text)` (Promise) and `processSync(text)`.
69
+ Trees are plain unist JSON objects.
70
+
71
+ ## Python
72
+
73
+ ```python
74
+ from textlane import html, md, textlane
75
+
76
+ file = (
77
+ textlane()
78
+ .use(md.parse())
79
+ .use(md.gfm())
80
+ .use(md.to_html({"allowDangerousHtml": True}))
81
+ .use(html.stringify())
82
+ .process("# hi")
83
+ )
84
+ file["value"] # "<h1>hi</h1>"
85
+ ```
86
+
87
+ Functions are snake_case (`md.to_html`, `nl.indefinite_article`); their options stay the
88
+ camelCase keys the plugin takes, typed as `TypedDict`s. `process(text)` and `run(tree)`
89
+ return directly; `await processor.aprocess(text)` and `await processor.arun(tree)` are their
90
+ coroutines. A
91
+ file and a tree are dicts.
92
+
93
+ ## Rust
94
+
95
+ ```rust
96
+ use textlane::{Processor, html, md};
97
+
98
+ let processor = Processor::new()
99
+ .with(md::Parse::default())
100
+ .with(md::ToHtml::default())
101
+ .with(html::Stringify::default())
102
+ .freeze()?;
103
+ let output = processor.process("# hi")?; // output.value, output.file.messages
104
+ ```
105
+
106
+ ## Memory
107
+
108
+ A document's trees are built in working memory that each thread keeps afterwards, emptied, so
109
+ the next document reuses it instead of asking the system again. At most 256 MB is kept per
110
+ thread; a larger document's memory is freed once it finishes. Change the cap, in bytes, with
111
+ `setRetainedMemory(bytes)` (Node.js), `textlane.set_retained_memory(bytes)` (Python) or
112
+ `textlane::set_retained_memory(bytes)` (Rust), and read it back with `retainedMemory()`,
113
+ `textlane.retained_memory()` or `textlane::read_retained_memory()`. It applies to every
114
+ processor in the process. Raise it for documents of several megabytes, which need more
115
+ than 256 MB of working memory; lower it, or set `0`, when idle memory matters more than speed.
116
+
117
+ ## Errors
118
+
119
+ Failures raise an `Error` (Node.js) or `textlane.TextlaneError` (Python) whose `code` names
120
+ the case: `unknown-plugin`, `invalid-options`, `missing-parser`, `missing-compiler`,
121
+ `frozen-processor`, `async-in-sync`, `invalid-message`. Handle by code, not by message.
122
+
123
+ ## Not yet
124
+
125
+ - A JavaScript or Python plugin joins only as a transformer: `use(fn, options)` calls it at
126
+ freeze (`this` is the processor in JavaScript, the first argument in Python) and runs what it
127
+ returns over the JSON tree; its file is vfile-shaped, its path from `process({value, path})`.
128
+ The tree crosses as JSON, so non-JSON values in nodes or `data` do not survive a native
129
+ stage. Syntax plugins (remark-gfm, remark-directive, remark-math) need the native ones; do
130
+ not port a pipeline that needs one textlane lacks, say so. A remark plugin that only turns
131
+ directives, `> [!NOTE]` alerts, definition lists or fenced code into MDX JSX elements is a
132
+ rule of `md.component` instead. A file-tree directive (livemark's `:::filetree`) is a rule with `treeAs`. remark-heading-id, strip-markdown, rehype-unwrap-images and
133
+ @stefanprobst/rehype-extract-toc are `md.headingId`, `md.strip`, `html.unwrapImages` and
134
+ `html.extractToc`; the table of contents lands in the result's `data.toc`. rehype-external-links is `html.externalLinks` (JSON options, no functions), and
135
+ `md.headingId({ attributes: true })` reads `{#id .class key=value}`. vfile-matter is
136
+ `md.frontmatter({ data: true })` (add `strip: true` to drop the node, `matters` for TOML too):
137
+ the YAML lands in the result's `data.matter`, `{}` without one; bad YAML fails with
138
+ `invalid-frontmatter`. An npm2yarn-style remark plugin (`@docusaurus/remark-plugin-npm2yarn`,
139
+ npm-to-yarn tabs) is `md.packageCommand`: a fenced `npm`, `pip` or `cargo` block becomes one
140
+ `PackageTabs` element with an attribute per manager (pnpm, yarn, bun; uv, poetry, pdm;
141
+ cargo-binstall). remark-toc is
142
+ `md.toc`: `heading` and `skip` are regex source strings, `parents` a JSON unist-util-is
143
+ test, never a function; JavaScript lookaround and back references fail with
144
+ `invalid-options`.
145
+ - Asset and page URLs relative to a Markdown file are `md.pathRewrite({ root, base, pages,
146
+ markdownLinks })`; pass the document as `{ value, path }` so it knows where the file lives.
147
+ - remark-stringify reads `settings` from processor data; textlane's `md.stringify` takes its
148
+ options directly.