推荐一波强悍且实用的 NPM 软件包

ゝ一纸荒年。 2023-01-15 14:26 141阅读 0赞

![0c5825753b5fa325f31811e3e3f21497.png][]

作者：ask\_the\_sky

https://juejin.cn/post/6950584088462163982

实用工具

### Lodash ###

lodash是一套现代 JavaScript 实用程序库，提供模块化、性能与多种附加功能。可提供关于 JavaScript 数组、对象及其他数据结构的多种实用功能。

![37fe9aa8a4caa26d1ba3b85dc06782a4.png][]

#### 安装及示例 ####

yarn add lodash
    
    复制代码

不要滥用，尽量使用 ES 自带方法 。我常用的一些方法如下

// -----------------------------深度比较两个对象的值是否全相等
    import { isEqual, cloneDeep, uniqBy, sortBy } from "lodash";
    
    const object = { a: 1 };
    const other = { a: 1 };
    
    isEqual(object, other);
    // => true
    
    object === other;
    // => false
    
    // -----------------------------深拷贝
    const objects = [{ a: 1 }, { b: 2 }];
    
    const deep = cloneDeep(objects);
    console.log(deep[0] === objects[0]);
    // => false
    
    // -----------------------------数组去重
    uniqBy([{ x: 1 }, { x: 2 }, { x: 1 }], "x");
    // => [{ 'x': 1 }, { 'x': 2 }]
    
    // -----------------------------数组排序
    const users = [
      { user: "fred", age: 48 },
      { user: "barney", age: 36 },
      { user: "fred", age: 40 },
      { user: "barney", age: 34 },
    ];
    sortBy(users, "age");
    /*
    [
      { 'user': 'barney', 'age': 34 },
      { 'user': 'barney', 'age': 36 },
      { 'user': 'fred', 'age': 40 },
      { 'user': 'fred', 'age': 48 },
    ];
    */
    
    复制代码

### qs ###

`qs` 处理 URL 查询字符串,支持内嵌对象和数组。简而言之，就是将对象和 URL 地址的参数互相转换

![653312cb2af840134b6c38d1f22bb8a7.png][]

##### 安装及示例 #####

yarn add qs
    
    复制代码

import { parse, stringify } from "qs";
    
    // 用途一
    // 将 浏览器上 URL地址参数转换为对象（字符串转对象）
    const urlParams = parse(window.location.href.split("?")[1]);
    
    // 用途二
    // 将对象参数 传递给到后端接口--GET 请求  （对象转字符串）
    const params = {
      name: "wang",
      age: "18",
      sex: "女",
    };
    
    // =>  /api/user?name=wang&age=18&sex=%E5%A5%B3
    const apiUrl = `/api/user?${stringify(params)}`;
    
    复制代码

### classnames ###

classnames有条件地将类名组合在一起

#### 安装及示例 ####

yarn add classnames
    
    复制代码

错误 ❎ 代码示例: React 原生动态添加多个样式类名会报错：

import styles from "./index.less";
    
    const Index=()=><div className={styles.class1 styles.class2}</div>
    
    复制代码

修改为如下代码即可解决

import React from "react"
    import classnames from 'classnames'
    
    import styles from "./index.less";
    
    const Index=()=>(<div
              className=classnames({
                  styles.class1,
                  styles.class2
              })>
    </div>)
    
    复制代码

### numeral ###

numeral是一个专门用来格式化数字的 NPM 库，同时 numeral 还能解析各种格式的数字。

![b17c3125e9c3b89b9bc96fec5c48c505.png][]

#### 安装及示例 ####

yarn add numeral
    
    复制代码

import numeral from "numeral";
    
    // 解析数字
    numeral("10,000.12"); // 10000.12
    numeral("$10,000.00"); // 10000
    numeral("3.467TB"); // 3467000000000
    numeral("-76%"); // -0.76
    
    // 格式化
    
    numeral(10000.23).format("0,0"); // '10,000'
    numeral(1000.234).format("$0,0.00"); // '$1,000.23'
    
    复制代码

### cross-env ###

cross-env是一个运行跨平台设置和使用环境变量的脚本

##### 安装及示例 #####

yarn add cross-env --dev
    
    复制代码

"scripts": {
        "start": "cross-env REACT_APP_ENV=development webpack",
        "build": "cross-env REACT_APP_ENV=production webpack",
      },
    
    复制代码

### path-to-regexp ###

path-to-regexp用来处理 url 中地址与参数，能够很方便得到我们想要的数据。

