sort-by 项目使用教程

sort-by 项目使用教程

sort-by A utility to create comparator functions for the native `Array.sort()`. Allows for sorting by multiple properties. 项目地址: https://gitcode.com/gh_mirrors/so/sort-by

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

sort-by/
├── dist/
│   └── ...
├── test/
│   └── ...
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE.txt
├── Makefile
├── README.md
├── component.json
├── index.js
└── package.json

• dist/: 存放编译后的文件。
• test/: 存放测试文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE.txt: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目说明文档。
• component.json: 组件配置文件。
• index.js: 项目入口文件。
• package.json: npm 包配置文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js。该文件是 sort-by 库的入口点，提供了创建比较器函数的功能，用于对数组进行排序。

var sortBy = require('sort-by');
users = [
  { id: 7, name: 'Foo', age: '34', email: { primary: 'foo@email.com' } },
  { id: 3, name: 'Baz', age: '67', email: { primary: 'baz@email.com' } },
  { id: 4, name: 'Bar', age: '67', email: { primary: 'bar@email.com' } }
];

users.sort(sortBy('name', 'age'));

3. 项目的配置文件介绍

package.json

package.json 是 npm 包的配置文件，包含了项目的元数据和依赖项。

{
  "name": "sort-by",
  "version": "1.2.0",
  "description": "A utility to create comparator functions for the native `Array.sort()`",
  "main": "index.js",
  "scripts": {
    "test": "make test"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/kvnneff/sort-by.git"
  },
  "author": "Kevin Neff",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/kvnneff/sort-by/issues"
  },
  "homepage": "https://github.com/kvnneff/sort-by"
}

Makefile

Makefile 是项目的构建文件，包含了项目的构建和测试命令。

test-node:
  @./node_modules/.bin/mocha --reporter spec

test-browser:
  @./node_modules/.bin/mocha-phantomjs test/index.html

.travis.yml

.travis.yml 是 Travis CI 的配置文件，用于自动化测试和持续集成。

language: node_js
node_js:
  - "0.10"
  - "0.12"
  - "4"
  - "5"
  - "6"
  - "7"
  - "8"
  - "9"
  - "10"
  - "11"
  - "12"
  - "13"
  - "14"
  - "15"
  - "16"
  - "17"
  - "18"
  - "19"
  - "20"

sort-by A utility to create comparator functions for the native `Array.sort()`. Allows for sorting by multiple properties. 项目地址: https://gitcode.com/gh_mirrors/so/sort-by