windows-development-sandbox 1.1.0 → 1.4.0

package/dist/cli/settings/index.js

@@ -1,131 +0,0 @@
-// The settings screen in the menu: every setting, generated from the zod schemas (so nothing needs to be listed by
-// hand), shown with its current value and description, edited with a fitting prompt and saved to a config file. Two
-// files can be edited: your own (all projects) and this folder's .sandbox-config.json (only what a project may set).
-// Edits keep comments and formatting, and nothing is written unless the whole file is still valid.
-import fs from 'node:fs';
-import path from 'node:path';
-import { select, Separator } from '@inquirer/prompts';
-import _ from 'lodash';
-import { DEFAULTS, loadConfig, userConfigPath } from '../../core/config.js';
-import { LOCAL_CONFIG_NAME, NEVER_LOOSER } from '../../core/local-config.js';
-import { Config as ConfigSchema, LocalOverrides } from '../../core/schema.js';
-import { c, clearScreen, pageSizeFor, shortenMiddle, termWidth } from '../colors.js';
-import { editConfigText, fileValue } from './edit.js';
-import { askValue } from './prompts.js';
-import { childrenOf, describeSetting, isSection, unwrap } from './schema.js';
-export { editConfigText } from './edit.js';
-/** Titles of the top-level sections in the menu. A test makes sure every section of the schema has one. */
-export const SECTION_TITLES = {
-    toolchains: 'Languages and tools', databases: 'Databases', sandbox: 'The sandbox machine (memory, window, GPU, network)', attach: 'Attaching (auto attach, auto hide)', agentCommands: 'Agent commands: claude, codex ... start in a sandbox (Beta)',
-    provisioning: 'Provisioning and git', downloads: 'Downloads (checksums)', secrets: 'Secrets', claudeProfile: 'Your Claude settings and history', storage: 'Storage',
-    network: 'Network', hooks: 'Hooks', personalization: 'Desktop look', projects: 'Several projects (project roots, adding folders while running)',
-};
-/** A value in one short line: maps as their keys, long lists shortened. */
-const show = (value) => {
-    if (value === undefined)
-        return c.dim('(not set)');
-    if (typeof value === 'string')
-        return value;
-    if (value && typeof value === 'object' && !Array.isArray(value)) {
-        const keys = Object.keys(value);
-        return keys.length ? '{ ' + _.truncate(keys.join(', '), { length: 60 }) + ' }' : '{}';
-    }
-    return _.truncate(JSON.stringify(value), { length: 70 });
-};
-const readText = (file) => (fs.existsSync(file) ? fs.readFileSync(file, 'utf8') : '');
-/** The user's settings with the built-in defaults filled in (what a sandbox would use without a project file). */
-const userConfig = (file) => loadConfig(fs.existsSync(file) ? file : undefined).config;
-/** What is in effect now: for your own file the merged config, for a project file only what that file sets. */
-const currentValue = (session, key, text, config) => session.target === 'project' ? fileValue(text, key) : _.get(config, key);
-/** Edits one setting: shows it, asks, saves (or resets it to the default / removes it from the project file). */
-const editSetting = async (session, schema, key, config) => {
-    const { file, target } = session;
-    const text = readText(file);
-    const inFile = fileValue(text, key);
-    const project = target === 'project';
-    console.log('\n' + c.cyan(key.join('.')) + (describeSetting(schema) ? '\n' + c.dim(describeSetting(schema)) : ''));
-    if (project && NEVER_LOOSER.includes(key.join('.')))
-        console.log(c.yellow('A project can only make this stricter than your own setting; a looser value is ignored.'));
-    console.log('Now: ' + (project ? show(inFile) + c.dim(inFile === undefined ? '  (not set in this project; yours: ' + show(_.get(config, key)) + ')' : '  (set in ' + file + ')') : show(_.get(config, key)) + (inFile === undefined ? c.dim('  (built-in default)') : c.dim('  (set in ' + file + ')'))));
-    const resetLabel = project ? 'Remove from this project file' : 'Reset to the default (' + show(_.get(DEFAULTS, key)) + ')';
-    const action = inFile === undefined ? 'change' : await select({ message: 'What now?', choices: [{ name: 'Change it', value: 'change' }, { name: resetLabel, value: 'reset' }, { name: c.dim('< back'), value: 'back' }] });
-    if (action === 'back')
-        return;
-    const answer = action === 'reset' ? { value: undefined } : await askValue(schema, key, project ? inFile ?? _.get(config, key) : _.get(config, key), config);
-    if (!answer)
-        return;
-    // In your own file the default needs no line; an unchanged value needs no save.
-    const value = !project && _.isEqual(answer.value, _.get(DEFAULTS, key)) ? undefined : answer.value;
-    if (value === inFile && (project || _.isEqual(answer.value, _.get(config, key)))) {
-        console.log(c.dim('Unchanged.'));
-        return;
-    }
-    const result = editConfigText(text, key, value, target);
-    if ('problems' in result) {
-        console.log(c.red('Not saved: ') + result.problems.join('; '));
-        return;
-    }
-    fs.mkdirSync(path.dirname(file), { recursive: true });
-    fs.writeFileSync(file, result.text, 'utf8');
-    console.log(c.green('Saved') + c.dim(' to ' + file + (project ? '.' : '. New sandboxes use it.')));
-    // The approval is tied to the file's exact contents, so any change makes the project file untrusted again.
-    if (project)
-        console.log(c.yellow('This project file is not approved any more: the next launch shows what it applies and asks you to approve it.'));
-};
-/** Browses one level of settings; sections open, leaves are edited. */
-const browse = async (session, schema, key) => {
-    for (;;) {
-        const config = userConfig(session.target === 'user' ? session.file : userConfigPath());
-        const entries = childrenOf(schema);
-        const text = readText(session.file);
-        clearScreen();
-        console.log(c.dim('Editing ' + shortenMiddle(session.file, termWidth() - 10)) + '\n' + c.dim('Values in ') + c.yellow('yellow') + c.dim(' (marked *) are set in that file; the rest are defaults.') + '\n');
-        const pickName = await select({
-            message: key.length ? key.join('.') : 'Settings',
-            pageSize: pageSizeFor(18),
-            choices: [
-                ...entries.map(([name, s]) => {
-                    const full = [...key, name];
-                    const changed = fileValue(text, full) !== undefined;
-                    const shown = show(currentValue(session, full, text, config));
-                    const label = isSection(s) ? (key.length ? name : SECTION_TITLES[name] ?? name) + c.dim(' ...') : name.padEnd(18) + ' ' + (changed ? c.yellow(shown) + ' *' : shown);
-                    return { name: label, value: name, description: describeSetting(s) };
-                }),
-                new Separator(),
-                { name: c.dim('< back'), value: '@back' },
-            ],
-        });
-        if (pickName === '@back')
-            return;
-        const child = unwrap(schema).shape[pickName];
-        if (isSection(child))
-            await browse(session, child, [...key, pickName]);
-        else
-            await editSetting(session, child, [...key, pickName], config);
-    }
-};
-/**
- * The settings screen: first which file to edit (your own, or this folder's project file), then its settings. Your file
- * is created when missing; so is the project file once a setting is saved.
- */
-export const settingsMenu = async (configPath, projectDir = process.cwd()) => {
-    const sessions = {
-        user: { target: 'user', file: configPath ?? userConfigPath(), schema: ConfigSchema },
-        project: { target: 'project', file: path.join(projectDir, LOCAL_CONFIG_NAME), schema: LocalOverrides },
-    };
-    for (;;) {
-        clearScreen();
-        const which = await select({
-            message: 'Which settings?',
-            choices: [
-                { name: 'Your settings (all projects)', description: sessions.user.file, value: 'user' },
-                { name: 'This project', description: sessions.project.file + ' (only what a project may set; needs your approval at launch)', value: 'project' },
-                new Separator(),
-                { name: c.dim('< back'), value: '@back' },
-            ],
-        });
-        if (which === '@back')
-            return;
-        await browse(sessions[which], sessions[which].schema, []);
-    }
-};

