Add `autocorrect-node` and configure that run lint before git commit. #14773

huacnlee · 2023-07-31T13:43:04Z

This will just be checking the changed files before git commit.

The autocorrect command provided by autocorrect-node NPM, there are no other binary need to install.

It also will follow the .autocorrectignore and .autocorrectrc rules.

@yin1999 @queengooborg

yin1999 · 2023-07-31T15:15:38Z

Hi @huacnlee. Should we also use autocorrect-node in autocorrect-lint workflow. As we could make sure the binary version is always the same.

By the way, do you have time to run a full autocorrect on zh-cn files again, and create some PRs to fix them :)

After that we should also add ci test to check if all the zh-cn documents are still "good" when we update the version of autocorrect-node.

huacnlee · 2023-08-01T01:58:55Z

Fail example

github-actions · 2023-08-02T02:19:29Z

Preview URLs

/zh-CN/docs/Glossary/Accent

(comment last updated: 2023-12-09 05:44:58)

yin1999 · 2023-09-04T02:17:52Z

As there are security limitation on GitHub Actions. Could you merge the workflow here into pr-check-lint_content, or do the same changes as what we made in this workflow - spreading into two jobs and use pull_request_target event instead.

github-actions · 2023-10-10T13:09:40Z

This pull request has merge conflicts that must be resolved before it can be merged.

yin1999

@huacnlee I've pushed some commits to merge autocorrect into our system. Could you have a look on this.

And I'm not sure about the ignore rules:

.autocorrectignore

package.json

Co-authored-by: A1lo <[email protected]>

huacnlee · 2023-10-13T10:07:59Z

@yin1999 The .autocorrectignore file is use same rules like the .gitignore.

yin1999

LGTM. Thanks @huacnlee.

ping @mdn/core-dev for the review from the development team

github-actions · 2023-10-30T13:06:16Z

This pull request has merge conflicts that must be resolved before it can be merged.

github-actions · 2023-12-07T13:10:17Z

This pull request has merge conflicts that must be resolved before it can be merged.

yin1999 · 2023-12-13T09:22:48Z

.github/workflows/markdown-lint-fix.yml

@@ -61,6 +61,7 @@ jobs:
        run: |
          yarn markdownlint-cli2 --fix "**/${{ matrix.lang }}/**/*.md"
          node ./scripts/check-url-locale.js --fix "files/${{ matrix.lang }}"
+          ls -d 2>/dev/null "files/${{ matrix.lang }}" "docs/${{ matrix.lang }}" | xargs yarn autocorrect --fix


Using ls -d to filter out non-existed dirs

yin1999 · 2023-12-13T09:23:13Z

@bsmth Sorry to bother you, this PR has been there for a long time. And most of the content changes come from myself, I think it would be better to have a double check from other people before we merge this. Do you have time to have a look on this :)

bsmth · 2023-12-15T08:36:03Z

Sorry to bother you, this PR has been there for a long time. And most of the content changes come from myself, I think it would be better to have a double check from other people before we merge this. Do you have time to have a look on this :)

This doesn't bother me at all, please continue to ping me on PRs where I can help review or unblock - that's what I'm here for :) I will have a look today 🙌🏻

bsmth · 2023-12-15T19:43:49Z

.github/workflows/autocorrect-lint.yml

-# - correct:   "Welcome, to read MDN Web Docs."
-#
-# More details:
-# https://github.com/huacnlee/autocorrect


It might be nice to have this documented somewhere in this repo, but not a blocker for this PR.

bsmth

No objections from me apart from adding some docs / linking to https://github.com/huacnlee/autocorrect somewhere. A README.md in https://github.com/mdn/translated-content/tree/main/.github/workflows? We can do in a follow-up.

bsmth · 2023-12-15T19:46:39Z

ping @mdn/core-dev for the review from the development team

It would be great to have a sign off from dev on this, also 👍🏻

caugner

LGTM, only affects zh-CN.

