tools: rolled up lint-md #20109

refack · 2018-04-17T16:40:51Z

replace remark-cli and remark-preset-lint-node with a "rolled-up" single file.

Should solve all build & Makefile issue
very size economic (17KB instead of 20MB ~1300 files)
includes all recipes for re rolling & updating

/CC @wooorm @nodejs/build
H/T: @rollup

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

refack · 2018-04-17T16:41:14Z

https://ci.nodejs.org/job/node-test-commit-lite/709/

vsemozhetbyt · 2018-04-17T16:47:23Z

tools/node-lint-md-cli-rollup/.gitignore

@@ -0,0 +1,2 @@
+/node_modules/
+/dist/


Nit: missing line break at EOF.

richardlau · 2018-04-17T16:53:42Z

tools/remark-cli/LICENSE

@@ -1,22 +0,0 @@
-(The MIT License)


Please could you update

node/tools/license-builder.sh

Line 88 in e86b319

addlicense "remark-cli" "tools/remark-cli" "$(cat ${rootdir}/tools/remark-cli/LICENSE)"

?

gibfahn · 2018-04-18T21:56:11Z

This sounds like a great solution to the problem. If it works we should probably consider doing the same for eslint.

joyeecheung · 2018-04-19T05:31:01Z

tools/node-lint-md-cli-rollup/package.json

