Autoformat makrdowns with dprint #311
Conversation
WalkthroughThe changes in this pull request primarily involve enhancements to GitHub Actions workflows and minor formatting adjustments across various Markdown files. Key modifications include the addition of a step to install the Changes
Possibly related issues
Possibly related PRs
Tip OpenAI O1 model for chat
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
| - name: Install dprint | ||
| run: | | ||
| curl -fsSL https://dprint.dev/install.sh | sh -s '0.45.0' > /dev/null 2>&1 | ||
| echo "/home/runner/.dprint/bin" >> "$GITHUB_PATH" |
There was a problem hiding this comment.
dprint には install だけの GitHub Action というのがないので、check action から抜粋してきています。 https://github.com/dprint/check/blob/2f1cf31537886c3bfb05591c031f7744e48ba8a1/action.yml#L16C1-L20C56
| @@ -58,7 +58,7 @@ Vaioのせいなのか、Windowsのせいなのか。。 | |||
| 諦めて、Windowsの起動に使われるファイルをgummibootのものと置き換えることでデュアルブートを実現。。 | |||
| 一応、やれればいいや、ということで。 | |||
|
|
|||
| * 先ほどのUSBからArch Linuxを起動し、無理やりgummibootを使わせるようにしにいく | |||
| - 先ほどのUSBからArch Linuxを起動し、無理やりgummibootを使わせるようにしにいく | |||
There was a problem hiding this comment.
個人的にもずっと * を使っていたんですが、dprint の markdown プラグインにはこれを変更するオプションが無いです
There was a problem hiding this comment.
かつてアスタリスク使っていたのだけど、最近はハイフンに矯正したかもしれない。prettier かな？がデフォでハイフンにしてくるみたいなのが理由だったかも...。なのでこれはハイフンになってもよし
|
|
||
| また、その他の作法として、 | ||
| * 手元でのアーカイブはしない。 | ||
| * QAが通ればそのまま審査へ | ||
|
|
There was a problem hiding this comment.
リストの前には必ず空行を入れてくるんですが、これは見た目にも影響するかも？
| @@ -191,5 +193,3 @@ https://github.com/pankona/KonaReflection | |||
| 追記：DeployGateさんへのアップロードについては[次回記事](http://pankona.github.io/blog/2015/04/22/travis-ci-with-deploygate/)も見てね。 | |||
|
|
|||
| 今回はここまで。 | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
こういう謎なインデントが消えるのはやはり嬉しい気がする
| @@ -22,11 +22,10 @@ categories: [その他] | |||
| この手のものは英語のままでいいと思う気持ちがある反面、 | |||
| やっぱり日本人は日本語のほうが速く読める人が多いだろうし、一定の価値はあるかな、等と思うところである。 | |||
|
|
|||
| 記事の中で印象深かったのは、*Compliment / reinforce good practices* の部分である。 | |||
| 記事の中で印象深かったのは、_Compliment / reinforce good practices_ の部分である。 | |||
There was a problem hiding this comment.
これはコンフィグで前の強調スタイルも選べることは選べそう
| @@ -84,7 +84,7 @@ env: | |||
| ``` | |||
|
|
|||
| ``` | |||
| - '[ "$TRAVIS_BRANCH" == "master" -a "$TRAVIS_PULL_REQUEST" == "false" ] && curl -F "file=@./bin/debug/android/KonaReflection-debug.apk" -F "token=${DEPLOYGATE_TOKEN}" -F "message=Deploy from Travis CI" https://deploygate.com/api/users/pankona/apps' | |||
| - '[ "$TRAVIS_BRANCH" == "master" -a "$TRAVIS_PULL_REQUEST" == "false" ] && curl -F "file=@./bin/debug/android/KonaReflection-debug.apk" -F "token=${DEPLOYGATE_TOKEN}" -F "message=Deploy from Travis CI" https://deploygate.com/api/users/pankona/apps' | |||
There was a problem hiding this comment.
このあたりはそもそもコードブロックに言語指定が無いことも影響してそうで、埋めてやるとより正確になりそう(markdown 中に現れるyamlはyamlプラグインでフォーマットとかまでしてくれたはず)
There was a problem hiding this comment.
hugo も対応しているので、つけたほうがレンダリング結果としても嬉しいと思う
これが
こうなる
There was a problem hiding this comment.
思った。過去のを読み返すいい機会になったのでは(偉そう)
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (2)
content/posts/generate-blog-post-from-issue.md (1)
50-52: The challenge with updating pull requests is a valid concern.The current workflow of force pushing to update the pull request may not be ideal, especially when editing the pull request from a PC. It's worth exploring alternative solutions to ensure a smoother collaboration process.
Consider the following suggestions:
- Implement a two-way sync between the issue and the pull request, so that changes made to either one are reflected in the other.
- Allow for manual triggering of the GitHub Action to update the pull request with the latest changes from the issue.
- Provide clear instructions for collaborators on how to work with this workflow and ensure their changes are properly synced.
.github/workflows/generate_pr_from_issue.yaml (1)
18-21: Consider using a version variable fordprint.To make it easier to update the
dprintversion in the future, consider defining a version variable at the beginning of the workflow file and using it in the installation command.For example:
env: DPRINT_VERSION: '0.45.0' steps: - name: Install dprint run: | curl -fsSL https://dprint.dev/install.sh | sh -s '${{ env.DPRINT_VERSION }}' > /dev/null 2>&1 echo "/home/runner/.dprint/bin" >> "$GITHUB_PATH"
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (75)
- .github/workflows/generate_pr_from_issue.yaml (2 hunks)
- .github/workflows/lint.yml (1 hunks)
- archetypes/default.md (0 hunks)
- content/posts/2021-conclusion.md (1 hunks)
- content/posts/300hot-per-month.md (0 hunks)
- content/posts/achieved-sell-book-in-techbookfest.md (1 hunks)
- content/posts/arch-windows-multiboot-tips.md (2 hunks)
- content/posts/atte-fes.md (1 hunks)
- content/posts/basic-of-writing-77-tips.md (1 hunks)
- content/posts/book-log-on-combat.md (0 hunks)
- content/posts/book-review-persona-of-leader.md (2 hunks)
- content/posts/chatgpt-generated-cooking-2024-03-04.md (0 hunks)
- content/posts/chrome-os-flex-on-vaio-pro-13.md (1 hunks)
- content/posts/cocos-with-travisci.md (7 hunks)
- content/posts/code-review-best-practices-jp-translation.md (1 hunks)
- content/posts/covid-19-infected.md (1 hunks)
- content/posts/decorate-git-command-in-alpine.md (2 hunks)
- content/posts/definitely-terminate-wsl2.md (1 hunks)
- content/posts/dokusho-meter.md (1 hunks)
- content/posts/droidkaigi-2018-todo.md (2 hunks)
- content/posts/droidkaigi_2018_material.md (0 hunks)
- content/posts/ebitengine-game-jam-2024.md (0 hunks)
- content/posts/em-dialy-2021-03-03.md (2 hunks)
- content/posts/entering-ikukyu.md (0 hunks)
- content/posts/equivalent-to-host-docker-internal-in-rancher-desktop.md (1 hunks)
- content/posts/first-vaccination.md (1 hunks)
- content/posts/fix-pygments.md (0 hunks)
- content/posts/gaming-pc-on-gcp-was-fired.md (1 hunks)
- content/posts/generate-blog-post-from-issue.md (3 hunks)
- content/posts/github-action-is-disabled-if-no-activity-in-the-repo.md (1 hunks)
- content/posts/github-actions-pull-request-target.md (1 hunks)
- content/posts/go-conference-2021-autumn-cfp-trial.md (1 hunks)
- content/posts/go-for-tech-book-fest-11.md (1 hunks)
- content/posts/golangtokyo-14.md (3 hunks)
- content/posts/golangtokyo-15.md (2 hunks)
- content/posts/golangtokyo-16.md (3 hunks)
- content/posts/golangtokyo-2.md (3 hunks)
- content/posts/golangtokyo-4.md (2 hunks)
- content/posts/golangtokyo-6.md (6 hunks)
- content/posts/golangtokyo.md (2 hunks)
- content/posts/hair-donation-is-a-long-way-to-go.md (0 hunks)
- content/posts/hard-to-review-the-pull-request.md (1 hunks)
- content/posts/histryback-by-swipe-on-firefox.md (0 hunks)
- content/posts/human-is-untyped.md (2 hunks)
- content/posts/jp-input-on-gnome-app.md (2 hunks)
- content/posts/kichijojipm-22.md (1 hunks)
- content/posts/let-us-create-a-game-part-1.md (2 hunks)
- content/posts/long-time-no-see-blog-post.md (2 hunks)
- content/posts/mashimahi.md (4 hunks)
- content/posts/misc.md (0 hunks)
- content/posts/my-back-is-dead.md (1 hunks)
- content/posts/my-first-post-2018.md (1 hunks)
- content/posts/my-first-post-by-hugo.md (1 hunks)
- content/posts/octopress-custom.md (1 hunks)
- content/posts/pitft-on-arch-linux.md (4 hunks)
- content/posts/please-tell-me-how-to-study-unity.md (1 hunks)
- content/posts/rails-on-raspi.md (1 hunks)
- content/posts/raspi-autologin.md (2 hunks)
- content/posts/raspi-livestream-web.md (1 hunks)
- content/posts/raspi-photo-during-streaming.md (2 hunks)
- content/posts/raspi-touch-panel.md (1 hunks)
- content/posts/reading-note.md (1 hunks)
- content/posts/remote-ltika.md (1 hunks)
- content/posts/second-child-has-come.md (0 hunks)
- content/posts/travis-ci-with-deploygate.md (2 hunks)
- content/posts/try-coderabbit.md (1 hunks)
- content/posts/umbrella-is-convenience-in-case-for-rain.md (0 hunks)
- content/posts/usb-wifi-dongle.md (2 hunks)
- content/posts/use-uim-mozc.md (0 hunks)
- content/posts/vaio-pro-palm-detect-on-archlinux.md (0 hunks)
- content/posts/writing-is-hard.md (1 hunks)
- content/posts/wsl2-uses-cpu-100-percent.md (1 hunks)
- content/posts/xiaomi-pad-6.md (1 hunks)
- content/posts/z370c-bad-point.md (0 hunks)
- dprint.json (1 hunks)
Files not reviewed due to no reviewable changes (16)
- archetypes/default.md
- content/posts/300hot-per-month.md
- content/posts/book-log-on-combat.md
- content/posts/chatgpt-generated-cooking-2024-03-04.md
- content/posts/droidkaigi_2018_material.md
- content/posts/ebitengine-game-jam-2024.md
- content/posts/entering-ikukyu.md
- content/posts/fix-pygments.md
- content/posts/hair-donation-is-a-long-way-to-go.md
- content/posts/histryback-by-swipe-on-firefox.md
- content/posts/misc.md
- content/posts/second-child-has-come.md
- content/posts/umbrella-is-convenience-in-case-for-rain.md
- content/posts/use-uim-mozc.md
- content/posts/vaio-pro-palm-detect-on-archlinux.md
- content/posts/z370c-bad-point.md
Files skipped from review due to trivial changes (46)
- content/posts/2021-conclusion.md
- content/posts/achieved-sell-book-in-techbookfest.md
- content/posts/arch-windows-multiboot-tips.md
- content/posts/atte-fes.md
- content/posts/basic-of-writing-77-tips.md
- content/posts/chrome-os-flex-on-vaio-pro-13.md
- content/posts/cocos-with-travisci.md
- content/posts/code-review-best-practices-jp-translation.md
- content/posts/covid-19-infected.md
- content/posts/definitely-terminate-wsl2.md
- content/posts/dokusho-meter.md
- content/posts/droidkaigi-2018-todo.md
- content/posts/em-dialy-2021-03-03.md
- content/posts/equivalent-to-host-docker-internal-in-rancher-desktop.md
- content/posts/first-vaccination.md
- content/posts/gaming-pc-on-gcp-was-fired.md
- content/posts/github-action-is-disabled-if-no-activity-in-the-repo.md
- content/posts/github-actions-pull-request-target.md
- content/posts/go-conference-2021-autumn-cfp-trial.md
- content/posts/go-for-tech-book-fest-11.md
- content/posts/golangtokyo-14.md
- content/posts/golangtokyo-15.md
- content/posts/golangtokyo-16.md
- content/posts/golangtokyo.md
- content/posts/hard-to-review-the-pull-request.md
- content/posts/jp-input-on-gnome-app.md
- content/posts/kichijojipm-22.md
- content/posts/let-us-create-a-game-part-1.md
- content/posts/mashimahi.md
- content/posts/my-back-is-dead.md
- content/posts/my-first-post-2018.md
- content/posts/my-first-post-by-hugo.md
- content/posts/octopress-custom.md
- content/posts/pitft-on-arch-linux.md
- content/posts/please-tell-me-how-to-study-unity.md
- content/posts/rails-on-raspi.md
- content/posts/raspi-autologin.md
- content/posts/raspi-livestream-web.md
- content/posts/raspi-photo-during-streaming.md
- content/posts/raspi-touch-panel.md
- content/posts/reading-note.md
- content/posts/remote-ltika.md
- content/posts/travis-ci-with-deploygate.md
- content/posts/try-coderabbit.md
- content/posts/usb-wifi-dongle.md
- content/posts/writing-is-hard.md
Additional context used
Markdownlint
content/posts/decorate-git-command-in-alpine.md
38-38: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
content/posts/golangtokyo-6.md
73-73: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
61-61: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
content/posts/golangtokyo-4.md
63-63: null
Bare URL used(MD034, no-bare-urls)
Gitleaks
content/posts/golangtokyo-4.md
24-24: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
77-77: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
115-115: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
content/posts/golangtokyo-2.md
79-79: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
143-143: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
151-151: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
LanguageTool
content/posts/golangtokyo-2.md
[uncategorized] ~71-~71: 「ことができる」という表現は冗長な可能性があります。
Context: ... を使い、テスト時に仮想的な入力を行えるようにする。 - 入力に対する出力で、Table Driven にすることができるようになる。 - ファイル出力 (ファイル出力...(DOUSI_KOTOGADEKIRU)
[uncategorized] ~75-~75: 「ことができる」という表現は冗長な可能性があります。
Context: ...時はオンメモリのバッファに出力できるようにする。 - バッファに出力された内容とその期待結果で、Table Driven することができるようになる。 # Mache...(DOUSI_KOTOGADEKIRU)
Additional comments not posted (23)
dprint.json (1)
8-9: LGTM!The addition of the markdown plugin to the dprint configuration aligns with the PR objective of enhancing the formatting of markdown files within the project. The plugin URL follows the correct format and there are no visible issues with this change.
content/posts/long-time-no-see-blog-post.md (1)
Line range hint
7-37: LGTM!The changes made in the blog post are well-structured and provide a clear explanation of the reminder system and its implementation. The use of
git logto check the last commit date, integration with Slack for notifications, and the development of a Go CLI tool for calculating the number of days since the last post demonstrate a solid technical approach. The GitHub Actions cron job is configured correctly and ensures that the reminders are triggered on a daily basis.Overall, the changes effectively convey the author's commitment to writing more consistently and introduce a practical solution to address the issue of inconsistent blogging. Great work!
content/posts/decorate-git-command-in-alpine.md (3)
7-7: LGTM!The addition of the line break improves the readability of the document. Good job!
37-37: LGTM!The addition of the line break improves the readability of the document. Good job!
44-44: LGTM!The addition of the line break improves the readability of the document. Good job!
content/posts/generate-blog-post-from-issue.md (1)
13-14: The bullet points are a great addition to the blog post.The bullet points provide a clear and concise overview of the GitHub Actions created. The links to the GitHub Actions are correctly formatted and point to the appropriate files in the repository.
content/posts/human-is-untyped.md (3)
7-7: LGTM!The added paragraph provides relevant context about the book reading club and sets the stage for the subsequent discussion. The content and formatting look good.
25-25: Insightful addition!The added list item provides a thoughtful comparison between software and human behavior, emphasizing the unpredictable nature of human responses due to emotions and varying conditions. This insight contributes to the overall discussion and highlights the challenges of managing teams. The content and formatting are on point.
Line range hint
1-52: Excellent reflections and insights!This document provides valuable insights into the challenges and considerations of managing human teams as an Engineering Manager (EM). Your reflections on the differences between software and human behavior are thought-provoking and contribute to the overall discussion. The proposed shift towards a more data-driven approach to team management indicates a positive direction for your role as an EM.
Some key takeaways:
- Human responses are influenced by emotions and conditions, making them less predictable than software behavior.
- EMs should focus on identifying and addressing exceptions in team dynamics rather than expecting consistent outputs akin to software.
- Implementing a data-driven approach to team management, such as monitoring productivity metrics and conducting regular 1-on-1 meetings, can help EMs detect and address issues more effectively.
Overall, the document is well-structured, and the content is insightful and relevant to the topic. Keep up the great work, and best of luck with implementing the data-driven approach in the upcoming year!
content/posts/xiaomi-pad-6.md (1)
27-27: LGTM!The paragraph is well-written and effectively conveys your experience and frustration with the inconsistent input switching behavior across different apps when using an external keyboard with your Android tablet. The content is relevant to the overall topic of the blog post.
.github/workflows/generate_pr_from_issue.yaml (1)
54-54: LGTM!The use of
dprint fmtto format the generated markdown file is a good addition to ensure consistent formatting.content/posts/book-review-persona-of-leader.md (2)
7-7: LGTM!The introductory sentence looks good. It provides context for why the author decided to read and review the book.
Line range hint
19-24: Looks good!The bullet list nicely summarizes several key points from the book about leadership style and priorities. The formatting is correct and the content is insightful.
content/posts/golangtokyo-6.md (3)
40-40: LGTM!The code block is a good addition to demonstrate the new alias feature in Go 1.9.
56-57: Also applies to: 65-66, 70-71, 75-76
113-115: Also applies to: 138-141, 147-148, 174-175content/posts/golangtokyo-4.md (4)
20-25: LGTM!The changes improve the formatting by adding a heading for the presentation and embedding a link to the slides. This enhances the readability and accessibility of the content.
Tools
Gitleaks
24-24: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
32-44: Looks good!The added content provides valuable insights into the presentation on concurrency for distributed web crawlers. It highlights the key challenges faced and the strategies used to overcome them, such as using goroutines and setting time limits for each crawling task. This information enhances the reader's understanding of the topic.
50-55: LGTM!Similar to the previous segment, the changes here improve the formatting by adding a heading for the presentation and embedding a link to the slides. This maintains consistency and enhances the readability of the content.
Tools
Gitleaks
54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
62-73: Looks good!The added content provides a concise overview of the presentation on Go's scheduler implementation. It introduces the key components (M, G, P) and provides a reference to a blog post with more detailed information. This is helpful for readers who want to dive deeper into the topic.
Tools
Markdownlint
63-63: null
Bare URL used(MD034, no-bare-urls)
content/posts/golangtokyo-2.md (3)
Line range hint
1-158: Formatting changes look good!The formatting enhancements, such as consistent bullet point styles and embedded card scripts for presentation links, improve the overall readability and structure of the blog post without altering the underlying content. Great job!
Tools
LanguageTool
[uncategorized] ~71-~71: 「ことができる」という表現は冗長な可能性があります。
Context: ... を使い、テスト時に仮想的な入力を行えるようにする。 - 入力に対する出力で、Table Driven にすることができるようになる。 - ファイル出力 (ファイル出力...(DOUSI_KOTOGADEKIRU)
[uncategorized] ~75-~75: 「ことができる」という表現は冗長な可能性があります。
Context: ...時はオンメモリのバッファに出力できるようにする。 - バッファに出力された内容とその期待結果で、Table Driven することができるようになる。 # Mache...(DOUSI_KOTOGADEKIRU)
Gitleaks
79-79: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
71-75: Ignore LanguageTool hints about redundant expressions.The LanguageTool hints flagging the expressions "ことができるようになる" as potentially redundant can be ignored in this context. The writing style is conversational and the expressions seem natural for explaining the concepts. No changes needed.
Tools
LanguageTool
[uncategorized] ~71-~71: 「ことができる」という表現は冗長な可能性があります。
Context: ... を使い、テスト時に仮想的な入力を行えるようにする。 - 入力に対する出力で、Table Driven にすることができるようになる。 - ファイル出力 (ファイル出力...(DOUSI_KOTOGADEKIRU)
[uncategorized] ~75-~75: 「ことができる」という表現は冗長な可能性があります。
Context: ...時はオンメモリのバッファに出力できるようにする。 - バッファに出力された内容とその期待結果で、Table Driven することができるようになる。 # Mache...(DOUSI_KOTOGADEKIRU)
34-36: Gitleaks false positives on embedly card keys.The potential API key leaks flagged by Gitleaks on these lines are false positives. The flagged
data-card-keyattributes contain embedly card keys for embedding presentation slides, not actual sensitive API keys. These can be safely ignored.Also applies to: 80-82, 144-146
|
差分でかくてわろた |
|
マージしてしまおう |
|
あざます！ |
| @@ -47,6 +51,7 @@ jobs: | |||
| - name: commit | |||
| run: | | |||
| GITHUB_TOKEN=${TOKEN} articlegen --issue-num=${{ github.event.issue.number }} > 'content/posts/${{ steps.normalizer.outputs.title }}.md' | |||
| dprint fmt 'content/posts/${{ steps.normalizer.outputs.title }}.md' | |||
There was a problem hiding this comment.
本当にちゃんと dprint もかかった状態でPRが来るかは author @pankona 氏が次の記事を書くなりしてくれないとわからないのでよろしくお願いいたします。
(ラベルのつけ外しでもくるっちゃくるだろうけども)
dprint config add markdowndprint fmtref: #310 (comment)
Summary by CodeRabbit
New Features
dprintcode formatter for improved documentation formatting.dprint.Bug Fixes
Documentation
Chores