Feathers-Hooks-Common 项目教程

Feathers-Hooks-Common 项目教程

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

Feathers-Hooks-Common 是一个为 Feathers.js 框架提供常用钩子（hooks）的库。以下是其基本的目录结构：

feathers-hooks-common/
├── lib/
│   ├── hooks/
│   ├── index.js
│   ├── utils/
├── test/
│   ├── hooks/
│   ├── index.test.js
│   ├── utils/
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

目录结构介绍

• lib/: 包含项目的主要代码，其中 hooks/ 目录存放各种钩子实现，index.js 是入口文件，utils/ 包含一些工具函数。
• test/: 包含项目的测试代码，结构与 lib/ 相似，用于测试钩子和工具函数。
• .editorconfig, .eslintrc, .gitignore, .npmignore, .travis.yml: 配置文件，用于代码格式化、代码检查、版本控制等。
• CHANGELOG.md: 记录项目的变更日志。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和脚本配置。
• yarn.lock: 锁定依赖版本的文件。

2. 项目的启动文件介绍

Feathers-Hooks-Common 的启动文件是 lib/index.js。这个文件导出了所有可用的钩子函数，使得用户可以方便地引入和使用这些钩子。

// lib/index.js
module.exports = {
  alterItems,
  cache,
  callbackToPromise,
  combine,
  disablePagination,
  disallow,
  discard,
  discardQuery,
  existsByDot,
  fastJoin,
  iff,
  iffElse,
  isNot,
  isProvider,
  keep,
  keepQuery,
  lowerCase,
  paramsFromClient,
  paramsForServer,
  populate,
  preventChanges,
  remove,
  removeQuery,
  replaceItems,
  required,
  runHook,
  serialize,
  setField,
  setNow,
  setSlug,
  softDelete,
  some,
  stashBefore,
  traverse,
  validate,
  validateSchema
};

3. 项目的配置文件介绍

Feathers-Hooks-Common 的配置文件主要包括 package.json 和一些用于开发和测试的配置文件。

package.json

package.json 文件包含了项目的元数据和依赖信息，以及一些脚本命令。

{
  "name": "feathers-hooks-common",
  "version": "5.0.6",
  "description": "Useful hooks for use with Feathersjs services.",
  "main": "lib/",
  "directories": {
    "lib": "lib",
    "test": "test"
  },
  "scripts": {
    "test": "npm run lint && npm run mocha",
    "lint": "eslint lib/ test/",
    "mocha": "mocha test/ --recursive --exit",
    "coverage": "nyc npm run mocha"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/feathersjs-ecosystem/feathers-hooks-common.git"
  },
  "keywords": [
    "feathers",
    "feathers-plugin",
    "hooks"
  ],
  "author": "Feathers contributors",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/feathersjs-ecosystem/feathers-hooks-common/issues"
  },
  "homepage": "https://github.com/feathersjs-ecosystem/feathers-hooks-common#readme",
  "dependencies": {
    "debug": "^4.1.1",
    "feathers-hooks-common": "^5.0.6",
    "lodash": "^4.17.