Improves "copywriting, correct spaces, words, and punctuations". (Source: https://github.com/huacnlee/autocorrect) Only enabled for zh-CN for now. Also runs before git commits. Co-authored-by: A1lo <[email protected]>

Add autocorrect-node and configure that run lint before git commit.

b64b311

huacnlee requested a review from a team as a code owner July 31, 2023 13:43

github-actions bot added the system Infrastructure and configuration for the project label Jul 31, 2023

huacnlee requested a review from a team as a code owner August 1, 2023 01:38

huacnlee requested review from yin1999 and removed request for a team August 1, 2023 01:38

github-actions bot added the l10n-zh Issues related to Chinese content. label Aug 1, 2023

huacnlee force-pushed the feat/add-autocorrect-node branch 3 times, most recently from 31572b1 to e201d58 Compare August 1, 2023 01:57

huacnlee force-pushed the feat/add-autocorrect-node branch 7 times, most recently from 5b511ef to df59f13 Compare August 1, 2023 02:48

github-actions bot removed the l10n-zh Issues related to Chinese content. label Aug 1, 2023

Update CI autocorrect.yml to use NPM command.

0848038

huacnlee force-pushed the feat/add-autocorrect-node branch from df59f13 to 0848038 Compare August 1, 2023 02:49

github-actions bot added the l10n-zh Issues related to Chinese content. label Aug 2, 2023

huacnlee force-pushed the feat/add-autocorrect-node branch 6 times, most recently from 739532e to 1a1ea1d Compare August 2, 2023 02:40

github-actions bot added the merge conflicts 🚧 This pull request has merge conflicts that must be resolved. label Oct 10, 2023

yin1999 added 3 commits October 13, 2023 10:08

Merge branch 'main' into pr/huacnlee/14773

c2af17f

chore(pre-commit-hook): use fix instead

2f278c6

chore(ci): merge autocorrect into existing lint/fix system

2f5140a

github-actions bot removed the merge conflicts 🚧 This pull request has merge conflicts that must be resolved. label Oct 13, 2023

yin1999 reviewed Oct 13, 2023

View reviewed changes

.autocorrectignore Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

huacnlee and others added 3 commits October 13, 2023 18:06

Update .autocorrectignore

7893631

Co-authored-by: A1lo <[email protected]>

Update package.json

e16d71a

Co-authored-by: A1lo <[email protected]>

Update package.json

8240e9f

Co-authored-by: A1lo <[email protected]>

yin1999 approved these changes Oct 15, 2023

View reviewed changes

github-actions bot added the merge conflicts 🚧 This pull request has merge conflicts that must be resolved. label Oct 30, 2023

Merge branch 'main' into feat/add-autocorrect-node

170203f

github-actions bot removed the merge conflicts 🚧 This pull request has merge conflicts that must be resolved. label Oct 30, 2023

github-actions bot added the merge conflicts 🚧 This pull request has merge conflicts that must be resolved. label Dec 7, 2023

Merge remote-tracking branch 'upstream/main' into pr/huacnlee/14773

debf4d0

github-actions bot removed the merge conflicts 🚧 This pull request has merge conflicts that must be resolved. label Dec 9, 2023

yin1999 reviewed Dec 13, 2023

View reviewed changes

bsmth reviewed Dec 15, 2023

View reviewed changes

bsmth approved these changes Dec 15, 2023

View reviewed changes

caugner approved these changes Dec 21, 2023

View reviewed changes

caugner merged commit 3c87751 into mdn:main Dec 21, 2023
10 of 11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `autocorrect-node` and configure that run lint before git commit. #14773

Add `autocorrect-node` and configure that run lint before git commit. #14773

huacnlee commented Jul 31, 2023 •

edited

Loading

yin1999 commented Jul 31, 2023

huacnlee commented Aug 1, 2023

github-actions bot commented Aug 2, 2023 •

edited

Loading

yin1999 commented Sep 4, 2023

github-actions bot commented Oct 10, 2023

yin1999 left a comment •

edited

Loading

huacnlee commented Oct 13, 2023

yin1999 left a comment

github-actions bot commented Oct 30, 2023

github-actions bot commented Dec 7, 2023

yin1999 Dec 13, 2023

yin1999 commented Dec 13, 2023

bsmth commented Dec 15, 2023

bsmth Dec 15, 2023

bsmth left a comment

bsmth commented Dec 15, 2023

caugner left a comment •

edited

Loading

Add autocorrect-node and configure that run lint before git commit. #14773

Add autocorrect-node and configure that run lint before git commit. #14773

Conversation

huacnlee commented Jul 31, 2023 • edited Loading

yin1999 commented Jul 31, 2023

huacnlee commented Aug 1, 2023

github-actions bot commented Aug 2, 2023 • edited Loading

yin1999 commented Sep 4, 2023

github-actions bot commented Oct 10, 2023

yin1999 left a comment • edited Loading

Choose a reason for hiding this comment

huacnlee commented Oct 13, 2023

yin1999 left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 30, 2023

github-actions bot commented Dec 7, 2023

yin1999 Dec 13, 2023

Choose a reason for hiding this comment

yin1999 commented Dec 13, 2023

bsmth commented Dec 15, 2023

bsmth Dec 15, 2023

Choose a reason for hiding this comment

bsmth left a comment

Choose a reason for hiding this comment

bsmth commented Dec 15, 2023

caugner left a comment • edited Loading

Choose a reason for hiding this comment

Add `autocorrect-node` and configure that run lint before git commit. #14773

Add `autocorrect-node` and configure that run lint before git commit. #14773

huacnlee commented Jul 31, 2023 •

edited

Loading

github-actions bot commented Aug 2, 2023 •

edited

Loading

yin1999 left a comment •

edited

Loading

caugner left a comment •

edited

Loading