Skip to content
This repository has been archived by the owner on Sep 29, 2024. It is now read-only.

Commit

Permalink
- Init project
Browse files Browse the repository at this point in the history
  • Loading branch information
ParticleG committed Jul 20, 2023
0 parents commit 7861282
Show file tree
Hide file tree
Showing 29 changed files with 3,010 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/* eslint-env node */
module.exports = {
env: {
browser: true,
es2021: true,
node: true,
'vue/setup-compiler-macros': true,
},
extends: [
'plugin:@typescript-eslint/recommended',
'plugin:vue/vue3-essential',
'prettier',
],
globals: {
ga: 'readonly', // Google Analytics
cordova: 'readonly',
__statics: 'readonly',
__QUASAR_SSR__: 'readonly',
__QUASAR_SSR_SERVER__: 'readonly',
__QUASAR_SSR_CLIENT__: 'readonly',
__QUASAR_SSR_PWA__: 'readonly',
process: 'readonly',
Capacitor: 'readonly',
chrome: 'readonly',
},
plugins: ['@typescript-eslint', 'vue'],
parserOptions: {
ecmaVersion: 'latest',
parser: require.resolve('@typescript-eslint/parser'),
extraFileExtensions: ['.vue'],
},
root: true,
rules: {
'prefer-promise-reject-errors': 'off',
quotes: ['warn', 'single', { avoidEscape: true }],
'@typescript-eslint/explicit-function-return-type': 'off',
'@typescript-eslint/no-var-requires': 'off',
'no-unused-vars': 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
},
};
25 changes: 25 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Build

on:
push:
tags: [v*]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: '0'
- name: Install dependencies
uses: pnpm/action-setup@v2.2.4
with:
version: latest
run_install: true
- name: Build
run: pnpm run build
- name: Upload release
uses: ncipollo/release-action@v1
with:
allowUpdates: true
artifacts: dist/hotkinkyjo-tampered.user.js
body: ${{ github.event.head_commit.message }}
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
.DS_Store
dist
dist-ssr
coverage
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
5 changes: 5 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://json.schemastore.org/prettierrc",
"semi": true,
"singleQuote": true
}
71 changes: 71 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# 「 hotkinkyjo 增强脚本 」

[📦 安装](#安装)

[📚 功能](#功能)

[👻 兼容性](#兼容性)

[📝 开发](#开发)

# 安装

需要浏览器装有 [Tampermonkey](https://tampermonkey.net/)[Violentmonkey](https://violentmonkey.github.io/) 插件,
下方表格中挑一个链接安装.

**注意事项**

- **⚠ 使用正式版 (GitHub 源) 须翻墙.**
- 对性能有影响.
- 默认不对未登录的状态做适配.
- 新版本一旦正式发布, 就不再对旧版本做任何技术支持.
- 使用外部网站的链接时 (如将下载任务发送到自己的服务器 / 使用链接安装组件等) 可能会提示"脚本试图访问跨域资源", 请选择"
始终允许".
- 需要在至少 1400 x 800 以上的逻辑分辨率下使用.

| 正式版 (GhProxy 加速) | 正式版 (GitHub 源) |
|-----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| [安装](https://ghproxy.com/https://github.com/STEA-TEAM/hotkinkyjo-tampered/releases/latest/download/hotkinkyjo-tampered.user.js) | [安装](https://github.com/STEA-TEAM/hotkinkyjo-tampered/releases/latest/download/hotkinkyjo-tampered.user.js) |

# 功能

# 兼容性

## 脚本管理器

### [Tampermonkey](https://tampermonkey.net/) / [Violentmonkey](https://violentmonkey.github.io/)

兼容, 但在较旧的浏览器中 Violentmonkey 可能无法运行此脚本.

### [Greasemonkey](https://www.greasespot.net/)

不兼容.

### [AdGuard](https://adguard.com/zh_cn/adguard-windows/overview.html)

未测试.

# 开发

### 克隆并安装依赖

```bash
git clone https://github.com/STEA-TEAM/hotkinkyjo-tampered.git
cd hotkinkyjo-tampered
pnpm install
```

### Dev(热更新)

```bash
pnpm run dev
# 在tampermonkey面板中新建一个脚本,将控制台输出的内容或`./dist/main.user.dev.js`的内容复制进去保存
# 代码热更新后刷新浏览器页面即可看到更改
```

### Build

```bash
pnpm run build
# 将`./dist/main.user.js`的内容发布即可
```
52 changes: 52 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"name": "hotkinkyjo-tampered",
"version": "1.0.0",
"description": "An hotkinkyjo script for enhanced experience",
"homepage": "https://github.com/STEA-TEAM/hotkinkyjo-tampered#readme",
"license": "LGPL-3.0",
"author": "ParticleG <particle_g@outlook.com> (https://github.com/ParticleG)",
"repository": {
"type": "git",
"url": "https://github.com/STEA-TEAM/hotkinkyjo-tampered"
},
"scripts": {
"dev": "vite build -m development",
"build": "vite build -m production",
"format": "prettier --write src/",
"lint": "eslint . --ext .vue,.js,.cjs,.mjs,.ts,.cts,.mts --fix --ignore-path .gitignore",
"type-check": "vue-tsc --noEmit"
},
"dependencies": {
"@quasar/extras": "^1.16.5",
"axios": "^1.4.0",
"humanize-duration": "^3.29.0",
"pinia": "^2.1.4",
"pinia-plugin-persistedstate": "^3.1.0",
"quasar": "^2.12.3",
"vue": "^3.3.4",
"vue-router": "^4.2.4"
},
"devDependencies": {
"@quasar/vite-plugin": "^1.4.1",
"@tsconfig/node18": "^2.0.1",
"@types/humanize-duration": "^3.27.1",
"@types/node": "^18.16.19",
"@typescript-eslint/eslint-plugin": "^5.62.0",
"@typescript-eslint/parser": "^5.62.0",
"@vitejs/plugin-vue": "^4.2.3",
"@vue/eslint-config-prettier": "^7.1.0",
"@vue/eslint-config-typescript": "^11.0.3",
"@vue/tsconfig": "^0.3.2",
"eslint": "^8.45.0",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-vue": "^9.15.1",
"prettier": "^2.8.8",
"rollup": "^3.26.3",
"rollup-plugin-sass": "^1.12.20",
"sass": "^1.64.0",
"typescript": "^5.1.6",
"vite": "^4.4.5",
"vue-tsc": "^1.8.5"
},
"private": true
}
Loading

0 comments on commit 7861282

Please sign in to comment.