@cbnventures/nova 0.13.0 → 0.14.0

package/build/src/cli/utility/initialize.js

@@ -1,7 +1,7 @@
 import { relative, sep } from 'path';
 import chalk from 'chalk';
 import prompts from 'prompts';
-import { itemAllowedPoliciesByRole, itemAllowedSyncProperties } from '../../lib/item.js';
+import { itemAllowedPoliciesByRole, itemAllowedRecipes, itemInitializeRolesToSync, itemInitializeValidEntityRoles, } from '../../lib/item.js';
 import { NovaConfig } from '../../lib/nova-config.js';
 import { PATTERN_EMAIL_SIMPLE, PATTERN_SLUG_SCOPED, PATTERN_SLUG_SIMPLE } from '../../lib/regex.js';
 import { discoverPathsWithFile } from '../../lib/utility.js';
@@ -223,7 +223,7 @@ export class CLIUtilityInitialize {
         const currentSlug = (config.project !== undefined && config.project.name !== undefined) ? config.project.name.slug ?? '' : '';
         const slugChanged = previousSlug !== currentSlug;
         if (slugChanged && config.workspaces !== undefined) {
-            const rolesToSync = ['project', 'docs', 'config', 'app', 'tool'];
+            const rolesToSync = [...itemInitializeRolesToSync];
             const slugPrefix = new RegExp(`^${previousSlug}-`);
             Logger.customize({
                 name: 'CLIUtilityInitialize.promptProject',
@@ -231,10 +231,10 @@ export class CLIUtilityInitialize {
                 padTop: 1,
             }).info(`Project slug updated from "${previousSlug || '(unset)'}" to "${currentSlug || '(unset)'}".`);
             for (const workspace of Object.values(config.workspaces)) {
-                if (!rolesToSync.includes(workspace.role)) {
+                if (rolesToSync.includes(workspace.role) === false) {
                     continue;
                 }
-                const { name } = workspace;
+                const name = workspace.name;
                 if (previousSlug === '' && currentSlug !== '') {
                     workspace.name = `${currentSlug}-${name}`;
                 }
@@ -292,11 +292,15 @@ export class CLIUtilityInitialize {
         };
         while (true) {
             const choices = [];
-            entities.forEach((entity, index) => {
+            for (let i = 0; i < entities.length; i += 1) {
+                const entity = entities[i];
+                if (entity === undefined) {
+                    continue;
+                }
                 const entityName = (entity.name !== undefined) ? entity.name.trim() : '';
                 const entityEmail = (entity.email !== undefined) ? entity.email.trim() : '';
                 const entityRoles = (Array.isArray(entity.roles)) ? entity.roles.filter((role) => role.trim() !== '') : [];
-                const label = entityName || entityEmail || `Entity ${index + 1}`;
+                const label = entityName || entityEmail || `Entity ${i + 1}`;
                 const descriptionParts = [];
                 if (entityEmail !== '') {
                     descriptionParts.push(entityEmail);
@@ -306,7 +310,7 @@ export class CLIUtilityInitialize {
                         .map((entityRole) => entityRole.trim())
                         .filter((entityRole) => entityRole.length > 0)
                         .reduce((unique, entityRole) => {
-                        if (!unique.includes(entityRole)) {
+                        if (unique.includes(entityRole) === false) {
                             unique.push(entityRole);
                         }
                         return unique;
@@ -321,7 +325,7 @@ export class CLIUtilityInitialize {
                     description: (description !== '') ? description : 'Update this entity.',
                     value: {
                         kind: 'edit',
-                        index,
+                        index: i,
                     },
                 });
                 choices.push({
@@ -329,10 +333,10 @@ export class CLIUtilityInitialize {
                     description: 'Delete this entity.',
                     value: {
                         kind: 'remove',
-                        index,
+                        index: i,
                     },
                 });
-            });
+            }
             choices.push({
                 title: 'Add new entity',
                 description: 'Create a new entity.',
@@ -387,7 +391,7 @@ export class CLIUtilityInitialize {
                 if (entityResult.action === 'back') {
                     continue;
                 }
-                entities[entityIndex] = entityResult.entity;
+                Reflect.set(entities, entityIndex, entityResult.entity);
                 sync();
                 Logger.customize({
                     name: 'CLIUtilityInitialize.promptEntities',
@@ -425,7 +429,7 @@ export class CLIUtilityInitialize {
         }
     }
     static async promptEntitiesForm(entity, mode) {
-        const validRoles = ['author', 'contributor', 'supporter'];
+        const validRoles = [...itemInitializeValidEntityRoles];
         const existingName = (entity !== undefined && typeof entity.name === 'string') ? entity.name : '';
         const existingEmail = (entity !== undefined && typeof entity.email === 'string') ? entity.email : '';
         const existingUrl = (entity !== undefined && typeof entity.url === 'string') ? entity.url : '';
@@ -699,7 +703,7 @@ export class CLIUtilityInitialize {
         return 'back';
     }
     static async promptWorkspaces(config) {
-        const workspaces = (config.workspaces) ? { ...(config.workspaces) } : {};
+        const workspaces = (config.workspaces !== undefined) ? { ...(config.workspaces) } : {};
         const rawWorkspacePaths = await discoverPathsWithFile('package.json', 'forward');
         const workspacePaths = rawWorkspacePaths.map((rawWorkspacePath) => {
             const relativePath = relative(process.cwd(), rawWorkspacePath);
@@ -845,11 +849,13 @@ export class CLIUtilityInitialize {
             type: 'select',
             name: 'workspaceRole',
             message: `Select a role for "${options.workspacePath}"`,
-            choices: allowedRoles.map((role) => ({
-                title: role.title,
-                description: role.description,
-                value: role.value,
-            })),
+            choices: allowedRoles.map((allowedRole) => {
+                return {
+                    title: allowedRole.title,
+                    description: allowedRole.description,
+                    value: allowedRole.value,
+                };
+            }),
             initial: Math.max(0, allowedRoles.findIndex((role) => options.existingWorkspace !== undefined && role.value === options.existingWorkspace.role)),
         });
         if (rolePrompt.cancelled) {
@@ -863,12 +869,15 @@ export class CLIUtilityInitialize {
             type: 'select',
             name: 'workspacePolicy',
             message: 'Select a policy',
-            choices: allowedPolicies.map((allowedPolicy) => ({
-                title: policy[allowedPolicy].label,
-                description: policy[allowedPolicy].description,
-                value: allowedPolicy,
-            })),
-            initial: Math.max(0, allowedPolicies.findIndex((policy) => options.existingWorkspace !== undefined && policy === options.existingWorkspace.policy)),
+            choices: allowedPolicies.map((allowedPolicy) => {
+                const policyEntry = Reflect.get(policy, allowedPolicy);
+                return {
+                    title: policyEntry.label,
+                    description: policyEntry.description,
+                    value: allowedPolicy,
+                };
+            }),
+            initial: Math.max(0, allowedPolicies.findIndex((allowedPolicy) => options.existingWorkspace !== undefined && allowedPolicy === options.existingWorkspace.policy)),
         });
         if (policyPrompt.cancelled) {
             return {
@@ -882,61 +891,233 @@ export class CLIUtilityInitialize {
                 action: 'back',
             };
         }
-        let syncProperties;
-        if (selectedPolicy === 'distributable') {
-            const syncPropertiesPrompt = await CLIUtilityInitialize.promptWithCancel({
-                type: 'multiselect',
-                name: 'workspaceSyncProperties',
-                message: 'Select metadata properties to sync',
-                choices: itemAllowedSyncProperties.map((property) => ({
-                    title: property,
-                    value: property,
-                    selected: (options.existingWorkspace !== undefined && options.existingWorkspace.syncProperties !== undefined) ? options.existingWorkspace.syncProperties.includes(property) : false,
-                })),
-            });
-            if (syncPropertiesPrompt.cancelled) {
+        const existingRecipes = (options.existingWorkspace !== undefined && options.existingWorkspace.recipes !== undefined) ? options.existingWorkspace.recipes : undefined;
+        const recipesPrompt = await CLIUtilityInitialize.promptWithCancel({
+            type: 'multiselect',
+            name: 'workspaceRecipes',
+            message: 'Select recipes to enable',
+            choices: itemAllowedRecipes.map((recipe) => {
+                const recipeTuple = (existingRecipes !== undefined) ? Reflect.get(existingRecipes, recipe) : undefined;
+                const recipeSelected = (Array.isArray(recipeTuple) && recipeTuple.length > 0 && recipeTuple[0] === true);
                 return {
-                    action: 'back',
+                    title: recipe,
+                    value: recipe,
+                    selected: recipeSelected,
                 };
-            }
-            const selectedSyncProperties = syncPropertiesPrompt.result.workspaceSyncProperties;
-            if (selectedSyncProperties.length > 0) {
-                syncProperties = selectedSyncProperties;
-            }
-        }
-        const pinVersionsPrompt = await CLIUtilityInitialize.promptWithCancel({
-            type: 'confirm',
-            name: 'workspacePinVersions',
-            message: 'Pin dependency versions?',
-            initial: options.existingWorkspace !== undefined && options.existingWorkspace.pinVersions === true,
+            }),
         });
-        if (pinVersionsPrompt.cancelled) {
+        if (recipesPrompt.cancelled) {
             return {
                 action: 'back',
             };
         }
-        const selectedPinVersions = pinVersionsPrompt.result.workspacePinVersions;
-        const syncLtsEnginesPrompt = await CLIUtilityInitialize.promptWithCancel({
-            type: 'confirm',
-            name: 'workspaceSyncLtsEngines',
-            message: 'Sync Node.js LTS engine constraint?',
-            initial: options.existingWorkspace !== undefined && options.existingWorkspace.syncLtsEngines === true,
-        });
-        if (syncLtsEnginesPrompt.cancelled) {
-            return {
-                action: 'back',
-            };
+        const selectedRecipes = recipesPrompt.result.workspaceRecipes;
+        const recipes = {};
+        for (const recipe of selectedRecipes) {
+            const existingTupleRaw = (existingRecipes !== undefined) ? Reflect.get(existingRecipes, recipe) : undefined;
+            const existingTuple = (Array.isArray(existingTupleRaw)) ? existingTupleRaw : undefined;
+            const existingSettings = (existingTuple !== undefined && existingTuple.length > 1) ? existingTuple[1] : undefined;
+            if (recipe === 'sync-identity' && selectedPolicy === 'distributable') {
+                const settingsPrompt = await CLIUtilityInitialize.promptWithCancel({
+                    type: 'multiselect',
+                    name: 'workspaceRecipeSettings',
+                    message: 'sync-identity: Select properties to sync',
+                    choices: [
+                        {
+                            title: 'description',
+                            value: 'description',
+                            selected: existingSettings !== undefined && existingSettings['description'] === true,
+                        },
+                        {
+                            title: 'keywords',
+                            value: 'keywords',
+                            selected: existingSettings !== undefined && existingSettings['keywords'] === true,
+                        },
+                    ],
+                });
+                if (settingsPrompt.cancelled) {
+                    return {
+                        action: 'back',
+                    };
+                }
+                const selectedSettings = settingsPrompt.result.workspaceRecipeSettings;
+                if (selectedSettings.length > 0) {
+                    const settings = {};
+                    for (const setting of selectedSettings) {
+                        Reflect.set(settings, setting, true);
+                    }
+                    Reflect.set(recipes, recipe, [true, settings]);
+                }
+                else {
+                    Reflect.set(recipes, recipe, [true]);
+                }
+            }
+            else if (recipe === 'sync-ownership' && selectedPolicy === 'distributable') {
+                const settingsPrompt = await CLIUtilityInitialize.promptWithCancel({
+                    type: 'multiselect',
+                    name: 'workspaceRecipeSettings',
+                    message: 'sync-ownership: Select properties to sync',
+                    choices: [
+                        {
+                            title: 'homepage',
+                            value: 'homepage',
+                            selected: existingSettings !== undefined && existingSettings['homepage'] === true,
+                        },
+                        {
+                            title: 'bugs',
+                            value: 'bugs',
+                            selected: existingSettings !== undefined && existingSettings['bugs'] === true,
+                        },
+                        {
+                            title: 'author',
+                            value: 'author',
+                            selected: existingSettings !== undefined && existingSettings['author'] === true,
+                        },
+                        {
+                            title: 'contributors',
+                            value: 'contributors',
+                            selected: existingSettings !== undefined && existingSettings['contributors'] === true,
+                        },
+                        {
+                            title: 'funding',
+                            value: 'funding',
+                            selected: existingSettings !== undefined && existingSettings['funding'] === true,
+                        },
+                        {
+                            title: 'repository',
+                            value: 'repository',
+                            selected: existingSettings !== undefined && existingSettings['repository'] === true,
+                        },
+                    ],
+                });
+                if (settingsPrompt.cancelled) {
+                    return {
+                        action: 'back',
+                    };
+                }
+                const selectedSettings = settingsPrompt.result.workspaceRecipeSettings;
+                if (selectedSettings.length > 0) {
+                    const settings = {};
+                    for (const setting of selectedSettings) {
+                        Reflect.set(settings, setting, true);
+                    }
+                    Reflect.set(recipes, recipe, [true, settings]);
+                }
+                else {
+                    Reflect.set(recipes, recipe, [true]);
+                }
+            }
+            else if (recipe === 'sync-environment') {
+                const settingsPrompt = await CLIUtilityInitialize.promptWithCancel({
+                    type: 'multiselect',
+                    name: 'workspaceRecipeSettings',
+                    message: 'sync-environment: Select settings',
+                    choices: [
+                        {
+                            title: 'trackNodeLtsVersions',
+                            value: 'trackNodeLtsVersions',
+                            selected: existingSettings !== undefined && existingSettings['trackNodeLtsVersions'] === true,
+                        },
+                    ],
+                });
+                if (settingsPrompt.cancelled) {
+                    return {
+                        action: 'back',
+                    };
+                }
+                const selectedSettings = settingsPrompt.result.workspaceRecipeSettings;
+                if (selectedSettings.length > 0) {
+                    const settings = {};
+                    for (const setting of selectedSettings) {
+                        Reflect.set(settings, setting, true);
+                    }
+                    Reflect.set(recipes, recipe, [true, settings]);
+                }
+                else {
+                    Reflect.set(recipes, recipe, [true]);
+                }
+            }
+            else if (recipe === 'cleanup') {
+                const settingsPrompt = await CLIUtilityInitialize.promptWithCancel({
+                    type: 'multiselect',
+                    name: 'workspaceRecipeSettings',
+                    message: 'cleanup: Select settings',
+                    choices: [
+                        {
+                            title: 'removeUnknownKeys',
+                            value: 'removeUnknownKeys',
+                            selected: existingSettings !== undefined && existingSettings['removeUnknownKeys'] === true,
+                        },
+                        {
+                            title: 'reorderKeys',
+                            value: 'reorderKeys',
+                            selected: existingSettings !== undefined && existingSettings['reorderKeys'] === true,
+                        },
+                    ],
+                });
+                if (settingsPrompt.cancelled) {
+                    return {
+                        action: 'back',
+                    };
+                }
+                const selectedSettings = settingsPrompt.result.workspaceRecipeSettings;
+                if (selectedSettings.length > 0) {
+                    const settings = {};
+                    for (const setting of selectedSettings) {
+                        Reflect.set(settings, setting, true);
+                    }
+                    Reflect.set(recipes, recipe, [true, settings]);
+                }
+                else {
+                    Reflect.set(recipes, recipe, [true]);
+                }
+            }
+            else if (recipe === 'normalize-dependencies') {
+                const settingsPrompt = await CLIUtilityInitialize.promptWithCancel({
+                    type: 'multiselect',
+                    name: 'workspaceRecipeSettings',
+                    message: 'normalize-dependencies: Select settings',
+                    choices: [
+                        {
+                            title: 'pinDependencyVersions',
+                            value: 'pinDependencyVersions',
+                            selected: existingSettings !== undefined && existingSettings['pinDependencyVersions'] === true,
+                        },
+                        {
+                            title: 'pinDevDependencyVersions',
+                            value: 'pinDevDependencyVersions',
+                            selected: existingSettings !== undefined && existingSettings['pinDevDependencyVersions'] === true,
+                        },
+                    ],
+                });
+                if (settingsPrompt.cancelled) {
+                    return {
+                        action: 'back',
+                    };
+                }
+                const selectedSettings = settingsPrompt.result.workspaceRecipeSettings;
+                if (selectedSettings.length > 0) {
+                    const settings = {};
+                    for (const setting of selectedSettings) {
+                        Reflect.set(settings, setting, true);
+                    }
+                    Reflect.set(recipes, recipe, [true, settings]);
+                }
+                else {
+                    Reflect.set(recipes, recipe, [true]);
+                }
+            }
+            else {
+                Reflect.set(recipes, recipe, [true]);
+            }
         }
-        const selectedSyncLtsEngines = syncLtsEnginesPrompt.result.workspaceSyncLtsEngines;
         return {
             action: 'apply',
             workspace: {
                 name: resolvedName,
                 role: selectedRole,
                 policy: selectedPolicy,
-                ...(syncProperties !== undefined) ? { syncProperties } : {},
-                ...(selectedPinVersions === true) ? { pinVersions: selectedPinVersions } : {},
-                ...(selectedSyncLtsEngines === true) ? { syncLtsEngines: selectedSyncLtsEngines } : {},
+                ...(Object.keys(recipes).length > 0) ? { recipes } : {},
             },
         };
     }
@@ -1010,7 +1191,7 @@ export class CLIUtilityInitialize {
                 sanitized: undefined,
             };
         }
-        if (!PATTERN_EMAIL_SIMPLE.test(trimmedValue)) {
+        if (PATTERN_EMAIL_SIMPLE.test(trimmedValue) === false) {
             return {
                 result: 'Enter a valid email address or leave blank.',
                 sanitized: undefined,
@@ -1036,7 +1217,7 @@ export class CLIUtilityInitialize {
             };
         }
         if (trimmedValue.length > 214
-            || !new RegExp(PATTERN_SLUG_SIMPLE, 'i').test(trimmedValue)) {
+            || new RegExp(PATTERN_SLUG_SIMPLE, 'i').test(trimmedValue) === false) {
             return {
                 result: 'Use only letters, numbers, hyphens, or underscores, and keep it at 214 characters or fewer.',
                 sanitized: undefined,
@@ -1091,7 +1272,9 @@ export class CLIUtilityInitialize {
             .map((item) => item.trim())
             .filter((item) => item !== '');
         for (let i = 0; i < items.length; i += 1) {
-            const { result, sanitized } = CLIUtilityInitialize.normalizeText(items[i], maxLengthPerItem);
+            const normalizedText = CLIUtilityInitialize.normalizeText(items[i], maxLengthPerItem);
+            const result = normalizedText.result;
+            const sanitized = normalizedText.sanitized;
             if (result !== true) {
                 return {
                     result: `Invalid entry "${items[i]}": Input a value under ${maxLengthPerItem} character(s) or remove entry.`,
@@ -1099,7 +1282,7 @@ export class CLIUtilityInitialize {
                 };
             }
             if (sanitized !== undefined) {
-                items[i] = sanitized;
+                Reflect.set(items, i, sanitized);
             }
         }
         return {
@@ -1168,7 +1351,9 @@ export class CLIUtilityInitialize {
             .map((item) => item.trim())
             .filter((item) => item !== '');
         for (let i = 0; i < items.length; i += 1) {
-            const { result, sanitized } = CLIUtilityInitialize.normalizeUrl(items[i], protocol);
+            const normalizedUrl = CLIUtilityInitialize.normalizeUrl(items[i], protocol);
+            const result = normalizedUrl.result;
+            const sanitized = normalizedUrl.sanitized;
             if (result !== true) {
                 const errorMessages = {
                     generic: 'Enter a valid generic URL (e.g., https://) or remove entry.',
@@ -1181,7 +1366,7 @@ export class CLIUtilityInitialize {
                 };
             }
             if (sanitized !== undefined) {
-                items[i] = sanitized;
+                Reflect.set(items, i, sanitized);
             }
         }
         return {
@@ -1208,7 +1393,7 @@ export class CLIUtilityInitialize {
             case 'app':
             case 'tool': {
                 const expectedPrefix = `${base}-`;
-                if (!trimmedValue.startsWith(expectedPrefix)) {
+                if (trimmedValue.startsWith(expectedPrefix) === false) {
                     return {
                         result: `Begin with "${expectedPrefix}" and add a descriptor slug.`,
                         sanitized: undefined,
@@ -1221,7 +1406,7 @@ export class CLIUtilityInitialize {
                         sanitized: undefined,
                     };
                 }
-                if (!PATTERN_SLUG_SIMPLE.test(descriptor)) {
+                if (PATTERN_SLUG_SIMPLE.test(descriptor) === false) {
                     return {
                         result: 'Descriptor must match the slug pattern (lowercase letters, numbers, hyphens, underscores).',
                         sanitized: undefined,
@@ -1235,7 +1420,7 @@ export class CLIUtilityInitialize {
             case 'template':
             case 'package':
             default: {
-                if (PATTERN_SLUG_SIMPLE.test(trimmedValue) || PATTERN_SLUG_SCOPED.test(trimmedValue)) {
+                if (PATTERN_SLUG_SIMPLE.test(trimmedValue) === true || PATTERN_SLUG_SCOPED.test(trimmedValue) === true) {
                     return {
                         result: true,
                         sanitized: trimmedValue,