本文参加了由公众号@若川视野 发起的每周源码共读活动， 点击了解详情一起参与。
这是源码共读的第36期，链接：【若川视野 x 源码共读】第36期 | 可能是历史上最简单的一期 omit.js 剔除对象中的属性。
目标
- 理解omit是如何剔除对象中的属性
- 了解源码使用的依赖包
- 复刻
omit是如何剔除对象中的属性？
先来看看源码
function omit(obj, fields) {
// eslint-disable-next-line prefer-object-spread
const shallowCopy = Object.assign({}, obj);
for (let i = 0; i < fields.length; i += 1) {
const key = fields[i];
delete shallowCopy[key];
}
return shallowCopy;
}
函数的入参为obj(目标对象)和fields(被剔除的属性的字符串数组)
- 首先，先用Object.assign浅拷贝了目标对象。
- Object.assign 不会复制原型链上的属性和不可枚举属性
- 循环fields，取出属性名，在浅拷贝对象上进行delete
- 只会删除第一层的对象属性，不能删除更深次的
- 返回浅拷贝对象
- 综上，它不会改变原对象，返回的对象是剔除了原型链属性和其不可枚举属性以及目标剔除属性的对象。
依赖包
- father 基于rollup和babel的打包器
- 基于docz 的文档
- 支持ts,eslint,test......
- 支持 cjs、esm 和 umd 三种格式的打包
- @umijs/fabric 包含 prettier，eslint，stylelint 的配置文件合集
- assert 一个和nodejs中assert差不多的包
- np 发包小助手
复刻
father
不需要文档的话安装father-build就行啦。配置说明
import { IBundleOptions } from "father"
const fatherOption: IBundleOptions = {
/**
* 入口文件
*/
entry: "src/index.js",
/**
* 是否输出 cjs 格式，以及指定 cjs 格式的打包方式
*/
cjs: "babel",
/**
* 是否输出 esm 格式，以及指定 esm 格式的打包方式
*/
esm: {
type: "babel",
importLibToEs: true // 是否在 esm 模式下把 import 项里的 /lib/ 转换为 /es/。
},
preCommit: {
eslint: true,
}
}
export default fatherOption
添加指令
"build": "father build",
@umijs/fabric
- 添加.eslintrc.js配置文件
module.exports = {
extends: [require.resolve("@umijs/fabric/dist/eslint")],
rules: {
// your rules lan de c+v
},
};
- 添加.eslintignore忽略文件
.eslintrc.js
lib
es
- 添加tsconfig配置文件，给源码加点类型~，又菜又爱写ts
function omit<T, K extends keyof T>(obj: T, fields: K[]): Omit<T, K> {
const shallowCopy = Object.assign({}, obj);
for (let i = 0; i < fields.length; i += 1) {
const key = fields[i];
delete shallowCopy[key];
}
return shallowCopy;
}
export default omit;
- test
- 安装assert
- deepEqual：测试返回的对象和原对象的深度是否相同 此方法只考虑自身的可枚举属性
import assert from "assert";
import omit from "../src";
describe("omit", () => {
it("应该创建一个浅拷贝", () => {
const original = { truth: "弥央真可爱" };
const newObj = omit(original, []);
assert.deepEqual(original, newObj); // 测试返回的对象和原对象的深度是否相同 此方法只考虑自身的可枚举属性
assert.notEqual(original, newObj);
});
it("应该删除传入的字段", () => {
const original = { name: "弥央", age: 18 };
assert.deepEqual(omit(original, ["age"]), { name: "弥央" });
assert.deepEqual(omit(original, ["name", "age"]), {});
});
it("应该不返回原对象原型链上的属性和自身的不可枚举属性", () => {
const original = Object.create(
{
desc: "是我老婆",
},
{
name: {
value: "弥央",
enumerable: true,
},
age: {
value: 18,
},
}
);
assert.deepEqual(omit(original, ["name"]), {});
});
});
添加指令
- coverage 覆盖率测试
- test
"coverage": "father test --coverage",
"test": "father test"
- 发布 在package中定义入口
"main": "lib/index.js",
"module": "es/index.js",
"types": "index.d.ts",
- 安装np npm install --global np 添加预发布指令
"prepublishOnly": "npm run build && np --yolo --no-publish",
- --yolo 跳过清理和测试
- --no-publish 跳过发布
