Created By JishuBao on 2019-04-22 12:38:22
Recently revised in 2019-04-23 20:59
欢迎大家来到技术宝的掘金世界,您的star是我写文章最大的动力!GitHub地址
最近新公司在制定一套UI规范,说是为了以后前端“即托即用”做准备。
本来前端人数就不多的我和我的小郝哥开始抓紧了节奏,准备开始写一些UI规范,但是由于我们俩都没有完整的了解过相关的方面的制作,我们在文档上煞费苦心,在制作UI规范文档中,我们发现在Vue中并不能直接像markdown一样写一些代码注释等。导致需要这样写,大家感受下:
其实我们的内心是崩溃的!如果每写一个都这样的话,咋整!也不是说难,就是太繁琐,咱也不敢想!所以技术宝觉得这样不行,然后灵机一动想到平时所用的ui框架vant,人家的官网做的是多么的好看,然后我打开了vant的源码,一开始我是没怎么看懂,后来我发现他用的是md文档,当时我心想,这么so easy的吗?
然后我直接引入了markdown文档格式文件md文件,然后...
明明别人的就能引入不报错,然后我发现那些Ui框架里面的package.json文件里面基本上都有一个vue-markdown-loader,机智的我很快就反应过来,他不识别md格式,就和不加vue-loader不能使用Vue一样,所以我们还是要加上这个vue-markdown-loader,技术宝这个时候突然萌生了一个想法,如果自己写一个loader呢,这样以来,既能理解,又能够对于这个loader了如指掌。话不多啥,开始启动我们的教程吧。
一、前置知识
你需要知道loader是干嘛用的,其实Loader就相当于一个“处理器”,将ts文件转化为js文件,将图像转化成内联data url等...
我们来写一个简单的loader
module.exports = function (src) {
const res = (
`<template>\n` +
`<h1>hello world</h1>\n` +
`</template>`
)
return res
}
复制代码
我承认这个loader长的确实是有一点智障的,但是这个Loader确实也做到了大部分Loader所做的事。
- 你需要知道loader是干嘛用的。
- 需要安装相对应的辅助工具包。
包名称 | 功能说明 |
---|---|
markdown-it | 渲染markdown基本语法 |
markdown-it-anchor | 为各级标题添加瞄点 |
markdown-it-container | 用于创建自定义的块级容器 |
markdown-it-emoji | 渲染emoji |
markdown-it-table-of-contents | 自动生成目录 |
highlight.js | 代码高亮 |
hash-sum | 产生一个基于的四字节十六进制哈希value |
lru-cache | 一个缓存对象,用于删除最近最少使用的项目 |
三、项目书写中遇到的问题/知识点
1.md文档中h1/h2标签大小一致
section h1{
font-size:2em;
}
复制代码
参考链接:h1和h2大小一致、如何去掉浏览器的默认样式
2.js方法replace方法
语法
stringObject.replace(regexp/substr,replacement)
参数
参数 | 参数类型 | 描述 | 是否必需 |
---|---|---|---|
stringObject | 字符串 | 一个字符串类型的值 | 是 |
regexp/substr | 正则对象/字符串 | 规定子字符串或要替换的模式的 RegExp 对象。值得注意的是如果该值是一个字符串,则将它作为要检索的直接量文本模式,而不是首先被转换为 RegExp 对象。 | 是 |
replacement | 一个字符串值 | 规定了替换文本或生成替换文本的函数 | 是 |
返回值:
一个新的字符串,是用 replacement 替换了 regexp 的第一次匹配或所有匹配之后得到的。
说明:
字符串 stringObject 的 replace() 方法执行的是查找并替换的操作。它将在 stringObject 中查找与 regexp 相匹配的子字符串,然后用replacement来替换这些子串。如果 regexp 具有全局标志 g,那么 replace() 方法将替换所有匹配的子串。否则,它只替换第一个匹配子串。replacement 可以是字符串,也可以是函数。如果它是字符串,那么每个匹配都将由字符串替换。但是 replacement 中的 $ 字符具有特定的含义。如下表所示,它说明从模式匹配得到的字符串将用于替换。
字符 | 替换文本 |
---|---|
$1、$2、...、$99 | 与 regexp 中的第 1 到第 99 个子表达式相匹配的文本。 |
$& | 与 regexp 相匹配的子串。 |
$` | 位于匹配子串左侧的文本。 |
$' | 位于匹配子串右侧的文本。 |
$$ | 直接量符号。 |
实例:
- 正则表达式第一个参数是字符串。
"Jsbao是是是男神".replace('是','不是');//Jsbao不是是是男神(只匹配第一个子串)
复制代码
2.正则表达式第一个参数是正则对象。
"Jsbao是是是男神".replace(/是/,'不是');//Jsbao不是是是男神(只匹配第一个子串)
复制代码
3.正则表达式第一个参数是正则对象且有g全局标志。
"Jsbao是是是男神".replace(/是/g,'不是');//Jsbao不是不是不是男神(匹配所有子串)
复制代码
4.正则表达式第二个参数是带有特殊含义的符号
"Jsbao是是是男神".replace(/(是)/g,'不$1');//Jsbao不是不是不是男神(匹配所有子串)
复制代码
注意$1此类特殊符号代表匹配的子项,故正则需要加(),代表匹配子项
5.正则表达式第二个参数是函数。
"Jsbao是男神".replace(/(是|男)/g,function(value){return value==='是'?'不是':'女'});//Jsbao不是女神
复制代码
此文中遇到的replace
str.replace(/(<pre|<code)/g,'$1 v-pre');//意思应该是将<pre或者<code替换成<pre v-pre或<code pre的形式
复制代码
参考链接:replace函数的作用
3.js方法Object.defineProperty()
Object.defineProperty() 方法会直接在一个对象上定义一个新属性,或者修改一个对象的现有属性, 并返回这个对象。
语法
Object.defineProperty(obj, prop, descriptor)
参数
参数 | 描述 |
---|---|
obj | 要在其上定义属性的对象 |
prop | 要定义或修改的属性的名称 |
descriptor | 将定义或修改的属性描述符 |
返回值
被传递给函数的对象。
在ES6中,由于 Symbol类型的特殊性,用Symbol类型的值来做对象的key与常规的定义或修改不同,而Object.defineProperty 是定义key为Symbol的属性的方法之一。
描述
该方法允许精确添加或修改对象的属性。通过赋值操作添加的普通属性是可枚举的,能够在属性枚举期间呈现出来(for...in 或 Object.keys 方法), 这些属性的值可以被改变,也可以被删除。这个方法允许修改默认的额外选项(或配置)。默认情况下,使用 Object.defineProperty() 添加的属性值是不可修改的。
属性描述符
对象里目前存在的属性描述符有两种主要形式:数据描述符和存取描述符。数据描述符是一个具有值的属性,该值可能是可写的,也可能不是可写的。存取描述符是由getter-setter函数对描述的属性。描述符必须是这两种形式之一;不能同时是两者。
属性 | 描述 | 是否是数据描述符属于的键值 | 是否是存取描述符属于的键值 |
---|---|---|---|
configurable | 当且仅当该属性的 configurable 为 true 时,该属性描述符才能够被改变,同时该属性也能从对应的对象上被删除。默认为 false。 | 是 | 是 |
enumerable | 当且仅当该属性的enumerable为true时,该属性才能够出现在对象的枚举属性中。默认为 false。 | 是 | 是 |
value | 该属性对应的值。可以是任何有效的 JavaScript 值(数值,对象,函数等)。默认为 undefined。 | 是 | 否 |
writable | 当且仅当该属性的writable为true时,value才能被赋值运算符改变。默认为 false。 | 是 | 否 |
get | 一个给属性提供 getter 的方法,如果没有 getter则为undefined。当访问该属性时,该方法会被执行,方法执行时没有参数传入,但是会传入this对象(由于继承关系,这里的this并不一定是定义该属性的对象)。默认为 undefined。 | 否 | 是 |
set | 一个给属性提供 setter 的方法,如果没有 setter 则为undefined。当属性值修改时,触发执行该方法。该方法将接受唯一参数,即该属性新的参数值。默认为 undefined。 | 否 | 是 |
如果一个描述符不具有value,writable,get 和 set 任意一个关键字,那么它将被认为是一个数据描述符。如果一个描述符同时有(value或writable)和(get或set)关键字,将会产生一个异常。
记住,这些选项不一定是自身属性,如果是继承来的也要考虑。为了确认保留这些默认值,你可能要在这之前冻结 Object.prototype,明确指定所有的选项,或者通过 Object.create(null)将__proto__属性指向null。
// 使用 __proto__
var obj = {};
var descriptor = Object.create(null); // 没有继承的属性
// 默认没有 enumerable,没有 configurable,没有 writable
descriptor.value = 'static';
Object.defineProperty(obj, 'key', descriptor);
// 显式
Object.defineProperty(obj, "key", {
enumerable: false,
configurable: false,
writable: false,
value: "static"
});
// 循环使用同一对象
function withValue(value) {
var d = withValue.d || (
withValue.d = {
enumerable: false,
writable: false,
configurable: false,
value: null
}
);
d.value = value;
return d;
}
// ... 并且 ...
Object.defineProperty(obj, "key", withValue("static"));
// 如果 freeze 可用, 防止代码添加或删除对象原型的属性
// (value, get, set, enumerable, writable, configurable)
(Object.freeze||Object)(Object.prototype);
复制代码
用法
- 创建属性:
如果对象中不存在指定的属性,Object.defineProperty()就创建这个属性。当描述符中省略某些字段时,这些字段将使用它们的默认值。拥有布尔值的字段的默认值都是false。value,get和set字段的默认值为undefined。一个没有get/set/value/writable定义的属性被称为“通用的”,并被“键入”为一个数据描述符。
var o = {}; // 创建一个新对象
// 在对象中添加一个属性与数据描述符的示例
Object.defineProperty(o, "a", {
value : 37,
writable : true,
enumerable : true,
configurable : true
});
// 对象o拥有了属性a,值为37
// 在对象中添加一个属性与存取描述符的示例
var bValue;
Object.defineProperty(o, "b", {
get : function(){
return bValue;
},
set : function(newValue){
bValue = newValue;
},
enumerable : true,
configurable : true
});
o.b = 38;
// 对象o拥有了属性b,值为38
// o.b的值现在总是与bValue相同,除非重新定义o.b
// 数据描述符和存取描述符不能混合使用
Object.defineProperty(o, "conflict", {
value: 0x9f91102,
get: function() {
return 0xdeadbeef;
}
});
// throws a TypeError: value appears only in data descriptors, get appears only in accessor descriptors
复制代码
- 修改属性
如果属性已经存在,Object.defineProperty()将尝试根据描述符中的值以及对象当前的配置来修改这个属性。如果旧描述符将其configurable 属性设置为false,则该属性被认为是“不可配置的”,并且没有属性可以被改变(除了单向改变 writable 为 false)。当属性不可配置时,不能在数据和访问器属性类型之间切换。
当试图改变不可配置属性(除了value和writable 属性之外)的值时会抛出TypeError,除非当前值和新值相同。
Writable属性
当writable属性设置为false时,该属性被称为“不可写”。它不能被重新分配。
var o = {}; // Creates a new object
Object.defineProperty(o, 'a', {
value: 37,
writable: false
});
console.log(o.a); // logs 37
o.a = 25; // No error thrown
// (it would throw in strict mode,
// even if the value had been the same)
console.log(o.a); // logs 37. The assignment didn't work.
// strict mode
(function() {
'use strict';
var o = {};
Object.defineProperty(o, 'b', {
value: 2,
writable: false
});
o.b = 3; // throws TypeError: "b" is read-only
return o.b; // returns 2 without the line above
}());
复制代码
Enumerable 特性
enumerable定义了对象的属性是否可以在 for...in 循环和 Object.keys() 中被枚举。
var o = {};
Object.defineProperty(o, "a", { value : 1, enumerable:true });
Object.defineProperty(o, "b", { value : 2, enumerable:false });
Object.defineProperty(o, "c", { value : 3 }); // enumerable defaults to false
o.d = 4; // 如果使用直接赋值的方式创建对象的属性,则这个属性的enumerable为true
for (var i in o) {
console.log(i);
}
// 打印 'a' 和 'd' (in undefined order)
Object.keys(o); // ["a", "d"]
o.propertyIsEnumerable('a'); // true
o.propertyIsEnumerable('b'); // false
o.propertyIsEnumerable('c'); // false
复制代码
Configurable 特性
configurable特性表示对象的属性是否可以被删除,以及除value和writable特性外的其他特性是否可以被修改。
var o = {};
Object.defineProperty(o, "a", { get : function(){return 1;},
configurable : false } );
// throws a TypeError
Object.defineProperty(o, "a", {configurable : true});
// throws a TypeError
Object.defineProperty(o, "a", {enumerable : true});
// throws a TypeError (set was undefined previously)
Object.defineProperty(o, "a", {set : function(){}});
// throws a TypeError (even though the new get does exactly the same thing)
Object.defineProperty(o, "a", {get : function(){return 1;}});
// throws a TypeError
Object.defineProperty(o, "a", {value : 12});
console.log(o.a); // logs 1
delete o.a; // Nothing happens
console.log(o.a); // logs 1
复制代码