chore: 新增 scripts 目录，添加 git hook

zhaohappy · Dec 13, 2024 · 00b556a · 00b556a
1 parent 45d6bad
commit 00b556a
Show file tree

Hide file tree

Showing 9 changed files with 163 additions and 29 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,3 +1,2 @@
-*.js
 *.d.ts
 *.test.ts
diff --git a/.github/commit-convention.md b/.github/commit-convention.md
@@ -0,0 +1,91 @@
+## Git Commit Message Convention
+
+> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+
+#### TL;DR:
+
+Messages must be matched by the following regex:
+
+```js
+/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .+/;
+```
+
+#### Examples
+
+Appears under "Features" header, `avformat` subheader:
+
+```
+feat(avformat): add 'IMp4Format' feature
+```
+
+Appears under "Bug Fixes" header, `avcodec` subheader, with a link to issue #00:
+
+```
+fix(avcodec): when stop reset subTaskId and subtitleTaskId
+
+close #00
+```
+
+Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
+
+```
+perf(avrender): improve performance by utilizing WebGL
+
+BREAKING CHANGE: The performance enhancement now relies on WebGL.
+```
+
+The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
+
+```
+revert: feat(avutil): add 'av1syntax' feature
+
+This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
+```
+
+### Full Message Format
+
+A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+### Revert
+
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
+
+Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
+
+### Scope
+
+The scope could be anything specifying the place of the commit change. For example `avformat`, `avcodec`, `avutil`, `avrender`, `avnetwork` etc...
+
+### Subject
+
+The subject contains a succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize the first letter
+- no dot (.) at the end
+
+### Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,7 +28,12 @@
     "eslint": "./node_modules/.bin/eslint -o=report.json -f=json './src/**/*.ts' -c=./eslint/typescript.js --rulesdir=./eslint/rules --ignore-path=./.eslintignore",
     "eslint-fix": "./node_modules/.bin/eslint './src/**/*.ts' -c=./eslint/typescript.js --rulesdir=./eslint/rules --ignore-path=./.eslintignore --fix",
     "eslint-check": "./node_modules/.bin/eslint './src/**/*.ts' -c=./eslint/typescript.js --rulesdir=./eslint/rules --ignore-path=./.eslintignore",
-    "build-debug": "cross-env NODE_ENV=development node --inspect-brk ./node_modules/webpack/bin/webpack.js --progress --env avplayer=1 release=0"
+    "build-debug": "cross-env NODE_ENV=development node --inspect-brk ./node_modules/webpack/bin/webpack.js --progress --env avplayer=1 release=0",
+    "postinstall": "simple-git-hooks"
+  },
+  "simple-git-hooks": {
+    "commit-msg": "node scripts/verify-commit.js",
+    "pre-commit": "node scripts/pre-commit.js"
   },
   "author": "Gaoxing Zhao",
   "license": "LGPL-3.0-or-later",
@@ -61,13 +66,12 @@
     "raw-loader": "^4.0.0",
     "rider": "^2.0.0",
     "schema-utils": "^3.1.0",
+    "simple-git-hooks": "^2.11.1",
     "stylus": "^0.54.2",
     "terser": "^5.36.0",
     "ts-jest": "^23.10.5",
     "ts-loader": "^9.4.4",
     "typedoc": "^0.27.2",
-    "typedoc-github-wiki-theme": "^2.0.0",
-    "typedoc-plugin-markdown": "^4.2.10",
     "typedoc-plugin-rename-defaults": "^0.7.1",
     "typescript": "^5.6.3",
     "webpack": "^5.92.0",

diff --git a/build/build-package.js → scripts/build-package.js b/build/build-package.js → scripts/build-package.js
diff --git a/scripts/pre-commit.js b/scripts/pre-commit.js
@@ -0,0 +1,25 @@
+const { execSync, spawnSync } = require('child_process');
+
+const modifiedList = execSync('git diff --cached --name-only')
+  .toString()
+  .trim()
+  .split('\n')
+  .filter(file => {
+    return /^src\/\S*\.[j|t]s$/.test(file)
+  })
+
+const result = spawnSync(
+  'node',
+  [
+    './node_modules/eslint/bin/eslint.js',
+    ...modifiedList,
+    '-c=./eslint/typescript.js',
+    '--rulesdir=./eslint/rules',
+    '--ignore-path=./.eslintignore'
+  ],
+  {
+    stdio: 'inherit'
+  }
+)
+
+process.exit(result.status)
diff --git a/build/update-dependencies.js → scripts/update-dependencies.js b/build/update-dependencies.js → scripts/update-dependencies.js
diff --git a/scripts/verify-commit.js b/scripts/verify-commit.js
@@ -0,0 +1,26 @@
+import pico from 'picocolors';
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+
+const msgPath = resolve('.git/COMMIT_EDITMSG');
+const msg = readFileSync(msgPath, 'utf-8').trim();
+
+const commitRE =
+  /^(Release v)|(Merge.*branch)|((revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip|release|version)(\(.+\))?: .+)/;
+
+if (!commitRE.test(msg)) {
+  console.error(
+    `\n  ${pico.white(pico.bgRed(' ERROR '))} ${pico.red(
+      `invalid commit message format.`,
+    )}\n\n` +
+      pico.red(
+        `  Proper commit message format is required for automated changelog generation. Examples:\n\n`,
+      ) +
+      `    ${pico.green(`feat(avformat): add 'IMp4Format' feature`)}\n` +
+      `    ${pico.green(
+        `fix(avcodec): when stop reset subTaskId and subtitleTaskId (close #00)`,
+      )}\n\n` +
+      pico.red(`  See .github/commit-convention.md for more details.\n`),
+  );
+  process.exit(1);
+}
diff --git a/src/cheap b/src/cheap
+1 −1		build/transformer.js
+1 −1		thread/runThread.ts
+12 −0		transformer/index.ts