Skip to content

fix: Ignore the nodejs-links for nodejs.org system #3981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 16, 2021
Merged

fix: Ignore the nodejs-links for nodejs.org system #3981

merged 1 commit into from
Jul 16, 2021

Conversation

SEWeiTung
Copy link
Contributor

@SEWeiTung SEWeiTung commented Jul 15, 2021 •
edited
Loading

  1. According to build(deps-dev): bump remark-preset-lint-node from 2.3.0 to 2.4.1 #3956, it seems we're ordering the links' titles with ASCII orders, however NOT all the docs (such as translations) and test\scripts*.md, we DON'T need to cope with this rule, so we should disable it manually as a special case.

Ref:
a. nodejs/remark-preset-lint-node#188.
b. nodejs/node#39170.

  1. Update related package.json by upgrading "remark-preset-lint-node" from "2.3.0" to "2.4.1".

@SEWeiTung
Copy link
Contributor Author

SEWeiTung commented Jul 15, 2021 •
edited
Loading

@Trott, @aduh95 and @nschonni: Maybe #3956 can be merged because of this fixture, because we've ignored it only, but keep other rules running.

Thanks for you BIG help in the previous discussion, it's a bit too tired and trouble to add each <!--disable lint....> in docs, Trott, so maybe this is a better way.

Just like other ignored rules, I just added this there to avoid the problem in the file.

@aduh95
Copy link
Contributor

aduh95 commented Jul 15, 2021

