Do not override any .env settings in .gitignore files (#10766)

* do not override .env settings in .gitignore files Fixes #10749 * fixup! do not override .env settings in .gitignore files * fixup! do not override .env settings in .gitignore files * fixup! do not override .env settings in .gitignore files

Author: petebacondarwin

.changeset/silly-parks-fall.md

@@ -0,0 +1,12 @@
+---
+"create-cloudflare": patch
+---
+
+Do not override any `.env` settings in `.gitignore` files
+
+Previously we only looked for `.env*` in the `gitignore` but now we cover more cases such as:
+
+- `.env`
+- `.env\*`
+- `.env.<local|production|staging|...>`
+- `.env\*.<local|production|staging|...>`

packages/create-cloudflare/src/__tests__/templates.test.ts

@@ -320,6 +320,32 @@ describe("addWranglerToGitIgnore", () => {
 `);
 });
 
+test("should not add the .env entries if some form of .env entries are already included", () => {
+mockGitIgnore(
+"my-project/.gitignore",
+`
+.env
+.env.*
+!.env.example
+`,
+);
+addWranglerToGitIgnore({
+project: { path: "my-project" },
+} as unknown as C3Context);
+
+expect(appendFileResults.file).toMatchInlineSnapshot(
+`"my-project/.gitignore"`,
+);
+expect(appendFileResults.content).toMatchInlineSnapshot(`
+"
+# wrangler files
+.wrangler
+.dev.vars*
+!.dev.vars.example
+"
+`);
+});
+
 test("should not add the .wrangler entry if a .wrangler/ is already included)", () => {
 mockGitIgnore(
 "my-project/.gitignore",

packages/create-cloudflare/src/templates.ts

@@ -958,7 +958,25 @@ export const addWranglerToGitIgnore = (ctx: C3Context) => {
 wranglerGitIgnoreFilesToAdd.push("!.dev.vars.example");
 }
 
-const hasDotEnv = existingGitIgnoreContent.match(/^\/?\.env\*(\s|$)/m);
+/**
+ * We check for the following type of occurrences:
+ *
+ * ```
+ * .env
+ * .env*
+ * .env.<local|production|staging|...>
+ * .env*.<local|production|staging|...>
+ * ```
+ *
+ * Any of these may alone on a line or be followed by a space and a trailing comment:
+ *
+ * ```
+ * .env.<local|production|staging> # some trailing comment
+ * ```
+ */
+const hasDotEnv = existingGitIgnoreContent.match(
+/^\/?\.env\*?(\..*?)?(\s|$)/m,
+);
 if (!hasDotEnv) {
 wranglerGitIgnoreFilesToAdd.push(".env*");
 }