Re-implement and enhance `check-formatting.yml` Github Actions workflow as a Node script
@miorel がすでに取り組んでいます。
2024年8月17日 から。
評価
この issue はまだ評価されていません。
説明
The workflow introduced in #225 is currently powered by a shell command, namely yarn format && git status --porcelain piped through some not very easy to maintain inline Perl.
Let's rewrite this as a Node script that's more maintainable. This is also an opportunity to address the other TODO in the workflow file, and have it output a summary as described at https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
The general behavior of the workflow should be:
- Run
yarn formatto rewrite any files that are not correctly formatted. This part can still happen outside Node, so for example the command we run becomes something likeyarn format && node some-script.js. - The script basically replaces the
git status --porcelainpart and the subsequent Perl expression it's piped into. The script should therefore still rungit status --porcelainfrom within Node and capture the output. - For each line in the output of
git status --porcelain, the script should remove the first 3 characters (see explanation of the format at https://git-scm.com/docs/git-status#_porcelain_format_version_1 to understand why) to get only the filename. It should then output an error message (using the format described at https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message) to indicate that the file in question doesn't respect the repository's formatting rules. - For bonus points (this part can be done as a separate PR) output a markdown summary at the end.
- If there were any files that were improperly formatted, the script should exit with a non-zero exit code so that the check fails and draws the attention of the author and reviewers.
- 主要言語
- TypeScript
- スター
- 20
- フォーク
- 12
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
code-chronicles-code/leetcode-curriculum のほかの issue
-
enhancement kotlin
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
good first issue tests
難易度 1/5 1〜3時間 初心者へのやさしさ 82/100
-
good first issue tests
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
-
good first issue tests
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
code-chronicles-code/leetcode-curriculum#418 · コメント 1 件 ·
code-chronicles-code/leetcode-curriculum の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
mksglu/context-mode#1200 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
anthropics/claude-code#96687 ·
-
good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
AOSSIE-Org/DebateAI#582 · コメント 2 件 ·