remark-cjk-friendly 1.0.1 → 1.2.0-rc.1

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 (4) hide show
  1. package/README.md +46 -8
  2. package/dist/index.d.ts +3 -1
  3. package/dist/index.js +11 -5
  4. package/package.json +14 -6
package/README.md CHANGED
@@ -55,23 +55,61 @@ Of course, not only the end side but also the start side has the same issue.
55
55
 
56
56
  CommonMark issue: https://github.com/commonmark/commonmark-spec/issues/650
57
57
 
58
+ ## When should I use this? / <span lang="ja">このパッケージを使うべき場合</span> / <span lang="zh-Hans-CN">何时使用此包</span> / <span lang="ko">이 패키지를 사용하는 시저</span>
59
+
60
+ If you are an engineer who must handle Chinese, Japanese, and Korean content that cannot be fully supervised, it is strongly recommended to use this package (adopt this specification instead of plain CommonMark or GFM). "Cannot be fully supervised" refers to situations such as:
61
+
62
+ 1. When you need to display user-generated or AI-generated content as-is
63
+ 2. When many translators do not understand this CommonMark behavior, and you cannot provide real-time rendering previews similar to production, and `<strong>` tags are not allowed
64
+ - When using translation services like Crowdin or Transifex
65
+ - When the person responsible for translation quality is not an engineer or does not understand this CommonMark behavior
66
+
67
+ Additionally, if you are creating Markdown-related software or services primarily targeting Chinese, Japanese, or Korean users (or all of them), it is strongly recommended to use this package (adopt this specification).
68
+
69
+ <span lang="ja">もしエンジニアであるあなたが全てに監修を入れられない日本語・中国語・韓国語のコンテンツを扱わなければならない場合、このパッケージを使う（素のCommonMarkやGFMではなく、この仕様を採用する）ことを強く推奨します。「全てに監修を入れられない」というのは、例えば次のようなものを指します。</span>
70
+
71
+ 1. <span lang="ja">ユーザまたはAIが作成したコンテンツをそのまま表示する必要がある場合</span>
72
+ 2. <span lang="ja">翻訳者に、このCommonMarkの仕様を理解していない人も多く、なおかつリアルタイムで本番同様の描画プレビューを提供できず、`<strong>`タグを許可していない場合</span>
73
+ - <span lang="ja">翻訳にCrowdin・Transifexなどの翻訳サービスを使っている場合</span>
74
+ - <span lang="ja">翻訳の品質に責任を負っている人が非エンジニアである、またはComonMarkのこの挙動を理解していない場合</span>
75
+
76
+ <span lang="ja">また、あなたが主に日本人・中国人・韓国人のいずれかまたは全てを対象としたMarkdown関連のソフトウェアやサービスを作成する場合も、このパッケージを使う（この仕様を採用する）ことを強く推奨します。</span>
77
+
78
+ <span lang="zh">如果作为工程师的您必须处理无法全面监督的中文、日文和韩文内容，强烈建议使用这个包装（采用此规范，而不是普通的CommonMark或GFM）。"无法全面监督"指的是以下情况：</span>
79
+
80
+ 1. <span lang="zh">当需要按原样显示用户生成或AI生成的内容时</span>
81
+ 2. <span lang="zh">当许多翻译人员不理解这个CommonMark行为，而且无法提供类似生产环境的实时渲染预览，并且不允许使用`<strong>`标签时</span>
82
+ - <span lang="zh">当使用Crowdin或Transifex等翻译服务时</span>
83
+ - <span lang="zh">当负责翻译质量的人不是工程师或不理解这个CommonMark行为时</span>
84
+
85
+ <span lang="zh">此外，如果您正在创建主要面向中国人、日本人或韩国人（或全部）的Markdown相关软件或服务，也强烈建议采用此规范。</span>
86
+
87
+ <span lang="ko">엔지니어로서 완전히 감독할 수 없는 일본어, 중국어, 한국어 콘텐츠를 다뤄야 하는 경우, 이 패키지를 사용하세요 (일반 CommonMark나 GFM 대신 이 사양을 채택할 것을 강력히 권장합니다). "완전히 감독할 수 없는"이란 다음과 같은 상황을 의미합니다:</span>
88
+
89
+ 1. <span lang="ko">사용자 또는 AI가 생성한 콘텐츠를 그대로 표시해야 하는 경우</span>
90
+ 2. <span lang="ko">많은 번역자가 이 CommonMark 동작을 이해하지 못하고, 실시간으로 실제 환경과 유사한 렌더링 미리보기를 제공할 수 없으며, `<strong>` 태그가 허용되지 않는 경우</span>
91
+ - <span lang="ko">Crowdin이나 Transifex 같은 번역 서비스를 사용하는 경우</span>
92
+ - <span lang="ko">번역 품질에 책임을 지는 사람이 엔지니어가 아니거나 이 CommonMark 동작을 이해하지 못하는 경우</span>
93
+
94
+ <span lang="ko">또한, 주로 일본어, 중국어, 한국어 사용자(또는 모두)를 대상으로 하는 Markdown 관련 소프트웨어나 서비스를 만들고 있다면, 이 패키지를 사용하세요 (이 사양을 채택할 것을 강력히 권장합니다).</span>
95
+
58
96
  ## Runtime Requirements / <span lang="ja">実行環境の要件</span> / <span lang="zh-Hans-CN">运行环境要求</span> / <span lang="ko">업데이트 전략</span>
