Skip to content

Commit

Permalink
Change to require Node.js 18
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Sep 27, 2024
1 parent c95f89a commit fcd9e43
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
24 changes: 21 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,18 @@
* [`Options`](#options)
* [`unified().use(remarkLintNoDeadUrls[, options])`](#unifieduseremarklintnodeadurls-options)
* [Related](#related)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)

## What is this?

This package checks whether URLs are alive or not.
This lint rule checks whether URLs are alive or not.

## When should I use this?

You can use this package to check that URLs are alive.
You can use this lint rule to check that URLs are alive.

It’s similar to [`remark-validate-links`][github-remark-validate-links],
but there’s an important difference.
Expand All @@ -48,7 +50,7 @@ You can use it when you want to check URLs programmatically yourself.
## Install

This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
In Node.js (version 18+),
install with [npm][npm-install]:

```sh
Expand Down Expand Up @@ -184,6 +186,22 @@ Transform (`(tree: Root, file: VFile) => Promise<Root>`).
* [`remark-validate-links`][github-remark-validate-links]
— ensure local links work

## Compatibility

This projects is compatible with maintained versions of Node.js.

When we cut a new major release,
we drop support for unmaintained versions of Node.
This means we try to keep the current release line,
`remark-lint-no-dead-urls@2`,
compatible with Node.js 18.

## Security

This package can typically be considered safe.
Note that this package checks URLs over the internet.
Don’t use this if you consider that’s dangerous.

## Contribute

See [`contributing.md`][health-contributing] in [`remarkjs/.github`][health]
Expand Down
4 changes: 2 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
"declarationMap": true,
"emitDeclarationOnly": true,
"exactOptionalPropertyTypes": true,
"lib": ["es2020"],
"lib": ["es2022"],
"module": "node16",
"strict": true,
"target": "es2020"
"target": "es2022"
},
"exclude": ["coverage/", "node_modules/"],
"include": ["**/*.js", "index.d.ts"]
Expand Down

0 comments on commit fcd9e43

Please sign in to comment.