@genesislcap/build-kit 14.142.0 → 14.142.1-alpha-d86f783.0

package/test/utils/seed.fetching.test.ts

@@ -0,0 +1,145 @@
+import { relative } from 'node:path';
+import { assert, createLogicSuite } from '@genesislcap/foundation-testing';
+import { getSeedDirs, resolveGitSeed, resolveNPMSeed } from '../../src/utils';
+
+const suite = createLogicSuite('resolveGitSeed');
+
+const scenarios = [
+  {
+    description: 'defaulting',
+    args: [],
+    expected: {
+      repo: 'genesiscommunitysuccess/blank-app-seed',
+      ref: 'main',
+      id: `gh:genesiscommunitysuccess/blank-app-seed#main`,
+    },
+  },
+  {
+    description: 'git user defaulting',
+    args: ['positions-app-seed'],
+    expected: {
+      repo: 'genesiscommunitysuccess/positions-app-seed',
+      ref: 'main',
+      id: `gh:genesiscommunitysuccess/positions-app-seed#main`,
+    },
+  },
+  {
+    description: 'custom ref',
+    args: ['positions-app-seed', 'mytag'],
+    expected: {
+      repo: 'genesiscommunitysuccess/positions-app-seed',
+      ref: 'mytag',
+      id: `gh:genesiscommunitysuccess/positions-app-seed#mytag`,
+    },
+  },
+  {
+    description: 'custom ref',
+    args: ['positions-app-seed', 'mytag', 'subfolder'],
+    expected: {
+      repo: 'genesiscommunitysuccess/positions-app-seed',
+      ref: 'mytag',
+      id: `gh:genesiscommunitysuccess/positions-app-seed/subfolder#mytag`,
+    },
+  },
+  {
+    description: 'custom provider',
+    args: ['positions-app-seed', 'mytag', 'subfolder', 'bitbucket'],
+    expected: {
+      repo: 'genesiscommunitysuccess/positions-app-seed',
+      ref: 'mytag',
+      id: `bitbucket:genesiscommunitysuccess/positions-app-seed/subfolder#mytag`,
+    },
+  },
+];
+
+scenarios.forEach((scenario) => {
+  suite(scenario.description, () => {
+    assert.equal(resolveGitSeed(...scenario.args), scenario.expected);
+  });
+});
+
+suite.run();
+
+const suite2 = createLogicSuite('resolveNPMSeed');
+
+const scenarios2 = [
+  {
+    description: 'defaulting',
+    args: [],
+    expected: {
+      artifact: 'genesislcap/blank-app-seed',
+      ref: 'latest',
+    },
+  },
+  {
+    description: 'custom seed',
+    args: ['positions-app-seed'],
+    expected: {
+      artifact: 'genesislcap/positions-app-seed',
+      ref: 'latest',
+    },
+  },
+  {
+    description: 'custom ref',
+    args: ['positions-app-seed', 'prerelease'],
+    expected: {
+      artifact: 'genesislcap/positions-app-seed',
+      ref: 'prerelease',
+    },
+  },
+  {
+    description: 'no scope',
+    args: ['my-seed', 'prerelease', 'false'],
+    expected: {
+      artifact: 'my-seed',
+      ref: 'prerelease',
+    },
+  },
+];
+
+scenarios2.forEach((scenario) => {
+  suite(scenario.description, () => {
+    assert.equal(resolveNPMSeed(...scenario.args), scenario.expected);
+  });
+});
+
+suite2.run();
+
+const suite3 = createLogicSuite('getSeedDirs');
+
+suite3('loading remote seed - init', async () => {
+  const dir = 'myapp';
+  const isInit = true;
+  const remote = true;
+  const result = getSeedDirs('blank-app-seed', dir, '', isInit, remote);
+  const genxDir = relative(process.cwd(), `${dir}/.genx`);
+  assert.equal(result, {
+    localPath: 'blank-app-seed',
+    dir,
+    subdir: '',
+    isLocalSeed: false,
+    genxDir,
+    extractedSeedDir: dir,
+    extractedSeedGenxDir: genxDir,
+  });
+});
+
+suite3('loading remote seed - add', async () => {
+  const dir = 'myapp';
+  const isInit = false;
+  const remote = true;
+  const result = getSeedDirs('blank-app-seed', dir, '', isInit, remote);
+  const genxDir = relative(process.cwd(), `${dir}/.genx`);
+  const extractedSeedGenxDir = relative(process.cwd(), `${dir}/.genx/tmp/.genx`);
+  assert.equal(result, {
+    localPath: 'blank-app-seed',
+    dir,
+    subdir: '',
+    isLocalSeed: false,
+    genxDir,
+    extractedSeedDir: `${dir}/.genx/tmp`,
+    extractedSeedGenxDir,
+  });
+});
+
+suite3.run();

