doc, tools: doc linting does not work in CI #12635

Activity

1. vsemozhetbyt

   added

   docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.

   toolsIssues and PRs related to the tools directory.Issues and PRs related to the tools directory.

   on Apr 25, 2017
2. vsemozhetbyt commented on Apr 25, 2017

   

   vsemozhetbyt

   on Apr 25, 2017

   Last edited by vsemozhetbyt

   ContributorAuthor

   More actions

   It seems these blocks also need to be edited, but I don't know how exactly:

   node/Makefile

   Lines 861 to 864 in b4fea2a

   	jslint-ci:
   	@echo "Running JS linter..."
   	$(NODE) tools/jslint.js $(PARALLEL_ARGS) -f tap -o test-eslint.tap \
   	benchmark lib test tools

   node/vcbuild.bat

   Lines 427 to 430 in b4fea2a

   	:jslint-ci
   	echo running jslint-ci
   	%config%\node tools\jslint.js -J -f tap -o test-eslint.tap benchmark lib test tools
   	goto exit

   Maybe some other files are also concerned (tools/jslint.js ?).

   сс @not-an-aardvark, @silverwind, @Trott
3. Trott commented on Apr 25, 2017

   

   Trott

   on Apr 25, 2017

   Member

   More actions

   @vsemozhetbyt I think all you need to do is add doc to the list of directories being linted. They're in alphabetical order, so it would go between benchmark and lib. Basically, compare line 864 of the Makefile (the version you have linked above) with line 859. Similar change in vcbuild.bat.

   👍React with 👍1Reacted by Vse Mozhe Buty
4. Trott commented on Apr 25, 2017

   

   Trott

   on Apr 25, 2017

   Member

   More actions

   @vsemozhetbyt Oh, wait, yeah, you'll also need to add the --ext=.js,.md stuff. And that will involve editing tools/jslint.js (which was originally authored by @mscdex, who I'll @-mention just in case there's already a provision for adding arbitrary CLI flags or something).

   👍React with 👍1Reacted by Vse Mozhe Buty
5. not-an-aardvark commented on Apr 25, 2017

   

   not-an-aardvark

   on Apr 25, 2017

   Contributor

   More actions

   Oh, I never realized that jslint.js was a runner for ESLint. I always thought it was running JSLint.

   👍React with 👍1Reacted by Vse Mozhe Buty
6. Trott commented on Apr 25, 2017

   

   Trott

   on Apr 25, 2017

   Member

   More actions

   @not-an-aardvark With make jslint, we run eslint with caching because people are likely to run that multiple times. On my machine, the first run takes about 23 seconds, but subsequent runs (once the cache is populated) are less than 2 seconds. Sweet!

   But on CI, there is no second run. There is only the first run. So jslint.js is used to parallelize the linting a bit to make it faster. On my machine, it takes about 15 seconds to run. It might be slightly longer once docs are added to its lint load the way they are for make jslint.

   Given that the linter is the fastest CI job we have, this is literally marginal value, but it used to run everywhere before ESLint had caching (or maybe before we knew to turn caching on).

   👍React with 👍1Reacted by Vse Mozhe Buty
7. vsemozhetbyt commented on Apr 25, 2017

   

   vsemozhetbyt

   on Apr 25, 2017

   Last edited by vsemozhetbyt

   ContributorAuthor

   More actions

   @Trott @not-an-aardvark It seems we need to update cliOptions for CLIEngine with extensions property. I shall try a PR.
8. vsemozhetbyt commented on Apr 25, 2017

   

   vsemozhetbyt

   on Apr 25, 2017

   ContributorAuthor

   More actions

   Trying: #12640
9. vsemozhetbyt

   closed this as completedin 42dca99on Apr 25, 2017
10. sjarmak

    added a commit that references this issue on Jul 27, 2026

    doc, tools: add doc linting to CI

    ...

    42dca99