From a63c1d3c19a3296db79a3c41e53a79f52230ab55 Mon Sep 17 00:00:00 2001 From: Kevin Van Lierde Date: Mon, 12 Jun 2023 00:44:21 +0200 Subject: [PATCH] Renames default export to 'metadata' for better editor intellisense --- lib/index.d.ts | 6 ++---- src/index.js | 4 ++-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index b6baa08..fbeeebd 100644 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -1,6 +1,6 @@ import Metalsmith from "metalsmith"; -export default initMetadata; +export default metadata; export type Options = { [key: string]: string; }; @@ -16,7 +16,5 @@ export type Options = { * // target a keypath * metalsmith.use(metadata({ 'config.nav.items': 'navitems.yaml' })) * ``` - * @param {Options} options - * @returns {import('metalsmith').Plugin} */ -declare function initMetadata(options?: Options): Metalsmith.Plugin; +declare function metadata(options?: Options): Metalsmith.Plugin; diff --git a/src/index.js b/src/index.js index 26f2d59..1673b59 100644 --- a/src/index.js +++ b/src/index.js @@ -62,7 +62,7 @@ function normalizeOptions(options) { * @param {Options} options * @returns {import('metalsmith').Plugin} */ -function initMetadata(options = {}) { +function metadata(options = {}) { options = normalizeOptions(options) if (Object.keys(options).length === 0) { return function metadata(files, metalsmith, done) { @@ -238,4 +238,4 @@ function initMetadata(options = {}) { } } -export default initMetadata +export default metadata