@graphcommerce/next-config 10.0.1-canary.0 → 10.0.1-canary.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 10.0.1-canary.2
+
+## 10.0.1-canary.1
+
+### Patch Changes
+
+- [#2571](https://github.com/graphcommerce-org/graphcommerce/pull/2571) [`a16bed1`](https://github.com/graphcommerce-org/graphcommerce/commit/a16bed1b8670932e273d5ea7114bf01fda40f2f8) - Always copy the file if the original file is a core file, allowing overrides. ([@paales](https://github.com/paales))
+
 ## 10.0.1-canary.0
 
 ### Patch Changes

package/__tests__/commands/copyFiles.ts

@@ -16,6 +16,7 @@ vi.mock('fs/promises', () => ({
     stat: vi.fn(),
     unlink: vi.fn(),
     rmdir: vi.fn(),
+    rename: vi.fn(),
   },
   readFile: vi.fn(),
   writeFile: vi.fn(),
@@ -24,6 +25,7 @@ vi.mock('fs/promises', () => ({
   stat: vi.fn(),
   unlink: vi.fn(),
   rmdir: vi.fn(),
+  rename: vi.fn(),
 }))
 
 // Mock fast-glob
@@ -425,11 +427,17 @@ describe('copyFiles', () => {
       }
       return Promise.reject(new Error(`ENOENT: no such file or directory, open '${filePath}'`))
     })
+    mockFs.rename.mockResolvedValue(undefined)
 
     await copyFiles()
 
+    // Unmanaged files should be renamed to .original and a new managed file created
+    expect(mockFs.rename).toHaveBeenCalledWith(
+      path.join(mockCwd, 'file.ts'),
+      path.join(mockCwd, 'file.original.ts'),
+    )
     expect(consoleInfo).toHaveBeenCalledWith(
-      expect.stringContaining('Note: File file.ts has been modified'),
+      expect.stringContaining('Renamed existing file to: file.original.ts'),
     )
   })
 

package/__tests__/config/utils/__snapshots__/mergeEnvIntoConfig.ts.snap

@@ -2,7 +2,6 @@
 
 exports[`parses an env config object 1`] = `
 {
-  "GC_DEMO_MODE": true,
   "GC_STOREFRONT": [
     {
       "defaultLocale": true,
@@ -14,10 +13,8 @@ exports[`parses an env config object 1`] = `
     },
   ],
   "GC_STOREFRONT_0_DEFAULT_LOCALE": true,
-  "GC_STOREFRONT_0_HYGRAPH_LOCALES_0": "en",
   "GC_STOREFRONT_0_LOCALE": "en",
   "GC_STOREFRONT_0_MAGENTO_STORE_CODE": "en_us",
-  "GC_STOREFRONT_1_HYGRAPH_LOCALES_0": "de",
   "GC_STOREFRONT_1_LOCALE": "de",
   "GC_STOREFRONT_1_MAGENTO_STORE_CODE": "de_de",
 }

package/__tests__/interceptors/findPlugins.ts

