reexport gulp again. support async twig.logicLoader

bemit · Sep 12, 2021 · 6ff008a · 6ff008a
1 parent c621af9
commit 6ff008a
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 59 deletions.
diff --git a/Gulpfile.js b/Gulpfile.js
@@ -39,6 +39,9 @@ const tasks = ampCreator({
                 canonical: 'http://localhost:4488/' + file.relative,
             },
         }),
+        logicLoader: async () => {
+            return {}
+        },
     },
     prettyUrlExtensions: ['html'],
 })

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,9 +1,10 @@
 {
     "name": "create-amp-page",
-    "version": "1.0.0-alpha.1",
+    "version": "1.0.0-alpha.2",
     "license": "MIT",
     "homepage": "https://github.com/bemit/create-amp-page",
     "author": "Michael Becker <https://mlbr.xyz>",
+    "description": "Full fledged static side generator composed out of extendable gulp tasks, optimized for - but not limited to - AMP.",
     "keywords": [
         "amp",
         "accelerated-mobile-pages",

diff --git a/src/AmpCreatorOptions.d.ts b/src/AmpCreatorOptions.d.ts
@@ -112,7 +112,10 @@ export interface AmpCreatorOptions {
         logicLoader?: () => {
             functions?: TwigFunction[]
             filters?: TwigFunction[]
-        }
+        } | Promise<{
+            functions?: TwigFunction[]
+            filters?: TwigFunction[]
+        }>
         // output file extension including the '.' like path.extname(filename). Use true to keep source extname and a "falsy" value to drop the file extension
         outputExtname?: string | boolean
         // enables debug info logging

diff --git a/src/htmlTask/htmlTask.js b/src/htmlTask/htmlTask.js
@@ -30,54 +30,56 @@ export const makeTwigHandler = ({
         addImageSuffix,
     ]
 
-    return () => subpipe((stream) => {
+    return async () => {
         // share twig logic for `twig-as-entrypoint` and `frontmatter-as-entrypoint` (collections)
         const extraLogic = {
             functions: undefined,
             filters: undefined,
         }
         if(twig.logicLoader) {
-            const logic = twig.logicLoader()
+            const logic = await twig.logicLoader()
             if(logic.functions) {
                 extraLogic.functions = logic.functions
             }
             if(logic.filters) {
                 extraLogic.filters = logic.filters
             }
         }
-        return stream
-            .pipe(twigGulp({
-                base: paths.html,
-                extend: twig && twig.extend,
-                functions: [
-                    ...extendedTwigFunctions,
-                    ...(twig && twig.functions ? twig.functions : []),
-                    ...(extraLogic.functions || []),
-                ],
-                filters: [
-                    ...(twig && twig.filters ? twig.filters : []),
-                    ...(extraLogic.filters || []),
-                ],
-                extname: twig && typeof twig.outputExtname !== 'undefined' ? twig.outputExtname : '.html',
-                cache: !!(twig && twig.cache),
-                debug: !!(twig && twig.debug),
-                trace: !!(twig && twig.trace),
-            }))
-            // middlewares after twig compilation
-            // middlewares for style injection
-            .pipe(injectCSS({
-                paths, injectTag: cssInjectTag,
-                failOnSize: process.env.NODE_ENV === 'production',
-                cssBuffer: cssBuffer,
-            }))
-            // middlewares after CSS injection
-            .pipe(cleanHtmlCss({
-                minifyHtml,
-                cleanInlineCSS,
-                cleanInlineCSSWhitelist,
-            }))
-            .pipe(ampOptimizer(ampOptimize))
-    })
+        return subpipe((stream) =>
+            stream
+                .pipe(twigGulp({
+                    base: paths.html,
+                    extend: twig && twig.extend,
+                    functions: [
+                        ...extendedTwigFunctions,
+                        ...(twig && twig.functions ? twig.functions : []),
+                        ...(extraLogic.functions || []),
+                    ],
+                    filters: [
+                        ...(twig && twig.filters ? twig.filters : []),
+                        ...(extraLogic.filters || []),
+                    ],
+                    extname: twig && typeof twig.outputExtname !== 'undefined' ? twig.outputExtname : '.html',
+                    cache: Boolean(twig && twig.cache),
+                    debug: Boolean(twig && twig.debug),
+                    trace: Boolean(twig && twig.trace),
+                }))
+                // middlewares after twig compilation
+                // middlewares for style injection
+                .pipe(injectCSS({
+                    paths, injectTag: cssInjectTag,
+                    failOnSize: process.env.NODE_ENV === 'production',
+                    cssBuffer: cssBuffer,
+                }))
+                // middlewares after CSS injection
+                .pipe(cleanHtmlCss({
+                    minifyHtml,
+                    cleanInlineCSS,
+                    cleanInlineCSSWhitelist,
+                }))
+                .pipe(ampOptimizer(ampOptimize)),
+        )
+    }
 }
 
 export const makeHtmlTask = (
@@ -94,31 +96,41 @@ export const makeHtmlTask = (
     const htmlTasks = []
 
     const twigHandler = makeTwigHandler({paths, twig, ...options})
-    htmlTasks.push(function pagesByTemplates() {
-        return gulp.src(paths.htmlPages + '/*.twig')
-            .pipe(twigDataHandler(twig))
-            .pipe(twigHandler())
-            .pipe(gulp.dest(paths.dist))
-            .pipe(browsersync.stream())
-    })
+    htmlTasks.push(
+        function pagesByTemplates() {
+            return new Promise(async (resolve, reject) => {
+                gulp.src(paths.htmlPages + '/*.twig')
+                    .pipe(twigDataHandler(twig))
+                    .pipe(await twigHandler())
+                    .pipe(gulp.dest(paths.dist))
+                    .pipe(browsersync.stream())
+                    .on('finish', resolve)
+                    .on('error', reject)
+            })
+        },
+    )
 
     if(collections && Array.isArray(collections)) {
         collections.forEach(collection => {
             htmlTasks.push(
                 function pagesByFrontmatter() {
-                    return gulp.src(collection.data)
-                        .pipe(twigMultiLoad(
-                            {
-                                ...twig,
-                                ...(collection.fmMap ? {fmMap: collection.fmMap} : {}),
-                                ...(collection.customMerge ? {customMerge: collection.customMerge} : {}),
-                            },
-                            collection.tpl,
-                        ))
-                        .pipe(twigHandler())
-                        .pipe(twigMultiSave(collection.ext))
-                        .pipe(gulp.dest(path.join(paths.dist, collection.base)))
-                        .pipe(browsersync.stream())
+                    return new Promise(async (resolve, reject) => {
+                        gulp.src(collection.data)
+                            .pipe(twigMultiLoad(
+                                {
+                                    ...twig,
+                                    ...(collection.fmMap ? {fmMap: collection.fmMap} : {}),
+                                    ...(collection.customMerge ? {customMerge: collection.customMerge} : {}),
+                                },
+                                collection.tpl,
+                            ))
+                            .pipe(await twigHandler())
+                            .pipe(twigMultiSave(collection.ext))
+                            .pipe(gulp.dest(path.join(paths.dist, collection.base)))
+                            .pipe(browsersync.stream())
+                            .on('finish', resolve)
+                            .on('error', reject)
+                    })
                 },
             )
         })

diff --git a/src/index.js b/src/index.js
@@ -1,2 +1,3 @@
 export * from './ampCreator.js'
 export * from './AmpCreatorOptions.js'
+export * from 'gulp'