commit bc8b9f52258f278f409529adc6836146b55865b4 Author: roymondchen Date: Thu Feb 17 14:47:39 2022 +0800 refactor: make it public diff --git a/.browserslistrc b/.browserslistrc new file mode 100644 index 00000000..214388fe --- /dev/null +++ b/.browserslistrc @@ -0,0 +1,3 @@ +> 1% +last 2 versions +not dead diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..c24743d0 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,7 @@ +[*.{js,jsx,ts,tsx,vue}] +indent_style = space +indent_size = 2 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +max_line_length = 100 diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 00000000..9c8cf245 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,8 @@ +dist +coverage +node_modules +dest + +comp-entry.ts +config-entry.ts +value-entry.ts \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 00000000..620fc9d3 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,63 @@ +module.exports = { + env: { + node: true, + browser: true, + es2021: true, + }, + globals: { + describe: true, + it: true, + expect: true, + jest: true, + beforeEach: true, + }, + extends: [ + 'eslint-config-tencent', + 'eslint-config-tencent/ts', + 'plugin:vue/vue3-essential', + 'eslint-config-tencent/prettier', + ], + parser: 'vue-eslint-parser', + parserOptions: { + ecmaVersion: 12, + parser: '@typescript-eslint/parser', + extraFileExtensions: ['.vue'], + sourceType: 'module', + }, + plugins: [ + 'vue', + '@typescript-eslint', + 'simple-import-sort' + ], + ignorePatterns: ['.eslintrc.js'], + rules: { + 'vue/no-mutating-props': 'off', + 'no-param-reassign': 'off', + '@typescript-eslint/no-require-imports': 'off', + 'simple-import-sort/imports': [ + "error", { + groups: [ + ['./polyfills'], + // Node.js builtins. You could also generate this regex if you use a `.js` config. + // For example: `^(${require("module").builtinModules.join("|")})(/|$)` + [ + "^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)", + ], + // Packages. `react|vue` related packages come first. + ["^(react|vue|vite)", "^@?\\w"], + ["^(@tmagic)(/.*|$)"], + // Internal packages. + ["^(@|@editor)(/.*|$)"], + // Side effect imports. + ["^\\u0000"], + // Parent imports. Put `..` last. + ["^\\.\\.(?!/?$)", "^\\.\\./?$"], + // Other relative imports. Put same-folder imports and `.` last. + ["^\\./(?=.*/)(?!/?$)", "^\\.(?!/?$)", "^\\./?$"], + // Style imports. + ["^.+\\.s?css$"], + ], + } + ] + }, +}; diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..fb9e2aa2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +.DS_Store +node_modules +dist + +# local env files +.env.local +.env.*.local + +# Log files +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* + +# Editor directories and files +.idea +.vscode +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw? + +coverage diff --git a/.husky/commit-msg b/.husky/commit-msg new file mode 100755 index 00000000..e8511eae --- /dev/null +++ b/.husky/commit-msg @@ -0,0 +1,4 @@ +#!/bin/sh +. "$(dirname "$0")/_/husky.sh" + +npx --no-install commitlint --edit $1 diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100755 index 00000000..36af2198 --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,4 @@ +#!/bin/sh +. "$(dirname "$0")/_/husky.sh" + +npx lint-staged diff --git a/.husky/pre-push b/.husky/pre-push new file mode 100755 index 00000000..449fcdee --- /dev/null +++ b/.husky/pre-push @@ -0,0 +1,4 @@ +#!/bin/sh +. "$(dirname "$0")/_/husky.sh" + +npm test diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..45f03895 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,136 @@ +## Issue 提交 + +#### 对于贡献者 + +在提 issue 前请确保满足一下条件： + +- 必须是一个 bug 或者功能新增。 +- 已经在 issue 中搜索过，并且没有找到相似的 issue 或者解决方案。 + +## Pull request + +我们除了希望听到您的反馈和建议外，我们也希望您接受代码形式的直接帮助，对我们的 GitHub 发出 pull request 请求。 + +以下是具体步骤： + +#### Fork仓库 + +点击 `Fork` 按钮，将需要参与的项目仓库 fork 到自己的 Github 中。 + +#### Clone 已 fork 项目 + +在自己的 github 中，找到 fork 下来的项目，git clone 到本地。 + +```bash +$ git clone git@github.com:/tmagic-editor.git +``` + +#### 添加 tmagic-editor 仓库 + +将 fork 源仓库连接到本地仓库： + +```bash +$ git remote add +# 例如： +$ git remote add wepy git@github.com:Tencent/tmagic-editor.git +``` + +#### 保持与 tmagic-editor 仓库的同步 + +更新上游仓库： + +```bash +$ git pull --rebase +# 等同于以下两条命令 +$ git fetch +$ git rebase / +``` + +## Commit + +对于如何提交 git commit message，我们有非常精确的规则。我们希望所有的 commit message 更具可读性，这样在查看项目历史记录会变得容易，同时我们使用 commit message 生成 Changelog. + +本项目使用了 `@commitlint` 作为 commit lint 工具，并使用 [`@commitlint/config-angular`](https://www.npmjs.com/package/@commitlint/config-angular)作为基础规则，请使用下面任意一种方式提交你的 commit. + +- 全局安装 `npm install -g commitizen`，然后使用 `cz` 提交 +- 使用 `git commit -a` 提交，请注意 message 符合我们的要求 + +### 提交格式 + +每个 commit message 包括 **header**, **body** 和 **footer**. + +header 具有特殊的格式，包括 **type**, **scope** 和 **subject**, type 和 subject 是必须的，scope 是可选的。 + +```vim +(): + + + +