+  },
+  "scripts": {
+    "build": "rollup -c",
+    "build-node": "npm run build && cp dist/* .."


The lint-md-build makefile target is removed, can you add it back with a command that runs this?

Since our CI runs this for every lint, I've made make lint-md-build a no-op, and added make lint-md-rollup

joyeecheung · 2018-04-19T05:32:47Z

Very nice work. Thank you for working on this!

BridgeAR · 2018-04-25T11:30:13Z

This is marked as WIP @refack is there anything else to do to get this landed (besides open comments)?

refack · 2018-04-27T20:55:58Z

refack is there anything else to do to get this landed (besides open comments)?

I was hoping for some feedback on how we should track the license, and document this. Also i'm not sure how to test the new script...

joyeecheung · 2018-04-28T05:26:45Z

@refack I think writing a bad .md in the root directory then running make lint-md expecting a non-zero exit code and some output complaining about it should be enough. Can be part of the doctool test suite. If we don't want to always run it we can just tweak the makefile and/or vcbuild.bat, it should be fine as long as it's run in the linter CI.

BridgeAR · 2018-05-15T11:53:18Z

Ping @refack

BridgeAR · 2018-05-25T10:56:59Z

I guess it is a good idea to do this but I am going to close this due to no response. If anyone feels like taking a stab at this, that would be great.

@refack please reopen in case you want to continue working on this.

refack · 2018-09-06T22:48:39Z

Why should this not trigger the rollup?

Also lint-md-rollup uses npm up, and there is some spesific workaround code in the rollup config that could break:
https://github.com/nodejs/node/blob/67b6082e119b85551e5dcf4243b09f08f50f42ce/tools/node-lint-md-cli-rollup/rollup.config.js#L28-L36

refack · 2018-09-07T14:06:30Z

https://ci.nodejs.org/job/node-test-pull-request/17071/

PR-URL: nodejs#20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

* remove unused `tools/remark-cli` * vcbuild tested with `vcbuild nobuild noprojgen lint-md-build lint-md` PR-URL: nodejs#20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

refack · 2018-09-11T18:14:14Z

Landed in
d3442f2
2120dac
7fcc178
fe6c74c
e4dd213

PR-URL: #20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

* remove unused `tools/remark-cli` * vcbuild tested with `vcbuild nobuild noprojgen lint-md-build lint-md` PR-URL: #20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

- In release guide - In Travis config Refs: nodejs#20109

- In release guide - In Travis config Refs: #20109 PR-URL: #22991 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

refack added wip Issues and PRs that are still a work in progress. doc Issues and PRs related to the documentations. build Issues and PRs related to build files or the CI. tools Issues and PRs related to the tools directory. labels Apr 17, 2018

refack self-assigned this Apr 17, 2018

refack requested review from MylesBorins, Trott, watilde, targos, joyeecheung and vsemozhetbyt April 17, 2018 16:40

nodejs-github-bot added build Issues and PRs related to build files or the CI. meta Issues and PRs related to the general management of the project. tools Issues and PRs related to the tools directory. labels Apr 17, 2018

vsemozhetbyt reviewed Apr 17, 2018

View reviewed changes

tools/node-lint-md-cli-rollup/.gitignore Outdated

@@ -0,0 +1,2 @@

/node_modules/

/dist/

Copy link

Contributor

vsemozhetbyt Apr 17, 2018

Choose a reason for hiding this comment

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

Nit: missing line break at EOF.

richardlau reviewed Apr 17, 2018

View reviewed changes

joyeecheung reviewed Apr 19, 2018

View reviewed changes

jasnell approved these changes Apr 19, 2018

View reviewed changes

devsnek approved these changes Apr 19, 2018

View reviewed changes

This was referenced Apr 28, 2018

tools: don't create package-lock.json #17330

Closed

build: search missing dependencies on lint-md #19249

Closed

bzoz mentioned this pull request May 2, 2018

win, build: add documentation support to vcbuild #19663

Closed

2 tasks

refack added 5 commits September 11, 2018 14:12

tools: vendor in node-lint-md-cli-rollup

d3442f2

PR-URL: nodejs#20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

tools: update node-lint-md-cli-rollup

2120dac

PR-URL: nodejs#20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

tools: relocate remark-preset-lint-node

7fcc178

PR-URL: nodejs#20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

tools: make lint-md-rollup & checkin lint-md.js

fe6c74c

PR-URL: nodejs#20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

refack force-pushed the rolled-up-lint-md branch from 67b6082 to e4dd213 Compare September 11, 2018 18:13

refack merged commit e4dd213 into nodejs:master Sep 11, 2018

refack deleted the rolled-up-lint-md branch September 11, 2018 18:14

targos pushed a commit that referenced this pull request Sep 11, 2018

tools: vendor in node-lint-md-cli-rollup

37b27a5

PR-URL: #20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

targos pushed a commit that referenced this pull request Sep 11, 2018

tools: update node-lint-md-cli-rollup

25e1060

PR-URL: #20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

targos pushed a commit that referenced this pull request Sep 11, 2018

tools: relocate remark-preset-lint-node

350a3e1

PR-URL: #20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

targos pushed a commit that referenced this pull request Sep 11, 2018

tools: make lint-md-rollup & checkin lint-md.js

22fefae

PR-URL: #20109 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

targos mentioned this pull request Sep 18, 2018

Release proposal: v10.11.0 #22932

Merged

targos added a commit to targos/node that referenced this pull request Sep 21, 2018

build,doc: remove outdated lint-md-build

07cd754

- In release guide - In Travis config Refs: nodejs#20109

targos mentioned this pull request Sep 21, 2018

build,doc: remove outdated lint-md-build #22991

Closed

refack removed their assignment Oct 12, 2018

richardlau mentioned this pull request Nov 5, 2018

possible make lint-md-build bug #21648

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tools: rolled up lint-md #20109

tools: rolled up lint-md #20109

refack commented Apr 17, 2018 •

edited

Loading

refack commented Apr 17, 2018

vsemozhetbyt Apr 17, 2018

richardlau Apr 17, 2018

gibfahn commented Apr 18, 2018

joyeecheung Apr 19, 2018 •

edited

Loading

refack Sep 6, 2018

joyeecheung commented Apr 19, 2018

BridgeAR commented Apr 25, 2018 •

edited

Loading

refack commented Apr 27, 2018

joyeecheung commented Apr 28, 2018

BridgeAR commented May 15, 2018

BridgeAR commented May 25, 2018

refack commented Sep 6, 2018

refack commented Sep 7, 2018

refack commented Sep 11, 2018

tools: rolled up lint-md #20109

tools: rolled up lint-md #20109

Conversation

refack commented Apr 17, 2018 • edited Loading

Checklist

refack commented Apr 17, 2018

vsemozhetbyt Apr 17, 2018

Choose a reason for hiding this comment

richardlau Apr 17, 2018

Choose a reason for hiding this comment

gibfahn commented Apr 18, 2018

joyeecheung Apr 19, 2018 • edited Loading

Choose a reason for hiding this comment

refack Sep 6, 2018

Choose a reason for hiding this comment

joyeecheung commented Apr 19, 2018

BridgeAR commented Apr 25, 2018 • edited Loading

refack commented Apr 27, 2018

joyeecheung commented Apr 28, 2018

BridgeAR commented May 15, 2018

BridgeAR commented May 25, 2018

refack commented Sep 6, 2018

refack commented Sep 7, 2018

refack commented Sep 11, 2018

refack commented Apr 17, 2018 •

edited

Loading

joyeecheung Apr 19, 2018 •

edited

Loading

BridgeAR commented Apr 25, 2018 •

edited

Loading