js 中有 `RegExp` 方法做正则表达式校验，而 `path-to-regexp` 可以看成是 url 字符串的正则表达式。

#### 安装及示例 ####

yarn add path-to-regexp
    
    复制代码

`pathToRegexp`方法可以类比于 js 中 `new RegExp('xxx')`。

import pathToRegexp from "path-to-regexp";
    
    const re = pathToRegexp("/foo/:bar");
    console.log(re); // /^\/foo\/((?:[^\/]+?))(?:\/(?=$))?$/i
    
    复制代码

`compile`用于填充 url 字符串的参数值。

var pathToRegexp = require("path-to-regexp");
    
    var url = "/user/:id/:name";
    var data = { id: 10001, name: "bob" };
    
    // /user/10001/bob
    console.log(pathToRegexp.compile(url)(data));
    
    复制代码

--------------------

## 日期格式 ##

### Day.js ###

Day.js 是一款快速且轻量化的 Moment.js(自 2020 年 9 月起进入纯维护模式,不再开发新版本) 替代方案。二者拥有类似的 API，只要你接触过 `Moment.js`，就能够快速上手 `Day.js`。

![d00dba7365d9a6393d158caaa31c7cc9.png][]

#### 安装 ####

yarn add dayjs
    
    复制代码

#### 示例 ####

import dayjs from "dayjs";
    
    const myformat = "YYYY-MM-DD HH:mm:ss";
    
    // -------------------------以字符串形式返回 当前时间
    const data = dayjs().format(myformat);
    // =>  2020-11-25 12:25:56
    
    // -------------------------日期格式化
    const data1 = dayjs("2020-11-25 12:25:56").format("YYYY/MM/DD HH/mm/ss");
    // => 2020/11/25 12/25/56
    
    // -------------------------多久之前
    var relativeTime = require("dayjs/plugin/relativeTime");
    dayjs.extend(relativeTime);
    const data1 = dayjs("2020-11-25 11:40:41").fromNow();
    
    // =>
    
    复制代码

--------------------

## Linters 与格式化工具 ##

### ESLint ###

ESLint 是一个很好用的工具，可用来避免代码错误并强制开发团队使用编码标准。ESLint 是用于识别和报告 ECMAScript/JavaScript 代码中模式的工具。ESLint 具备全面的可插入特性，每项规则对应一款插件，供你在运行时添加更多内容。

![f292568928cc9fc9bba05bcb838a6e94.png][]

##### 安装和使用 #####

$ yarn add eslint --dev
    
    复制代码

然后，你应该设置一个配置文件：

$ ./node_modules/.bin/eslint --init
    
    复制代码

之后，你可以在任何文件或目录上运行 ESLint，如下所示：

$ ./node_modules/.bin/eslint yourfile.js
    
    复制代码

有关更多说明，请参阅官方文档，其中有许多入门和配置示例。

### Prettier ###

Prettier 是一款风格鲜明的代码格式化程序。它通过解析代码并使用自己的规则（限定最大行长）对代码进行重新输出，借此实现统一的样式；

![d5ecebb154606ca26c409edef3820bac.png][]

#### 安装 ####

yarn add --dev --exact prettier
    
    复制代码

#### 示例 ####

创建 `.prettierrc.js` 加入自定义格式化规则

module.exports = {
      trailingComma: "es5",
      tabWidth: 4,
      semi: false,
      singleQuote: true,
    };
    
    复制代码

创建 `.prettierignore` 加入需要忽略的文件或目录

# Ignore artifacts:
    build
    coverage
    
    复制代码

执行格式化命令

# 格式化src目录下的所有js文件
    
    prettier --write "src/**/*.js"
    
    复制代码

### stylelint ###

stylelint 一个强大的样式规则，可以让你强制执行样式规范，避免书写错误的样式代码

#### 安装 ####

yarn add stylelint stylelint-config-standard --dev
    
    复制代码

#### 示例 ####

创建`.stylelintrc.js`并加入配置

module.exports = {
      extends: "stylelint-config-standard",
    };
    
    复制代码

执行 lint 命令

# 检查 src目录下所有css文件是否符合规范
    npx stylelint "src/**/*.css"
    
    复制代码

### Husky ###

Husky 可以帮助我们简单直接地实现 git hooks。你们团队正在协作开发，并希望在整个团队中推行一套编码标准？没问题！有了 Husky，你就可以要求所有人在提交或推送到存储库之前自动完成 lint 并测试其代码。

![4c2c58b80b88aeee5bfd2f0f7c59eef8.png][]

##### 安装及示例 #####

