remark-cjk-friendly 2.1.0 → 2.2.0

package/README.md

@@ -170,13 +170,13 @@ const processor = unified()
 const htmlResult = (await processor.process(markdownString)).toString();
 ```
 
-This plugin also wires the reverse path for `remark-stringify` / `mdast-util-to-markdown`, so CJK text around `*` / `**` stays raw when it is valid under this specification instead of being escaped as character references.
+This plugin also wires the reverse path for `remark-stringify` / `mdast-util-to-markdown`, so CJK text around `*` / `**` stays raw when it is valid under this specification instead of being escaped as character references. If you don't need this (only need Markdown parsing), or don't need parsing and only need this serialization, you can import from `remark-cjk-friendly/parseOnly` or `remark-cjk-friendly/serializeOnly` instead of `remark-cjk-friendly` to avoid bundling the unnecessary processing.
 
-<span lang="ja">このプラグインは`remark-stringify` / `mdast-util-to-markdown`向けの逆方向シリアライズ拡張も自動で配線するため、この仕様で妥当なケースでは`*` / `**`の前後にあるCJK文字が文字参照へエスケープされず、そのまま出力されます。</span>
+<span lang="ja">このプラグインは`remark-stringify` / `mdast-util-to-markdown`向けの逆方向シリアライズ拡張も自動で配線するため、この仕様で妥当なケースでは`*` / `**`の前後にあるCJK文字が文字参照へエスケープされず、そのまま出力されます。これが不要（Markdownのパースのみが必要）、またはパースが不要でこのシリアライズのみが必要な場合は、`remark-cjk-friendly`の代わりにそれぞれ`remark-cjk-friendly/parseOnly`または`remark-cjk-friendly/serializeOnly`からインポートすると、不要な方の処理のバンドルを避けることができます。</span>
 
-<span lang="zh-Hans-CN">此插件还会自动接入 `remark-stringify` / `mdast-util-to-markdown` 的反向序列化扩展，因此在本规范允许的情况下，`*` / `**` 周围的 CJK 文字会保持原样输出，而不会被转义为字符引用。</span>
+<span lang="zh-Hans-CN">此插件还会自动接入 `remark-stringify` / `mdast-util-to-markdown` 的反向序列化扩展，因此在本规范允许的情况下，`*` / `**` 周围的 CJK 文字会保持原样输出，而不会被转义为字符引用。如果不需要此功能（仅需要 Markdown 解析），或者不需要解析仅需要序列化，可以分别从 `remark-cjk-friendly/parseOnly` 或 `remark-cjk-friendly/serializeOnly` 导入，而不是从 `remark-cjk-friendly` 导入，以避免打包不必要的处理。</span>
 
-<span lang="ko">이 플러그인은 `remark-stringify` / `mdast-util-to-markdown`용 역방향 직렬화 확장도 자동으로 연결하므로, 이 사양에서 유효한 경우 `*` / `**` 주변의 CJK 문자가 문자 참조로 이스케이프되지 않고 그대로 출력됩니다.</span>
+<span lang="ko">이 플러그인은 `remark-stringify` / `mdast-util-to-markdown`용 역방향 직렬화 확장도 자동으로 연결하므로, 이 사양에서 유효한 경우 `*` / `**` 주변의 CJK 문자가 문자 참조로 이스케이프되지 않고 그대로 출력됩니다. 이 기능이 필요 없는 경우（Markdown 파싱만 필요）또는 파싱이 필요 없고 직렬화만 필요한 경우, `remark-cjk-friendly` 대신 각각 `remark-cjk-friendly/parseOnly` 또는 `remark-cjk-friendly/serializeOnly`에서 가져오면 불필요한 처리 번들을 피할 수 있습니다.</span>
 
 For MDX, add `remarkCjkFriendly` to the `remarkPlugins` array in the config object:
 

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 //#region src/index.d.ts
 /**
  * Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
+ *
+ * This plugin supports both parsing and serializing. If you want to support only one of them, it is recommended to use {@linkcode remarkCjkFriendlyParseOnly} (`remark-cjk-friendly/parseOnly`) or {@linkcode remarkCjkFriendlySerializeOnly} (`remark-cjk-friendly/serializeOnly`) instead to minimize bundled dependencies.
  */
 declare function remarkCjkFriendly(this: unknown): void;
 //#endregion

package/dist/index.js

@@ -1,16 +1,15 @@
-import { cjkFriendlyToMarkdown } from "mdast-util-to-markdown-cjk-friendly";
-import { cjkFriendlyExtension } from "micromark-extension-cjk-friendly";
+import remarkCjkFriendlyParseOnly from "./parseOnly.js";
+import remarkCjkFriendlySerializeOnly from "./serializeOnly.js";
 
 //#region src/index.ts
 /**
 * Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
+*
+* This plugin supports both parsing and serializing. If you want to support only one of them, it is recommended to use {@linkcode remarkCjkFriendlyParseOnly} (`remark-cjk-friendly/parseOnly`) or {@linkcode remarkCjkFriendlySerializeOnly} (`remark-cjk-friendly/serializeOnly`) instead to minimize bundled dependencies.
 */
 function remarkCjkFriendly() {
-	const data = this.data();
-	const micromarkExtensions = data.micromarkExtensions || (data.micromarkExtensions = []);
-	const toMarkdownExtensions = data.toMarkdownExtensions || (data.toMarkdownExtensions = []);
-	micromarkExtensions.push(cjkFriendlyExtension());
-	toMarkdownExtensions.push(cjkFriendlyToMarkdown());
+	remarkCjkFriendlyParseOnly.call(this);
+	remarkCjkFriendlySerializeOnly.call(this);
 }
 
 //#endregion

package/dist/parseOnly.d.ts

@@ -0,0 +1,9 @@
+//#region src/parseOnly.d.ts
+/**
+ * Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
+ *
+ * This plugin only supports parsing. If you have been using {@linkcode remarkCjkFriendly} (`remark-cjk-friendly`) since v2.0.1 or earlier, it is recommended to migrate to this to minimize bundled dependencies.
+ */
+declare function remarkCjkFriendlyParseOnly(this: unknown): void;
+//#endregion
+export { remarkCjkFriendlyParseOnly as default };

package/dist/parseOnly.js

@@ -0,0 +1,15 @@
+import { cjkFriendlyExtension } from "micromark-extension-cjk-friendly";
+
+//#region src/parseOnly.ts
+/**
+* Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
+*
+* This plugin only supports parsing. If you have been using {@linkcode remarkCjkFriendly} (`remark-cjk-friendly`) since v2.0.1 or earlier, it is recommended to migrate to this to minimize bundled dependencies.
+*/
+function remarkCjkFriendlyParseOnly() {
+	const data = this.data();
+	(data.micromarkExtensions || (data.micromarkExtensions = [])).push(cjkFriendlyExtension());
+}
+
+//#endregion
+export { remarkCjkFriendlyParseOnly as default };

package/dist/serializeOnly.d.ts

@@ -0,0 +1,9 @@
+//#region src/serializeOnly.d.ts
+/**
+ * Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
+ *
+ * This plugin only supports serializing.
+ */
+declare function remarkCjkFriendlySerializeOnly(this: unknown): void;
+//#endregion
+export { remarkCjkFriendlySerializeOnly as default };

package/dist/serializeOnly.js

@@ -0,0 +1,15 @@
+import { cjkFriendlyToMarkdown } from "mdast-util-to-markdown-cjk-friendly";
+
+//#region src/serializeOnly.ts
+/**
+* Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
+*
+* This plugin only supports serializing.
+*/
+function remarkCjkFriendlySerializeOnly() {
+	const data = this.data();
+	(data.toMarkdownExtensions || (data.toMarkdownExtensions = [])).push(cjkFriendlyToMarkdown());
+}
+
+//#endregion
+export { remarkCjkFriendlySerializeOnly as default };

package/package.json

@@ -1,12 +1,20 @@
 {
   "name": "remark-cjk-friendly",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./parseOnly": {
+      "types": "./dist/parseOnly.d.ts",
+      "default": "./dist/parseOnly.js"
+    },
+    "./serializeOnly": {
+      "types": "./dist/serializeOnly.d.ts",
+      "default": "./dist/serializeOnly.js"
+    },
     "./package.json": "./package.json"
   },
   "module": "./dist/index.js",
@@ -36,8 +44,8 @@
   "description": "remark plugin to make Markdown emphasis (`**`) in CommonMark (and MDX) more friendly with Chinese, Japanese, and Korean (CJK)",
   "sideEffects": false,
   "dependencies": {
-    "mdast-util-to-markdown-cjk-friendly": "1.0.0",
-    "micromark-extension-cjk-friendly": "2.0.1"
+    "micromark-extension-cjk-friendly": "2.0.1",
+    "mdast-util-to-markdown-cjk-friendly": "1.0.0"
   },
   "devDependencies": {
     "@mdx-js/mdx": "^3.1.1",