File tree Expand file tree Collapse file tree 4 files changed +31
-7
lines changed
Expand file tree Collapse file tree 4 files changed +31
-7
lines changed Original file line number Diff line number Diff line change 1414
1515![ image-20230816235634094] ( README.assets/image-20230816235634094.png )
1616
17- 仓库创建好了之后修改` package.json ` 文件,把相关字段替换为你自己的,比如名字、作者、仓库地址等等:
17+ 仓库创建好了克隆到本地,在项目根目录下执行命令安装依赖:
18+
19+ ``` bash
20+ npm install
21+ ```
22+
23+ 安装依赖可能会花点时间,稍微耐心等待一会儿:
24+
25+ ![ image-20230817003339266] ( README.assets/image-20230817003339266.png )
26+
27+ 如果依赖安装过慢或者下载不下来,可以为` npm ` 配置国内镜像源或者使用` cnpm ` 。
28+
29+ 然后修改` package.json ` 文件,把相关字段替换为你自己的,比如名字、作者、仓库地址等等:
1830
1931``` js
2032{
3345}
3446```
3547
36- 在 ` userscript-headers.js ` 文件中存放的是默认的油猴头文件:
48+ 在项目根目录下的 ` userscript-headers.js ` 文件中存放的是默认的油猴头文件,在 ` webpack ` 编译的时候会把这个文件放到编译后的文件的头部作为油猴的插件声明 :
3749
3850```
3951// ==UserScript==
4860// ==/UserScript==
4961```
5062
51- ` ${name} ` 这种是支持的一些变量,在编译的时候会从` package.json ` 中获取对应的值替换掉。
63+ ` ${name} ` 、` ${version} ` 这种是支持的一些变量,在编译的时候会从` package.json ` 中获取对应的值替换掉,这样对于这些可能会重复或者一直变的内容我们就可以从一个源引用使用而不用重复设置或者反复修改了。
64+
65+ 然后就可以开心的写代码了,在编写代码的时候你可以使用npm命令为项目添加依赖,对于一个稍微复杂点的脚本而言很可能会引用外部的依赖:
66+
67+ ``` bash
68+ npm add xxx
69+ ```
70+
71+ 但是需要注意,这些依赖最终会被打包进` ./dist/index.js ` ,而这个文件是不适合太大的,所以尽可能不要引用太多的第三方库。
72+
73+ 同时你现在可以在` src ` 目录下以模块化的方式组织你的代码,而不必像之前那样来回上下拉扯一个几千行的` JavaScript ` 文件,单文件开发那简直是一种对脑力的摧残...
74+
75+ ![ image-20230817003923075] ( README.assets/image-20230817003923075.png )
5276
53- 然后就可以开心的写代码了, 当你需要测试的时候,执行:
77+ 当你需要测试的时候,执行:
5478
5579``` bash
5680npm run watch
@@ -60,13 +84,13 @@ npm run watch
6084
6185![ image-20230817000716664] ( README.assets/image-20230817000716664.png )
6286
63- 并在最后添加一行引入编译后的文件:
87+ 并在最后添加一行引入编译后的文件,注意这个 ` file:// ` 后面的地址是指向你的编译后的 ` ./dist/index.js ` 的绝对路径 :
6488
6589``` js
6690// @require file://D:/workspace/userscript-template/dist/index.js
6791```
6892
69- 比如一个开发时使用的油猴脚本的例子,油猴中不实际配置内容,而是使用require指向我们build后的文件,这样当修改完代码热加载编译的时候浏览器中引用的JS也是最新的 :
93+ 比如下面是一个开发时使用的油猴脚本的实际例子,油猴中没有实际代码,而是使用 ` require ` 指向我们 ` build ` 后的文件,这样当修改完代码 ` webpack ` 自动热编译的时候浏览器中引用的 ` ./dist/index.js ` 也是最新的 :
7094
7195``` js
7296// ==UserScript==
Original file line number Diff line number Diff line change 55 "repository" : " https://github.com/JSREI/userscript-template.git" ,
66 "scripts" : {
77 "build" : " webpack --config webpack.prod.js" ,
8- "watch" : " webpack --watch --config webpack.dev.js" ,
8+ "watch" : " webpack --watch --config webpack.dev.js"
99 },
1010 "author" :
" CC11001100 <[email protected] >" ,
1111 "license" : " MIT" ,
You can’t perform that action at this time.
0 commit comments