Renames default export to 'metadata' for better editor intellisense

metalsmith · Jun 11, 2023 · a63c1d3 · a63c1d3
1 parent 28a0cc5
commit a63c1d3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git 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
@@ -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