Feat/rollup

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ----
 
+## 4.0.0-alpha.0
+
+- optionalPeerDependencies nodejieba, @node-rs/jieba, and segmentit.
+- 打包为 esm 和 umd 格式。
+
+## 3.1.0
+
+- release 3.1.0, with output amd format.
+
 ## 3.0.0-alpha.7 (2023-11-20)
 
 - feat: dynamic import optional dependencies.

package.json

@@ -1,12 +1,12 @@
 {
   "name": "pinyin",
-  "version": "3.1.0",
+  "version": "4.0.0-alpha.0",
   "description": "汉语拼音转换工具。",
-  "main": "./lib/pinyin.js",
-  "module": "./esm/pinyin.js",
+  "main": "./dist/pinyin.js",
+  "module": "./dist/pinyin.mjs",
   "browser": {
-    "./lib/pinyin.js": "./lib/pinyin-web.js",
-    "./esm/pinyin.js": "./esm/pinyin-web.js"
+    "./dist/pinyin.js": "./lib/pinyin-web.js",
+    "./dist/pinyin.mjs": "./esm/pinyin-web.js"
   },
   "bin": {
     "pinyin": "./bin/pinyin"
@@ -23,7 +23,8 @@
   "scripts": {
     "start": "dumi dev",
     "prepublishOnly": "npm run build",
-    "build": "tsc --downlevelIteration -p tsconfig-es5.json & tsc --downlevelIteration -p tsconfig.json & npm run build:amd",
+    "build": "rollup -c && rollup -c rollup.esm.config.js",
+    "build:tsc": "tsc --downlevelIteration -p tsconfig-es5.json & tsc --downlevelIteration -p tsconfig.json & npm run build:amd",
     "build:amd": "tsc --downlevelIteration -p tsconfig-amd.json",
     "doc:build": "rm -rf ./src/.umi && dumi build",
     "doc:deploy": "npm run doc:build && cp CNAME docs-dist/dist && gh-pages -d docs-dist/dist",
@@ -34,14 +35,28 @@
   "dependencies": {
     "commander": "~1.1.1"
   },
-  "optionalDependencies": {
+  "peerDependencies": {
     "@node-rs/jieba": "^1.6.0",
     "nodejieba": "2.5.2",
     "segmentit": "^2.0.3"
   },
+  "peerDependenciesMeta": {
+    "@node-rs/jieba": {
+      "optional": true
+    },
+    "nodejieba": {
+      "optional": true
+    },
+    "segmentit": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@babel/preset-env": "^7.15.6",
     "@babel/preset-typescript": "^7.15.0",
+    "@rollup/plugin-commonjs": "^17.1.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^11.2.0",
     "@types/jest": "^27.0.2",
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.14.0",
@@ -62,6 +77,11 @@
     "prettier": "^2.6.0",
     "react-json-view": "^1.21.3",
     "request": "~2.68.0",
+    "rollup": "2.60.0",
+    "rollup-plugin-alias": "^2.2.0",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.34.1",
     "ts-node": "^10.5.0",
     "typescript": "^4.4.4"
   },

rollup.config.js

@@ -0,0 +1,37 @@
+import path from "path";
+import json from "@rollup/plugin-json";
+import { terser } from "rollup-plugin-terser";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import commonjs from "@rollup/plugin-commonjs"; // commonjs模块转换插件
+import cleanup from "rollup-plugin-cleanup";
+import ts from "rollup-plugin-typescript2";
+import alias from "rollup-plugin-alias";
+
+const plugins = [
+  cleanup(),
+  json(),
+  nodeResolve(),
+  ts({
+    tsconfig: path.resolve(__dirname, "./tsconfig.json"), // 导入本地ts配置
+    clean: true,
+    useTsconfigDeclarationDir: true,
+  }),
+  commonjs(),
+  alias({
+    entries: [{ find: "@", replacement: "./src" }],
+  }),
+  terser(),
+];
+
+module.exports = {
+  input: path.resolve("./src/pinyin.ts"),
+  output: [
+    {
+      exports: "auto",
+      file: path.resolve(__dirname, "./dist/pinyin.js"),
+      format: "umd",
+      name: "pinyin",
+    },
+  ],
+  plugins,
+};

rollup.esm.config.js

@@ -0,0 +1,33 @@
+import path from "path";
+import json from "@rollup/plugin-json";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import commonjs from "@rollup/plugin-commonjs"; // commonjs模块转换插件
+import ts from "rollup-plugin-typescript2";
+import alias from "rollup-plugin-alias";
+
+const plugins = [
+  json(),
+  nodeResolve(),
+  ts({
+    tsconfig: path.resolve(__dirname, "./tsconfig.json"), // 导入本地ts配置
+    clean: true,
+    useTsconfigDeclarationDir: true,
+  }),
+  commonjs(),
+  alias({
+    entries: [{ find: "@", replacement: "./src" }],
+  }),
+];
+
+module.exports = {
+  input: path.resolve("./src/pinyin.ts"),
+  output: [
+    {
+      exports: "auto",
+      file: path.resolve(__dirname, "./dist/pinyin.mjs"),
+      format: "es",
+      sourcemap: false,
+    },
+  ],
+  plugins,
+};

src/segment.ts

@@ -1,8 +1,8 @@
 import type { IPinyinSegment } from "./declare";
 
 let nodeRsJiebaLoaded = false; // @node-rs/jieba 加载词典。
 let segmentit: any; // segmentit 加载词典。
 let hansIntlSegmenter: any; // Intl.Segmenter
 
 /**
  * TODO: 分词并带词性信息，需要调整 segment_pinyin 方法。
@@ -14,6 +14,10 @@
     if (segment === "@node-rs/jieba") {
       // eslint-disable-next-line @typescript-eslint/no-var-requires
       const { load, cut /*, tag */ } = require("@node-rs/jieba");
+      if (!load || !cut) {
+        console.error("pinyin v4: \"@node-rs/jieba\" is peerDependencies");
+        return [hans];
+      }
       if (!nodeRsJiebaLoaded) {
         nodeRsJiebaLoaded = true;
         load();
@@ -26,6 +30,10 @@
     if (segment === "segmentit") {
       // eslint-disable-next-line @typescript-eslint/no-var-requires
       const { Segment, useDefault } = require("segmentit");
+      if (!Segment) {
+        console.error("pinyin v4: \"segmentit\" is peerDependencies");
+        return [hans];
+      }
       if (!segmentit) {
         segmentit = useDefault(new Segment());
       }
@@ -48,6 +56,10 @@
 
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const nodejieba = require("nodejieba");
+    if (!nodejieba) {
+      console.error("pinyin v4: \"nodejieba\" is peerDependencies");
+      return [hans];
+    }
     // 默认使用 nodejieba (C++)
     // return nodejieba.tag(hans);
     // nodejieba 定义的类型返回值错误，先忽略。

tsconfig.json

@@ -5,8 +5,8 @@
     "resolveJsonModule": true,
     "declaration": true,
     "outDir": "esm",
-    "module": "ES2015",
-    "target": "esnext",
+    "module": "esnext",
+    "target": "es6",
     "lib": ["esnext"],
     "sourceMap": true,
     "baseUrl": "./src/",