@MaledongGit can you pull the bot commit to your branch to run the CI with it (curl -L https://github.com/nodejs/nodejs.org/pull/3956.patch | git am && git push)?

@SEWeiTung
Copy link
Contributor Author

SEWeiTung commented Jul 15, 2021 •
edited
Loading

Test have all passed after upgration

fix: Ignore the nodejs-links for nodejs.org system
ed4980e 
According to #3956, it seems
we're ordering the links' titles with ASCII orders, however NOT all the
docs (such as translations) and test\scripts\*.md, we DON'T need to cope
with this rule, so we should disable it manually as a special case.

Ref:
1. nodejs/remark-preset-lint-node#188.
2. nodejs/node#39170.
@SEWeiTung SEWeiTung requested review from aduh95, nschonni and Trott July 15, 2021 10:52
nschonni
nschonni reviewed Jul 15, 2021
View reviewed changes
package-lock.json
@@ -1,7 +1,11829 @@
{
"name": "nodejs.org",
"lockfileVersion": 2,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure reformating the lockfile as part of this should be included

Trott
Trott approved these changes Jul 15, 2021
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I wonder if we can add a .remarkrc file to locale/en to re-enable this rule for just things under that path. That's the way .eslintrc files work, but I'm not sure if .remarkrc does cascading that way.

@SEWeiTung
Copy link
Contributor Author

LGTM. I wonder if we can add a .remarkrc file to locale/en to re-enable this rule for just things under that path. That's the way .eslintrc files work, but I'm not sure if .remarkrc does cascading that way.

@Trott: Yes, I tried yesterday and it really can be put directly under 'en', however considering there're so many errors of syntaxes in English. I'm NOT sure whether to put it there, and it will break the test checking. I want to merge this first and then I'll submit another PR about English docs' checking....

image

The result is:

PS D:\Projects\node_proj\nodejs.org> npm run test:lint:md

> test:lint:md
> remark -qf .

locale\en\about\governance.md
    33:1-33:123  warning  Unordered reference ("Community Committee (CommComm)" should be before "collaborator-guide.md")      
   nodejs-links  remark-lint
     37:1-37:37  warning  Unordered reference ("TSC" should be before "Technical Steering Committee (TSC)")
   nodejs-links  remark-lint

locale\en\about\index.md
     64:1-64:71  warning  Broken link
   nodejs-links  remark-lint
     67:1-67:62  warning  Broken link
   nodejs-links  remark-lint
     68:1-68:62  warning  Unordered reference ("Event Machine" should be before "event loop")
   nodejs-links  remark-lint

locale\en\about\resources.md
    10:19-10:59  warning  Broken link
   nodejs-links  remark-lint
     13:5-13:76  warning  Broken link
   nodejs-links  remark-lint

locale\en\about\trademark.md
     32:5-32:76  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\announcements\nodejs-foundation-survey.md
   105:3-105:94  warning  Broken link
   nodejs-links  remark-lint
  106:3-106:101  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\community\v5-to-v7.md
     15:1-15:77  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\npm\2013-outage-postmortem.md
     82:1-82:68  warning  Unordered reference ("npm-python" should be before "npm-rubygems")
   nodejs-links  remark-lint
     84:1-84:70  warning  Unordered reference ("ops-compaction" should be before "ops-new-machine")
   nodejs-links  remark-lint
     85:1-85:56  warning  Unordered reference ("compaction" should be before "ops-compaction")
   nodejs-links  remark-lint

locale\en\blog\release\v0.10.41.md
   11:81-11:173  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\release\v0.12.9.md
   11:81-11:173  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\release\v4.2.3.md
   11:81-11:173  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\release\v5.1.1.md
   11:81-11:173  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\release\v8.0.0.md
   259:1-259:75  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\uncategorized\evolving-the-node-js-brand.md
     17:1-17:79  warning  Broken link
   nodejs-links  remark-lint
     21:1-21:83  warning  Broken link
   nodejs-links  remark-lint
     27:1-27:93  warning  Broken link
   nodejs-links  remark-lint
     31:1-31:89  warning  Broken link
   nodejs-links  remark-lint
     37:1-37:99  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\uncategorized\ldapjs-a-reprise-of-ldap.md
  94:310-94:412  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\uncategorized\porting-node-to-windows-with-microsofts-help.md
  11:159-11:199  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\uncategorized\trademark.md
     19:1-19:63  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\vulnerability\december-2015-security-releases.md
    12:32-12:84  warning  Broken link
   nodejs-links  remark-lint
   12:86-12:128  warning  Broken link
   nodejs-links  remark-lint
  12:130-12:178  warning  Broken link
   nodejs-links  remark-lint
  12:183-12:226  warning  Broken link
   nodejs-links  remark-lint
   21:68-21:110  warning  Broken link
   nodejs-links  remark-lint
   22:87-22:135  warning  Broken link
   nodejs-links  remark-lint
   23:65-23:108  warning  Broken link
   nodejs-links  remark-lint
   33:87-33:135  warning  Broken link
   nodejs-links  remark-lint
   34:65-34:108  warning  Broken link
   nodejs-links  remark-lint
   44:87-44:135  warning  Broken link
   nodejs-links  remark-lint
   45:65-45:108  warning  Broken link
   nodejs-links  remark-lint
   53:68-53:120  warning  Broken link
   nodejs-links  remark-lint
   54:68-54:110  warning  Broken link
   nodejs-links  remark-lint
   55:87-55:135  warning  Broken link
   nodejs-links  remark-lint
   56:65-56:108  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\vulnerability\february-2016-security-releases.md
    14:32-14:84  warning  Broken link
   nodejs-links  remark-lint
   14:86-14:130  warning  Broken link
   nodejs-links  remark-lint
  14:132-14:180  warning  Broken link
   nodejs-links  remark-lint
  14:185-14:228  warning  Broken link
   nodejs-links  remark-lint
   26:68-26:120  warning  Broken link
   nodejs-links  remark-lint
   27:68-27:112  warning  Broken link
   nodejs-links  remark-lint
   28:87-28:135  warning  Broken link
   nodejs-links  remark-lint
   29:65-29:108  warning  Broken link
   nodejs-links  remark-lint
   43:68-43:120  warning  Broken link
   nodejs-links  remark-lint
   44:68-44:112  warning  Broken link
   nodejs-links  remark-lint
   45:87-45:135  warning  Broken link
   nodejs-links  remark-lint
   46:65-46:108  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\vulnerability\november-2018-security-releases.md
    27:40-27:88  warning  Broken link
   nodejs-links  remark-lint
  27:174-27:214  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\weekly-updates\weekly-update.2015-12-04.md
    17:28-17:80  warning  Broken link
   nodejs-links  remark-lint
   17:82-17:124  warning  Broken link
   nodejs-links  remark-lint
  17:126-17:174  warning  Broken link
   nodejs-links  remark-lint
  17:179-17:223  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\weekly-updates\weekly-update.2016-02-15.md
    15:25-15:77  warning  Broken link
   nodejs-links  remark-lint
   15:79-15:123  warning  Broken link
   nodejs-links  remark-lint
  15:125-15:173  warning  Broken link
   nodejs-links  remark-lint
  15:178-15:222  warning  Broken link
   nodejs-links  remark-lint

locale\en\blog\wg\diag-wg-update-2017-02.md
     70:1-70:65  warning  Unordered reference ("CLI debugger" should be before "async_hooks")
   nodejs-links  remark-lint
     73:1-73:63  warning  Unordered reference ("Diagnostics WG" should be before "diag-agenda")
   nodejs-links  remark-lint
     75:1-75:89  warning  Unordered reference ("Inspector" should be before "Inspector API")
   nodejs-links  remark-lint
     79:1-79:70  warning  Broken link
   nodejs-links  remark-lint
     79:1-79:70  warning  Unordered reference ("Node.js Foundation survey" should be before "node-report")
   nodejs-links  remark-lint
     81:1-81:66  warning  Unordered reference ("Open an issue" should be before "nodejs/node")
   nodejs-links  remark-lint
     83:1-83:61  warning  Unordered reference ("Trace Controller" should be before "stability")
   nodejs-links  remark-lint

locale\en\docs\guides\anatomy-of-an-http-transaction.md
   408:1-408:68  warning  Unordered reference ("`Server`" should be before "`createServer`")
   nodejs-links  remark-lint
   410:1-410:50  warning  Unordered reference ("API reference" should be before "`listen`")
   nodejs-links  remark-lint
   414:1-414:47  warning  Unordered reference ("`Buffer`" should be before "`rawHeaders`")
   nodejs-links  remark-lint
   416:1-416:45  warning  Unordered reference ("`body`" should be before "`concat-stream`")
   nodejs-links  remark-lint
   418:1-418:79  warning  Unordered reference ("`EventEmitter`" should be before "`npm`")
   nodejs-links  remark-lint
   420:1-420:84  warning  Unordered reference ("`ServerResponse`" should be before "handling these errors")
   nodejs-links  remark-lint
   422:1-422:84  warning  Unordered reference ("`WritableStream`" should be before "`setHeader`")
   nodejs-links  remark-lint
   424:1-424:51  warning  Unordered reference ("`express`" should be before "`writeHead`")
   nodejs-links  remark-lint
   426:1-426:86  warning  Unordered reference ("`pipe`" should be before "`router`")
   nodejs-links  remark-lint
   427:1-427:60  warning  Unordered reference ("`Error` documentation" should be before "`pipe`")
   nodejs-links  remark-lint

locale\en\docs\guides\backpressuring-in-streams.md
   597:1-597:47  warning  Unordered reference ("`Buffer`" should be before "`Stream`")
   nodejs-links  remark-lint
   600:1-600:73  warning  Unordered reference ("`Readable`" should be before "`Writable`")
   nodejs-links  remark-lint
   601:1-601:83  warning  Unordered reference ("`Duplex`" should be before "`Readable`")
   nodejs-links  remark-lint
   604:1-604:67  warning  Unordered reference ("`'drain'`" should be before "`zlib`")
   nodejs-links  remark-lint
   605:1-605:71  warning  Unordered reference ("`'data'` event" should be before "`'drain'`")
   nodejs-links  remark-lint
   608:1-608:89  warning  Unordered reference ("`._read()`" should be before "`.write()`")
   nodejs-links  remark-lint
   614:1-614:96  warning  Unordered reference ("`.push()`" should be before "`.uncork()`")
   nodejs-links  remark-lint
  617:1-617:118  warning  Unordered reference ("implementing Readable streams" should be before "implementing Writable streams")  nodejs-links  remark-lint
   620:1-620:69  warning  Unordered reference ("`backpressure`" should be before "other packages")
   nodejs-links  remark-lint
   621:1-621:50  warning  Unordered reference ("Node.js v0.10" should be before "`backpressure`")
   nodejs-links  remark-lint
   625:1-625:63  warning  Unordered reference ("`readable-stream`" should be before "return value")
   nodejs-links  remark-lint
   628:1-628:43  warning  Unordered reference ("`dtrace`" should be before "great blog post")
   nodejs-links  remark-lint
   630:1-630:46  warning  Unordered reference ("`gzip(1)`" should be before "`zip(1)`")
   nodejs-links  remark-lint
  633:1-633:101  warning  Unordered reference ("`.pipe()`" should be before "`stream state machine`")
   nodejs-links  remark-lint
   635:1-635:44  warning  Unordered reference ("`pump`" should be before "piped")
   nodejs-links  remark-lint
   636:1-636:89  warning  Unordered reference ("`pipeline`" should be before "`pump`")
   nodejs-links  remark-lint

locale\en\docs\guides\blocking-vs-non-blocking.md
   11:60-11:142  warning  Broken link
   nodejs-links  remark-lint
   142:3-142:30  warning  Broken link
   nodejs-links  remark-lint

locale\en\docs\guides\event-loop-timers-and-nexttick.md
   490:1-490:51  warning  Unordered reference ("REPL" should be before "libuv")
   nodejs-links  remark-lint

locale\en\docs\guides\index.md
     10:3-10:66  warning  Broken link
   nodejs-links  remark-lint
     11:3-11:76  warning  Broken link
   nodejs-links  remark-lint
     12:3-12:79  warning  Broken link
   nodejs-links  remark-lint
     13:3-13:72  warning  Broken link
   nodejs-links  remark-lint
     14:3-14:73  warning  Broken link
   nodejs-links  remark-lint
     15:3-15:91  warning  Broken link
   nodejs-links  remark-lint
     20:3-20:84  warning  Broken link
   nodejs-links  remark-lint
    21:3-21:110  warning  Broken link
   nodejs-links  remark-lint
     22:3-22:96  warning  Broken link
   nodejs-links  remark-lint
     23:3-23:55  warning  Broken link
   nodejs-links  remark-lint
     27:3-27:84  warning  Broken link
   nodejs-links  remark-lint
     28:3-28:92  warning  Broken link
   nodejs-links  remark-lint
     29:3-29:74  warning  Broken link
   nodejs-links  remark-lint
     30:3-30:65  warning  Broken link
   nodejs-links  remark-lint
     31:3-31:75  warning  Broken link
   nodejs-links  remark-lint
     32:3-32:50  warning  Broken link
   nodejs-links  remark-lint

locale\en\docs\guides\simple-profiling.md
   282:1-282:85  warning  Unordered reference ("benefits of asynchronous programming" should be before "profiler inside V8")   
   nodejs-links  remark-lint
   283:1-283:53  warning  Broken link
   nodejs-links  remark-lint

locale\en\docs\guides\timers-in-node.md
     13:1-13:62  warning  Broken link
   nodejs-links  remark-lint
   99:65-99:143  warning  Broken link
   nodejs-links  remark-lint
  193:21-194:69  warning  Broken link
   nodejs-links  remark-lint

locale\en\docs\index.md
     45:5-45:33  warning  Broken link
   nodejs-links  remark-lint
     49:5-49:39  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\HTTP\servers\how-to-create-a-HTTPS-server.md
  23:299-23:362  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\HTTP\servers\how-to-read-POST-data.md
  39:222-39:304  warning  Broken link
   nodejs-links  remark-lint
   41:34-41:108  warning  Broken link
   nodejs-links  remark-lint
  41:221-41:305  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\HTTP\servers\how-to-serve-static-files.md
   10:28-10:100  warning  Broken link
   nodejs-links  remark-lint
  10:198-10:269  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\advanced\streams\what-are-streams.md
    46:34-46:96  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\child-processes\how-to-spawn-a-child-process.md
   37:54-37:116  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\errors\what-is-the-error-object.md
   48:61-48:145  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\errors\what-is-try-catch.md
  53:292-53:356  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\file-system\how-to-read-files-in-nodejs.md
    61:25-61:87  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\file-system\how-to-search-files-and-directories-in-nodejs.md
  10:114-10:178  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\file-system\how-to-store-local-config-data.md
  11:126-11:184  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\file-system\how-to-use-the-path-module.md
  72:383-72:484  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\getting-started\control-flow\how-to-write-asynchronous-code.md
  43:335-43:410  warning  Broken link
   nodejs-links  remark-lint
  46:306-46:390  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\getting-started\control-flow\what-are-callbacks.md
   59:43-59:124  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\getting-started\control-flow\what-are-event-emitters.md
  12:290-12:340  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\getting-started\globals-in-node-js.md
  16:115-16:177  warning  Broken link
   nodejs-links  remark-lint
  17:117-17:179  warning  Broken link
   nodejs-links  remark-lint
  18:116-18:204  warning  Broken link
   nodejs-links  remark-lint
   22:99-22:158  warning  Broken link
   nodejs-links  remark-lint
  23:142-23:200  warning  Broken link
   nodejs-links  remark-lint
  25:134-25:193  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\getting-started\npm\what-is-npm.md
   16:93-16:173  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\getting-started\the-console-module.md
  41:116-41:183  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\getting-started\the-process-module.md
   58:74-58:159  warning  Broken link
   nodejs-links  remark-lint
  77:214-77:316  warning  Broken link
   nodejs-links  remark-lint

locale\en\knowledge\javascript-conventions\how-to-create-default-parameters-for-functions.md
   33:49-33:144  warning  Broken link
   nodejs-links  remark-lint

‼ 152 warnings

@SEWeiTung SEWeiTung merged commit b0b170c into nodejs:master Jul 16, 2021
@SEWeiTung SEWeiTung deleted the fixRemarkLinks branch July 16, 2021 00:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott approved these changes

@aduh95 aduh95 aduh95 approved these changes

+1 more reviewer

@nschonni nschonni nschonni left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@SEWeiTung @aduh95 @Trott @nschonni