59
97
 
60
- This package uses the [`v` flag of the regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets) introduced in ES2024 to determine whether the character is an emoji or not.
98
+ This package is ESM-only. It requires Node.js 16 or later.
61
99
 
62
- <span lang="ja">本パッケージは文字が絵文字かどうかを判定するために、ES2024で導入された[正規表現の`v`フラグ](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets)を使用しています。</span>
100
+ <span lang="ja">本パッケージはESM専用です。Node.js 16以上が必要です。</span>
63
101
 
64
- <span lang="zh-CN">本包使用 ES2024 引入的[`v` 标志](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets) 来判断字符是否为 emoji。</span>
102
+ <span lang="zh-Hans-CN">此包仅支持ESM。需要Node.js 16或更高版本。</span>
65
103
 
66
- <span lang="ko">이 패키지는 ES2024에서 도입된 [`v` 플래그](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets)를 사용하여 문자가 이모지인지 여부를 판단합니다.</span>
104
+ <span lang="ko">이 패키지는 ESM만 사용을 위한 패키지입니다. Node.js 16或更高版本가 필요입니다.</span>
67
105
 
68
- It makes this package compatible only with relatively recent browsers and Node.js:
106
+ This package uses the [`v` flag for regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets) introduced in ES2024, if available, to determine whether a character is an emoji. In the following compatible environments, it will comply with the Unicode version supported by the runtime. Otherwise, it will fall back to the snapshot as of Unicode 16.
69
107
 
70
- <span lang="ja">このため、本パッケージは、次のような比較的新しいブラウザやNode.jsでしか動作しません。</span>
108
+ <span lang="ja">本パッケージは文字が絵文字かどうかを判定するために、ES2024で導入された[正規表現の`v`フラグ](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets)が利用可能であれば使用します。以下の対応環境の場合、ランタイムが対応しているUnicodeバージョンに準拠します。それ以外の場合、Unicode 16時点のスナップショットにフォールバックします。</span>
71
109
 
72
- <span lang="zh-CN">因此，本包只兼容比较新的浏览器和 Node.js:</span>
110
+ <span lang="zh-Hans-CN">本包使用ES2024引入的[正则表达式`v`标志](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets)（如果可用）来判断字符是否为表情符号。在以下兼容环境中，将遵循运行时支持的Unicode版本。否则，将回退到Unicode 16的快照。</span>
73
111
 
