Merge pull request #34 from paritytech/yuri/gitignore-backsync

Use .gitignore as the source of truth for back-sync

Author: mutantcornholio

package.json

@@ -8,6 +8,7 @@
     "@eng-automation/js-style": "^3.1.0",
     "chokidar": "^4.0.1",
     "commander": "^12.1.0",
+    "ignore": "^7.0.5",
     "prettier": "^3.5.3",
     "prettier-plugin-tailwindcss": "^0.6.11",
     "type-fest": "^4.27.0",

src/scripts/backSync.ts

@@ -1,8 +1,9 @@
-import { availableTemplates, configs, TemplateNames } from "#src/templateConfigs/index";
+import { availableTemplates, TemplateNames } from "#src/templateConfigs/index";
 import { colors as c, success } from "#src/util/log";
 import chokidar from "chokidar";
 import { Option, program } from "commander";
 import fs from "fs";
+import ignore from "ignore";
 import * as process from "node:process";
 import path from "path";
 import { debuglog } from "util";
@@ -19,7 +20,10 @@ program
 program.parse();
 const options: { source: string; template: TemplateNames; rm: boolean } = program.opts();
 
-const config = configs[options.template];
+const alwaysIgnorePatterns = [/^\.papi\/metadata.*/];
+
+const gitignoreContents = fs.readFileSync(path.join(options.source, ".gitignore"), "utf-8");
+const gitignoreIg = ignore().add(gitignoreContents);
 
 const watcher = chokidar.watch(options.source, {
   persistent: true,
@@ -28,9 +32,11 @@ const watcher = chokidar.watch(options.source, {
   ignored: (updPath) => {
     if (updPath === options.source) return false;
     const relpath = path.relative(options.source, updPath);
-    const matched = config.backSyncPatterns.some((pattern) => pattern.test(relpath));
 
-    return !matched;
+    if (alwaysIgnorePatterns.some((pattern) => pattern.test(relpath))) return true;
+    if (gitignoreIg.ignores(relpath)) return true;
+
+    return false;
   },
 });
 

src/templateConfigs/index.ts

@@ -4,7 +4,6 @@ import reactSolidityHardhat from "./react-solidity-hardhat";
 
 export type TemplateConfig = {
   setupPapi: boolean;
-  backSyncPatterns: RegExp[];
   instructions: string;
   npmRoots: string[];
 };

src/templateConfigs/react-papi-tailwind.ts

@@ -3,7 +3,6 @@ import { colors as c } from "#src/util/log";
 
 const config: TemplateConfig = {
   setupPapi: true,
-  backSyncPatterns: [/^src.*/],
   npmRoots: ["/"],
   instructions: `
 ${c.secondary("Start app:")}

src/templateConfigs/react-solidity-hardhat.ts

@@ -4,22 +4,6 @@ import { colors as c } from "#src/util/log";
 const config: TemplateConfig = {
   setupPapi: false,
   npmRoots: ["contracts", "frontend"],
-  backSyncPatterns: [
-    /^contracts$/,
-    /^contracts\/contracts.*/,
-    /^contracts\/ignition$/,
-    /^contracts\/ignition.*/,
-    /^contracts\/test.*/,
-    /^contracts\/package\.json/,
-    /^contracts\/package-lock\.json/,
-    /^contracts\/tsconfig\.json/,
-    /^contracts\/hardhat.config.ts/,
-    /^frontend$/,
-    /^frontend\/src.*/,
-    /^frontend\/package\.json/,
-    /^frontend\/package-lock\.json/,
-    /^README.md$/,
-  ],
   instructions: `
 ${c.primary("Develop smart contracts:")}
 ${c.primary("1. ")}${c.secondary("set up hardhat environment (see README.md): ")}

src/templateConfigs/react-solidity.ts

@@ -4,18 +4,6 @@ import { colors as c } from "#src/util/log";
 const config: TemplateConfig = {
   setupPapi: false,
   npmRoots: ["contracts", "frontend"],
-  backSyncPatterns: [
-    /^contracts$/,
-    /^contracts\/.+.sol/,
-    /^contracts\/package\.json/,
-    /^contracts\/tsconfig\.json/,
-    /^contracts\/src.*/,
-    /^frontend$/,
-    /^frontend\/src.*/,
-    /^frontend\/package\.json/,
-    /^package\.json/,
-    /^package-lock\.json/,
-  ],
   instructions: `
 ${c.primary("For Remix environment:")}
 ${c.primary("1. ")}${c.secondary("start remixd environment: ")}${c.code("pnpm remixd")}

…lates/react-solidity/frontend/.gitignore …plates/react-solidity-hardhat/.gitignoretemplates/react-solidity/frontend/.gitignore renamed to templates/react-solidity-hardhat/.gitignore templates/react-solidity/frontend/.gitignore renamed to templates/react-solidity-hardhat/.gitignore

@@ -7,7 +7,7 @@ yarn-error.log*
 pnpm-debug.log*
 lerna-debug.log*
 
-../node_modules
+node_modules
 dist
 dist-ssr
 *.local

templates/react-solidity-hardhat/frontend/.gitignore

@@ -1,4 +1,3 @@
-node_modules
 .env
 
 # Wagmi generated types

templates/react-solidity/contracts/.gitignore

@@ -1099,6 +1099,7 @@ __metadata:
     chalk-template: "npm:^0.5.0"
     chokidar: "npm:^4.0.1"
     commander: "npm:^12.1.0"
+    ignore: "npm:^7.0.5"
     prettier: "npm:^3.5.3"
     prettier-plugin-tailwindcss: "npm:^0.6.11"
     type-fest: "npm:^4.27.0"
@@ -2019,6 +2020,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"ignore@npm:^7.0.5":
+  version: 7.0.5
+  resolution: "ignore@npm:7.0.5"
+  checksum: 10c0/ae00db89fe873064a093b8999fe4cc284b13ef2a178636211842cceb650b9c3e390d3339191acb145d81ed5379d2074840cf0c33a20bdbd6f32821f79eb4ad5d
+  languageName: node
+  linkType: hard
+
 "import-fresh@npm:^3.2.1":
   version: 3.3.0
   resolution: "import-fresh@npm:3.3.0"