开源项目 `pinyin` 使用教程

1. 项目的目录结构及介绍

pinyin/
├── dist/
│   ├── pinyin.js
│   └── pinyin.min.js
├── src/
│   ├── data/
│   │   ├── dict-zi.json
│   │   └── dict-zi-small.json
│   ├── pinyin.js
│   └── utils.js
├── test/
│   ├── index.html
│   └── test.js
├── .babelrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js

• dist/：包含编译后的文件，如 pinyin.js 和 pinyin.min.js。
• src/：源代码目录，包含主要的逻辑文件和数据文件。
  • data/：包含拼音数据文件，如 dict-zi.json 和 dict-zi-small.json。
  • pinyin.js：主逻辑文件。
  • utils.js：工具函数文件。
• test/：测试文件目录，包含测试用例和测试页面。
• .babelrc：Babel 配置文件。
• .gitignore：Git 忽略文件配置。
• .npmignore：NPM 忽略文件配置。
• .travis.yml：Travis CI 配置文件。
• LICENSE：项目许可证。
• README.md：项目说明文档。
• package.json：NPM 包配置文件。
• webpack.config.js：Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/pinyin.js。这个文件包含了拼音转换的主要逻辑和接口。通过引入这个文件，可以调用其提供的函数来进行拼音转换。

// 示例代码
const pinyin = require('./src/pinyin');
console.log(pinyin('你好')); // 输出: ["nǐ hǎo"]

3. 项目的配置文件介绍

• package.json：这个文件包含了项目的元数据和依赖信息。通过这个文件，可以了解项目的名称、版本、作者、依赖包等信息。

{
  "name": "pinyin",
  "version": "1.0.0",
  "description": "Convert Chinese characters to pinyin.",
  "main": "dist/pinyin.js",
  "scripts": {
    "build": "webpack",
    "test": "mocha test/test.js"
  },
  "author": "creeperyang",
  "license": "MIT",
  "dependencies": {
    "babel-core": "^6.26.3",
    "babel-loader": "^7.1.5",
    "babel-preset-env": "^1.7.0",
    "webpack": "^4.41.2",
    "webpack-cli": "^3.3.10"
  },
  "devDependencies": {
    "mocha": "^6.2.2"
  }
}

• webpack.config.js：这个文件是 Webpack 的配置文件，用于定义如何打包项目。

const path = require('path');

module.exports = {
  entry: './src/pinyin.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'pinyin.js',
    library: 'pinyin',
    libraryTarget: 'umd'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  }
};

通过这些配置文件，可以了解项目的构建和运行方式。