.github/workflows/main.yml

@@ -17,5 +17,5 @@ jobs:
     strategy:
       matrix:
         node:
-          - lts/hydrogen
+          - lts/gallium
           - node

.npmrc

@@ -1,2 +1,2 @@
-package-lock=false
 ignore-scripts=true
+package-lock=false

lib/index.js

@@ -1,13 +1,10 @@
-/**
- * @typedef {import('hast').Element} Element
- */
-
 import {convertElement} from 'hast-util-is-element'
 
+const names = new Set(['h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hgroup'])
+
 /**
  * Check if the given value is a *heading content* element.
  *
- * @type {import('hast-util-is-element').AssertPredicate<Element & {tagName: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'hgroup'}>}
  * @param node
  *   Thing to check (typically `Node`).
  * @returns
@@ -16,13 +13,12 @@ import {convertElement} from 'hast-util-is-element'
  *   The elements `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, and `hgroup` are
  *   heading content.
  */
-// @ts-expect-error Sure, the assertion matches.
-export const heading = convertElement([
-  'h1',
-  'h2',
-  'h3',
-  'h4',
-  'h5',
-  'h6',
-  'hgroup'
-])
+export const heading = convertElement(
+  /**
+   * @param element
+   * @returns {element is {tagName: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'hgroup'}}
+   */
+  function (element) {
+    return names.has(element.tagName)
+  }
+)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hast-util-heading",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "hast utility to check if a node is a heading element",
   "license": "MIT",
   "keywords": [
@@ -25,54 +25,54 @@
   ],
   "sideEffects": false,
   "type": "module",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "exports": "./index.js",
   "files": [
     "lib/",
     "index.d.ts",
     "index.js"
   ],
   "dependencies": {
-    "@types/hast": "^2.0.0",
-    "hast-util-is-element": "^2.0.0"
+    "@types/hast": "^3.0.0",
+    "hast-util-is-element": "^3.0.0"
   },
   "devDependencies": {
-    "@types/node": "^18.0.0",
-    "c8": "^7.0.0",
-    "prettier": "^2.0.0",
+    "@types/node": "^20.0.0",
+    "c8": "^8.0.0",
+    "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
     "type-coverage": "^2.0.0",
-    "typescript": "^4.0.0",
-    "xo": "^0.53.0"
+    "typescript": "^5.0.0",
+    "xo": "^0.55.0"
   },
   "scripts": {
     "prepack": "npm run build && npm run format",
     "build": "tsc --build --clean && tsc --build && type-coverage",
-    "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
+    "format": "remark . -qfo && prettier . -w --log-level warn && xo --fix",
     "test-api": "node --conditions development test.js",
-    "test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api",
+    "test-coverage": "c8 --100 --reporter lcov npm run test-api",
     "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
-    "tabWidth": 2,
-    "useTabs": false,
-    "singleQuote": true,
     "bracketSpacing": false,
     "semi": false,
-    "trailingComma": "none"
-  },
-  "xo": {
-    "prettier": true
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "none",
+    "useTabs": false
   },
   "remarkConfig": {
     "plugins": [
-      "preset-wooorm"
+      "remark-preset-wooorm"
     ]
   },
   "typeCoverage": {
     "atLeast": 100,
     "detail": true,
+    "ignoreCatch": true,
     "strict": true
+  },
+  "xo": {
+    "prettier": true
   }
 }

readme.md

@@ -32,7 +32,7 @@ looking for!
 ## Install
 
 This package is [ESM only][esm].
-In Node.js (version 14.14+ and 16.0+), install with [npm][]:
+In Node.js (version 16+), install with [npm][]:
 
 ```sh
 npm install hast-util-heading
@@ -41,14 +41,14 @@ npm install hast-util-heading
 In Deno with [`esm.sh`][esmsh]:
 
 ```js
-import {heading} from 'https://esm.sh/hast-util-heading@2'
+import {heading} from 'https://esm.sh/hast-util-heading@3'
 ```
 
 In browsers with [`esm.sh`][esmsh]:
 
 ```html
 <script type="module">
-  import {heading} from 'https://esm.sh/hast-util-heading@2?bundle'
+  import {heading} from 'https://esm.sh/hast-util-heading@3?bundle'
 </script>
 ```
 
@@ -69,13 +69,14 @@ heading({
 heading({
   type: 'element',
   tagName: 'h1',
+  properties: {},
   children: [{type: 'text', value: 'Delta'}]
 }) // => true
 ```
 
 ## API
 
