Update DefaultSetter TS type signature; minor enhancements

Author: webketje

lib/index.d.ts

@@ -1,13 +1,17 @@
-import { Plugin, File } from 'metalsmith';
+import Metalsmith, { Plugin, File, Files } from 'metalsmith';
 
 export default defaultValues;
 
-export type DefaultSetter<FileMeta, GlobalMeta> = (data:FileMeta, metadata: GlobalMeta) => any
-export interface DefaultsSet<FileMeta = File, GlobalMeta = {[key:string]:any}> {
+export type DefaultSetter<FileMeta extends File = File> = (
+  currentFile: Readonly<FileMeta>, 
+  currentPath: Readonly<string>,
+  files:Readonly<Files>,
+  metalsmith:Readonly<Metalsmith>
+) => any
+
+export interface DefaultsSet<FileMeta extends File = File> {
   /** an object whose keys will be set as file metadata keys */
-  defaults: {
-    [key:string]: DefaultSetter<FileMeta, GlobalMeta>|string|boolean|number|Object;
-  }
+  defaults: Record<string, DefaultSetter<FileMeta>|string|boolean|number|object>
   /**
    * 1 or more glob patterns to match files.
    * @default '**'
@@ -19,20 +23,21 @@ export interface DefaultsSet<FileMeta = File, GlobalMeta = {[key:string]:any}> {
    */
   strategy?: 'keep'|'overwrite'
 }
-export type Options<FileMeta, GlobalMeta> = DefaultsSet<FileMeta, GlobalMeta>|DefaultsSet<FileMeta, GlobalMeta>[]
+export type Options<FileMeta extends File = File> = DefaultsSet<FileMeta>|DefaultsSet<FileMeta>[]
 /**
- * Set `defaults` to file metadata matching `pattern`'s.
+ * Set `defaults` or _computed values_ to file metadata matching `pattern`'s.
  * 
  * @example
- * metalsmith.use(defaultValues({
-    pattern: 'posts/*.md',
-    defaults: {
-      layout: 'post.hbs',
-      draft: false,
-      date(post) {
-        return post.stats.ctime
-      }
-    }
-  }))
+ * metalsmith.use(defaultValues([{
+ *  pattern: 'posts/*.md',
+ *  defaults: {
+ *    layout: 'post.hbs',
+ *    draft: false,
+ *    'some.nested.property': true,
+ *    isodate(post, postPath, allFiles, metalsmith) {
+ *      return new Date(post.stats.ctime).toISOString()
+ *    }
+ *  }
+ *}))
  **/
-declare function defaultValues<FileMeta = File, GlobalMeta = {[key:string]:any}>(options: Options<FileMeta, GlobalMeta>): Plugin;
+declare function defaultValues<FileMeta extends File = File>(options: Options<FileMeta>): Plugin;

src/index.js

@@ -2,8 +2,10 @@ import getDefaultsSetter from './set_defaults.js'
 
 /**
  * @callback DefaultSetter
- * @param {import('metalsmith').File} file
- * @param {Object<string, *>} metadata
+ * @param {import('metalsmith').File} currentFile
+ * @param {string} currentPath
+ * @param {import('metalsmith').Files} files
+ * @param {import('metalsmith')} metadata
  */
 
 /**
@@ -51,7 +53,7 @@ function defaultValues(options) {
       options = [options]
     }
     debug('Running with options: %O ', options)
-    const defaultSets = (options || []).map((defaultsSet) => ({ ...defaultDefaultsSet, ...defaultsSet }))
+    const defaultSets = options.map((defaultsSet) => ({ ...defaultDefaultsSet, ...defaultsSet }))
 
     // Loop through configurations
     defaultSets.forEach(function ({ pattern, defaults, strategy }) {

test/index.js

@@ -1,4 +1,3 @@
-/* eslint-env node, mocha */
 import { fileURLToPath } from 'node:url'
 import { readFileSync } from 'node:fs'
 import assert from 'node:assert'

test/index.ts

@@ -6,14 +6,20 @@ type File = Metalsmith.File<{
   draft?: boolean
 }>
 
-defaultValues<File, { buildVersion: 'v1.0.0' }>({
+type Meta = {
+  buildVersion: string
+}
+
+defaultValues<File>({
   strategy: 'overwrite',
   pattern: '**/*.html',
   defaults: {
     excerpt(file) {
       return file.contents.toString().slice(0, 250) + '...'
     },
-    buildVersion(_, meta) {
+    buildVersion(_, path, files, metalsmith) {
+      files[path].contents
+      const meta = metalsmith.metadata() as Meta
       return meta.buildVersion
     },
     draft(file) {