package/test/utils/seed.meta.test.ts

@@ -0,0 +1,33 @@
+import { assert, createLogicSuite } from '@genesislcap/foundation-testing';
+import { loadGenxModule, loadSeed } from '../../src/utils';
+
+const suite = createLogicSuite('loadSeed');
+
+suite('loading local seed', async () => {
+  const result = await loadSeed('./test/fixtures/mock-seed/.genx');
+  assert.type(result.configure, 'function');
+});
+
+suite.run();
+
+const suite2 = createLogicSuite('loadGenxModule');
+
+suite2('loading local seed', async () => {
+  const result = await loadGenxModule('./test/fixtures/mock-seed/.genx');
+  assert.equal(result, {
+    name: 'mock-seed',
+    description: 'Mock Seed',
+    version: '1.0.0',
+    license: 'Apache-2.0',
+    genxSeedConfig: {
+      processFiles: {
+        interpolateVariables: {
+          enabled: true,
+          include: ['.kt', '.md'],
+        },
+      },
+    },
+  });
+});
+
+suite2.run();

package/dist/utils/seed.d.ts

@@ -1,31 +0,0 @@
-import type { PackageJson } from 'pkg-types';
-export type LocalFetchResult = {
-    local: boolean;
-    genxDir: string;
-    seed: string;
-    subdir: string;
-    pkg: PackageJson;
-    dir: string;
-    extractedSeedDir: string;
-    extractedSeedGenxDir: string;
-};
-export type RemoteFetchResult = LocalFetchResult & {
-    repo: string;
-    user: string;
-    ref: string;
-    provider: string;
-    id: string;
-};
-export type FetchResult = LocalFetchResult | RemoteFetchResult;
-export declare const installSeedDeps: (dir: any, isLogLevelVerbose: any) => Promise<void>;
-export declare const loadSeed: (dir: any) => Promise<{
-    prompts: any;
-    configure: any;
-    details: any;
-    defaults: import("inquirer").Question<import("inquirer").Answers>;
-    validators: import("inquirer").Question<import("inquirer").Answers>;
-    validate: (data: any) => any[];
-}>;
-export declare const fetchSeed: (seed: string, dir: string, remote: boolean, ref: string, insecure: boolean, subdir: string, isInit: boolean) => Promise<FetchResult>;
-export declare const configureSeedApp: (seedInfo: any, fetchSeedResult: any, params: any, dir: any, skipOptionalPrompts: any, isInit: boolean) => Promise<void>;
-//# sourceMappingURL=seed.d.ts.map

package/dist/utils/seed.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"seed.d.ts","sourceRoot":"","sources":["../../src/utils/seed.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAY7C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,WAAW,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAiB/D,eAAO,MAAM,eAAe,qDAmC3B,CAAC;AAGF,eAAO,MAAM,QAAQ;;;;;;;EAgBpB,CAAC;AAeF,eAAO,MAAM,SAAS,SACd,MAAM,OACP,MAAM,UACH,OAAO,OACV,MAAM,YACD,OAAO,UACT,MAAM,UACN,OAAO,KACd,QAAQ,WAAW,CAiFrB,CAAC;AA6FF,eAAO,MAAM,gBAAgB,iGAMnB,OAAO,kBAyChB,CAAC"}

package/dist/utils/seed.js

