Refactor to use interface for exposed types

Author: wooorm

.gitignore

@@ -6,3 +6,4 @@
 coverage/
 node_modules/
 yarn.lock
+!/index.d.ts

index.d.ts

@@ -0,0 +1,13 @@
+import type {Options as MicromarkOptions} from 'micromark-extension-gfm'
+import type {Options as MdastOptions} from 'mdast-util-gfm'
+
+export {default} from './lib/index.js'
+
+/**
+ * Configuration for `remark-gfm`.
+ *
+ * Currently supports `singleTilde` as a parse option and
+ * `tableCellPadding`, `tablePipeAlign`, and `stringLength` as
+ * a serialization option.
+ */
+export interface Options extends MicromarkOptions, MdastOptions {}

index.js

@@ -1,5 +1,2 @@
-/**
- * @typedef {import('./lib/index.js').Options} Options
- */
-
+// Note: types exposed from `index.d.ts`.
 export {default} from './lib/index.js'

lib/index.js

@@ -1,17 +1,11 @@
 /**
- * @import {Options as MdastOptions} from 'mdast-util-gfm'
  * @import {Root} from 'mdast'
- * @import {Options as MicromarkOptions} from 'micromark-extension-gfm'
+ * @import {Options} from 'remark-gfm'
  * @import {} from 'remark-parse'
  * @import {} from 'remark-stringify'
  * @import {Processor} from 'unified'
  */
 
-/**
- * @typedef {MicromarkOptions & MdastOptions} Options
- *   Configuration.
- */
-
 import {gfmFromMarkdown, gfmToMarkdown} from 'mdast-util-gfm'
 import {gfm} from 'micromark-extension-gfm'
 

package.json

@@ -29,7 +29,6 @@
   },
   "exports": "./index.js",
   "files": [
-    "index.d.ts.map",
     "index.d.ts",
     "index.js",
     "lib/"
@@ -86,6 +85,29 @@
   "version": "4.0.0",
   "xo": {
     "overrides": [
+      {
+        "files": [
+          "**/*.d.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/array-type": [
+            "error",
+            {
+              "default": "generic"
+            }
+          ],
+          "@typescript-eslint/ban-types": [
+            "error",
+            {
+              "extendDefaults": true
+            }
+          ],
+          "@typescript-eslint/consistent-type-definitions": [
+            "error",
+            "interface"
+          ]
+        }
+      },
       {
         "files": [
           "test/**/*.js"

tsconfig.json

@@ -12,5 +12,5 @@
     "target": "es2022"
   },
   "exclude": ["coverage/", "node_modules/"],
-  "include": ["**/*.js"]
+  "include": ["**/*.js", "index.d.ts"]
 }