refactor: generate .d.ts from jsdoc (#10)

.github/workflows/release.yml

@@ -18,6 +18,7 @@ jobs:
           node-version: 18.x
           registry-url: https://registry.npmjs.org
       - run: pnpm install
+      - run: pnpm build
       - run: pnpm publish --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

@@ -38,6 +38,7 @@
     "url": "https://github.com/ykzts/edge-sitemap.git"
   },
   "scripts": {
+    "build": "tsc",
     "format": "prettier -w .",
     "lint": "eslint src",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest src"

src/.gitignore

@@ -0,0 +1 @@
+*.d.ts

src/index.js

@@ -4,8 +4,8 @@
 
 /**
  * @typedef {Object} SitemapItem
- * @property {SitemapChangeFreq} changefreq
- * @property {`${number}-${number}-${number}`} lastmod
+ * @property {SitemapChangeFreq=} changefreq
+ * @property {`${number}-${number}-${number}`=} lastmod
  * @property {(URL|string)} loc
  * @property {number=} priority
  */
@@ -28,9 +28,14 @@ export class SitemapTransformer {
   #indent
 
   /**
-   * @param {SitemapStreamOptions=} options
+   * @param {SitemapTransformerOptions=} options
    */
-  constructor({ baseURL, pretty = false } = {}) {
+  constructor(
+    /** @todo https://github.com/microsoft/TypeScript/pull/52880 */
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    { baseURL, pretty = false } = {}
+  ) {
     this.#baseURL = baseURL
     this.#lf = pretty ? '\n' : ''
     this.#indent = pretty ? '  ' : ''
@@ -108,7 +113,12 @@ export class SitemapStream extends TransformStream {
   /**
    * @param {SitemapStreamOptions=} options
    */
-  constructor({ baseURL, pretty = false } = {}) {
+  constructor(
+    /** @todo https://github.com/microsoft/TypeScript/pull/52880 */
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    { baseURL, pretty = false } = {}
+  ) {
     super(new SitemapTransformer({ baseURL, pretty }))
   }
 }

src/index.test.js

@@ -1,5 +1,5 @@
 import { expect, test } from '@jest/globals'
-import { SitemapStream } from '.'
+import { SitemapStream } from './index.js'
 
 /**
  * @param {import('.').SitemapItem[]} sitemapItems

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "module": "Node16",
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ES2022"
+  },
+  "exclude": ["./src/**/*.d.ts", "./src/**/*.test.js"],
+  "include": ["./src/**/*"]
+}