package/dist/cli/settings/prompts.d.ts

@@ -1,7 +0,0 @@
-import type { Config } from '../../core/types.js';
-import { type Schema } from './schema.js';
-export type Answer = {
-    value: unknown;
-} | undefined;
-/** `key` is the setting's path; `config` (the user's settings) lets the default agent be picked from the configured ones. */
-export declare const askValue: (schema: Schema, key: string[], current: unknown, config?: Config) => Promise<Answer>;

package/dist/cli/settings/prompts.js

@@ -1,48 +0,0 @@
-// The prompt that fits a setting's type. Returns the new value, or undefined to change nothing.
-import { input, select } from '@inquirer/prompts';
-import { c } from '../colors.js';
-import { jsonExample, kind, promptKind, unwrap } from './schema.js';
-const CANCEL = '@cancel';
-const cancel = { name: c.dim('< cancel'), value: CANCEL };
-const pick = async (label, choices, current) => {
-    const v = await select({ message: label, choices: [...choices, cancel], default: current });
-    return v === CANCEL ? undefined : { value: v };
-};
-const typed = async (label, current, validate, convert) => {
-    const shown = current === undefined ? '' : typeof current === 'string' ? current : JSON.stringify(current);
-    const answer = await input({ message: label + c.dim(' (empty = cancel)'), default: shown, validate: (v) => (v === '' ? true : validate(v)) });
-    return answer === '' ? undefined : { value: convert(answer) };
-};
-const BOOLEANS = [{ name: 'true', value: true }, { name: 'false', value: false }];
-/** `key` is the setting's path; `config` (the user's settings) lets the default agent be picked from the configured ones. */
-export const askValue = async (schema, key, current, config) => {
-    const label = key.join('.');
-    const s = unwrap(schema);
-    // The default agent is one of the configured ones: a list, not free text.
-    if (label === 'defaultHarness' && config)
-        return pick(label, Object.keys(config.harnesses).map((h) => ({ name: h, value: h })), current);
-    switch (promptKind(s)) {
-        case 'boolean': return pick(label, BOOLEANS, current);
-        case 'enum': return pick(label, Object.values(s._zod.def.entries ?? {}).map((v) => ({ name: String(v), value: v })), current);
-        case 'union': {
-            const options = s._zod.def.options ?? [];
-            const literals = options.filter((o) => kind(o) === 'literal').flatMap((o) => unwrap(o)._zod.def.values ?? []);
-            const other = options.find((o) => !['literal', 'boolean'].includes(kind(o)));
-            const choices = [...(options.some((o) => kind(o) === 'boolean') ? BOOLEANS : []), ...literals.map((v) => ({ name: String(v), value: v }))];
-            if (!other)
-                return pick(label, choices, current);
-            const chosen = await pick(label, [...choices, { name: 'a ' + kind(other) + ' ...', value: '@other' }], current);
-            return chosen?.value === '@other' ? askValue(other, key, current) : chosen;
-        }
-        case 'number': return typed(label, current, (v) => (Number.isFinite(Number(v)) ? true : 'Enter a number, e.g. 8192.'), Number);
-        case 'string': return typed(label, current, () => true, (v) => v);
-        case 'string-list': return typed(label + c.dim(' (comma separated, [] = none)'), current, () => true, (v) => (v.trim() === '[]' ? [] : v.split(',').map((x) => x.trim()).filter(Boolean)));
-        default: return typed(label + c.dim(' (JSON, e.g. ' + jsonExample(key, s) + ')'), current, (v) => { try {
-            JSON.parse(v);
-            return true;
-        }
-        catch {
-            return 'valid JSON';
-        } }, (v) => JSON.parse(v));
-    }
-};

