@hanseltime/template-repo-sync 2.3.0 → 2.4.0-alpha.0

package/lib/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/esm/checkout-drivers/git-checkout.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gitCheckout = void 0;
-const child_process_1 = require("child_process");
-async function gitCheckout(options) {
-    const { branch, remoteName, tmpDir } = options;
-    const remoteInfo = (0, child_process_1.execSync)(`git remote show ${remoteName}`, {
-        cwd: tmpDir,
-        env: process.env,
-    }).toString();
-    const defaultMatch = /HEAD branch:\s*([a-zA-Z0-9_-]+)/.exec(remoteInfo);
-    if (!defaultMatch || !defaultMatch[1]) {
-        throw new Error(`Could not determine default branch of cloned repo.\nAttempted to find in remote info:\n${remoteInfo} `);
-    }
-    const defaultBranch = defaultMatch[1];
-    // Skip this if the default branch is already pulled
-    if (defaultBranch !== branch) {
-        (0, child_process_1.execSync)(`git fetch ${remoteName} ${branch}`, {
-            cwd: tmpDir,
-            env: process.env,
-        });
-        (0, child_process_1.execSync)(`git checkout -b ${branch} --track ${remoteName}/${branch}`, {
-            cwd: tmpDir,
-            env: process.env,
-        });
-    }
-    return true;
-}
-exports.gitCheckout = gitCheckout;

package/lib/esm/checkout-drivers/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./git-checkout"), exports);
-__exportStar(require("./types"), exports);

package/lib/esm/checkout-drivers/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/esm/clone-drivers/git-clone.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gitClone = void 0;
-const child_process_1 = require("child_process");
-const path_1 = require("path");
-const CLONE_DIR = "cloned_repo";
-async function gitClone(tmpDir, repoUrl) {
-    (0, child_process_1.execSync)(`git clone ${repoUrl} ${CLONE_DIR}`, {
-        cwd: tmpDir,
-        env: process.env,
-    });
-    return {
-        dir: (0, path_1.resolve)(tmpDir, CLONE_DIR),
-        remoteName: "origin",
-    };
-}
-exports.gitClone = gitClone;

package/lib/esm/clone-drivers/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./git-clone"), exports);

package/lib/esm/clone-drivers/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/esm/diff-drivers/git-diff.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gitDiff = void 0;
-const child_process_1 = require("child_process");
-/**
- * For a given directory with a git configuration, this will return the modified, added, and
- * deleted files since the last afterRef
- * @param gitDir The git directory folder
- * @param afterRef The git ref to look for diffs after
- * @returns
- */
-async function gitDiff(gitDir, afterRef) {
-    const baseCommand = `git diff ${afterRef}.. --no-renames --name-only`;
-    const modifiedFiles = (0, child_process_1.execSync)(`${baseCommand} --diff-filter=M`, {
-        cwd: gitDir,
-    })
-        .toString()
-        .trim()
-        .split("\n")
-        .filter((s) => s !== "");
-    const addedFiles = (0, child_process_1.execSync)(`${baseCommand} --diff-filter=A`, {
-        cwd: gitDir,
-    })
-        .toString()
-        .trim()
-        .split("\n")
-        .filter((s) => s !== "");
-    const deletedFiles = (0, child_process_1.execSync)(`${baseCommand} --diff-filter=D`, {
-        cwd: gitDir,
-    })
-        .toString()
-        .trim()
-        .split("\n")
-        .filter((s) => s !== "");
-    return {
-        modified: modifiedFiles,
-        added: addedFiles,
-        deleted: deletedFiles,
-    };
-}
-exports.gitDiff = gitDiff;

package/lib/esm/diff-drivers/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./git-diff"), exports);

package/lib/esm/diff-drivers/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/esm/formatting/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./sync-results-to-md"), exports);
-__exportStar(require("./infer-json-indent"), exports);

