Twemoji 项目使用教程

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

Twemoji 项目的目录结构如下：

twemoji/
├── assets/
│   ├── 72x72/
│   ├── 128x128/
│   └── ...
├── scripts/
│   ├── build.js
│   ├── clean.js
│   └── ...
├── src/
│   ├── 72x72/
│   ├── 128x128/
│   └── ...
├── test/
│   ├── browser/
│   ├── node/
│   └── ...
├── .gitignore
├── .npmignore
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
└── ...

目录介绍

• assets/: 包含不同尺寸的 emoji 图片资源。
• scripts/: 包含项目的构建和清理脚本。
• src/: 包含 emoji 图片的源文件。
• test/: 包含项目的测试文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmignore: 指定 npm 发布时忽略的文件和目录。
• .travis.yml: Travis CI 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。

2. 项目的启动文件介绍

Twemoji 项目的启动文件主要是 package.json 中的脚本部分。以下是一些关键的启动脚本：

{
  "scripts": {
    "build": "node scripts/build.js",
    "clean": "node scripts/clean.js",
    "test": "npm run test:node && npm run test:browser",
    "test:node": "mocha test/node/**/*.js",
    "test:browser": "karma start test/browser/karma.conf.js"
  }
}

启动脚本介绍

• build: 运行构建脚本，生成 emoji 图片资源。
• clean: 运行清理脚本，清除生成的文件。
• test: 运行所有测试，包括 Node.js 和浏览器测试。
• test:node: 运行 Node.js 测试。
• test:browser: 运行浏览器测试。

3. 项目的配置文件介绍

Twemoji 项目的主要配置文件是 package.json 和 karma.conf.js。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键配置：

{
  "name": "twemoji",
  "version": "14.0.2",
  "description": "A Unicode standard based emoji library",
  "main": "index.js",
  "scripts": {
    "build": "node scripts/build.js",
    "clean": "node scripts/clean.js",
    "test": "npm run test:node && npm run test:browser",
    "test:node": "mocha test/node/**/*.js",
    "test:browser": "karma start test/browser/karma.conf.js"
  },
  "dependencies": {
    "emoji-datasource": "^6.0.0"
  },
  "devDependencies": {
    "chai": "^4.3.4",
    "karma": "^6.3.4",
    "mocha": "^9.0.3"
  }
}

karma.conf.js

karma.conf.js 文件是 Karma 测试运行器的配置文件，用于配置浏览器测试环境。以下是一些关键配置：

module.exports = function(config) {
  config.set({
    frameworks: ['mocha', 'chai'],
    files: [
      'test/browser/**/*.js'
    ],
    browsers: ['Chrome', 'Firefox'],
    reporters: ['progress'],
    singleRun: true,
    concurrency: Infinity
  });
};

配置文件介绍

• package.json: 包含项目的名称