micromark-extension-sub 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+# micromark-extension-sub
+
+[micromark](https://github.com/micromark/micromark) extension for inline substitution syntax (`:sub[INITIAL]{REPLACEMENT}`).
+
+Inline substitution enables progressive disclosure — show brief content initially, reveal full content on activation. Useful for TL;DR summaries, spoilers, and interactive learning. For a complete solution, use [`remark-sub`](https://www.npmjs.com/package/remark-sub).
+
+## Install
+
+```bash
+npm install micromark-extension-sub
+```
+
+## Usage
+
+```javascript
+import { micromark } from 'micromark'
+import { sub } from 'micromark-extension-sub'
+
+const html = micromark(':sub[initial]{replacement}', {
+  extensions: [sub()],
+  htmlExtensions: [{
+    enter: {
+      sub() { this.tag('<span class="sub">') }
+    },
+    exit: {
+      subInitialData(token) {
+        this.tag('<span class="initial">')
+        this.raw(this.sliceSerialize(token))
+        this.tag('</span>')
+      },
+      subReplacementData(token) {
+        this.tag('<span class="replacement">')
+        this.raw(this.sliceSerialize(token))
+        this.tag('</span>')
+      },
+      sub() { this.tag('</span>') }
+    }
+  }]
+})
+
+// Output: <p><span class="sub"><span class="initial">initial</span><span class="replacement">replacement</span></span></p>
+```
+
+**Note:** This extension only tokenizes the syntax. You must provide an `htmlExtensions` handler to render output, or use [`remark-sub`](https://www.npmjs.com/package/remark-sub) for a complete solution.
+
+## Tokens
+
+- `sub` — The whole construct
+- `subMarker` — The `:sub[`, `]`, `{`, and `}` markers
+- `subInitialData` — The INITIAL content
+- `subReplacementData` — The REPLACEMENT content
+
+## Syntax
+
+- Starts with `:sub[` (no whitespace allowed)
+- INITIAL ends with `]` (with bracket balancing)
+- REPLACEMENT is between `{` and `}` (with brace balancing)
+- Cannot span multiple lines
+- Must not be preceded by a word character (a-z, A-Z, 0-9, _)
+
+## Escaping
+
+**In INITIAL:**
+- `\]` → literal `]` (doesn't close)
+- `\[` → literal `[` (no depth change)
+- `\\` → literal `\`
+
+**In REPLACEMENT:**
+- `\}` → literal `}` (doesn't close)
+- `\{` → literal `{` (no depth change)
+- `\\` → literal `\`
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { sub, subConstruct } from './syntax.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { sub, subConstruct } from './syntax.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA"}

package/dist/syntax.d.ts

@@ -0,0 +1,13 @@
+import type { Construct, Extension } from 'micromark-util-types';
+declare module 'micromark-util-types' {
+    interface TokenTypeMap {
+        sub: 'sub';
+        subMarker: 'subMarker';
+        subInitialData: 'subInitialData';
+        subReplacementData: 'subReplacementData';
+    }
+}
+declare const subConstruct: Construct;
+export declare function sub(): Extension;
+export { subConstruct };
+//# sourceMappingURL=syntax.d.ts.map

package/dist/syntax.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"syntax.d.ts","sourceRoot":"","sources":["../src/syntax.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EAET,SAAS,EAIV,MAAM,sBAAsB,CAAA;AAE7B,OAAO,QAAQ,sBAAsB,CAAC;IACpC,UAAU,YAAY;QACpB,GAAG,EAAE,KAAK,CAAA;QACV,SAAS,EAAE,WAAW,CAAA;QACtB,cAAc,EAAE,gBAAgB,CAAA;QAChC,kBAAkB,EAAE,oBAAoB,CAAA;KACzC;CACF;AAED,QAAA,MAAM,YAAY,EAAE,SAInB,CAAA;AAiMD,wBAAgB,GAAG,IAAI,SAAS,CAM/B;AAED,OAAO,EAAE,YAAY,EAAE,CAAA"}

package/dist/syntax.js

@@ -0,0 +1,181 @@
+const subConstruct = {
+    name: 'sub',
+    tokenize: tokenizeSub,
+    previous: previousSub
+};
+function previousSub(code) {
+    // :sub[ must not be preceded by an ASCII word character (a-z, A-Z, 0-9, _)
+    if (code === null)
+        return true; // start of document
+    if ((code >= 97 && code <= 122) || // a-z
+        (code >= 65 && code <= 90) || // A-Z
+        (code >= 48 && code <= 57) || // 0-9
+        code === 95 // _
+    ) {
+        return false;
+    }
+    return true;
+}
+function tokenizeSub(effects, ok, nok) {
+    let bracketDepth = 0;
+    let braceDepth = 0;
+    return start;
+    function start(code) {
+        // Must start with ':'
+        if (code !== 58)
+            return nok(code); // :
+        effects.enter('sub');
+        effects.enter('subMarker');
+        effects.consume(code);
+        return colonConsumed;
+    }
+    function colonConsumed(code) {
+        if (code !== 115)
+            return nok(code); // s
+        effects.consume(code);
+        return s;
+    }
+    function s(code) {
+        if (code !== 117)
+            return nok(code); // u
+        effects.consume(code);
+        return su;
+    }
+    function su(code) {
+        if (code !== 98)
+            return nok(code); // b
+        effects.consume(code);
+        return sub;
+    }
+    function sub(code) {
+        if (code !== 91)
+            return nok(code); // [
+        effects.consume(code);
+        effects.exit('subMarker');
+        effects.enter('subInitialData');
+        bracketDepth = 0;
+        return insideInitialStart;
+    }
+    function insideInitialStart(code) {
+        // Empty initial not allowed - must have at least one char
+        if (code === 93)
+            return nok(code); // ]
+        return insideInitial(code);
+    }
+    function insideInitial(code) {
+        // Cannot span lines
+        if (code === null || code === -5 || code === -4 || code === -3 || code === 10 || code === 13) {
+            return nok(code);
+        }
+        // Backslash - potential escape
+        if (code === 92) { // \
+            effects.consume(code);
+            return insideInitialAfterBackslash;
+        }
+        // Opening bracket - increase depth
+        if (code === 91) { // [
+            bracketDepth++;
+            effects.consume(code);
+            return insideInitial;
+        }
+        // Closing bracket
+        if (code === 93) { // ]
+            if (bracketDepth > 0) {
+                bracketDepth--;
+                effects.consume(code);
+                return insideInitial;
+            }
+            // End of initial, expect {
+            effects.exit('subInitialData');
+            effects.enter('subMarker');
+            effects.consume(code);
+            return afterInitial;
+        }
+        effects.consume(code);
+        return insideInitial;
+    }
+    function insideInitialAfterBackslash(code) {
+        // Cannot span lines
+        if (code === null || code === -5 || code === -4 || code === -3 || code === 10 || code === 13) {
+            return nok(code);
+        }
+        // Escaped chars: ] [ \ - consume without special handling
+        if (code === 93 || code === 91 || code === 92) {
+            effects.consume(code);
+            return insideInitial;
+        }
+        // Not a special char - go back to insideInitial to handle this char normally
+        return insideInitial(code);
+    }
+    function afterInitial(code) {
+        if (code !== 123)
+            return nok(code); // {
+        effects.consume(code);
+        effects.exit('subMarker');
+        effects.enter('subReplacementData');
+        braceDepth = 0;
+        return insideReplacementStart;
+    }
+    function insideReplacementStart(code) {
+        // Empty replacement not allowed - must have at least one char
+        if (code === 125)
+            return nok(code); // }
+        return insideReplacement(code);
+    }
+    function insideReplacement(code) {
+        // Cannot span lines
+        if (code === null || code === -5 || code === -4 || code === -3 || code === 10 || code === 13) {
+            return nok(code);
+        }
+        // Backslash - potential escape
+        if (code === 92) { // \
+            effects.consume(code);
+            return insideReplacementAfterBackslash;
+        }
+        // Opening brace - increase depth
+        if (code === 123) { // {
+            braceDepth++;
+            effects.consume(code);
+            return insideReplacement;
+        }
+        // Closing brace
+        if (code === 125) { // }
+            if (braceDepth > 0) {
+                braceDepth--;
+                effects.consume(code);
+                return insideReplacement;
+            }
+            // End of replacement
+            effects.exit('subReplacementData');
+            effects.enter('subMarker');
+            effects.consume(code);
+            effects.exit('subMarker');
+            effects.exit('sub');
+            return ok;
+        }
+        effects.consume(code);
+        return insideReplacement;
+    }
+    function insideReplacementAfterBackslash(code) {
+        // Cannot span lines
+        if (code === null || code === -5 || code === -4 || code === -3 || code === 10 || code === 13) {
+            return nok(code);
+        }
+        // Escaped chars: } { \ - consume without special handling
+        if (code === 125 || code === 123 || code === 92) {
+            effects.consume(code);
+            return insideReplacement;
+        }
+        // Not a special char - go back to insideReplacement to handle this char normally
+        return insideReplacement(code);
+    }
+}
+export function sub() {
+    return {
+        text: {
+            58: subConstruct // :
+        }
+    };
+}
+export { subConstruct };
+//# sourceMappingURL=syntax.js.map

package/dist/syntax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"syntax.js","sourceRoot":"","sources":["../src/syntax.ts"],"names":[],"mappings":"AAkBA,MAAM,YAAY,GAAc;IAC9B,IAAI,EAAE,KAAK;IACX,QAAQ,EAAE,WAAW;IACrB,QAAQ,EAAE,WAAW;CACtB,CAAA;AAED,SAAS,WAAW,CAAwB,IAAU;IACpD,2EAA2E;IAC3E,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA,CAAC,oBAAoB;IACnD,IACE,CAAC,IAAI,IAAI,EAAE,IAAI,IAAI,IAAI,GAAG,CAAC,IAAI,MAAM;QACrC,CAAC,IAAI,IAAI,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC,IAAK,MAAM;QACrC,CAAC,IAAI,IAAI,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC,IAAK,MAAM;QACrC,IAAI,KAAK,EAAE,CAAqB,IAAI;MACpC,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,WAAW,CAElB,OAAgB,EAChB,EAAS,EACT,GAAU;IAEV,IAAI,YAAY,GAAG,CAAC,CAAA;IACpB,IAAI,UAAU,GAAG,CAAC,CAAA;IAElB,OAAO,KAAK,CAAA;IAEZ,SAAS,KAAK,CAAC,IAAU;QACvB,sBAAsB;QACtB,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACtC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACpB,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;QAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,SAAS,aAAa,CAAC,IAAU;QAC/B,IAAI,IAAI,KAAK,GAAG;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACvC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,CAAC,CAAA;IACV,CAAC;IAED,SAAS,CAAC,CAAC,IAAU;QACnB,IAAI,IAAI,KAAK,GAAG;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACvC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,SAAS,EAAE,CAAC,IAAU;QACpB,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACtC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,SAAS,GAAG,CAAC,IAAU;QACrB,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACtC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACzB,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;QAC/B,YAAY,GAAG,CAAC,CAAA;QAChB,OAAO,kBAAkB,CAAA;IAC3B,CAAC;IAED,SAAS,kBAAkB,CAAC,IAAU;QACpC,0DAA0D;QAC1D,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACtC,OAAO,aAAa,CAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;IAED,SAAS,aAAa,CAAC,IAAU;QAC/B,oBAAoB;QACpB,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAC7F,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAClB,CAAC;QAED,+BAA+B;QAC/B,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI;YACrB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,2BAA2B,CAAA;QACpC,CAAC;QAED,mCAAmC;QACnC,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI;YACrB,YAAY,EAAE,CAAA;YACd,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,aAAa,CAAA;QACtB,CAAC;QAED,kBAAkB;QAClB,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI;YACrB,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;gBACrB,YAAY,EAAE,CAAA;gBACd,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBACrB,OAAO,aAAa,CAAA;YACtB,CAAC;YACD,2BAA2B;YAC3B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;YAC9B,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;YAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,YAAY,CAAA;QACrB,CAAC;QAED,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,SAAS,2BAA2B,CAAC,IAAU;QAC7C,oBAAoB;QACpB,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAC7F,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAClB,CAAC;QAED,0DAA0D;QAC1D,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAC9C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,aAAa,CAAA;QACtB,CAAC;QAED,6EAA6E;QAC7E,OAAO,aAAa,CAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;IAED,SAAS,YAAY,CAAC,IAAU;QAC9B,IAAI,IAAI,KAAK,GAAG;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACvC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACzB,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;QACnC,UAAU,GAAG,CAAC,CAAA;QACd,OAAO,sBAAsB,CAAA;IAC/B,CAAC;IAED,SAAS,sBAAsB,CAAC,IAAU;QACxC,8DAA8D;QAC9D,IAAI,IAAI,KAAK,GAAG;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA,CAAC,IAAI;QACvC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED,SAAS,iBAAiB,CAAC,IAAU;QACnC,oBAAoB;QACpB,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAC7F,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAClB,CAAC;QAED,+BAA+B;QAC/B,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI;YACrB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,+BAA+B,CAAA;QACxC,CAAC;QAED,iCAAiC;QACjC,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC,IAAI;YACtB,UAAU,EAAE,CAAA;YACZ,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,iBAAiB,CAAA;QAC1B,CAAC;QAED,gBAAgB;QAChB,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC,IAAI;YACtB,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;gBACnB,UAAU,EAAE,CAAA;gBACZ,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBACrB,OAAO,iBAAiB,CAAA;YAC1B,CAAC;YACD,qBAAqB;YACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;YAClC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;YAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YACzB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACnB,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,iBAAiB,CAAA;IAC1B,CAAC;IAED,SAAS,+BAA+B,CAAC,IAAU;QACjD,oBAAoB;QACpB,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAC7F,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAClB,CAAC;QAED,0DAA0D;QAC1D,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAChD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,iBAAiB,CAAA;QAC1B,CAAC;QAED,iFAAiF;QACjF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;AACH,CAAC;AAED,MAAM,UAAU,GAAG;IACjB,OAAO;QACL,IAAI,EAAE;YACJ,EAAE,EAAE,YAAY,CAAC,IAAI;SACtB;KACF,CAAA;AACH,CAAC;AAED,OAAO,EAAE,YAAY,EAAE,CAAA"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "micromark-extension-sub",
+  "version": "1.0.0",
+  "description": "Micromark extension for inline substitution syntax (:sub[...]{...})",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "micromark-util-symbol": "^2.0.0",
+    "micromark-util-types": "^2.0.0"
+  },
+  "devDependencies": {
+    "micromark": "^4.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^4.0.16"
+  },
+  "keywords": ["micromark", "substitution", "inline", "toggle"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/weavepage/remark-sub.git",
+    "directory": "packages/micromark-extension-sub"
+  }
+}