package/lib/esm/formatting/infer-json-indent.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.inferJSONIndent = void 0;
-const spacingRegex = /[{[]\n?(?<spacing>\s+)["tf\d]/;
-function inferJSONIndent(rawJSON) {
-    const match = spacingRegex.exec(rawJSON);
-    if (!match?.groups?.spacing) {
-        // eslint-disable-next-line no-console
-        console.warn(`Could not find json indentation for json string: ${rawJSON.slice(40)} ... \nDefaulting to 4 spaces`);
-        // Four spaces
-        return "    ";
-    }
-    const spacing = match.groups.spacing;
-    // Handle the case where there were multiple newlines before a value
-    const lastNewLine = spacing.lastIndexOf("\n");
-    return match?.groups.spacing.slice(lastNewLine >= 0 ? lastNewLine + 1 : 0);
-}
-exports.inferJSONIndent = inferJSONIndent;

package/lib/esm/formatting/sync-results-to-md.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.syncResultsToMd = void 0;
-const template_sync_1 = require("../template-sync");
-function syncResultsToMd(result) {
-    return `# ${template_sync_1.TEMPLATE_SYNC_LOCAL_CONFIG} 
-
-## Stopped the following files from syncing:
-
-${result.localSkipFiles.reduce((s, file) => {
-        return `${s}* ${file}\n`;
-    }, "")}
-
-## Changed the following files from what they would have synced:
-
-${Object.keys(result.localFileChanges).reduce((s, file) => {
-        return `${s}${file}
-\`\`\`diff
-${result.localFileChanges[file].reduce((diffS, change) => {
-            return `${diffS}\n${makeChangeIntoDiffLines(change)}`;
-        }, "")}
-\`\`\``;
-    }, "")}
-
-## Files Modified (${result.modifiedFiles.total})
-
-Added:
-${result.modifiedFiles.added.reduce((s, f) => {
-        return `${s}\n- ${f}`;
-    }, "")}
-
-Modified:
-${result.modifiedFiles.modified.reduce((s, f) => {
-        return `${s}\n- ${f}`;
-    }, "")}
-
-Deleted:
-${result.modifiedFiles.deleted.reduce((s, f) => {
-        return `${s}\n- ${f}`;
-    }, "")}
-`;
-}
-exports.syncResultsToMd = syncResultsToMd;
-function makeChangeIntoDiffLines(change, nonchangeMax = 3) {
-    const operator = change.added ? "+" : change.removed ? "-" : "";
-    if (!operator &&
-        nonchangeMax > 0 &&
-        change.count &&
-        change.count > nonchangeMax) {
-        const lines = change.value.split("\n");
-        const partial = lines.slice(lines.length - nonchangeMax);
-        return `...\n${partial.join("\n")}\n`;
-    }
-    return change.value.split("\n").reduce((s, line) => {
-        return `${s}${operator}${line}\n`;
-    }, "");
-}

package/lib/esm/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./template-sync"), exports);
-__exportStar(require("./formatting"), exports);

package/lib/esm/load-plugin.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPlugin = void 0;
-const plugins_1 = require("./plugins");
-const fs_1 = require("fs");
-const path_1 = require("path");
-/**
- * Loads the plugin associated with the merge config
- * @param mergeConfig
- * @param forExt
- * @param configDir
- * @returns
- */
-async function loadPlugin(mergeConfig, configDir) {
-    if (mergeConfig.plugin.startsWith("_")) {
-        const defaultHandler = Object.values(plugins_1.defaultExtensionMap).find((el) => el.builtinName === mergeConfig.plugin);
-        if (!defaultHandler) {
-            throw new Error(`No builtin merge function supplied for ${mergeConfig.plugin}.  Cannot have merge config without custom plugin supplied.`);
-        }
-        return defaultHandler;
-    }
-    let handler;
-    // First check if this is a local .js file
-    const localPath = (0, path_1.resolve)(configDir, mergeConfig.plugin);
-    const importPath = (0, fs_1.existsSync)(localPath) ? localPath : mergeConfig.plugin;
-    try {
-        // Sad workaround for testing since dynamic import segfaults
-        if (process.env.JEST_WORKER_ID !== undefined) {
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            handler = require(importPath);
-        }
-        else {
-            handler = (await import(importPath));
-        }
-        if (!handler.merge) {
-            handler = handler
-                .default;
-        }
-    }
-    catch (err) {
-        console.error(err);
-        throw err;
-    }
-    return handler;
-}
-exports.loadPlugin = loadPlugin;

package/lib/esm/match.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAllFilesInDir = exports.invertMatchPatterns = void 0;
-const fs_1 = require("fs");
-const micromatch_1 = require("micromatch");
-const path_1 = require("path");
-function invertMatchPatterns(patterns) {
-    return patterns.map((pattern) => {
-        if (pattern.startsWith("!")) {
-            return pattern.slice(1);
-        }
-        return `!${pattern}`;
-    });
-}
-exports.invertMatchPatterns = invertMatchPatterns;
-/**
- * Gets all the files in the directory recursively while avoiding any micromatch patterns
- * that would match for ignoring
- *
- * @param dir
- * @param ignorePatterns
- * @returns
- */
-function getAllFilesInDir(dir, ignorePatterns) {
-    return recurseDirsForFiles(dir, ignorePatterns);
-}
-exports.getAllFilesInDir = getAllFilesInDir;
-function recurseDirsForFiles(dirpath, ignorePatterns, relativeRoot = "") {
-    return (0, fs_1.readdirSync)(dirpath, {
-        withFileTypes: true,
-    }).reduce((files, f) => {
-        const relPath = (0, path_1.join)(relativeRoot, f.name);
-        if ((0, micromatch_1.some)(relPath, ignorePatterns)) {
-            return files;
-        }
-        // Ensure we aren't ignoring these folders explicitly
-        if (f.isDirectory()) {
-            files.push(...recurseDirsForFiles((0, path_1.join)(dirpath, f.name), ignorePatterns, relPath));
-        }
-        else {
-            files.push(relPath);
-        }
-        return files;
-    }, []);
-}

package/lib/esm/merge-file.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeFile = void 0;
-const micromatch_1 = require("micromatch");
-const path_1 = require("path");
-const fs_1 = require("fs");
-const promises_1 = require("fs/promises");
-const load_plugin_1 = require("./load-plugin");
-const diff_1 = require("diff");
-const fs_extra_1 = require("fs-extra");
-/**
- * Applies the merge to a file according to the context information.
- *
- * Returns true if merged and false if skipped
- * @param relPath
- * @param context
- * @returns
- */
-async function mergeFile(relPath, context) {
-    const { localTemplateSyncConfig, templateSyncConfig, tempCloneDir, cwd } = context;
-    if ((0, micromatch_1.some)(relPath, localTemplateSyncConfig.ignore)) {
-        return {
-            ignoredDueToLocal: true,
-        };
-    }
-    const ext = (0, path_1.extname)(relPath);
-    const filePath = (0, path_1.join)(cwd, relPath);
-    const templatePath = (0, path_1.join)(tempCloneDir, relPath);
-    // Unless there's a need, we remove files that were deleted and don't pass them to plugins yet
-    if (context.fileOperation === "deleted") {
-        if ((0, fs_1.existsSync)(filePath)) {
-            await (0, promises_1.rm)(filePath);
-        }
-        return {
-            ignoredDueToLocal: false,
-            localChanges: [],
-        };
-    }
-    const mergeConfig = templateSyncConfig.merge?.find((mergeConfig) => (0, micromatch_1.isMatch)(relPath, mergeConfig.glob));
-    const localMergeConfig = localTemplateSyncConfig.merge?.find((mergeConfig) => (0, micromatch_1.isMatch)(relPath, mergeConfig.glob));
-    const mergeHandler = mergeConfig
-        ? await (0, load_plugin_1.loadPlugin)(mergeConfig, tempCloneDir)
-        : undefined;
-    const localMergeHandler = localMergeConfig
-        ? await (0, load_plugin_1.loadPlugin)(localMergeConfig, cwd)
-        : undefined;
-    // Either write the merge or write the file
-    let fileContents;
-    const localChanges = [];
-    if ((0, fs_1.existsSync)(filePath) && (mergeHandler || localMergeHandler)) {
-        const originalCurrentFile = (await (0, promises_1.readFile)(filePath)).toString();
-        if (mergeHandler) {
-            fileContents = await safeMerge(mergeHandler, mergeConfig?.plugin ?? `default for ${ext}`, originalCurrentFile, (await (0, promises_1.readFile)(templatePath)).toString(), {
-                relFilePath: relPath,
-                mergeArguments: mergeConfig?.options ?? {},
-                isLocalOptions: false,
-            });
-        }
-        else {
-            // Apply overwrite if we didn't set up merge
-            fileContents = (await (0, promises_1.readFile)(templatePath)).toString();
-        }
-        // We apply the localMerge Config to the fileContent output by the template merge
-        if (localMergeHandler) {
-            const localContents = await safeMerge(localMergeHandler, localMergeConfig?.plugin ?? `default for ${ext}`, originalCurrentFile, fileContents, {
-                relFilePath: relPath,
-                mergeArguments: localMergeConfig?.options ?? {},
-                isLocalOptions: true,
-            });
-            localChanges.push(...(0, diff_1.diffLines)(fileContents, localContents));
-            fileContents = localContents;
-        }
-    }
-    else {
-        // Just perform simple overwrite
-        fileContents = (await (0, promises_1.readFile)(templatePath)).toString();
-    }
-    await (0, fs_extra_1.outputFile)(filePath, fileContents);
-    return {
-        ignoredDueToLocal: false,
-        localChanges,
-    };
-}
-exports.mergeFile = mergeFile;
-/**
- * Simple helper function to ensure that we don't let bad plugins corrupt the call flow
- * @param plugin
- */
-async function safeMerge(plugin, pluginPath, current, fromTemplate, context) {
-    const ret = await plugin.merge(current, fromTemplate, context);
-    if (typeof ret !== "string") {
-        throw new Error(`Plugin ${pluginPath} did not return string for merge function!  This is not allowed!`);
-    }
-    if (!ret) {
-        throw new Error(`Plugin ${pluginPath} should not make a merge be an empty string!`);
-    }
-    return ret;
-}

package/lib/esm/plugins/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultExtensionMap = void 0;
-const json_merge_1 = require("./json-merge");
-exports.defaultExtensionMap = {
-    ".json": {
-        merge: json_merge_1.merge,
-        validate: json_merge_1.validate,
-        builtinName: "_json",
-    },
-};