Renames default export to layouts for better intellisense

metalsmith · Apr 3, 2023 · 10eaa0c · 10eaa0c
1 parent f8cd111
commit 10eaa0c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1,7 +1,7 @@
 import { Plugin } from "metalsmith";
 import getTransformer from "./get-transformer";
 
-export default initLayouts;
+export default layouts;
 /**
  * `@metalsmith/layouts` options
  */
@@ -32,7 +32,7 @@ export type Options = {
  * @param {Options} options
  * @returns {import('metalsmith').Plugin}
  */
-declare function initLayouts(options: Options): Plugin;
-declare namespace initLayouts {
+declare function layouts(options: Options): Plugin;
+declare namespace layouts {
     export { getTransformer };
 }
diff --git a/src/index.js b/src/index.js
@@ -109,7 +109,7 @@ function validate({ filename, files, settings }) {
  * @param {Options} options
  * @returns {import('metalsmith').Plugin}
  */
-function initLayouts(options) {
+function layouts(options) {
   return function layouts(files, metalsmith, done) {
     debug = metalsmith.debug('@metalsmith/layouts')
 
@@ -167,5 +167,5 @@ function initLayouts(options) {
 // ensures non-breaking change:
 // import { getTransformer } from '@metalsmith/layouts' instead of
 // import getTransformer from '@metalsmith/layouts/get-transformer'
-initLayouts.getTransformer = getTransformer
-export default initLayouts
+layouts.getTransformer = getTransformer
+export default layouts