Commit 9a41ced
build: only lint markdown files that have changed (POSIX-only)
Update Makefile so that only markdown files that have changed will be
linted. Currently, if one file in doc/api has changed, all files in
doc/api are linted.
On Windows, the lint-md task currently lints all files regardless of
whether any files has changed, and that behavior is unchanged here.
A further improvement is that when tools/lint-md.js is rebuilt, the
timestamp file is removed so that all files are linted again. This is
because rebuilding lint-md.js can introduce new rules or modify existing
rules, so re-linting everything helps make sure that accidental breakage
doesn't slip by unnoticed.
PR-URL: #31923
Reviewed-By: Anna Henningsen <anna@addaleax.net>1 parent 3849474 commit 9a41ced
1 file changed
Lines changed: 15 additions & 19 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1165,6 +1165,7 @@ bench-addons-clean: | |||
| 1165 | 1165 | ||
| 1166 | 1166 | .PHONY: lint-md-rollup | |
| 1167 | 1167 | lint-md-rollup: | |
| 1168 | + $(RM) tools/.*mdlintstamp | ||
| 1168 | 1169 | cd tools/node-lint-md-cli-rollup && npm install | |
| 1169 | 1170 | cd tools/node-lint-md-cli-rollup && npm run build-node | |
| 1170 | 1171 | ||
@@ -1177,28 +1178,23 @@ lint-md-clean: | |||
| 1177 | 1178 | lint-md-build: | |
| 1178 | 1179 | $(warning "Deprecated no-op target 'lint-md-build'") | |
| 1179 | 1180 | ||
| 1180 | - LINT_MD_DOC_FILES = $(shell find doc -type f -name '*.md') | ||
| 1181 | - run-lint-doc-md = tools/lint-md.js -q -f $(LINT_MD_DOC_FILES) | ||
| 1182 | - # Lint all changed markdown files under doc/ | ||
| 1183 | - tools/.docmdlintstamp: $(LINT_MD_DOC_FILES) | ||
| 1184 | - @echo "Running Markdown linter on docs..." | ||
| 1185 | - @$(call available-node,$(run-lint-doc-md)) | ||
| 1186 | - @touch $@ | ||
| 1181 | + ifeq ("$(wildcard tools/.mdlintstamp)","") | ||
| 1182 | + LINT_MD_NEWER = | ||
| 1183 | + else | ||
| 1184 | + LINT_MD_NEWER = -newer tools/.mdlintstamp | ||
| 1185 | + endif | ||
| 1187 | 1186 | ||
| 1188 | - LINT_MD_TARGETS = src lib benchmark test tools/doc tools/icu | ||
| 1189 | - LINT_MD_ROOT_DOCS := $(wildcard *.md) | ||
| 1190 | - LINT_MD_MISC_FILES := $(shell find $(LINT_MD_TARGETS) -type f \ | ||
| 1191 | - ! -path '*node_modules*' ! -path 'test/fixtures/*' -name '*.md') \ | ||
| 1192 | - $(LINT_MD_ROOT_DOCS) | ||
| 1193 | - run-lint-misc-md = tools/lint-md.js -q -f $(LINT_MD_MISC_FILES) | ||
| 1194 | - # Lint other changed markdown files maintained by us | ||
| 1195 | - tools/.miscmdlintstamp: $(LINT_MD_MISC_FILES) | ||
| 1196 | - @echo "Running Markdown linter on misc docs..." | ||
| 1197 | - @$(call available-node,$(run-lint-misc-md)) | ||
| 1187 | + LINT_MD_TARGETS = doc src lib benchmark test tools/doc tools/icu $(wildcard *.md) | ||
| 1188 | + LINT_MD_FILES = $(shell find $(LINT_MD_TARGETS) -type f \ | ||
| 1189 | + ! -path '*node_modules*' ! -path 'test/fixtures/*' -name '*.md' \ | ||
| 1190 | + $(LINT_MD_NEWER)) | ||
| 1191 | + run-lint-md = tools/lint-md.js -q -f --no-stdout $(LINT_MD_FILES) | ||
| 1192 | + # Lint all changed markdown files maintained by us | ||
| 1193 | + tools/.mdlintstamp: $(LINT_MD_FILES) | ||
| 1194 | + @echo "Running Markdown linter..." | ||
| 1195 | + @$(call available-node,$(run-lint-md)) | ||
| 1198 | 1196 | @touch $@ | |
| 1199 | 1197 | ||
| 1200 | - tools/.mdlintstamp: tools/.miscmdlintstamp tools/.docmdlintstamp | ||
| 1201 | - | ||
| 1202 | 1198 | .PHONY: lint-md | |
| 1203 | 1199 | # Lints the markdown documents maintained by us in the codebase. | |
| 1204 | 1200 | lint-md: | tools/.mdlintstamp | |
0 commit comments