@shopify/cli-hydrogen 4.1.0 → 4.1.2

package/dist/lib/shopify-config.test.js

@@ -0,0 +1,209 @@
+import { describe, it, expect } from 'vitest';
+import { inTemporaryDirectory, mkdir, writeFile, fileExists, readFile } from '@shopify/cli-kit/node/fs';
+import { joinPath, dirname } from '@shopify/cli-kit/node/path';
+import { getConfig, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT, setShop, setStorefront, unsetStorefront, ensureShopifyGitIgnore } from './shopify-config.js';
+
+describe("getConfig()", () => {
+  describe("when no config exists", () => {
+    it("returns an empty object", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const config = await getConfig(tmpDir);
+        expect(config).toStrictEqual({});
+      });
+    });
+  });
+  describe("when a config exists", () => {
+    it("returns the config", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const existingConfig = {
+          shop: "my-shop"
+        };
+        const filePath = joinPath(tmpDir, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT);
+        await mkdir(dirname(filePath));
+        await writeFile(filePath, JSON.stringify(existingConfig));
+        const config = await getConfig(tmpDir);
+        expect(config).toStrictEqual(existingConfig);
+      });
+    });
+  });
+});
+describe("setShop()", () => {
+  describe("when no config exists", () => {
+    it("creates a new config file", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const filePath = joinPath(tmpDir, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT);
+        expect(await fileExists(filePath)).toBeFalsy();
+        await setShop(tmpDir, "new-shop");
+        expect(await fileExists(filePath)).toBeTruthy();
+      });
+    });
+    it("returns the new config", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const config = await setShop(tmpDir, "new-shop");
+        expect(config).toStrictEqual({
+          shop: "new-shop"
+        });
+      });
+    });
+  });
+  describe("when a config exists", () => {
+    it("updates the config file", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const existingConfig = {
+          shop: "previous-shop",
+          storefront: {
+            id: "gid://shopify/HydrogenStorefront/1",
+            title: "Hydrogen"
+          }
+        };
+        const filePath = joinPath(tmpDir, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT);
+        await mkdir(dirname(filePath));
+        await writeFile(filePath, JSON.stringify(existingConfig));
+        expect(JSON.parse(await readFile(filePath))).toStrictEqual(
+          existingConfig
+        );
+        await setShop(tmpDir, "new-shop");
+        expect(JSON.parse(await readFile(filePath))).toStrictEqual({
+          ...existingConfig,
+          shop: "new-shop"
+        });
+      });
+    });
+    it("returns the new config", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const existingConfig = {
+          shop: "previous-shop",
+          storefront: {
+            id: "gid://shopify/HydrogenStorefront/1",
+            title: "Hydrogen"
+          }
+        };
+        const filePath = joinPath(tmpDir, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT);
+        await mkdir(dirname(filePath));
+        await writeFile(filePath, JSON.stringify(existingConfig));
+        const config = await setShop(tmpDir, "new-shop");
+        expect(config).toStrictEqual({
+          ...existingConfig,
+          shop: "new-shop"
+        });
+      });
+    });
+  });
+});
+describe("setStorefront()", () => {
+  it("updates the config file", async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const existingConfig = {
+        shop: "previous-shop",
+        storefront: {
+          id: "gid://shopify/HydrogenStorefront/1",
+          title: "Hydrogen"
+        }
+      };
+      const filePath = joinPath(tmpDir, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT);
+      await mkdir(dirname(filePath));
+      await writeFile(filePath, JSON.stringify(existingConfig));
+      expect(JSON.parse(await readFile(filePath))).toStrictEqual(
+        existingConfig
+      );
+      const newStorefront = {
+        id: "gid://shopify/HydrogenStorefront/2",
+        title: "Remix"
+      };
+      await setStorefront(tmpDir, newStorefront);
+      expect(JSON.parse(await readFile(filePath))).toStrictEqual({
+        ...existingConfig,
+        storefront: newStorefront
+      });
+    });
+  });
+  it("returns the new config", async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const existingConfig = {
+        shop: "previous-shop",
+        storefront: {
+          id: "gid://shopify/HydrogenStorefront/1",
+          title: "Hydrogen"
+        }
+      };
+      const filePath = joinPath(tmpDir, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT);
+      await mkdir(dirname(filePath));
+      await writeFile(filePath, JSON.stringify(existingConfig));
+      const newStorefront = {
+        id: "gid://shopify/HydrogenStorefront/2",
+        title: "Remix"
+      };
+      const config = await setStorefront(tmpDir, newStorefront);
+      expect(config).toStrictEqual({
+        ...existingConfig,
+        storefront: newStorefront
+      });
+    });
+  });
+});
+describe("unsetStorefront()", () => {
+  it("removes the storefront configuration and returns the config", async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const existingConfig = {
+        shop: "previous-shop",
+        storefront: {
+          id: "gid://shopify/HydrogenStorefront/1",
+          title: "Hydrogen"
+        }
+      };
+      const filePath = joinPath(tmpDir, SHOPIFY_DIR, SHOPIFY_DIR_PROJECT);
+      await mkdir(dirname(filePath));
+      await writeFile(filePath, JSON.stringify(existingConfig));
+      expect(JSON.parse(await readFile(filePath))).toStrictEqual(
+        existingConfig
+      );
+      const config = await unsetStorefront(tmpDir);
+      expect(config).toStrictEqual({
+        shop: "previous-shop",
+        storefront: void 0
+      });
+      expect(JSON.parse(await readFile(filePath))).toStrictEqual({
+        shop: "previous-shop"
+      });
+    });
+  });
+});
+describe("ensureShopifyGitIgnore()", () => {
+  describe("when a .gitignore file already exists", () => {
+    it("updates the .gitignore file and returns true", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const existingFileContents = "node_modules\r\n";
+        const filePath = joinPath(tmpDir, ".gitignore");
+        await writeFile(filePath, JSON.stringify(existingFileContents));
+        expect(await readFile(filePath)).not.toContain(".shopify");
+        const result = await ensureShopifyGitIgnore(tmpDir);
+        expect(await readFile(filePath)).toContain(".shopify");
+        expect(result).toBeTruthy();
+      });
+    });
+    describe("and the file is already ignoring .shopify", () => {
+      it("does not update the file and returns false", async () => {
+        await inTemporaryDirectory(async (tmpDir) => {
+          const existingFileContents = "node_modules\n.shopify\r\n";
+          const filePath = joinPath(tmpDir, ".gitignore");
+          await writeFile(filePath, JSON.stringify(existingFileContents));
+          const originalFile = await readFile(filePath);
+          const result = await ensureShopifyGitIgnore(tmpDir);
+          expect(await readFile(filePath)).toStrictEqual(originalFile);
+          expect(result).toBeFalsy();
+        });
+      });
+    });
+  });
+  describe("when a .gitignore does not exist", () => {
+    it("creates the .gitignore file and returns true", async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const filePath = joinPath(tmpDir, ".gitignore");
+        expect(await fileExists(filePath)).toBeFalsy();
+        const result = await ensureShopifyGitIgnore(tmpDir);
+        expect(await readFile(filePath)).toContain(".shopify");
+        expect(result).toBeTruthy();
+      });
+    });
+  });
+});

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"4.1.0","commands":{"hydrogen:build":{"id":"hydrogen:build","description":"Builds a Hydrogen storefront for production.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"sourcemap":{"name":"sourcemap","type":"boolean","description":"Generate sourcemaps for the build.","allowNo":false},"disable-route-warning":{"name":"disable-route-warning","type":"boolean","description":"Disable warning about missing standard routes.","allowNo":false},"base":{"name":"base","type":"option","hidden":true,"multiple":false},"entry":{"name":"entry","type":"option","hidden":true,"multiple":false},"target":{"name":"target","type":"option","hidden":true,"multiple":false}},"args":[]},"hydrogen:check":{"id":"hydrogen:check","description":"Returns diagnostic information about a Hydrogen storefront.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false}},"args":[{"name":"resource","description":"The resource to check. Currently only 'routes' is supported.","required":true,"options":["routes"]}]},"hydrogen:dev":{"id":"hydrogen:dev","description":"Runs Hydrogen storefront in an Oxygen worker for development.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"port":{"name":"port","type":"option","description":"Port to run the server on.","multiple":false,"default":3000},"disable-virtual-routes":{"name":"disable-virtual-routes","type":"boolean","description":"Disable rendering fallback routes when a route file doesn't exist","allowNo":false},"host":{"name":"host","type":"option","hidden":true,"multiple":false}},"args":[]},"hydrogen:g":{"id":"hydrogen:g","description":"Shortcut for `hydrogen generate`. See `hydrogen generate --help` for more information.","strict":false,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[]},"hydrogen:init":{"id":"hydrogen:init","description":"Creates a new Hydrogen storefront.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false},"path":{"name":"path","type":"option","description":"The path to the directory of the new Hydrogen storefront.","multiple":false},"language":{"name":"language","type":"option","description":"Sets the template language to use. One of `js` or `ts`.","multiple":false},"template":{"name":"template","type":"option","description":"Sets the template to use. One of `demo-store` or `hello-world`.","multiple":false},"install-deps":{"name":"install-deps","type":"boolean","description":"Auto install dependencies using the active package manager","allowNo":true}},"args":[]},"hydrogen:preview":{"id":"hydrogen:preview","description":"Runs a Hydrogen storefront in an Oxygen worker for production.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"port":{"name":"port","type":"option","description":"Port to run the server on.","multiple":false,"default":3000}},"args":[]},"hydrogen:shortcut":{"id":"hydrogen:shortcut","description":"Creates a global `h2` shortcut for the Hydrogen CLI","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{},"args":[]},"hydrogen:generate:route":{"id":"hydrogen:generate:route","description":"Generates a standard Shopify route.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"adapter":{"name":"adapter","type":"option","description":"Remix adapter used in the route. The default is `@shopify/remix-oxygen`.","multiple":false},"typescript":{"name":"typescript","type":"boolean","description":"Generate TypeScript files","allowNo":false},"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false},"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false}},"args":[{"name":"route","description":"The route to generate. One of home,page,cart,products,collections,policies,robots,sitemap,account,all.","required":true,"options":["home","page","cart","products","collections","policies","robots","sitemap","account","all"]}]},"hydrogen:generate:routes":{"id":"hydrogen:generate:routes","description":"Generates all supported standard shopify routes.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"adapter":{"name":"adapter","type":"option","description":"Remix adapter used in the route. The default is `@shopify/remix-oxygen`.","multiple":false},"typescript":{"name":"typescript","type":"boolean","description":"Generate TypeScript files","allowNo":false},"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false},"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false}},"args":[]}}}
+{"version":"4.1.2","commands":{"hydrogen:build":{"id":"hydrogen:build","description":"Builds a Hydrogen storefront for production.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"sourcemap":{"name":"sourcemap","type":"boolean","description":"Generate sourcemaps for the build.","allowNo":false},"disable-route-warning":{"name":"disable-route-warning","type":"boolean","description":"Disable warning about missing standard routes.","allowNo":false},"base":{"name":"base","type":"option","hidden":true,"multiple":false},"entry":{"name":"entry","type":"option","hidden":true,"multiple":false},"target":{"name":"target","type":"option","hidden":true,"multiple":false}},"args":[]},"hydrogen:check":{"id":"hydrogen:check","description":"Returns diagnostic information about a Hydrogen storefront.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false}},"args":[{"name":"resource","description":"The resource to check. Currently only 'routes' is supported.","required":true,"options":["routes"]}]},"hydrogen:dev":{"id":"hydrogen:dev","description":"Runs Hydrogen storefront in an Oxygen worker for development.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"port":{"name":"port","type":"option","description":"Port to run the server on.","multiple":false,"default":3000},"disable-virtual-routes":{"name":"disable-virtual-routes","type":"boolean","description":"Disable rendering fallback routes when a route file doesn't exist","allowNo":false},"debug":{"name":"debug","type":"boolean","description":"Attaches a Node inspector","allowNo":false},"host":{"name":"host","type":"option","hidden":true,"multiple":false}},"args":[]},"hydrogen:g":{"id":"hydrogen:g","description":"Shortcut for `hydrogen generate`. See `hydrogen generate --help` for more information.","strict":false,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[]},"hydrogen:init":{"id":"hydrogen:init","description":"Creates a new Hydrogen storefront.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false},"path":{"name":"path","type":"option","description":"The path to the directory of the new Hydrogen storefront.","multiple":false},"language":{"name":"language","type":"option","description":"Sets the template language to use. One of `js` or `ts`.","multiple":false},"template":{"name":"template","type":"option","description":"Sets the template to use. One of `demo-store` or `hello-world`.","multiple":false},"install-deps":{"name":"install-deps","type":"boolean","description":"Auto install dependencies using the active package manager","allowNo":true}},"args":[]},"hydrogen:link":{"id":"hydrogen:link","description":"Link a local project to one of your shop's Hydrogen storefronts.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","hidden":true,"aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false},"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"shop":{"name":"shop","type":"option","char":"s","description":"Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).","multiple":false},"storefront":{"name":"storefront","type":"option","char":"h","description":"The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")","multiple":false}},"args":[]},"hydrogen:list":{"id":"hydrogen:list","description":"Returns a list of Hydrogen storefronts available on a given shop.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","hidden":true,"aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"shop":{"name":"shop","type":"option","char":"s","description":"Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).","multiple":false}},"args":[]},"hydrogen:preview":{"id":"hydrogen:preview","description":"Runs a Hydrogen storefront in an Oxygen worker for production.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"port":{"name":"port","type":"option","description":"Port to run the server on.","multiple":false,"default":3000}},"args":[]},"hydrogen:shortcut":{"id":"hydrogen:shortcut","description":"Creates a global `h2` shortcut for the Hydrogen CLI","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{},"args":[]},"hydrogen:unlink":{"id":"hydrogen:unlink","description":"Unlink a local project from a Hydrogen storefront.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","hidden":true,"aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false}},"args":[]},"hydrogen:env:pull":{"id":"hydrogen:env:pull","description":"Populate your .env with variables from your Hydrogen storefront.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","hidden":true,"aliases":[],"flags":{"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false},"shop":{"name":"shop","type":"option","char":"s","description":"Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).","multiple":false},"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false}},"args":[]},"hydrogen:generate:route":{"id":"hydrogen:generate:route","description":"Generates a standard Shopify route.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"adapter":{"name":"adapter","type":"option","description":"Remix adapter used in the route. The default is `@shopify/remix-oxygen`.","multiple":false},"typescript":{"name":"typescript","type":"boolean","description":"Generate TypeScript files","allowNo":false},"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false},"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false}},"args":[{"name":"route","description":"The route to generate. One of home,page,cart,products,collections,policies,robots,sitemap,account,all.","required":true,"options":["home","page","cart","products","collections","policies","robots","sitemap","account","all"]}]},"hydrogen:generate:routes":{"id":"hydrogen:generate:routes","description":"Generates all supported standard shopify routes.","strict":true,"pluginName":"@shopify/cli-hydrogen","pluginAlias":"@shopify/cli-hydrogen","pluginType":"core","aliases":[],"flags":{"adapter":{"name":"adapter","type":"option","description":"Remix adapter used in the route. The default is `@shopify/remix-oxygen`.","multiple":false},"typescript":{"name":"typescript","type":"boolean","description":"Generate TypeScript files","allowNo":false},"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the destination directory and files if they already exist.","allowNo":false},"path":{"name":"path","type":"option","description":"The path to the directory of the Hydrogen storefront. The default is the current directory.","multiple":false}},"args":[]}}}

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "@shopify:registry": "https://registry.npmjs.org"
   },
-  "version": "4.1.0",
+  "version": "4.1.2",
   "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
   "scripts": {
@@ -27,14 +27,14 @@
   },
   "peerDependencies": {
     "@remix-run/react": "^1.15.0",
-    "@shopify/hydrogen-react": "^2023.1.8",
-    "@shopify/remix-oxygen": "^1.0.5"
+    "@shopify/hydrogen-react": "^2023.4.1",
+    "@shopify/remix-oxygen": "^1.0.6"
   },
   "dependencies": {
     "@oclif/core": "2.1.4",
     "@remix-run/dev": "1.15.0",
     "@shopify/cli-kit": "3.45.0",
-    "@shopify/mini-oxygen": "^1.3.1",
+    "@shopify/mini-oxygen": "^1.5.0",
     "ansi-colors": "^4.1.3",
     "fast-glob": "^3.2.12",
     "fs-extra": "^10.1.0",