@@ -1,264 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configureSeedApp = exports.fetchSeed = exports.loadSeed = exports.installSeedDeps = void 0;
-const tslib_1 = require("tslib");
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const consola_1 = require("consola");
-const giget_1 = require("giget");
-const child_process_1 = require("./child-process");
-const console_1 = require("./console");
-const fs_1 = require("./fs");
-const handlebars_1 = require("./handlebars");
-const json_1 = require("./json");
-const object_1 = require("./object");
-const prompts_1 = require("./prompts");
-const PROMPT_DATA_FILE = 'answers.json';
-// map repo to Giget-compatible template ID
-const resolveSeed = (seed = '', ref = 'main', subdir = '', provider = 'gh') => {
-    const parts = seed.split('/');
-    const repo = parts.pop() || 'blank-app-seed';
-    const user = parts.pop() || 'genesiscommunitysuccess';
-    const dir = subdir ? `/${subdir}` : '';
-    return {
-        repo,
-        user,
-        ref,
-        provider,
-        id: `${provider}:${user}/${repo}${dir}#${ref}`,
-    };
-};
-const installSeedDeps = (dir, isLogLevelVerbose) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    let dependencies = {};
-    try {
-        const packageJSONPath = (0, node_path_1.resolve)(dir, 'package.json');
-        const packageJSON = require(packageJSONPath);
-        dependencies = packageJSON.dependencies || {};
-    }
-    catch (e) { }
-    consola_1.consola.debug('Seed NPM dependencies', {
-        targetInstallDir: dir,
-        dependencyCount: Object.keys(dependencies).length,
-    });
-    if (Object.keys(dependencies).length !== 0) {
-        const start2 = Date.now();
-        consola_1.consola.info('Installing seed NPM dependencies...');
-        yield (0, child_process_1.runAsync)(dir, 'npm install', {
-            prefixCommandWithNode: false,
-            exitOnError: false,
-            verbose: isLogLevelVerbose,
-            env: Object.assign(Object.assign({}, process.env), { NODE_ENV: 'production' }),
-        }).catch((err) => {
-            consola_1.consola.error('Unexpected error installing seed dependencies. Try re-runing with --log-level verbose');
-            if (err) {
-                consola_1.consola.error(err);
-            }
-            process.exit(1);
-        });
-        consola_1.consola.success(`Installed in ${Date.now() - start2}ms`);
-    }
-});
-exports.installSeedDeps = installSeedDeps;
-// load seed details including prompt question defaults and validators
-const loadSeed = (dir) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const GENX_RC = '.genxrc.js';
-    const genxConfigPath = (0, node_path_1.resolve)(dir, GENX_RC);
-    const { prompts, configure, details } = require(genxConfigPath);
-    const defaults = yield (0, prompts_1.getPromptDefaults)(prompts());
-    const validators = yield (0, prompts_1.getPromptValidators)(prompts());
-    const validate = (data) => (0, prompts_1.validateSeedData)(data, validators);
-    return {
-        prompts: prompts(),
-        configure: configure(),
-        details: details(),
-        defaults,
-        validators,
-        validate,
-    };
-});
-exports.loadSeed = loadSeed;
-const loadGenxModule = (genxDir, module = 'package.json', warnIfMissing = true) => {
-    const path = (0, node_path_1.resolve)(genxDir, module);
-    try {
-        return require(path);
-    }
-    catch (e) {
-        if (warnIfMissing) {
-            consola_1.consola.warn(`Could not load ${module} from ${genxDir}`);
-        }
-        return {};
-    }
-};
-// download remote or copy local seed
-const fetchSeed = (seed, dir, remote, ref, insecure, subdir, isInit) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    // disable SSL cert verification
-    if (insecure) {
-        process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-    }
-    const GENX_DIR = '/.genx';
-    const TMP_DIR = '/tmp';
-    const start = Date.now();
-    const localPath = subdir ? `${seed}/${subdir}` : seed;
-    const isLocalSeed = !remote && (0, node_fs_1.existsSync)(localPath);
-    const genxDir = (0, node_path_1.relative)(process.cwd(), `${dir}${GENX_DIR}`);
-    const extractedSeedDir = isInit ? dir : (0, node_path_1.relative)(process.cwd(), `${dir}${GENX_DIR}${TMP_DIR}`);
-    const extractedSeedGenxDir = isInit
-        ? genxDir
-        : (0, node_path_1.relative)(process.cwd(), `${extractedSeedDir}${GENX_DIR}`);
-    if (!isInit) {
-        yield (0, fs_1.rm)(extractedSeedDir);
-        (0, node_fs_1.mkdirSync)(extractedSeedDir);
-    }
-    let result;
-    if (isLocalSeed) {
-        consola_1.consola.info(`Copying local seed ${(0, console_1.bold)(localPath)}`);
-        try {
-            if (ref) {
-                consola_1.consola.warn(`${(0, console_1.bold)('ref')} has no effect when used with a local seed`);
-            }
-            (0, node_fs_1.cpSync)(localPath, extractedSeedDir, { recursive: true });
-            consola_1.consola.success(`Seed copied in ${Date.now() - start}ms`);
-            result = {
-                local: true,
-                genxDir,
-                seed: localPath,
-                subdir,
-                pkg: loadGenxModule(extractedSeedGenxDir),
-                dir,
-                extractedSeedDir,
-                extractedSeedGenxDir,
-            };
-        }
-        catch (e) {
-            consola_1.consola.error(`Error copying ${localPath} to ${(0, console_1.bold)(dir)}`, e);
-            process.exit(1);
-        }
-    }
-    else {
-        const data = resolveSeed(seed, ref, subdir);
-        const subDirMessage = subdir ? `, subdir ${(0, console_1.bold)(subdir)}` : '';
-        consola_1.consola.info(`Downloading ${(0, console_1.bold)(data.user)} seed ${(0, console_1.bold)(data.repo)} (Git ref ${(0, console_1.bold)(data.ref)}${subDirMessage}) to ${(0, console_1.bold)(dir)} directory...`);
-        try {
-            yield (0, giget_1.downloadTemplate)(data.id, {
-                dir: extractedSeedDir,
-                // auth?: string; // custom Authorization token to use for downloading template
-                registry: false, // disable built-in Giget registry
-            });
-            consola_1.consola.success(`Seed downloaded in ${Date.now() - start}ms`);
-            result = Object.assign({ local: false, genxDir,
-                seed,
-                subdir, pkg: loadGenxModule(extractedSeedGenxDir), dir,
-                extractedSeedDir,
-                extractedSeedGenxDir }, data);
-        }
-        catch (err) {
-            const error = process.env.DEBUG ? err : err.message;
-            consola_1.consola.error(error);
-            process.exit(1);
-        }
-    }
-    yield removeExclusions(extractedSeedDir, (_a = result.pkg.genxSeedConfig) === null || _a === void 0 ? void 0 : _a.exclude);
-    return result;
-});
-exports.fetchSeed = fetchSeed;
-const removeExclusions = (dir, exclusions) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    try {
-        const exclude = (exclusions !== null && exclusions !== void 0 ? exclusions : []).map((x) => (0, node_path_1.resolve)(dir, x));
-        yield Promise.all(exclude.map((exclusion) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-            if ((0, node_fs_1.existsSync)(exclusion)) {
-                yield (0, fs_1.rm)(exclusion);
-                consola_1.consola.debug(`Excluded: ${exclusion}`);
-            }
-            else {
-                consola_1.consola.debug(`Ignored invalid exclusion: ${exclusion}`);
-            }
-        })));
-    }
-    catch (err) {
-        const error = process.env.DEBUG ? err : err.message;
-        consola_1.consola.error(error);
-        process.exit(1);
-    }
-});
-const processItem = ({ base, dir: itemDir, path, isDir, ext, stats }, data, renamingEnabled, interpolationEnabled, interpolationWhitelist) => {
-    const baseNew = (0, handlebars_1.render)(base, data);
-    const needsRenaming = renamingEnabled && baseNew !== base;
-    const pathNew = needsRenaming ? (0, node_path_1.resolve)(itemDir, baseNew) : path;
-    if (needsRenaming) {
-        try {
-            (0, node_fs_1.renameSync)((0, node_path_1.resolve)(itemDir, base), (0, node_path_1.resolve)(itemDir, baseNew));
-            consola_1.consola.debug(`Renamed ${(0, console_1.bold)(base)} to ${(0, console_1.bold)(baseNew)}`);
-        }
-        catch (e) {
-            consola_1.consola.error(`Error renaming ${(0, console_1.bold)(base)} to ${(0, console_1.bold)(baseNew)}`);
-        }
-    }
-    // Handlebars rendering
-    if (interpolationEnabled && !isDir && interpolationWhitelist.some((i) => baseNew.includes(i))) {
-        try {
-            (0, handlebars_1.renderFile)(pathNew, data, pathNew);
-            consola_1.consola.debug(`Interpolated variables in ${pathNew}`);
-        }
-        catch (e) {
-            consola_1.consola.error(`Error interpolating variables in ${pathNew}`);
-        }
-    }
-    return { isDir, ext, dir: itemDir, base: baseNew, path: pathNew, stats };
-};
-const processOptions = (fetchSeedResult, dir, data, isInit, persistedAnswers) => {
-    var _a, _b;
-    const options = ((_a = fetchSeedResult.pkg) === null || _a === void 0 ? void 0 : _a.genxSeedConfig) || {};
-    consola_1.consola.debug('Seed options', JSON.stringify(options));
-    if (options.processFiles) {
-        const ignoreDirs = ((_b = options.processFiles) === null || _b === void 0 ? void 0 : _b.exclude) || [
-            '.git',
-            '.genx',
-            '.github',
-            'node_modules',
-            '.gradle',
-            'gradle',
-        ];
-        const filter = (entry) => !ignoreDirs.includes(entry.base);
-        const mapper = (entry) => {
-            var _a, _b, _c, _d, _e;
-            return processItem(entry, data, !!((_a = options.processFiles) === null || _a === void 0 ? void 0 : _a.rename), !!((_c = (_b = options.processFiles) === null || _b === void 0 ? void 0 : _b.interpolateVariables) === null || _c === void 0 ? void 0 : _c.enabled), (_e = (_d = options.processFiles) === null || _d === void 0 ? void 0 : _d.interpolateVariables) === null || _e === void 0 ? void 0 : _e.include);
-        };
-        (0, fs_1.listAllFiles)(dir, filter, mapper);
-    }
-    if (options.persistAnswers) {
-        const jsonPath = (0, node_path_1.resolve)(fetchSeedResult.genxDir, PROMPT_DATA_FILE);
-        const additions = persistedAnswers.additions || [];
-        const json = isInit
-            ? data
-            : Object.assign(Object.assign({}, data), { appSeed: persistedAnswers.appSeed, additions: [...additions, data.appSeed] });
-        (0, json_1.writeJSON)(jsonPath, json);
-    }
-};
-// run seed configure script
-const configureSeedApp = (seedInfo, fetchSeedResult, params, dir, skipOptionalPrompts, isInit) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const { configure, prompts, details, defaults, validate } = seedInfo;
-    // load persisted answers if available
-    const persistedAnswers = loadGenxModule(fetchSeedResult.genxDir, PROMPT_DATA_FILE, false);
-    // get prompt answers
-    const data = yield (0, prompts_1.getData)(persistedAnswers, prompts, details, defaults, validate, params, dir, skipOptionalPrompts, fetchSeedResult);
-    consola_1.consola.debug('Loaded seed data', data);
-    const utils = {
-        writeFileWithData: handlebars_1.renderFile,
-        editJSONFile: json_1.editJSONFile,
-        replaceObjectKeys: object_1.replaceObjectKeys,
-        listAllFiles: fs_1.listAllFiles,
-        rename: fs_1.rename,
-    };
-    // run seed configure script
-    yield configure(data, utils).catch((e) => consola_1.consola.error(e));
-    // process seed exclusions, render templates, rename files/folders
-    processOptions(fetchSeedResult, fetchSeedResult.extractedSeedDir, data, isInit, persistedAnswers);
-    // when adding seed, copy result from temp folder to the app root (omitting .genx folder of the seed)
-    if (!isInit) {
-        yield (0, fs_1.rm)(fetchSeedResult.extractedSeedGenxDir);
-        (0, node_fs_1.cpSync)(fetchSeedResult.extractedSeedDir, dir, { recursive: true });
-        yield (0, fs_1.rm)(fetchSeedResult.extractedSeedDir);
-    }
-});
-exports.configureSeedApp = configureSeedApp;