package/dist/cli/settings/schema.d.ts

@@ -1,33 +0,0 @@
-import type { z } from 'zod';
-export type Schema = z.ZodType & {
-    _zod: {
-        def: {
-            type: string;
-            options?: Schema[];
-            values?: unknown[];
-            entries?: Record<string, string>;
-            element?: Schema;
-            innerType?: Schema;
-        };
-    };
-    shape?: Record<string, Schema>;
-    description?: string;
-};
-/** optional()/default() wrappers hide the real type. */
-export declare const unwrap: (s: Schema) => Schema;
-export declare const kind: (s: Schema) => string;
-export declare const isSection: (s: Schema) => boolean;
-/** The settings one level below a section (or the top level), in schema order. */
-export declare const childrenOf: (schema: Schema) => [string, Schema][];
-/** The description, which `.partial()` and `.optional()` wrappers may carry on the inner schema instead. */
-export declare const describeSetting: (s: Schema) => string | undefined;
-/** Every setting that is edited with a prompt of its own (everything that is not a section), with its path. */
-export declare const leavesOf: (schema: Schema, key?: string[]) => {
-    key: string[];
-    schema: Schema;
-}[];
-export type PromptKind = 'boolean' | 'enum' | 'union' | 'number' | 'string' | 'string-list' | 'json';
-/** Which prompt edits this setting. Lists of objects and maps (mappings, harnesses, environment) fall back to JSON. */
-export declare const promptKind: (schema: Schema) => PromptKind;
-/** A one-line example of the JSON a setting expects, shown in its prompt. */
-export declare const jsonExample: (key: string[], schema: Schema) => string;

