Adds *.local to .gitignore and functions ignore for functions setup

CHANGELOG.md

@@ -0,0 +1 @@
+- Adds `*.local` to .gitignore and functions ignore for `init functions`. (#7018)

src/init/features/functions/index.ts

@@ -20,22 +20,22 @@
 /**
  * Set up a new firebase project for functions.
  */
 export async function doSetup(setup: any, config: Config, options: Options): Promise<any> {
   const projectId = setup?.rcfile?.projects?.default;
   if (projectId) {
     await requirePermissions({ ...options, project: projectId });
     await Promise.all([
       ensure(projectId, functionsOrigin(), "unused", true),
       ensure(projectId, runtimeconfigOrigin(), "unused", true),
     ]);
   }
   setup.functions = {};
   // check if functions have been initialized yet
   if (!config.src.functions) {
     setup.config.functions = [];
     return initNewCodebase(setup, config);
   }
   setup.config.functions = normalizeAndValidate(setup.config.functions);
   const codebases = setup.config.functions.map((cfg: any) => clc.bold(cfg.codebase));
   logger.info(`\nDetected existing codebase(s): ${codebases.join(", ")}\n`);
   const choices = [
@@ -181,13 +181,25 @@
   const cbconfig = configForCodebase(setup.config.functions, setup.functions.codebase);
   switch (language) {
     case "javascript":
-      cbconfig.ignore = ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"];
+      cbconfig.ignore = [
+        "node_modules",
+        ".git",
+        "firebase-debug.log",
+        "firebase-debug.*.log",
+        "*.local",
+      ];
       break;
     case "typescript":
-      cbconfig.ignore = ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"];
+      cbconfig.ignore = [
+        "node_modules",
+        ".git",
+        "firebase-debug.log",
+        "firebase-debug.*.log",
+        "*.local",
+      ];
       break;
     case "python":
-      cbconfig.ignore = ["venv", ".git", "firebase-debug.log", "firebase-debug.*.log"];
+      cbconfig.ignore = ["venv", ".git", "firebase-debug.log", "firebase-debug.*.log", "*.local"];
       break;
   }
   return require("./" + language).setup(setup, config);

src/test/init/features/functions.spec.ts

@@ -15,7 +15,7 @@ function createExistingTestSetupAndConfig(): { setup: Setup; config: Config } {
   const cbconfig = {
     source: TEST_SOURCE_DEFAULT,
     codebase: TEST_CODEBASE_DEFAULT,
-    ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"],
+    ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log", "*.local"],
     predeploy: ['npm --prefix "$RESOURCE_DIR" run lint'],
   };
 
@@ -85,7 +85,7 @@ describe("functions", () => {
         expect(setup.config.functions[0]).to.deep.equal({
           source: TEST_SOURCE_DEFAULT,
           codebase: TEST_CODEBASE_DEFAULT,
-          ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"],
+          ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log", "*.local"],
           predeploy: ['npm --prefix "$RESOURCE_DIR" run lint'],
         });
         expect(askWriteProjectFileStub.getCalls().map((call) => call.args[0])).to.deep.equal([
@@ -112,7 +112,7 @@ describe("functions", () => {
         expect(setup.config.functions[0]).to.deep.equal({
           source: TEST_SOURCE_DEFAULT,
           codebase: TEST_CODEBASE_DEFAULT,
-          ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"],
+          ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log", "*.local"],
           predeploy: [
             'npm --prefix "$RESOURCE_DIR" run lint',
             'npm --prefix "$RESOURCE_DIR" run build',
@@ -149,13 +149,25 @@ describe("functions", () => {
           {
             source: TEST_SOURCE_DEFAULT,
             codebase: TEST_CODEBASE_DEFAULT,
-            ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"],
+            ignore: [
+              "node_modules",
+              ".git",
+              "firebase-debug.log",
+              "firebase-debug.*.log",
+              "*.local",
+            ],
             predeploy: ['npm --prefix "$RESOURCE_DIR" run lint'],
           },
           {
             source: "testsource2",
             codebase: "testcodebase2",
-            ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"],
+            ignore: [
+              "node_modules",
+              ".git",
+              "firebase-debug.log",
+              "firebase-debug.*.log",
+              "*.local",
+            ],
             predeploy: ['npm --prefix "$RESOURCE_DIR" run lint'],
           },
         ]);
@@ -185,7 +197,13 @@ describe("functions", () => {
           {
             source: TEST_SOURCE_DEFAULT,
             codebase: TEST_CODEBASE_DEFAULT,
-            ignore: ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"],
+            ignore: [
+              "node_modules",
+              ".git",
+              "firebase-debug.log",
+              "firebase-debug.*.log",
+              "*.local",
+            ],
             predeploy: ['npm --prefix "$RESOURCE_DIR" run lint'],
           },
         ]);

templates/init/functions/javascript/_gitignore

@@ -1 +1,2 @@
-node_modules/
+node_modules/
+*.local

templates/init/functions/python/_gitignore

@@ -0,0 +1 @@
+*.local

templates/init/functions/typescript/_gitignore

@@ -7,3 +7,4 @@ typings/
 
 # Node.js dependency directory
 node_modules/
+*.local