yarn add husky --dev
    
    复制代码

下面是一个实现 husky hooks 的示例：

// package.json
    {
      "husky": {
        "hooks": {
          "pre-commit": "npm lint",
          "pre-push": "npm test"
        }
      }
    }
    
    复制代码

这里 `pre-commit` 的 `hooks` 会在你提交到存储库之前运行。在将代码推送到存储库之前，将运行 `pre-push hook`。

--------------------

## ♂️ 数据生成器 ##

### Uuid ###

uuid是一个便捷的微型软件包，能够快速生成更为复杂的通用唯一标识符（UUID）。

#### 安装及示例 ####

npm install uuid
    
    复制代码

import { v4 as uuidv4 } from "uuid";
    uuidv4(); // ⇨ '9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d'
    
    复制代码

### faker.js ###

faker.js非常实用的工具包，用于在浏览器及 Node.js 中生成大量假数据。

![aebd9f17cf9b0f96f59376ad68f1550f.png][]

#### 安装及示例 ####

yarn add faker
    
    复制代码

import faker from "faker"
    
    function generateCustomers () {
      const customers = []
    
      for (let id = 0; id < 50; id++) {
        const firstName = faker.name.firstName()
        const lastName = faker.name.firstName()
        const phoneNumber = faker.phone.phoneNumberFormat()
        const zipCode = faker.address.zipCode()
        const date = faker.date.recent()
    
        customers.push({
          id,
          firstName,
          lastName ,
          phoneNumber ,
          zipCode,
          date
        })
      }
    
      return { customers }
    
    复制代码

### Mock.js ###

Mock.js 是一个模拟数据生成器，可帮助前端开发和原型与后端进度分开，并减少某些单调性，尤其是在编写自动化测试时。

![b06658eb6688ad3fa25176469237a95c.png][]

##### 安装及示例 #####

npm install mockjs
    
    复制代码

import Mock from "mockjs";
    
    const Random = Mock.Random
    
    function generateCustomers () {
      const customers = []
    
      for (let id = 0; id < 50; id++) {
        const firstName = Random.first()
        const lastName = Random.last()
        const province = Random.province()
        const date = Random.date()
    
        customers.push({
          id,
          firstName,
          lastName ,
          province,
          date
        })
      }
    
      return { customers }
    
    复制代码

--------------------

## 测试工具 ##

### Jest ###

Jest 是一款便捷好用的 JavaScript 测试框架，以简单为核心诉求。您可以通过易于上手且功能丰富的 API 编写测试，从而快速获取结果。

![3ef5b6361f242ec685852e261f0b0e56.png][]

#### 安装及示例 ####

yarn add --dev jest
    
    复制代码

测试`sum`函数，这个函数的功能是两数相加。首先创建 `sum.js` 文件：

function sum(a, b) {
      return a + b;
    }
    module.exports = sum;
    
    复制代码

接下来，创建名为 `sum.test.js` 的文件。这个文件包含了实际测试内容：

const sum = require("./sum");
    
    test("adds 1 + 2 to equal 3", () => {
      expect(sum(1, 2)).toBe(3);
    });
    
    复制代码

将如下代码添加到 `package.json` 中：

{
      "script": {
        "test": "jest"
      }
    }
    
    复制代码

最后，运行 `yarn test` ，Jest 将输出如下信息：

PASS  ./sum.test.js
    ✓ adds 1 + 2 to equal 3 (5ms)
    
    复制代码

### Mocha ###

Mocha 是一个功能丰富的 javascript 测试框架，运行在 node.js 和浏览器中，使异步测试变得简单有趣。Mocha 测试连续运行，允许灵活和准确的报告，同时将未捕获的异常映射到正确的测试用例。

### 安装及示例 ###

yarn add mocha --dev
    
    复制代码

接下来，创建名为 `test.js` 的文件。这个文件包含了实际测试内容：

将如下代码添加到 `package.json` 中：

{
      "script": {
        "test": "mocha"
      }
    }
    
    复制代码

最后，运行 `yarn test` ，Mocha 将输出如下信息：

$ ./node_modules/mocha/bin/mocha
    
      Array
        #indexOf()
          ✓ should return -1 when the value is not present
    
    
      1 passing (9ms)
    
    复制代码

--------------------

## 进程管理器与运行器 ##

### Nodemon ###

nodemon用来监视 node.js 应用程序中的任何更改并自动重启服务,非常适合用在开发环境中。

nodemon 将监视启动目录中的文件，如果有任何文件更改，nodemon 将自动重新启动 node 应用程序。

#### 安装及示例 ####

yarn add  nodemon global
    
    复制代码

`server.js`表示一个 Node.js 入口文件

"scripts": {
        "start": "nodemon server.js",
      }
    
    复制代码

### PM2 ###

PM2 是一个具有内置负载均衡器的 Node.js 应用程序的生产流程管理器。有了它，你就可以让应用程序永远保持活跃，可以在不停机的前提下重新加载它们，并简化常见的系统管理任务。

![6bd1c5584dfce819d286f9592cd34a09.png][]

##### 安装及示例 #####

$ yarn add global pm2
    
    复制代码

你可以像下面一样启动任何应用程序（Node.js、Python、Ruby、$PATH 中的二进制文件……）

$ pm2 start app.js
    
    复制代码

现在，你的应用将被守护、监控并永远保持活跃。有关流程管理的更多信息见此：

应用程序启动后，你就可以轻松管理它们。可以通过以下方法列出所有正在运行的应用程序：

$ pm2 ls
    
    复制代码

![44bdf7cf3ace07980d46eeb7e37297cf.png][]

查阅官方文档，以获取 PM2 功能给的完整列表。

### Concurrently ###

Concurrently简单而直接——可同时运行多条命令的实用工具。

![cc239bf14dbb628b9b3b0f517d664b6a.png][]

##### 安装及示例 #####

yarn add concurrently global
    
    复制代码

时启动前端 webpack 项目和 后端 node 项目

// package.json   同
    "scripts": {
        "start": "concurrently \"webpack-dev-server\" \"nodemon server.js\"",
      },
    
    复制代码

--------------------

## Web sockets ##

### Socket.io ###

Socket.IO 支持实时、双向、基于事件的通信功能。它能够运行在各类平台、浏览器及设备之上，且拥有良好的可靠性与速度表现。

![74f8223b88d09d453514f5caa3a65491.png][]

#### 安装及示例 ####

官方教程

### WS ###

WS易于使用、快速且经过全面测试的 WebSocket 客户端与服务器实现。同时也是一套强大、抽象度更低且几乎能够与 Socket.io 相媲美的替代方案。

官方教程

--------------------

## 最后 ##

在日常工作中你还使用哪些 NPM 工具库呢？欢迎在评论区留下的你的见解！

觉得有收获的朋友欢迎点赞，关注一波!

####  ####

[0c5825753b5fa325f31811e3e3f21497.png]: /images/20221022/cd491510a304444fb2f95b02f6541314.png
[37fe9aa8a4caa26d1ba3b85dc06782a4.png]: /images/20221022/83f4f94c0dab4e1ebeec7e55920a6a31.png
[653312cb2af840134b6c38d1f22bb8a7.png]: /images/20221022/c02f5959b6b34394a20652892a3c0133.png
[b17c3125e9c3b89b9bc96fec5c48c505.png]: /images/20221022/b739165dba314ecb84e29426d20e8567.png
[d00dba7365d9a6393d158caaa31c7cc9.png]: /images/20221022/d6d052834b2848b3a772b1efbedfc1e9.png
[f292568928cc9fc9bba05bcb838a6e94.png]: /images/20221022/cf22542e0e4e43a98cf8daafdc8b3aa6.png
[d5ecebb154606ca26c409edef3820bac.png]: /images/20221022/0291e51d7a2347568b41d417fbf6e2fd.png
[4c2c58b80b88aeee5bfd2f0f7c59eef8.png]: /images/20221022/3804bc7144dd4c5da3661a4e4952c82c.png
[aebd9f17cf9b0f96f59376ad68f1550f.png]: /images/20221022/0afe713ea2614084b1e9d90d3d9d4fae.png
[b06658eb6688ad3fa25176469237a95c.png]: /images/20221022/de3c60a1af154fd0acb034f632dd1909.png
[3ef5b6361f242ec685852e261f0b0e56.png]: /images/20221022/bc828f62ca714aa19ff8b1dc3c96db71.png
[6bd1c5584dfce819d286f9592cd34a09.png]: /images/20221022/74dcd6d7e06646c78f47b712d1dc6265.png
[44bdf7cf3ace07980d46eeb7e37297cf.png]: /images/20221022/4b04aa42fc4b4d508d157465ee50c0f4.png
[cc239bf14dbb628b9b3b0f517d664b6a.png]: /images/20221022/72ff038a8b064556886d138f6317eb20.png
[74f8223b88d09d453514f5caa3a65491.png]: /images/20221022/f152b230366d4ffca9aab7fd16592fb6.png