Fuse.js 项目教程

Fuse.js 项目教程

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

Fuse.js 是一个轻量级的模糊搜索库，其目录结构相对简单。以下是主要的目录和文件介绍：

fuse.js/
├── dist/
│   ├── fuse.js
│   ├── fuse.min.js
│   └── fuse.esm.js
├── src/
│   ├── bitap/
│   │   ├── bitap_score.js
│   │   ├── bitap_regex_search.js
│   │   ├── bitap_search.js
│   │   └── bitap_symbol_table.js
│   ├── core.js
│   ├── index.js
│   └── utils.js
├── test/
│   ├── index.js
│   └── tests.js
├── .babelrc
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js

• dist/：包含构建后的文件，如 fuse.js、fuse.min.js 和 fuse.esm.js。
• src/：源代码目录，包含核心逻辑和工具函数。
• test/：测试文件目录。
• .babelrc：Babel 配置文件。
• .eslintrc：ESLint 配置文件。
• .gitignore：Git 忽略文件配置。
• .npmignore：NPM 忽略文件配置。
• .travis.yml：Travis CI 配置文件。
• LICENSE：项目许可证。
• package.json：项目依赖和脚本配置。
• README.md：项目说明文档。
• webpack.config.js：Webpack 配置文件。

2. 项目的启动文件介绍

Fuse.js 的启动文件是 src/index.js，这个文件导出了 Fuse 类，是整个库的入口点。

import Fuse from './core';
export default Fuse;

3. 项目的配置文件介绍

Fuse.js 的配置文件主要是 package.json 和 webpack.config.js。

package.json

这个文件包含了项目的元数据、依赖和脚本命令。

{
  "name": "fuse.js",
  "version": "6.6.2",
  "description": "Lightweight fuzzy-search",
  "main": "dist/fuse.js",
  "module": "dist/fuse.esm.js",
  "types": "dist/fuse.d.ts",
  "scripts": {
    "build": "npm run build:umd && npm run build:esm && npm run build:types",
    "build:umd": "webpack",
    "build:esm": "rollup -c",
    "build:types": "tsc -p tsconfig.json",
    "test": "jest"
  },
  "keywords": [
    "fuzzy-search"
  ],
  "author": "Kiro Risk <kirollos@gmail.com> (https://kiro.me)",
  "license": "Apache-2.0",
  "devDependencies": {
    "@babel/core": "^7.12.3",
    "@babel/preset-env": "^7.12.1",
    "babel-loader": "^8.1.0",
    "eslint": "^7.10.0",
    "jest": "^26.6.0",
    "rollup": "^2.32.1",
    "typescript": "^4.0.3",
    "webpack": "^5.1.3",
    "webpack-cli": "^4.1.0"
  }
}

webpack.config.js

这个文件是 Webpack 的配置文件，用于构建 UMD 格式的输出文件。

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'fuse.js',
    library: 'Fuse',
    libraryTarget: 'umd',
    globalObject: 'this'