Ask to enable Yarn Zero-install during setup (#273)

Author: koistya

.github/workflows/pull_request.yaml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - run: yarn install --immutable-cache
+      - run: yarn install
 
       # Analyze code for potential problems
       - run: yarn prettier --check .

.gitignore

@@ -10,13 +10,14 @@
 node_modules/
 
 # Yarn Zero-installs
-# https://yarnpkg.com/advanced/qa/#which-files-should-be-gitignored
+# https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
 .yarn/*
-!.yarn/cache
+#!.yarn/cache
 !.yarn/releases
 !.yarn/plugins
 !.yarn/sdks
-!.yarn/versionss
+!.yarn/versions
+.pnp.*
 
 # Logs
 yarn-debug.log*

README.md

@@ -45,6 +45,7 @@ Just clone the repo and run `yarn setup` followed by `yarn start`:
 $ git clone --origin=upstream --branch=main --single-branch \
     https://github.com/kriasoft/nodejs-api-starter.git example
 $ cd ./example                  # Change current directory to the newly created one
+$ yarn install                  # Install project dependencies
 $ yarn setup                    # Configure environment variables
 $ yarn start                    # Launch Node.js API and web application
 ```

setup.js

@@ -127,6 +127,12 @@ const questions = [
       );
     },
   })),
+  {
+    type: "confirm",
+    name: "yarn",
+    message: "Enable Yarn Zero-install?",
+    default: true,
+  },
   {
     type: "confirm",
     name: "clean",
@@ -137,6 +143,25 @@ const questions = [
 ];
 
 async function done(answers) {
+  // Enable/disable Yarn Zero-install
+  if (answers.yarn) {
+    await replace(`.gitignore`, /^#!\.yarn\/cache$/m, `!.yarn/cache`);
+    await replace(`.gitignore`, /^\.pnp\.\*$/m, `#.pnp.*`);
+    await replace(
+      `.github/workflows/pull_request.yaml`,
+      /yarn install$/m,
+      `yarn install --immutable --immutable-cache`,
+    );
+  } else {
+    await replace(`.gitignore`, /^!\.yarn\/cache$/m, `#!.yarn/cache`);
+    await replace(`.gitignore`, /^#\.pnp\.\*$/m, `.pnp.*`);
+    await replace(
+      `.github/workflows/pull_request.yaml`,
+      /yarn install.*$/m,
+      `yarn install`,
+    );
+  }
+
   // Remove this script
   if (answers.clean) {
     fs.unlinkSync("./setup.js");
@@ -146,8 +171,6 @@ async function done(answers) {
     spawn.sync("yarn", ["remove", "inquirer", "cross-spawn", "dotenv"], {
       stdio: "inherit",
     });
-  } else {
-    spawn.sync("yarn", ["install"], { stdio: "inherit" });
   }
 
   if (answers.setup) {
@@ -166,14 +189,19 @@ async function done(answers) {
     console.log(
       `  Done! Now you can migrate the database and launch the app by running:`,
     );
-    console.log(`  `);
-    console.log(`  $ yarn db:reset`);
-    console.log(`  $ yarn api:start`);
-    console.log(`  $ yarn web:start`);
-    console.log(`  `);
   } else {
+    console.log(`  `);
     console.log(`  No problem. You can run this script at any time later.`);
+    console.log(
+      `  Now you can migrate the database and launch the app by running:`,
+    );
   }
+
+  console.log(`  `);
+  console.log(`  $ yarn db:reset`);
+  console.log(`  $ yarn api:start`);
+  console.log(`  $ yarn web:start`);
+  console.log(`  `);
 }
 
 inquirer