package/dist/cli/settings/schema.js

@@ -1,29 +0,0 @@
-/** optional()/default() wrappers hide the real type. */
-export const unwrap = (s) => (['optional', 'default', 'nullable'].includes(s._zod.def.type) && s._zod.def.innerType ? unwrap(s._zod.def.innerType) : s);
-export const kind = (s) => unwrap(s)._zod.def.type;
-export const isSection = (s) => kind(s) === 'object' && Boolean(unwrap(s).shape);
-/** Settings not worth editing here (the schema link). */
-const HIDDEN = new Set(['$schema']);
-/** The settings one level below a section (or the top level), in schema order. */
-export const childrenOf = (schema) => Object.entries(unwrap(schema).shape ?? {}).filter(([name]) => !HIDDEN.has(name));
-/** The description, which `.partial()` and `.optional()` wrappers may carry on the inner schema instead. */
-export const describeSetting = (s) => s.description ?? unwrap(s).description;
-/** Every setting that is edited with a prompt of its own (everything that is not a section), with its path. */
-export const leavesOf = (schema, key = []) => childrenOf(schema).flatMap(([name, child]) => (isSection(child) ? leavesOf(child, [...key, name]) : [{ key: [...key, name], schema: child }]));
-/** Which prompt edits this setting. Lists of objects and maps (mappings, harnesses, environment) fall back to JSON. */
-export const promptKind = (schema) => {
-    const s = unwrap(schema);
-    const type = s._zod.def.type;
-    if (type === 'boolean' || type === 'enum' || type === 'union' || type === 'number' || type === 'string')
-        return type;
-    if (type === 'array' && s._zod.def.element && kind(s._zod.def.element) === 'string')
-        return 'string-list';
-    return 'json';
-};
-const JSON_EXAMPLES = {
-    harnesses: '{"mytool": {"npmPackage": "my-cli", "npmBin": "my-cli", "arguments": [], "environment": {}}}',
-    mappings: '[{"host": "C:\\\\data", "guest": "C:\\\\Data", "readOnly": true}]',
-    environment: '{"NPM_CONFIG_REGISTRY": "https://registry.example.com"}',
-};
-/** A one-line example of the JSON a setting expects, shown in its prompt. */
-export const jsonExample = (key, schema) => JSON_EXAMPLES[key[key.length - 1]] ?? (unwrap(schema)._zod.def.type === 'array' ? '["value", ...]' : '{"name": "value"}');