feat(generate): add flags to skip default steps

Using --skip-live or --skip-components you may now
opt-out of bookshop/generate building those files for you.

Author: bglw

javascript-modules/generate/main.js

@@ -32,6 +32,8 @@ const addComponentTo = (obj, component) => {
 
 async function run() {
     program.option("-d, --dot", "Look for Bookshops inside . directories");
+    program.option("--skip-live", "Don't build live editing JS or add live editing scripts to HTML");
+    program.option("--skip-components", "Don't build the component browser JS or add component browser scripts to HTML");
     program.parse(process.argv);
     const options = program.opts();
 
@@ -94,14 +96,22 @@ async function run() {
         fs.writeFileSync(infoJsonFile, JSON.stringify(info_json, null, 2));
         console.log(`📚 ———— Added components as CloudCannon Structures`);
 
-        const liveEditingNeeded = await hydrateLiveForSite(siteRoot, options);
-        if (liveEditingNeeded) {
-            await buildLiveScript(siteRoot, bookshopRoots);
+        if (!options.skipLive) {
+            const liveEditingNeeded = await hydrateLiveForSite(siteRoot, options);
+            if (liveEditingNeeded) {
+                await buildLiveScript(siteRoot, bookshopRoots);
+            }
+        } else {
+            console.log(`📚 ———— Skipping live editing generation`);
         }
 
-        const componentBrowserNeeded = await hydrateComponentBrowserForSite(siteRoot, options);
-        if (componentBrowserNeeded) {
-            await buildBrowserScript(siteRoot, bookshopRoots);
+        if (!options.skipComponents) {
+            const componentBrowserNeeded = await hydrateComponentBrowserForSite(siteRoot, options);
+            if (componentBrowserNeeded) {
+                await buildBrowserScript(siteRoot, bookshopRoots);
+            }
+        } else {
+            console.log(`📚 ———— Skipping component browser generation`);
         }
     }
 

javascript-modules/integration-tests/features/generate/structure_generation.feature

@@ -78,3 +78,10 @@ Feature: Bookshop Structure Generation
     And site/public/_cloudcannon/bookshop-live.js should leniently contain each row: 
       | text |
       | {{ .card_text }} |
+
+  Scenario: Can skip live editing
+    When I run "npm run generate-no-live" in the . directory
+    Then stderr should be empty
+    And stdout should contain "Skipping live editing generation"
+    And site/public/index.html should not contain the text "_cloudcannon"
+    And site/public/_cloudcannon/bookshop-live.js should not exist

javascript-modules/integration-tests/support/starters/generate/package.json

@@ -3,9 +3,10 @@
   "private": true,
   "scripts": {
     "start": "bookshop-generate",
+    "generate-no-live": "bookshop-generate --skip-live",
     "cc-hugo": "cloudcannon-hugo --baseURL /"
   },
   "devDependencies": {
     "@bookshop/generate": "file:../../../javascript-modules/generate"
   }
-}
+}