Skip to content

A simple tools for write and test quantumult scripts easier

Notifications You must be signed in to change notification settings

oustn/scriptwriters

Repository files navigation

Scriptwriters

Scriptwriters 提供一系列的工具用于 Quantumult X 脚本的开发和调试,可以像开发前端项目一样使用 typescriptnpm module 来帮助开发脚本。

安装

Scriptwriters 提供两个依赖包:@scriptwriter/cli@scriptwriter/quantumultcli 内置了脚本的开发服务和构建功能,quantumult 内置了一些 API 封装。

使用 npm 安装依赖。

npm install @scriptwriter/cli --save-dev
npm install @scriptwriter/quantumult --save

开始使用

  1. 创建项目文件夹
mkdir demo-scripts
  1. 初始化 package.json
cd demo-scripts && npm init -y
  1. 安装依赖
npm install @scriptwriter/cli --save-dev && npm install @scriptwriter/quantumult --save
  1. 添加 tsconfig.json

根据自己的需求配置。

{
  "compilerOptions": {
    "outDir": "./dist/",
    "noImplicitAny": true,
    "module": "es6",
    "target": "es5",
    "allowJs": false,
    "strictNullChecks": true,
    "moduleResolution": "NodeNext",
    "allowSyntheticDefaultImports": true
  }
}
  1. 添加运行脚本

在 package.json 中添加运行脚本:

  "scripts": {
    "prebuild": "rm -rf dist",
    "build": "NODE_ENV=production scriptwriter-cli build",
    "dev": "scriptwriter-cli dev"
  }
  1. 运行开发脚本
npm run dev

打开控制台输出的地址,可以看到首页的效果。

开始你的第一个脚本

License

MIT