74
- <span lang="ko">따라서, 이 패키지는 비교적 최신 브라우저와 Node.js에서만 작동합니다.</span>
112
+ <span lang="ko">이 패키지는 문자가 이모지인지 판단하기 위해 ES2024에서 도입된 [정규표현식 `v` 플래그](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets)를 사용할 수 있다면 사용합니다. 다음 호환 환경에서는 런타임이 지원하는 Unicode 버전을 따릅니다. 그렇지 않은 경우, Unicode 16 시점의 스냅샷으로 폴백합니다.</span>
75
113
 
76
114
  - Chrome / Edge 112 or later
77
115
  - Firefox 116 or later
package/dist/index.d.ts CHANGED
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
3
3
  */
4
- export default function remarkCjkFriendly(this: unknown): void;
4
+ declare function remarkCjkFriendly(this: unknown): void;
5
+
6
+ export { remarkCjkFriendly as default };
package/dist/index.js CHANGED
@@ -1,7 +1,13 @@
1
- import * as __WEBPACK_EXTERNAL_MODULE_micromark_extension_cjk_friendly_1c72e10b__ from "micromark-extension-cjk-friendly";
1
+ // src/index.ts
2
+ import { cjkFriendlyExtension } from "micromark-extension-cjk-friendly";
2
3
  function remarkCjkFriendly() {
3
- const data = this.data();
4
- const micromarkExtensions = data.micromarkExtensions || (data.micromarkExtensions = []);
5
- micromarkExtensions.push((0, __WEBPACK_EXTERNAL_MODULE_micromark_extension_cjk_friendly_1c72e10b__.cjkFriendlyExtension)());
4
+ const data = this.data();
5
+ const micromarkExtensions = (
6
+ // biome-ignore lint/suspicious/noAssignInExpressions: base plugin (remark-gfm) already does this
7
+ data.micromarkExtensions || (data.micromarkExtensions = [])
8
+ );
9
+ micromarkExtensions.push(cjkFriendlyExtension());
6
10
  }
7
- export { remarkCjkFriendly as default };
11
+ export {
12
+ remarkCjkFriendly as default
13
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "remark-cjk-friendly",
3
- "version": "1.0.1",
3
+ "version": "1.2.0-rc.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -8,6 +8,8 @@
8
8
  "default": "./dist/index.js"
9
9
  }
10
10
  },
11
+ "module": "./dist/index.js",
12
+ "types": "./dist/index.d.ts",
11
13
  "files": [
12
14
  "dist",
13
15
  "LICENSE",
@@ -33,7 +35,7 @@
33
35
  "description": "remark plugin to make Markdown emphasis (`**`) in CommonMark (and MDX) more friendly with Chinese, Japanese, and Korean (CJK)",
34
36
  "sideEffects": false,
35
37
  "dependencies": {
36
- "micromark-extension-cjk-friendly": "<2.0.0"
38
+ "micromark-extension-cjk-friendly": "^1.2.0-rc.1"
37
39
  },
38
40
  "devDependencies": {
39
41
  "@mdx-js/mdx": "^3.1.0",
@@ -54,14 +56,20 @@
54
56
  }
55
57
  },
56
58
  "engines": {
57
- "node": ">=20"
59
+ "node": ">=16"
58
60
  },
59
61
  "scripts": {
60
- "build": "rslib build",
61
- "dev": "rslib build --watch",
62
- "test": "vitest --run",
62
+ "build:rslib": "rslib build",
63
+ "build": "tsup",
64
+ "build:lib": "tsup",
65
+ "dev:rslib": "rslib build --watch",
66
+ "dev": "tsup --watch",
67
+ "dev:lib": "tsup --watch",
68
+ "test": "vitest run",
69
+ "test:lib": "vitest run",
63
70
  "test:up": "vitest -u",
64
71
  "test:watch": "vitest watch",
72
+ "test:lib:watch": "vitest watch",
65
73
  "lint:type": "tsc --noEmit"
66
74
  }
67
75
  }