sitevision-cli 1.0.0-beta.31 → 1.0.0-beta.32

package/dist/utils/process-runner.d.ts

@@ -24,7 +24,8 @@ export declare class ProcessRunner extends EventEmitter {
     private readonly command;
     private readonly args;
     private readonly cwd?;
-    constructor(command: string, args?: string[], cwd?: string);
+    private readonly env?;
+    constructor(command: string, args?: string[], cwd?: string, env?: NodeJS.ProcessEnv);
     run(): Promise<ProcessResult>;
     kill(): void;
     getOutput(): ProcessOutput[];

package/dist/utils/process-runner.js

@@ -53,16 +53,19 @@ export class ProcessRunner extends EventEmitter {
     command;
     args;
     cwd;
-    constructor(command, args = [], cwd) {
+    env;
+    constructor(command, args = [], cwd, env) {
         super();
         this.command = command;
         this.args = args;
         this.cwd = cwd;
+        this.env = env;
     }
     run() {
         return new Promise((resolve, reject) => {
             this.process = spawnChild(this.command, this.args, {
                 cwd: this.cwd || process.cwd(),
+                env: this.env,
                 shell: true,
                 stdio: 'pipe',
             });

package/dist/utils/project-detection.d.ts

@@ -99,6 +99,13 @@ export declare function readManifest(cwd: string): {
     manifestPath: string;
     manifest: SitevisionManifest;
 } | null;
+/**
+ * Set one text field of manifest.json, or one language of a localized field.
+ * An empty value removes the key. A value that is already a string is replaced
+ * in the text, so comments and formatting survive; anything else rewrites the
+ * file, which is refused when that would drop comments.
+ */
+export declare function writeManifestField(manifestPath: string, key: string, value: string, lang?: string): void;
 /**
  * Detect if the current directory is a Sitevision project
  */
@@ -169,8 +176,9 @@ export declare const IMPLICIT_VALUES: Record<string, unknown>;
 export declare function getPackageJsonSyncChanges(dir: string): PackageJsonSyncChange[];
 export declare function hasPackageJson(dir: string): boolean;
 /**
- * Copy the pending shared values from .dev_properties.json into package.json,
- * creating package.json when the directory has none. Throws if it cannot be
+ * Copy the pending shared values from .dev_properties.json, and the manifest
+ * fields package.json mirrors, into package.json, creating package.json when
+ * the directory has none. Throws if it cannot be
  * read or written.
  */
 export declare function syncDevPropertiesToPackageJson(dir: string): boolean;

package/dist/utils/project-detection.js

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import { getDeployPassword, setDeployPassword, getSessionCookie, } from './keychain.js';
-import { parseJsonc } from './jsonc.js';
+import { parseJsonc, stripJsonComments } from './jsonc.js';
 import { getLanguage } from './i18n.js';
 // =============================================================================
 // LOCALIZED TEXT
@@ -302,6 +302,40 @@ export function readManifest(cwd) {
     }
     return null;
 }
+const JSON_STRING = String.raw `"(?:[^"\\]|\\.)*"`;
+const escapeRegExp = (s) => s.replaceAll(/[$()*+.?[\\\]^{|}]/g, String.raw `\$&`);
+/**
+ * Set one text field of manifest.json, or one language of a localized field.
+ * An empty value removes the key. A value that is already a string is replaced
+ * in the text, so comments and formatting survive; anything else rewrites the
+ * file, which is refused when that would drop comments.
+ */
+export function writeManifestField(manifestPath, key, value, lang) {
+    const raw = fs.readFileSync(manifestPath, 'utf-8');
+    const wanted = parseJsonc(raw);
+    const holder = lang ? wanted[key] : wanted;
+    const leaf = lang ?? key;
+    // JSON.stringify drops an undefined key.
+    holder[leaf] = value || undefined;
+    const prefix = lang
+        ? String.raw `"${escapeRegExp(key)}"\s*:\s*\{[^}]*?"${escapeRegExp(lang)}"\s*:\s*`
+        : String.raw `"${escapeRegExp(key)}"\s*:\s*`;
+    const patched = raw.replace(new RegExp(`(${prefix})${JSON_STRING}`), (_, before) => before + JSON.stringify(value));
+    let patchedOk = false;
+    try {
+        patchedOk = JSON.stringify(parseJsonc(patched)) === JSON.stringify(wanted);
+    }
+    catch { }
+    if (patchedOk) {
+        fs.writeFileSync(manifestPath, patched);
+        return;
+    }
+    if (stripJsonComments(raw) !== raw) {
+        throw new Error(`${manifestPath} has comments; add or remove "${leaf}" by hand`);
+    }
+    const indent = /^(?<indent>[\t ]+)/m.exec(raw)?.groups?.['indent'] ?? '\t';
+    fs.writeFileSync(manifestPath, JSON.stringify(wanted, null, indent) + (raw.endsWith('\n') ? '\n' : ''));
+}
 /**
  * Detect if the current directory is a Sitevision project
  */
@@ -568,6 +602,38 @@ function pendingSync(dir) {
     }
     return pending;
 }
+// Manifest fields package.json mirrors under the same name; the manifest wins.
+const MANIFEST_PACKAGE_KEYS = ['version', 'description', 'author'];
+/**
+ * Manifest values the app's own package.json does not mirror yet. Nothing when
+ * either file is missing, so syncing never creates a package.json for this.
+ */
+function pendingManifestSync(dir) {
+    const packageJson = readPackageJson(dir);
+    if (!packageJson)
+        return [];
+    let manifest;
+    try {
+        manifest = readManifest(dir)?.manifest;
+    }
+    catch { }
+    if (!manifest)
+        return [];
+    const pending = [];
+    for (const key of MANIFEST_PACKAGE_KEYS) {
+        const value = key === 'description'
+            ? localizedText(manifest.description, 'en')
+            : manifest[key];
+        const current = packageJson[key];
+        // ponytail: an author object ({name, email}) is left alone.
+        if (!value || typeof value !== 'string' || value === current)
+            continue;
+        if (current !== undefined && typeof current !== 'string')
+            continue;
+        pending.push({ key, from: current, value });
+    }
+    return pending;
+}
 /** What an unset field means, so spelling out the default is not a change. */
 export const IMPLICIT_VALUES = {
     authMethod: 'basic',
@@ -579,27 +645,38 @@ const display = (value) => typeof value === 'string' ? value : JSON.stringify(va
 /** What syncing this directory would change in its package.json. */
 export function getPackageJsonSyncChanges(dir) {
     const current = readPackageDefaults(dir);
-    return pendingSync(dir).map(({ key, value }) => current[key] === undefined
-        ? { key: packageLabel(key), to: display(value) }
-        : {
-            key: packageLabel(key),
-            from: display(current[key]),
-            to: display(value),
-        });
+    return [
+        ...pendingSync(dir).map(({ key, value }) => current[key] === undefined
+            ? { key: packageLabel(key), to: display(value) }
+            : {
+                key: packageLabel(key),
+                from: display(current[key]),
+                to: display(value),
+            }),
+        ...pendingManifestSync(dir).map(({ key, from, value }) => ({
+            key,
+            ...(from !== undefined && { from }),
+            to: value,
+        })),
+    ];
 }
 export function hasPackageJson(dir) {
     return fs.existsSync(path.join(dir, 'package.json'));
 }
 /**
- * Copy the pending shared values from .dev_properties.json into package.json,
- * creating package.json when the directory has none. Throws if it cannot be
+ * Copy the pending shared values from .dev_properties.json, and the manifest
+ * fields package.json mirrors, into package.json, creating package.json when
+ * the directory has none. Throws if it cannot be
  * read or written.
  */
 export function syncDevPropertiesToPackageJson(dir) {
     const pending = pendingSync(dir);
-    if (pending.length === 0 && hasPackageJson(dir))
+    const mirrored = pendingManifestSync(dir);
+    if (pending.length + mirrored.length === 0 && hasPackageJson(dir))
         return false;
     updatePackageJson(dir, packageJson => {
+        for (const { key, value } of mirrored)
+            packageJson[key] = value;
         for (const { key, value } of pending) {
             const topKey = PACKAGE_TOP_KEYS[key];
             if (topKey) {

package/dist/utils/tasks.d.ts

@@ -1,5 +1,5 @@
 import type { ProjectInfo, SigningCredentials, DeployConfig } from '../types/index.js';
-export type TaskKind = 'dev' | 'watch' | 'build' | 'sign' | 'deploy' | 'activate' | 'install';
+export type TaskKind = 'dev' | 'watch' | 'build' | 'sign' | 'deploy' | 'activate' | 'install' | 'create';
 export type TaskStatus = 'running' | 'success' | 'error' | 'stopped';
 export type LogLevel = 'info' | 'ok' | 'warn' | 'error';
 export interface LogLine {
@@ -26,6 +26,16 @@ export declare function getTasks(): Task[];
 export declare function useTasks(): Task[];
 export declare function runningTasks(appRoot?: string): Task[];
 export declare function clearFinished(): void;
+type Log = (tag: string, text: string, level?: LogLevel) => void;
+export declare function createTask(kind: TaskKind, project: {
+    root: string;
+    manifest: Pick<ProjectInfo['manifest'], 'name' | 'id'>;
+}, label: string, stop?: () => void): {
+    task: Task;
+    log: Log;
+    finish: (status: TaskStatus, error?: string) => void;
+};
+export declare function setPhase(task: Task, phase: string): void;
 export interface DeployOptions {
     force?: boolean;
     production?: boolean;
@@ -48,3 +58,4 @@ export interface DevOptions {
  * deploy. Runs until `task.stop()`; the task stays in the registry meanwhile.
  */
 export declare function startDev(project: ProjectInfo, options: DevOptions): Task;
+export {};

package/dist/utils/tasks.js

@@ -32,7 +32,7 @@ export function clearFinished() {
     tasks = tasks.filter(t => t.status === 'running');
     notify();
 }
-function createTask(kind, project, label, stop = () => { }) {
+export function createTask(kind, project, label, stop = () => { }) {
     const task = {
         id: nextId++,
         kind,
@@ -69,7 +69,7 @@ function createTask(kind, project, label, stop = () => { }) {
     };
     return { task, log, finish };
 }
-function setPhase(task, phase) {
+export function setPhase(task, phase) {
     task.phase = phase;
     notify();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sitevision-cli",
-	"version": "1.0.0-beta.31",
+	"version": "1.0.0-beta.32",
 	"license": "MIT",
 	"bin": {
 		"svc": "dist/cli.js"