pinyin-voice-data 1.0.0

package/README.md

@@ -0,0 +1,102 @@
+## pinyin-voice 资源库
+
+该库为 pinyin-voice 的资源 CDN 库
+
+也可以用于支持离线化使用 pinyin-voice 部分在线资源，及生产环境部署到自己的服务器中
+
+### 1. 安装
+
+```
+npm i pinyin-voice-data -D
+```
+
+### 2. 运行
+
+首先配置 package.json scripts
+
+```json
+{
+    "scripts": {
+        "pinyin-voice-serve": "pinyin-voice-serve 3002",
+        "pinyin-voice-prod": "pinyin-voice-serve-prod"
+    }
+}
+```
+
+运行一个本地的服务，端口可以自定义
+
+```
+npm run pinyin-voice-serve
+```
+
+运行成功之后可以访问以下链接查看是否正确运行
+
+[http://localhost:3002/voice/a.mp3](http://localhost:3002/voice/a.mp3)
+
+### 3. 开发环境使用
+
+```js
+import pinyinVoice from 'pinyin-voice';
+pinyinVoice.setResourceBase('http://localhost:{port}/')
+```
+
+### 4. 生产环境使用
+
+如需将资源部署到您的生产环境服务器
+
+请执行
+
+```
+npm run pinyin-voice-prod
+```
+
+会在项目根目录生成 pinyin-voice-data 目录，将该文件夹放置在您的 http 服务器中
+
+假设可访问路径为 `https://www.xxx.com/pinyin-voice-data/`
+
+则对 pinyin-voice 设置如下
+
+```js
+import pinyinVoice from 'pinyin-voice';
+pinyinVoice.setResourceBase('https://www.xxx.com/pinyin-voice-data/')
+```
+
+### 5. API
+
+```ts
+export const name: 'pinyin-voice-data';
+
+export function serve(port?: number): void;
+
+export function build(): void;
+
+export default {
+    name,
+    serve,
+    build,
+}
+```
+
+```js
+import {serve} from 'pinyin-voice-data';
+serve(port);
+```
+
+```js
+import {build} from 'pinyin-voice-data';
+build();
+```
+
+### 6. 或者可以全局安装使用
+
+```
+npm i pinyin-voice-data -g
+```
+
+```
+pinyin-voice-serve [port]
+```
+
+```
+pinyin-voice-serve-prod
+```

package/bin/lib.js

@@ -0,0 +1,32 @@
+const gulp = require('gulp');
+const path = require('path');
+const {server, defaults} = require('lite-server')
+
+function build(){
+    console.log('Progress is running, please wait ...');
+    gulp.src(path.resolve(__dirname, '../voice/*.mp3'))
+        .pipe(gulp.dest(path.resolve(process.cwd(), 'pinyin-voice-data/voice')))
+        .on('end', () => {
+            console.log('Finish voice!');
+        });
+}
+
+async function serve(port){
+    const chalk = (await import('chalk')).default;
+    try{
+        if(typeof process !== 'undefined' && !port) {
+            port = process.argv[2];
+        }
+        port = parseInt(port || 7077);
+        console.log(chalk.green(`--Running pinyin-voice server [port=${port}] ...`));
+        defaults.port = port;
+        defaults.files = ['./**/*.{html,htm,css,js,json,mp3}'];
+        defaults.server.baseDir = path.resolve(__dirname, '../');
+        defaults.watchOptions = {};
+        server();
+    }catch(err){
+        console.log(chalk.red('--Run Failed'), err);
+    }
+}
+
+module.exports = {build, serve};

package/bin/serve-prod.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const {build} = require('./lib');
+
+build();

package/bin/serve.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const {serve} = require('./lib');
+
+serve();

package/index.d.ts

@@ -0,0 +1,11 @@
+export const name: 'pinyin-voice-data';
+
+export function serve(port?: number): void;
+
+export function build(): void;
+
+export default {
+    name,
+    serve,
+    build,
+}

package/index.js

@@ -0,0 +1,7 @@
+const {serve, build} = require('./bin/lib')
+
+module.exports = {
+    name: 'pinyin-voice-data',
+    serve,
+    build,
+};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "pinyin-voice-data",
+  "version": "1.0.0",
+  "description": "pinyin-voice的资源库",
+  "main": "index.js",
+  "typings": "index.d.ts",
+  "scripts": {},
+  "bin": {
+    "pinyin-voice-serve": "bin/serve.js",
+    "pinyin-voice-serve-prod": "bin/serve-prod.js"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^5.0.1",
+    "gulp": "^4.0.2",
+    "lite-server": "^2.6.1",
+    "pinyin-voice-data": "file:pinyin-voice-data-1.0.0.tgz"
+  }
+}