@@ -557,6 +557,14 @@ it('finds plugins', () => {
         "targetModule": "@graphcommerce/magento-product-configurable",
         "type": "component",
       },
+      {
+        "enabled": true,
+        "sourceExport": "GraphQLProvider",
+        "sourceModule": "@graphcommerce/magento-recently-viewed-products/plugins/AddRecentlyViewedProductsTypePolicies",
+        "targetExport": "GraphQLProvider",
+        "targetModule": "@graphcommerce/graphql",
+        "type": "component",
+      },
       {
         "enabled": true,
         "sourceExport": "cartItemToCartItemInput",

package/__tests__/interceptors/generateInterceptors.ts

@@ -87,7 +87,7 @@ it('it generates an interceptor', async () => {
      * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
      * original source changes.
      *
-     * @see {@link file://./PaymentMethodContextProvider.tsx} for original source file
+     * @see {@link file://./PaymentMethodContextProvider.original.tsx} for original source file
      * @see {PluginAddBraintreeMethods} for source of applied plugin
      * @see {PluginAddMollieMethods} for source of applied plugin
      */
@@ -188,7 +188,7 @@ it('it can apply multiple plugins to a single export', async () => {
      * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
      * original source changes.
      *
-     * @see {@link file://./PaymentMethodContextProvider.tsx} for original source file
+     * @see {@link file://./PaymentMethodContextProvider.original.tsx} for original source file
      * @see {PluginAddAdyenMethods} for source of applied plugin
      * @see {PluginAddMollieMethods} for source of applied plugin
      */
@@ -257,7 +257,7 @@ it('it handles on duplicates gracefully', async () => {
      * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
      * original source changes.
      *
-     * @see {@link file://./PaymentMethodContextProvider.tsx} for original source file
+     * @see {@link file://./PaymentMethodContextProvider.original.tsx} for original source file
      * @see {PluginAddBraintreeMethods} for source of applied plugin
      * @see {PluginAddBraintreeMethods} for source of applied plugin
      */
@@ -434,7 +434,7 @@ it('adds debug logging to interceptors for components', async () => {
      * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
      * original source changes.
      *
-     * @see {@link file://./graphqlConfig.ts} for original source file
+     * @see {@link file://./graphqlConfig.original.ts} for original source file
      * @see {pluginhygraphInitMemoryCache} for source of applied plugin
      * @see {pluginmagentoInitMemoryCache} for source of applied plugin
      */

package/dist/index.js

@@ -729,7 +729,9 @@ async function generateInterceptor(interceptor, config, oldInterceptorSource) {
           `@see {${sourceName(name(replacePlugin))}} for source of replaced component`
         );
       } else {
-        pluginSee.push(`@see {@link file://./${targetExport}.tsx} for original source file`);
+        pluginSee.push(
+          `@see {@link file://./${targetExport}.original.tsx} for original source file`
+        );
       }
       const pluginInterceptors = componentPlugins.reverse().map((plugin) => {
         const pluginName = sourceName(name(plugin));
@@ -774,7 +776,9 @@ export const ${targetExport} = ${carry}`;
           `@see {${sourceName(name(replacePlugin))}} for source of replaced function`
         );
       } else {
-        pluginSee.push(`@see {@link file://./${targetExport}.ts} for original source file`);
+        pluginSee.push(
+          `@see {@link file://./${targetExport}.original.ts} for original source file`
+        );
       }
       const pluginInterceptors = functionPlugins.reverse().map((plugin) => {
         const pluginName = sourceName(name(plugin));
@@ -1079,7 +1083,7 @@ async function updateGitignore(managedFiles) {
   try {
     content = await fs.readFile(gitignorePath, "utf-8");
     debug("Reading existing .gitignore");
-  } catch (err) {
+  } catch {
     debug(".gitignore not found, creating new file");
     content = "";
   }
@@ -1114,6 +1118,11 @@ function getFileManagement(content) {
   if (contentStr.startsWith(MANAGED_BY_GC)) return "graphcommerce";
   return "unmanaged";
 }
+function getOriginalFilename(filePath) {
+  const ext = path.extname(filePath);
+  const base = filePath.slice(0, -ext.length);
+  return `${base}.original${ext}`;
+}
 async function copyFiles() {
   const startTime = performance.now();
   debug("Starting copyFiles");
@@ -1220,11 +1229,15 @@ Path: ${copyDir}`
             return;
           }
           if (management === "unmanaged") {
+            const originalPath = getOriginalFilename(targetPath);
+            await fs.rename(targetPath, originalPath);
+            const originalRelative = getOriginalFilename(file);
             console.info(
-              `Note: File ${file} has been modified. Add '${MANAGED_LOCALLY.trim()}' at the top to manage it locally.`
+              `Renamed existing file to: ${originalRelative}
+Creating managed file: ${file}`
             );
-            debug(`File ${file} doesn't have management comment, skipping`);
-            return;
+            debug(`Renamed ${file} to ${originalRelative}`);
+            targetContent = void 0;
           }
           debug(`File ${file} is managed by graphcommerce, will update if needed`);
         } catch (err) {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/next-config",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "10.0.1-canary.0",
+  "version": "10.0.1-canary.2",
   "type": "module",
   "exports": {
     ".": {
@@ -63,7 +63,7 @@
   },
   "peerDependencies": {
     "@apollo/client": "*",
-    "@graphcommerce/prettier-config-pwa": "^10.0.1-canary.0",
+    "@graphcommerce/prettier-config-pwa": "^10.0.1-canary.2",
     "@lingui/loader": "*",
     "@lingui/macro": "*",
     "@lingui/react": "*",

package/src/commands/copyFiles.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-await-in-loop */
 import fs from 'fs/promises'
 import path from 'path'
 import fg from 'fast-glob'
@@ -38,7 +37,7 @@ async function updateGitignore(managedFiles: string[]) {
   try {
     content = await fs.readFile(gitignorePath, 'utf-8')
     debug('Reading existing .gitignore')
-  } catch (err) {
+  } catch {
     debug('.gitignore not found, creating new file')
     content = ''
   }
@@ -79,6 +78,13 @@ function getFileManagement(content: Buffer | undefined): 'local' | 'graphcommerc
   return 'unmanaged'
 }
 
+/** Generates the .original filename for a given file path (e.g., file.tsx -> file.original.tsx) */
+function getOriginalFilename(filePath: string): string {
+  const ext = path.extname(filePath)
+  const base = filePath.slice(0, -ext.length)
+  return `${base}.original${ext}`
+}
+
 /**
  * The packages are @graphcommerce/* packages and have special treatment.
  *
@@ -88,7 +94,8 @@ function getFileManagement(content: Buffer | undefined): 'local' | 'graphcommerc
  *
  *    1. If the file doesn't exist: Create directories and the file with "managed by: graphcommerce"
  *    2. If the file exists and starts with "managed by: local": Skip the file
- *    3. If the file exists but doesn't have a management comment: Suggest adding "managed by: local"
+ *    3. If the file exists but doesn't have a management comment: Rename to filename.original.ext and
+ *          create the new managed file
  *    4. If the file is managed by graphcommerce: Update if content differs
  */
 export async function copyFiles() {
@@ -213,11 +220,15 @@ Found in packages:
             return
           }
           if (management === 'unmanaged') {
+            // Rename existing file to .original and create new managed file
+            const originalPath = getOriginalFilename(targetPath)
+            await fs.rename(targetPath, originalPath)
+            const originalRelative = getOriginalFilename(file)
             console.info(
-              `Note: File ${file} has been modified. Add '${MANAGED_LOCALLY.trim()}' at the top to manage it locally.`,
+              `Renamed existing file to: ${originalRelative}\nCreating managed file: ${file}`,
             )
-            debug(`File ${file} doesn't have management comment, skipping`)
-            return
+            debug(`Renamed ${file} to ${originalRelative}`)
+            targetContent = undefined // Treat as new file from here
           }
 
           debug(`File ${file} is managed by graphcommerce, will update if needed`)

package/src/interceptors/generateInterceptor.ts

@@ -199,7 +199,9 @@ export async function generateInterceptor(
             `@see {${sourceName(name(replacePlugin))}} for source of replaced component`,
           )
         } else {
-          pluginSee.push(`@see {@link file://./${targetExport}.tsx} for original source file`)
+          pluginSee.push(
+            `@see {@link file://./${targetExport}.original.tsx} for original source file`,
+          )
         }
 
         const pluginInterceptors = componentPlugins
@@ -259,7 +261,9 @@ export const ${targetExport} = ${carry}`
             `@see {${sourceName(name(replacePlugin))}} for source of replaced function`,
           )
         } else {
-          pluginSee.push(`@see {@link file://./${targetExport}.ts} for original source file`)
+          pluginSee.push(
+            `@see {@link file://./${targetExport}.original.ts} for original source file`,
+          )
         }
 
         const pluginInterceptors = functionPlugins