Add augmentation of types in file.data.meta

.gitignore

@@ -1,6 +1,7 @@
 coverage/
 node_modules/
 .DS_Store
-*.d.ts
+test/*.d.ts
+index.d.ts
 *.log
 yarn.lock

complex-types.d.ts

@@ -0,0 +1,29 @@
+// Need a random export to turn this into a module?
+export type Whatever = unknown
+
+declare module 'vfile' {
+  interface DataMap {
+    meta: {
+      /**
+       * Date when this content was first published.
+       *
+       * Populated by `unified-infer-git-meta` from Git history.
+       */
+      published?: Date
+
+      /**
+       * Date when this content was last modified.
+       *
+       * Populated by `unified-infer-git-meta` from Git history.
+       */
+      modified?: Date
+
+      /**
+       * Authors who contributed to this content.
+       *
+       * Populated by `unified-infer-git-meta` from Git history.
+       */
+      author?: string
+    }
+  }
+}

index.js

@@ -1,4 +1,6 @@
 /**
+ * @typedef {import('./complex-types.js')} DoNotTouchThisAsItIncludesAugmentation
+ *
  * @callback Format
  *   Format function.
  * @param {Array<string>} authors
@@ -111,9 +113,8 @@ export default function unifiedInferGitMeta(options = {}) {
     const matter = /** @type {Record<string, unknown>} */ (
       file.data.matter || {}
     )
-    const meta = /** @type {Record<string, unknown>} */ (
-      file.data.meta || (file.data.meta = {})
-    )
+    const meta = file.data.meta || (file.data.meta = {})
+
     if (!matter.published && !meta.published) meta.published = published
     if (!matter.modified && !meta.modified) meta.modified = modified
     if (author && !matter.author && !meta.author) meta.author = author

package.json

@@ -26,6 +26,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
+    "complex-types.d.ts",
     "index.d.ts",
     "index.js"
   ],
@@ -58,7 +59,7 @@
     "xo": "^0.50.0"
   },
   "scripts": {
-    "build": "rimraf \"*.d.ts\" \"test/**/*.d.ts\" && tsc && type-coverage",
+    "build": "rimraf \"{index,test}.d.ts\" \"test/**/*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "test-api": "node --conditions development test/index.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test/index.js",

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "include": ["*.js", "test/**/*.js"],
+  "include": ["test/**/*.js", "*.js"],
   "compilerOptions": {
     "target": "ES2020",
     "lib": ["ES2020"],