-This package exports the identifier [`heading`][heading].
+This package exports the identifier [`heading`][api-heading].
 There is no default export.
 
 ### `heading(value)`
@@ -101,10 +102,13 @@ It exports no additional types.
 
 ## Compatibility
 
-Projects maintained by the unified collective are compatible with all maintained
+Projects maintained by the unified collective are compatible with maintained
 versions of Node.js.
-As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+.
-Our projects sometimes work with older versions, but this is not guaranteed.
+
+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, `hast-util-heading@^3`,
+compatible with Node.js 16.
 
 ## Security
 
@@ -176,9 +180,9 @@ abide by its terms.
 
 [downloads]: https://www.npmjs.com/package/hast-util-heading
 
-[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-heading.svg
+[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-heading
 
-[size]: https://bundlephobia.com/result?p=hast-util-heading
+[size]: https://bundlejs.com/?q=hast-util-heading
 
 [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
 
@@ -218,4 +222,4 @@ abide by its terms.
 
 [xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
 
-[heading]: #headingvalue
+[api-heading]: #headingvalue

test.js

@@ -1,49 +1,60 @@
 import assert from 'node:assert/strict'
 import test from 'node:test'
-import {heading} from './index.js'
-import * as mod from './index.js'
+import {heading} from 'hast-util-heading'
 
-test('heading', () => {
-  assert.deepEqual(
-    Object.keys(mod).sort(),
-    ['heading'],
-    'should expose the public api'
-  )
+test('heading', async function (t) {
+  await t.test('should expose the public api', async function () {
+    assert.deepEqual(Object.keys(await import('hast-util-heading')).sort(), [
+      'heading'
+    ])
+  })
 
-  assert.equal(heading(), false, 'should return `false` without node')
+  await t.test('should return `false` without node', async function () {
+    // @ts-expect-error: check how a missing `node` is handled.
+    assert.equal(heading(), false)
+  })
 
-  assert.equal(heading(null), false, 'should return `false` with `null`')
+  await t.test('should return `false` with `null`', async function () {
+    assert.equal(heading(null), false)
+  })
 
-  assert.equal(
-    heading({type: 'text'}),
-    false,
-    'should return `false` when without `element`'
+  await t.test(
+    'should return `false` when without `element`',
+    async function () {
+      assert.equal(heading({type: 'text'}), false)
+    }
   )
 
-  assert.equal(
-    heading({type: 'element'}),
-    false,
-    'should return `false` when with invalid `element`'
+  await t.test(
+    'should return `false` when with invalid `element`',
+    async function () {
+      assert.equal(heading({type: 'element'}), false)
+    }
   )
 
-  assert.equal(
-    heading({
-      type: 'element',
-      tagName: 'a',
-      properties: {href: '#alpha', title: 'Bravo'},
-      children: [{type: 'text', value: 'Charlie'}]
-    }),
-    false,
-    'should return `false` when without not heading'
+  await t.test(
+    'should return `false` when without not heading',
+    async function () {
+      assert.equal(
+        heading({
+          type: 'element',
+          tagName: 'a',
+          properties: {href: '#alpha', title: 'Bravo'},
+          children: [{type: 'text', value: 'Charlie'}]
+        }),
+        false
+      )
+    }
   )
 
-  assert.equal(
-    heading({
-      type: 'element',
-      tagName: 'h1',
-      children: [{type: 'text', value: 'Delta'}]
-    }),
-    true,
-    'should return `true` when with heading'
-  )
+  await t.test('should return `true` when with heading', async function () {
+    assert.equal(
+      heading({
+        type: 'element',
+        tagName: 'h1',
+        children: [{type: 'text', value: 'Delta'}]
+      }),
+      true
+    )
+  })
 })

tsconfig.json

@@ -1,17 +1,15 @@
 {
-  "include": ["**/**.js"],
-  "exclude": ["coverage/", "node_modules/"],
   "compilerOptions": {
     "checkJs": true,
+    "customConditions": ["development"],
     "declaration": true,
     "emitDeclarationOnly": true,
     "exactOptionalPropertyTypes": true,
-    "forceConsistentCasingInFileNames": true,
-    "lib": ["es2020"],
+    "lib": ["es2022"],
     "module": "node16",
-    "newLine": "lf",
-    "skipLibCheck": true,
     "strict": true,
-    "target": "es2020"
-  }
+    "target": "es2022"
+  },
+  "exclude": ["coverage/", "node_modules/"],
+  "include": ["**/*.js"]
 }