Skip to content

Require Node.js 20 and update CI/docs #1832

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.

Sign up for GitHub

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

Merged
coliff merged 1 commit into from
Mar 22, 2026
+25 −6
Merged

Require Node.js 20 and update CI/docs #1832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ We welcome any type of contribution, not only code. You can help with
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
- **Code**: take a look at the [open issues](https://github.com/HTMLHint/HTMLHint/issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.

## Development setup

Use Node.js 20 or later (the repo pins a version with [Volta](https://volta.sh/) in `package.json`).

## Submitting code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
Expand Down
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- All code should be formatted with Prettier.
- Use ESLint to check for JavaScript errors.
- Rollup is used for building the project.
- Node v20 is used for development.
- Node.js 20 or newer is required; Volta pins the repo to Node 20 LTS in `package.json`.
- Core code is in TypeScript v5.4.5.
- All new rules for HTMLHint should be placed in the rules directory.
- Tests for new rules should be added in rules and follow the naming pattern `<rule-name>.spec.js`.
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/ossf-scorecard.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ on:
push:
branches: ['main']

concurrency:
group: scorecard-${{ github.ref }}
cancel-in-progress: true

permissions: read-all

jobs:
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/spellcheck.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ on:
pull_request:
branches: [main]

concurrency:
group: spellcheck-${{ github.ref }}
cancel-in-progress: true

permissions:
contents: read

Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/super-linter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ on:
branches-ignore:
- 'dependabot/**'

concurrency:
group: super-linter-${{ github.event.pull_request.number || github.ref }}
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

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

The concurrency group here differs between push and pull_request runs (PR uses the number; push uses the ref). That means a push-triggered run on a PR branch won’t be canceled when the pull_request-triggered run starts, so you can still get duplicate runs for the same branch/PR. Consider using a shared key like the head branch name for PRs (e.g., github.head_ref) and github.ref_name for pushes, or drop the push trigger if pull_request coverage is sufficient.

Suggested change
group: super-linter-${{ github.event.pull_request.number || github.ref }}
group: super-linter-${{ github.head_ref || github.ref_name }}

Copilot uses AI. Check for mistakes.
cancel-in-progress: true

permissions:
contents: read

Expand Down
1 change: 0 additions & 1 deletion .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ jobs:
fail-fast: false
matrix:
node:
- 18
- 20
- 22
- 24
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v20
v20.20.1
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@

## 📟 Installation and Usage

HTMLHint requires [Node.js](https://nodejs.org/) 20 or later.

There are two ways to install HTMLHint: globally and locally.

### Local Installation and Usage
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@
"typescript": "5.4.5"
},
"engines": {
"node": ">=18"
"node": ">=20"
},
"volta": {
"node": "18.20.8"
"node": "20.20.1"
}
}
2 changes: 2 additions & 0 deletions website/src/content/docs/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: How to set up HTMLHint in your project by adding it as a dev depend

import { Tabs, TabItem } from '@astrojs/starlight/components';

HTMLHint requires Node.js 20 or later.

1\. Use npm or yarn to install HTMLHint:

<Tabs>
Expand Down
Loading