Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,6 @@ updates:
patterns:
- '*'

- package-ecosystem: npm
directory: /tools/lint-md
schedule:
interval: monthly
cooldown:
semver-major-days: 5
semver-minor-days: 5
semver-patch-days: 5
commit-message:
prefix: tools
open-pull-requests-limit: 10
groups:
lint-md:
applies-to: version-updates
patterns:
- '*'

- package-ecosystem: npm
directory: /tools/doc
schedule:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/build-tarball.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ on:
- tools/doc/**
- tools/eslint-rules/**
- tools/eslint/**
- tools/lint-md/**
- typings/**
- vcbuild.bat
- .**
Expand Down Expand Up @@ -51,7 +50,6 @@ on:
- tools/doc/**
- tools/eslint-rules/**
- tools/eslint/**
- tools/lint-md/**
- typings/**
- vcbuild.bat
- .**
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/coverage-windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ on:
- tools/doc/**
- tools/eslint-rules/**
- tools/eslint/**
- tools/lint-md/**
- typings/**
- .**
- '!.github/workflows/coverage-windows.yml'
Expand All @@ -48,7 +47,6 @@ on:
- tools/doc/**
- tools/eslint-rules/**
- tools/eslint/**
- tools/lint-md/**
- typings/**
- .**
- '!.github/workflows/coverage-windows.yml'
Expand Down
4 changes: 0 additions & 4 deletions .github/workflows/linters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,6 @@ jobs:
echo
exit "$EXIT_CODE"
fi
- name: Get release version numbers
if: ${{ github.event.pull_request && github.event.pull_request.base.ref == github.event.pull_request.base.repo.default_branch }}
id: get-released-versions
run: ./tools/lint-md/list-released-versions-from-changelogs.mjs >> $GITHUB_OUTPUT
- name: Lint markdown files
run: |
echo "::add-matcher::.github/workflows/remark-lint-problem-matcher.json"
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/test-macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ on:
- tools/doc/**
- tools/eslint-rules/**
- tools/eslint/**
- tools/lint-md/**
- typings/**
- vcbuild.bat
- .**
Expand Down Expand Up @@ -52,7 +51,6 @@ on:
- tools/doc/**
- tools/eslint-rules/**
- tools/eslint/**
- tools/lint-md/**
- typings/**
- vcbuild.bat
- .**
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ release.
LTS releases.
* Release versions in **bold** text are the most recent supported releases.

***
---

***
---

## 2016-05-06, Version 0.12.14 (Maintenance), @rvagg

Expand Down
13 changes: 4 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -1403,24 +1403,20 @@ LINT_MD_TARGETS = doc src lib benchmark test tools/doc tools/icu $(wildcard *.md
LINT_MD_FILES = $(shell $(FIND) $(LINT_MD_TARGETS) -type f \
! -path '*node_modules*' ! -path 'test/fixtures/*' -name '*.md' \
$(LINT_MD_NEWER))
run-lint-md = tools/lint-md/lint-md.mjs $(LINT_MD_FILES)

# Check for a specific file, as (empty) directories are persisted in git.
tools/lint-md/node_modules/remark-parse/package.json:
-cd tools/lint-md && $(call available-node,$(run-npm-ci))
run-lint-md = tools/doc/lint-md.mjs $(LINT_MD_FILES)

# Lint all changed markdown files maintained by us
tools/.mdlintstamp: tools/lint-md/node_modules/remark-parse/package.json $(LINT_MD_FILES)
tools/.mdlintstamp: tools/doc/node_modules $(LINT_MD_FILES)
$(info Running Markdown linter...)
@$(call available-node,$(run-lint-md))
@touch $@

.PHONY: lint-md
lint-md: lint-js-doc | tools/.mdlintstamp ## Lint the markdown documents maintained by us in the codebase.

run-format-md = tools/lint-md/lint-md.mjs --format $(LINT_MD_FILES)
run-format-md = tools/doc/lint-md.mjs --format $(LINT_MD_FILES)
.PHONY: format-md
format-md: tools/lint-md/node_modules/remark-parse/package.json ## Format the markdown documents maintained by us in the codebase.
format-md: tools/doc/node_modules ## Format the markdown documents maintained by us in the codebase.
$(info Formatting Markdown...)
@$(call available-node,$(run-format-md))

Expand Down Expand Up @@ -1659,7 +1655,6 @@ lint-clean: ## Remove linting artifacts.
$(RM) tools/.*lintstamp
$(RM) .eslintcache
$(RM) -r tools/eslint/node_modules
$(RM) -r tools/lint-md/node_modules
$(RM) tools/pip/site_packages

HAS_DOCKER ?= $(shell command -v docker > /dev/null 2>&1; [ $$? -eq 0 ] && echo 1 || echo 0)
Expand Down
18 changes: 9 additions & 9 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ professionalism across all documents.
7. [Formatting](#formatting)
8. [Product and Project Naming](#product-and-project-naming)

***
---

## General guidelines

Expand All @@ -38,7 +38,7 @@ professionalism across all documents.

* Validate documentation changes using `make test-doc -j` or `vcbuild test-doc`.

***
---

## Writing style

Expand Down Expand Up @@ -68,7 +68,7 @@ professionalism across all documents.
* Use precise technical terms and avoid colloquialisms.
* Define any specialized terms or acronyms at first use.

***
---

## Punctuation

Expand All @@ -87,7 +87,7 @@ professionalism across all documents.
* Use colons to introduce lists or explanations.
* Use semicolons to link closely related independent clauses.

***
---

## Document structure

Expand All @@ -109,7 +109,7 @@ professionalism across all documents.

* Use tables to present structured information clearly. Ensure they are readable in plain text.

***
---

## API documentation

Expand All @@ -129,7 +129,7 @@ professionalism across all documents.
* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.
```

***
---

## Code blocks

Expand Down Expand Up @@ -165,7 +165,7 @@ professionalism across all documents.
* Use comments to explain complex logic within code examples.
* Follow the standard commenting style of the respective language.

***
---

## Formatting

Expand Down Expand Up @@ -198,7 +198,7 @@ professionalism across all documents.
* Returns: {AsyncHook} A reference to `asyncHook`.
```

***
---

## Product and project naming

Expand All @@ -225,7 +225,7 @@ professionalism across all documents.

For topics not addressed here, please consult the [Microsoft Writing Style Guide][].

***
---

[Microsoft Writing Style Guide]: https://learn.microsoft.com/en-us/style-guide/welcome/
[US spelling]: https://learn.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words
Expand Down
6 changes: 3 additions & 3 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@ changes:
description: The elements of `list` can now be `Uint8Array`s.
-->

* `list` {Buffer\[] | Uint8Array\[]} List of `Buffer` or {Uint8Array}
* `list` {Buffer\[]|Uint8Array\[]} List of `Buffer` or {Uint8Array}
instances to concatenate.
* `totalLength` {integer} Total length of the `Buffer` instances in `list`
when concatenated.
Expand Down Expand Up @@ -5288,7 +5288,7 @@ added:
- v18.15.0
-->

* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
* `input` {Buffer|ArrayBuffer|TypedArray} The input to validate.
* Returns: {boolean}

This function returns `true` if `input` contains only valid ASCII-encoded data,
Expand All @@ -5304,7 +5304,7 @@ added:
- v18.14.0
-->

* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
* `input` {Buffer|ArrayBuffer|TypedArray} The input to validate.
* Returns: {boolean}

This function returns `true` if `input` contains only valid UTF-8-encoded data,
Expand Down
Loading
Loading