markdown-it-cjk-friendly 0.3.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2024 Tatsunori Uchino, and authors and contributors of original packages
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+# markdown-it-cjk-friendly
+
+[![Version](https://img.shields.io/npm/v/markdown-it-cjk-friendly)](https://npmjs.com/package/markdown-it-cjk-friendly)
+
+A [markdown-it](https://github.com/markdown-it/markdown-it) plugin to make Markdown emphasis (`**`) in CommonMark compatible with Chinese, Japanese, and Korean.
+
+<span lang="ja">CommonMarkの強調記号(`**`)を中国語・日本語・韓国語にきちんと対応させるための[markdown-it](https://github.com/markdown-it/markdown-it)プラグイン</span>
+
+<span lang="zh-Hans-CN">一个 [markdown-it](https://github.com/markdown-it/markdown-it) 插件，用于使 CommonMark 的强调标记(`**`)能够正确支持中文、日语和韩语文本。</span>
+
+<span lang="ko">CommonMark의 강조 표시(**) 를 중국어, 일본어, 한국어와 호환되도록 만드는 [markdown-it](https://github.com/markdown-it/markdown-it) 플러그인</span>
+
+## Problem / <span lang="ja">問題</span> / <span lang="zh-Hans-CN">问题</span> / <span lang="ko">문제점</span>
+
+CommonMark has a problem that the following emphasis marks `**` are not recognized as emphasis marks in Japanese and Chinese.
+
+<span lang="ja">CommonMarkには、日本語・中国語内の次のような強調記号(`**`)が強調記号として認識されない問題があります。</span>
+
+<span lang="zh-Hans-CN">CommonMark存在以下问题：在中文和日语文本中，强调标记**不会被识别为强调标记。</span>
+
+<span lang="ko">CommonMark는 일본어와 중국어에서 다음과 같은 강조 표시 **가 강조 표시로 인식되지 않는 문제가 있습니다.</span>
+
+```md
+**このアスタリスクは強調記号として認識されず、そのまま表示されます。**この文のせいで。
+
+**该星号不会被识别，而是直接显示。**这是因为它没有被识别为强调符号。
+
+**이 별표는 강조 표시로 인식되지 않고 그대로 표시됩니다(이 괄호 때문에)**이 문장 때문에.
+```
+
+This problem occurs because the character just inside the `**` is a (Japanese or Chinese) punctuation mark (。) or parenthesis and the character just outside is not a space or punctuation mark.
+
+<span lang="ja">これが起こった原因は、終了側の`**`のすぐ内側が約物（。やカッコ）、かつ外側が約物や空白以外の文字であるためです。</span>
+
+<span lang="zh-Hans-CN">这个问题是因为在`**`的结束部分，内侧字符是标点符号（。）或括号，而外侧字符不是空格或标点符号。</span>
+
+<span lang="ko">이 문제는 `**` 바로 안쪽의 문자가 (일본어나 중국어) 문장 부호(。) 또는 괄호이고 바깥쪽 문자가 공백이나 문장 부호가 아니기 때문에 발생합니다.</span>
+
+Of course, not only the end side but also the start side has the same issue.
+
+<span lang="ja">もちろん終了側だけでなく、開始側も同様の問題が存在します。</span>
+
+<span lang="zh-Hans-CN">当然，不仅是结束侧，开始侧也存在同样的问题。</span>
+
+<span lang="ko">물론 끝나는 부분뿐만 아니라 시작하는 부분에서도 동일한 문제가 있습니다.</span>
+
+CommonMark issue: https://github.com/commonmark/commonmark-spec/issues/650
+
+## Installation / <span lang="ja">インストール</span> / <span lang="zh-Hans-CN">安装</span> / <span lang="ko">설치</span>
+
+Install `markdown-it-cjk-friendly` via [npm](https://www.npmjs.com/):
+
+<span lang="ja">`markdown-it-cjk-friendly`を[npm](https://www.npmjs.com/)でインストールしてください。</span>
+
+<span lang="zh-Hans-CN">通过 [npm](https://www.npmjs.com/) 安装 `markdown-it-cjk-friendly`。</span>
+
+<span lang="ko">`markdown-it-cjk-friendly`를 [npm](https://www.npmjs.com/)으로 설치하세요.</span>
+
+
+```bash
+npm install markdown-it-cjk-friendly
+```
+
+If you use another package manager, please replace `npm` with the command of the package manager you use (e.g. `pnpm`).
+
+<span lang="ja">npm以外のパッケージマネージャを使う場合は、`npm`を当該パッケージマネージャのコマンド（例：`pnpm`）に置き換えてください。</span>
+
+<span lang="zh-Hans-CN">如果使用其他包管理器，请将 `npm` 替换为当时包管理器的命令（例如：`pnpm`）。</span>
+
+<span lang="ko">다른 패키지 매니저를 사용하는 경우 `npm`을 해당 패키지 매니저의 명령어(예: `pnpm`)로 바꾸어 주세요.</span>
+
+## Usage / <span lang="ja">使い方</span> / <span lang="zh-Hans-CN">用法</span> / <span lang="ko">사용법</span>
+
+Import `markdown-it` and `markdown-it-cjk-friendly`, and use the plugin as follows:
+
+<span lang="ja">`markdown-it`と`markdown-it-cjk-friendly`をインポートし、次のようにプラグインを使用してください。</span>
+
+<span lang="zh-Hans-CN">通过 `markdown-it` 和 `markdown-it-cjk-friendly` 导入，然后使用插件如下：</span>
+
+<span lang="ko">`markdown-it`와 `markdown-it-cjk-friendly`를 임포트하고 다음과 같이 플러그인을 사용하세요.</span>
+
+```js
+import MarkdownIt from "markdown-it";
+import markdownItCjkFriendly from "markdown-it-cjk-friendly";
+
+const md = MarkdownIt();
+md.use(markdownItCjkFriendly);
+```
+
+## Contributing / <span lang="ja">貢献</span> / <span lang="zh-Hans-CN">贡献</span> / <span lang="ko">기여</span>
+
+### Setup
+
+Install the dependencies:
+
+```bash
+pnpm install
+```
+
+### Get Started
+
+Build the library:
+
+```bash
+pnpm build
+```
+
+Build the library in watch mode:
+
+```bash
+pnpm dev
+```

package/dist/index.cjs

@@ -0,0 +1,114 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = function(exports1, definition) {
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = function(obj, prop) {
+        return Object.prototype.hasOwnProperty.call(obj, prop);
+    };
+})();
+(()=>{
+    __webpack_require__.r = function(exports1) {
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    default: ()=>markdownItCjFriendlyPlugin
+});
+const external_get_east_asian_width_namespaceObject = require("get-east-asian-width");
+const utils_mjs_namespaceObject = require("markdown-it/lib/common/utils.mjs");
+function isCjkBase(uc) {
+    const eaw = (0, external_get_east_asian_width_namespaceObject.eastAsianWidthType)(uc);
+    switch(eaw){
+        case "fullwidth":
+        case "halfwidth":
+            return true;
+        case "wide":
+            return !/^\p{RGI_Emoji}/v.test(String.fromCodePoint(uc));
+        case "narrow":
+            return false;
+        case "ambiguous":
+            return 0xe0100 <= uc && uc <= 0xe01ef && null;
+        case "neutral":
+            return /^\p{sc=Hangul}/u.test(String.fromCodePoint(uc));
+    }
+}
+function isCjk(uc) {
+    return isCjkBase(uc) ?? false;
+}
+function isCjkOrIvs(uc) {
+    const raw = isCjkBase(uc);
+    return null === raw || raw;
+}
+function maybeHanSVS(uc) {
+    return (0xfff0 & uc) === 0xfe00 && (uc >= 0xfe00 && uc <= 0xfe02 || 0xfe0e === uc);
+}
+function markdownItCjFriendlyPlugin(md) {
+    const PreviousState = md.inline.State;
+    class CjFriendlyState extends PreviousState {
+        scanDelims(start, canSplitWord) {
+            const max = this.posMax;
+            const marker = this.src.charCodeAt(start);
+            let [lastChar, lastCharPos] = getLastCharCode(this.src, start);
+            if (maybeHanSVS(lastChar)) [lastChar, lastCharPos] = getLastCharCode(this.src, lastCharPos);
+            let pos = start;
+            while(pos < max && this.src.charCodeAt(pos) === marker)pos++;
+            const count = pos - start;
+            const nextChar = pos < max ? this.src.codePointAt(pos) : 0x20;
+            const isLastPunctChar = (0, utils_mjs_namespaceObject.isMdAsciiPunct)(lastChar) || (0, utils_mjs_namespaceObject.isPunctChar)(String.fromCodePoint(lastChar));
+            const isNextPunctChar = (0, utils_mjs_namespaceObject.isMdAsciiPunct)(nextChar) || (0, utils_mjs_namespaceObject.isPunctChar)(String.fromCodePoint(nextChar));
+            const isLastWhiteSpace = (0, utils_mjs_namespaceObject.isWhiteSpace)(lastChar);
+            const isNextWhiteSpace = (0, utils_mjs_namespaceObject.isWhiteSpace)(nextChar);
+            const isLastCJKChar = isCjkOrIvs(lastChar);
+            const isNextCJKChar = isCjk(nextChar);
+            const adjacentToCjChar = isLastCJKChar || isNextCJKChar;
+            const left_flanking = !isNextWhiteSpace && (!isNextPunctChar || isLastWhiteSpace || isLastPunctChar || adjacentToCjChar);
+            const right_flanking = !isLastWhiteSpace && (!isLastPunctChar || isNextWhiteSpace || isNextPunctChar || adjacentToCjChar);
+            const can_open = left_flanking && (canSplitWord || !right_flanking || isLastPunctChar);
+            const can_close = right_flanking && (canSplitWord || !left_flanking || isNextPunctChar);
+            return {
+                can_open,
+                can_close,
+                length: count
+            };
+            function getLastCharCode(str, pos) {
+                if (pos <= 0) return [
+                    0x20,
+                    -1
+                ];
+                const charCode = str.charCodeAt(pos - 1);
+                if ((0xfc00 & charCode) !== 0xdc00) return [
+                    charCode,
+                    pos - 1
+                ];
+                const codePoint = str.codePointAt(pos - 2);
+                return codePoint > 0xffff ? [
+                    codePoint,
+                    pos - 2
+                ] : [
+                    charCode,
+                    pos - 1
+                ];
+            }
+        }
+    }
+    md.inline.State = CjFriendlyState;
+}
+var __webpack_export_target__ = exports;
+for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
+if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
+    value: true
+});

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import type MarkdownIt from "markdown-it";
+export default function markdownItCjFriendlyPlugin(md: MarkdownIt): void;

package/dist/index.js

@@ -0,0 +1,80 @@
+import * as __WEBPACK_EXTERNAL_MODULE_get_east_asian_width_c890dec0__ from "get-east-asian-width";
+import * as __WEBPACK_EXTERNAL_MODULE_markdown_it_lib_common_utils_mjs_c48a6852__ from "markdown-it/lib/common/utils.mjs";
+function isCjkBase(uc) {
+    const eaw = (0, __WEBPACK_EXTERNAL_MODULE_get_east_asian_width_c890dec0__.eastAsianWidthType)(uc);
+    switch(eaw){
+        case "fullwidth":
+        case "halfwidth":
+            return true;
+        case "wide":
+            return !/^\p{RGI_Emoji}/v.test(String.fromCodePoint(uc));
+        case "narrow":
+            return false;
+        case "ambiguous":
+            return 0xe0100 <= uc && uc <= 0xe01ef && null;
+        case "neutral":
+            return /^\p{sc=Hangul}/u.test(String.fromCodePoint(uc));
+    }
+}
+function isCjk(uc) {
+    return isCjkBase(uc) ?? false;
+}
+function isCjkOrIvs(uc) {
+    const raw = isCjkBase(uc);
+    return null === raw || raw;
+}
+function maybeHanSVS(uc) {
+    return (0xfff0 & uc) === 0xfe00 && (uc >= 0xfe00 && uc <= 0xfe02 || 0xfe0e === uc);
+}
+function markdownItCjFriendlyPlugin(md) {
+    const PreviousState = md.inline.State;
+    class CjFriendlyState extends PreviousState {
+        scanDelims(start, canSplitWord) {
+            const max = this.posMax;
+            const marker = this.src.charCodeAt(start);
+            let [lastChar, lastCharPos] = getLastCharCode(this.src, start);
+            if (maybeHanSVS(lastChar)) [lastChar, lastCharPos] = getLastCharCode(this.src, lastCharPos);
+            let pos = start;
+            while(pos < max && this.src.charCodeAt(pos) === marker)pos++;
+            const count = pos - start;
+            const nextChar = pos < max ? this.src.codePointAt(pos) : 0x20;
+            const isLastPunctChar = (0, __WEBPACK_EXTERNAL_MODULE_markdown_it_lib_common_utils_mjs_c48a6852__.isMdAsciiPunct)(lastChar) || (0, __WEBPACK_EXTERNAL_MODULE_markdown_it_lib_common_utils_mjs_c48a6852__.isPunctChar)(String.fromCodePoint(lastChar));
+            const isNextPunctChar = (0, __WEBPACK_EXTERNAL_MODULE_markdown_it_lib_common_utils_mjs_c48a6852__.isMdAsciiPunct)(nextChar) || (0, __WEBPACK_EXTERNAL_MODULE_markdown_it_lib_common_utils_mjs_c48a6852__.isPunctChar)(String.fromCodePoint(nextChar));
+            const isLastWhiteSpace = (0, __WEBPACK_EXTERNAL_MODULE_markdown_it_lib_common_utils_mjs_c48a6852__.isWhiteSpace)(lastChar);
+            const isNextWhiteSpace = (0, __WEBPACK_EXTERNAL_MODULE_markdown_it_lib_common_utils_mjs_c48a6852__.isWhiteSpace)(nextChar);
+            const isLastCJKChar = isCjkOrIvs(lastChar);
+            const isNextCJKChar = isCjk(nextChar);
+            const adjacentToCjChar = isLastCJKChar || isNextCJKChar;
+            const left_flanking = !isNextWhiteSpace && (!isNextPunctChar || isLastWhiteSpace || isLastPunctChar || adjacentToCjChar);
+            const right_flanking = !isLastWhiteSpace && (!isLastPunctChar || isNextWhiteSpace || isNextPunctChar || adjacentToCjChar);
+            const can_open = left_flanking && (canSplitWord || !right_flanking || isLastPunctChar);
+            const can_close = right_flanking && (canSplitWord || !left_flanking || isNextPunctChar);
+            return {
+                can_open,
+                can_close,
+                length: count
+            };
+            function getLastCharCode(str, pos) {
+                if (pos <= 0) return [
+                    0x20,
+                    -1
+                ];
+                const charCode = str.charCodeAt(pos - 1);
+                if ((0xfc00 & charCode) !== 0xdc00) return [
+                    charCode,
+                    pos - 1
+                ];
+                const codePoint = str.codePointAt(pos - 2);
+                return codePoint > 0xffff ? [
+                    codePoint,
+                    pos - 2
+                ] : [
+                    charCode,
+                    pos - 1
+                ];
+            }
+        }
+    }
+    md.inline.State = CjFriendlyState;
+}
+export { markdownItCjFriendlyPlugin as default };

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "markdown-it-cjk-friendly",
+  "version": "0.3.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "module-sync": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist", "LICENSE", "README.md"],
+  "repository": {
+    "url": "https://github.com/tats-u/markdown-cjk-friendly"
+  },
+  "license": "MIT",
+  "author": "Tatsunori Uchino <tats.u@live.jp> (https://github.com/tats-u)",
+  "bugs": "https://github.com/tats-u/markdown-cjk-friendly/issues",
+  "keywords": [
+    "markdown-it-plugin",
+    "markdown-it",
+    "markdown",
+    "japanese",
+    "chinese",
+    "korean",
+    "cjk"
+  ],
+  "description": "markdown-it plugin to make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK)",
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "test": "vitest --run",
+    "test:up": "vitest -u",
+    "test:watch": "vitest watch",
+    "lint:type": "tsc --noEmit",
+    "prepack": "node -e \"require('fs').cpSync('../../LICENSE', './LICENSE')\""
+  },
+  "devDependencies": {
+    "@rslib/core": "^0.3.1",
+    "@types/markdown-it": "^14.1.2",
+    "markdown-it": "^14.1.0"
+  },
+  "peerDependencies": {
+    "@types/markdown-it": "*",
+    "markdown-it": "*"
+  },
+  "peerDependenciesMeta": {
+    "@types/markdown-it": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "get-east-asian-width": "^1.3.0"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}