https://github.com/oustn/scriptwriters
A simple tools for write and test quantumult scripts easier
https://github.com/oustn/scriptwriters
javascript quantumult quantumult-x rewrite task typescript
Last synced: 5 months ago
JSON representation
A simple tools for write and test quantumult scripts easier
- Host: GitHub
- URL: https://github.com/oustn/scriptwriters
- Owner: oustn
- Created: 2023-06-15T05:59:04.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T05:46:14.000Z (6 months ago)
- Last Synced: 2024-11-12T07:39:47.440Z (6 months ago)
- Topics: javascript, quantumult, quantumult-x, rewrite, task, typescript
- Language: TypeScript
- Homepage:
- Size: 817 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Scriptwriters
Scriptwriters 提供一系列的工具用于 Quantumult X 脚本的开发和调试，可以像开发前端项目一样使用 `typescript` 和 `npm module` 来帮助开发脚本。
## 安装
Scriptwriters 提供两个依赖包：`@scriptwriter/cli` 和 `@scriptwriter/quantumult`，`cli` 内置了脚本的开发服务和构建功能，`quantumult` 内置了一些 API 封装。
使用 [npm](http://npmjs.com/) 安装依赖。
```bash
npm install @scriptwriter/cli --save-dev
npm install @scriptwriter/quantumult --save
```
## 开始使用
1. 创建项目文件夹
```bash
mkdir demo-scripts
```
2. 初始化 package.json
```bash
cd demo-scripts && npm init -y
```
3. 安装依赖
```bash
npm install @scriptwriter/cli --save-dev && npm install @scriptwriter/quantumult --save
```
4. 添加 `tsconfig.json`
根据自己的需求配置。
```json
{
"compilerOptions": {
"outDir": "./dist/",
"noImplicitAny": true,
"module": "es6",
"target": "es5",
"allowJs": false,
"strictNullChecks": true,
"moduleResolution": "NodeNext",
"allowSyntheticDefaultImports": true
}
}
```
5. 添加运行脚本
在 package.json 中添加运行脚本：
```json
"scripts": {
"prebuild": "rm -rf dist",
"build": "NODE_ENV=production scriptwriter-cli build",
"dev": "scriptwriter-cli dev"
}
```
6. 运行开发脚本
```bash
npm run dev
```
打开控制台输出的地址，可以看到首页的效果。
## 开始你的第一个脚本
## License
[MIT](https://choosealicense.com/licenses/mit/)