init

Author: CC11001100

.gitignore

@@ -0,0 +1,132 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+.idea

README.assets/image-20230816233501101.png

@@ -0,0 +1,99 @@
+# UserScript Template 
+
+# 一、这是什么
+
+使用`NodeJS`+`WebPack`开发油猴脚本的方案，用于提升油猴开发体验，一个`JavaScript`文件几千行来回改本人真的有点顶不住......
+
+# 二、如何使用
+
+在当前仓库选择“Use this template” --> “Create a new repository”，创建一个新的仓库： 
+
+![image-20230816233501101](README.assets/image-20230816233501101.png)
+
+选择存放的位置以及设置仓库名字等等：
+
+![image-20230816235634094](README.assets/image-20230816235634094.png)
+
+仓库创建好了之后修改`package.json`文件，把相关字段替换为你自己的，比如名字、作者、仓库地址等等：
+
+```js
+{
+  "name": "userscript-foo",
+  "version": "0.0.1",
+  "main": "index.js",
+  "repository": "https://github.com/JSREI/userscript-template.git",
+  "scripts": {
+      // ... 
+  },
+  "author": "CC11001100 <[email protected]>",
+  "license": "MIT",
+  "devDependencies": {
+      //...
+  }
+}
+```
+
+在`userscript-headers.js`文件中存放的是默认的油猴头文件：
+
+```
+// ==UserScript==
+// @name         ${name}
+// @namespace    ${repository}
+// @version      ${version}
+// @description  ${description}
+// @document     ${document}
+// @author       ${author}
+// @match        *://*/*
+// @run-at       document-start
+// ==/UserScript==
+```
+
+`${name}`这种是支持的一些变量，在编译的时候会从`package.json`中获取对应的值替换掉。
+
+然后就可以开心的写代码了，当你需要测试的时候，执行：
+
+```bash
+npm run watch
+```
+
+然后把`./dist/index.js`中的文件头复制到你的油猴中：
+
+![image-20230817000716664](README.assets/image-20230817000716664.png)
+
+并在最后添加一行引入编译后的文件：
+
+```js
+// @require    file://D:/workspace/userscript-template/dist/index.js
+```
+
+比如一个开发时使用的油猴脚本的例子，油猴中不实际配置内容，而是使用require指向我们build后的文件，这样当修改完代码热加载编译的时候浏览器中引用的JS也是最新的：
+
+```js
+// ==UserScript==
+// @name         userscript-foo
+// @namespace    https://github.com/JSREI/userscript-template.git
+// @version      0.0.1
+// @description  
+// @document     
+// @author       CC11001100 <[email protected]>
+// @match        *://*/*
+// @run-at       document-start
+// @require    file://D:/workspace/userscript-template/dist/index.js
+// ==/UserScript==
+(() => {})();
+```
+
+当你需要发布的时候：
+
+```bash
+npm run build
+```
+
+然后把`./dist/index.js`文件拿去发布即可。
+
+
+
+
+
+
+