Skip to content

Commit

Permalink
[Init] 初始化第一个版本
Browse files Browse the repository at this point in the history
  • Loading branch information
VisualSJ committed Apr 18, 2024
0 parents commit 0e952fe
Show file tree
Hide file tree
Showing 22 changed files with 934 additions and 0 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
scripts
4 changes: 4 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
plugins: ['prettier'],
extends: ['plugin:prettier/recommended'],
};
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''
---

**Describe the bug**

A clear and concise description of what the bug is.

**To Reproduce**

Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**

A clear and concise description of what you expected to happen.

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**

Add any other context about the problem here.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: 问题反馈
about: 创建报告以帮助我们改进
title: ''
labels: 'bug'
assignees: ''
---

**描述错误**

对 bug 的简要概述。

**复现**

再现行为的步骤:
1. 转到“…”
2. 单击“….”
3. 向下滚动至“….”
4. 参见错误

**预期行为**

对你期望发生的事情进行清晰且简要的概述。

**屏幕截图**

如果可以,请添加屏幕截图以帮助解释您的问题。

**桌面(请填写以下信息):**

- 操作系统:[例如iOS]
- 系统版本:[例如windows11]
- 浏览器:[例如chrome、safari]
- 浏览器版本:[例如100]

**附加上下文**

在此处添加有关该问题的任何其他上下文。
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- 请勿删除注释,需要使用时请复制一遍 -->
## PR 类型

- [ ] 问题修复
- [ ] 优化
- [ ] 新功能
- [ ] 测试用例

<!-- 详细的描述这个修改的背景和原因 -->
## PR 描述

<!-- 请描述具体改动了哪些地方,为什么修改 -->
### 修改说明
1.
34 changes: 34 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: CI

on:
push: {}
merge_group:
pull_request:
types:
- opened
- synchronize
- ready_for_review
paths:
- 'source/**.ts'
- 'source/scripts/*.js'
- '.github/workfows/ci.yaml'

permissions:
contents: read

jobs:
check-tests:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
steps:
- uses: actions/checkout@v3

- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}

- name: Run CI
run: npm run ci
39 changes: 39 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 忽略操作系统生成的文件
.DS_Store
Thumbs.db

# 忽略 Node.js 生成的文件夹
node_modules/
npm-debug.log
yarn-error.log

# 忽略本地配置文件(例如,配置文件包含敏感信息)
config.js
.env

# 忽略依赖管理文件(可以用于避免冲突)
package-lock.json
yarn.lock

# 忽略构建输出和临时文件
dist/
build/
.tmp/
.cache/

# 忽略日志文件
logs/
*.log
npm-debug.log*

# 忽略测试结果
coverage/

# 忽略编辑器生成的文件
.vscode/
.idea/
*.swp

# 忽略自动生成的文档和注释
docs/
*.html
13 changes: 13 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# 使用 .gitignore 中的规则排除不需要包含在 npm 包中的文件
.github
.eslintrc.js
.eslintignore
.prettierrc.js
tsconfig.json
/source
/test
/script

# 如果需要在 npm 包中包含特定文件,请在下面取消注释并添加文件路径
!/build
!/dist
4 changes: 4 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
tabWidth: 4,
singleQuote: true,
};
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 itharbors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 0e952fe

Please sign in to comment.