-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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.
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
tools: eliminate intermediate module in doctools #20701
Conversation
This comment has been minimized.
This comment has been minimized.
This depending-on-a-module-in-an-unrelated-source-tree seems like a code smell to me. Wouldn't it be better to simply remove the checks from the tests (after making sure that the code doesn't use the version in |
I'm opposed to fast-tracking because I don't think this is the right approach, at least based on the context I have. It's possible that I don't fully understand the situation. |
TBH, I do not understand why we need So I am not sure how to proceed. Doctools only require Can we have cases when we build docs or run doctools tests without ESLint in the tree? |
Oh...I see. The js-yaml in doc/tools just loads the one from eslint anyway. /ping @addaleax who set it up that way partly (or entirely?) to avoid bloat in the repo. I don't oppose this change. No objection from me. I do think we shouldn't fast-track it. Let's give @addaleax and anyone else who may have set things up this way a chance to look at it. |
Hi! 👋 I don’t have any strong feelings over this. It kind of trades one hack for another. :) I think that ideally, what we’ll have at some point is just a global |
Landed in 01e2f48 |
PR-URL: #20701 Fixes: #20685 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
PR-URL: #20701 Fixes: #20685 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesFixes: #20685
We already check this path in doctools tests, so why not to require this module directly without unneeded overhead:
node/test/doctool/test-doctool-html.js
Lines 4 to 9 in 6de0f55
node/test/doctool/test-doctool-json.js
Lines 4 to 9 in 6de0f55
It seems we can leave this block unchanged, as this
package.json
is more informational than functional:node/tools/doc/package.json
Lines 12 to 14 in 6de0f55