Normalizr 开源项目教程

Normalizr 开源项目教程

normalizrpaularmstrong/normalizr: 正常化器（Normalizr）是一个JavaScript库，用于将复杂的JSON数据结构扁平化为规范化格式，便于在Redux等状态管理库中处理。它有助于解决API响应中的嵌套数据问题。项目地址:https://gitcode.com/gh_mirrors/no/normalizr

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

Normalizr 是一个用于将复杂 JSON 对象规范化的 JavaScript 库。以下是其主要目录结构：

normalizr/
├── examples/
├── src/
│   ├── schemas/
│   ├── index.js
│   └── utils.js
├── test/
├── .babelrc
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

目录介绍：

• examples/: 包含一些使用 Normalizr 的示例代码。
• src/: 项目的源代码目录。
  • schemas/: 定义各种数据结构的文件。
  • index.js: 项目的主入口文件。
  • utils.js: 包含一些工具函数。
• test/: 包含项目的测试文件。
• .babelrc: Babel 配置文件。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

Normalizr 的启动文件是 src/index.js。这个文件导出了 Normalizr 的主要功能，包括 schema 和 normalize 函数。

// src/index.js
import * as schemas from './schemas';
import { normalize, denormalize, schema, __tests__ } from './utils';

export {
  schemas,
  normalize,
  denormalize,
  schema,
  __tests__
};

主要功能：

• schemas: 包含各种数据结构的定义。
• normalize: 用于规范化 JSON 对象的函数。
• denormalize: 用于反规范化 JSON 对象的函数。
• schema: 定义数据结构的类。
• __tests__: 包含测试相关的功能。

3. 项目的配置文件介绍

.babelrc

Babel 配置文件，用于转译 JavaScript 代码。

{
  "presets": [
    ["env", {
      "targets": {
        "browsers": ["last 2 versions", "ie >= 11"]
      }
    }],
    "stage-0"
  ]
}

.eslintrc

ESLint 配置文件，用于代码风格检查。

{
  "extends": "eslint:recommended",
  "parserOptions": {
    "ecmaVersion": 6,
    "sourceType": "module"
  },
  "env": {
    "browser": true,
    "node": true,
    "es6": true
  },
  "rules": {
    "no-console": "off"
  }
}

package.json

项目依赖和脚本配置文件。

{
  "name": "normalizr",
  "version": "3.6.1",
  "description": "Normalizr is a small, but powerful utility for taking JSON with a schema definition and returning nested entities with their IDs, gathered in dictionaries.",
  "main": "lib/index.js",
  "scripts": {
    "build": "babel src --out-dir lib",
    "test": "jest",
    "lint": "eslint src test"
  },
  "dependencies": {
    "lodash": "^4.17.15"
  },
  "devDependencies": {
    "babel-cli": "^6.26.0",
    "babel-preset-env": "^1.7.0",
    "eslint": "^6.8.0",
    "jest": "^25.1.0"
  }
}

主要配置：

• scripts: 定义了一些常用的脚本命令，如 build、test 和 lint。
• dependencies: 项目运行时的依赖。

normalizrpaularmstrong/normalizr: 正常化器（Normalizr）是一个JavaScript库，用于将复杂的JSON数据结构扁平化为规范化格式，便于在Redux等状态管理库中处理。它有助于解决API响应中的嵌套数据问题。项目地址:https://gitcode.com/gh_mirrors/no/normalizr