sitevision-cli 1.0.0-beta.4 → 1.0.0-beta.5

package/dist/commands/dev.js

@@ -11,9 +11,10 @@ import { signApp, deployApp } from '../utils/sitevision-api.js';
 import { setDeployPassword } from '../utils/keychain.js';
 import { resolveSigningPassword } from '../utils/signing-password.js';
 import { copyStaticToBuild, createBuildZip, cleanBuild } from '../utils/zip.js';
-import { isBundledApp, getAppType, getFullAppId, getZipPath, getSignedZipPath, localizedText, } from '../utils/project-detection.js';
+import { isBundledApp, getAppType, getFullAppId, getZipPath, getSignedZipPath, localizedText, readManifest, } from '../utils/project-detection.js';
 export function DevScreen({ projectRoot, manifest, devProperties, signed, deploy = true, signingCredentials, onBack, onRetryCredentials, }) {
     const { exit } = useApp();
+    const [version, setVersion] = React.useState(manifest.version);
     const [state, setState] = React.useState({
         status: 'initializing',
         message: 'Starting webpack watch...',
@@ -34,6 +35,16 @@ export function DevScreen({ projectRoot, manifest, devProperties, signed, deploy
     const isBuildingRef = React.useRef(false);
     const pendingRebuildRef = React.useRef(false);
     // Sign (if needed) and deploy an already-built zip, updating UI state.
+    const refreshVersion = React.useCallback(() => {
+        try {
+            const fresh = readManifest(projectRoot)?.manifest.version;
+            if (fresh)
+                setVersion(fresh);
+        }
+        catch {
+            // keep last known version
+        }
+    }, [projectRoot]);
     const signAndDeploy = React.useCallback(async (zipPath, buildTime) => {
         try {
             let deployZipPath = zipPath;
@@ -57,6 +68,7 @@ export function DevScreen({ projectRoot, manifest, devProperties, signed, deploy
                 }
                 deployZipPath = signedZipPath;
             }
+            refreshVersion();
             // Watch/build-only mode: stop after building (and signing).
             if (!deploy || !devProperties) {
                 setState(prev => ({
@@ -113,7 +125,15 @@ export function DevScreen({ projectRoot, manifest, devProperties, signed, deploy
                 error: error instanceof Error ? error.message : String(error),
             }));
         }
-    }, [projectRoot, manifest, devProperties, signed, deploy, signingCredentials]);
+    }, [
+        projectRoot,
+        manifest,
+        devProperties,
+        signed,
+        deploy,
+        signingCredentials,
+        refreshVersion,
+    ]);
     // In-house webpack path: copy static, zip, then sign + deploy.
     const handleBuildComplete = React.useCallback(async (result) => {
         if (!result.success) {
@@ -353,7 +373,7 @@ export function DevScreen({ projectRoot, manifest, devProperties, signed, deploy
     };
     return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Box, { marginBottom: 1, children: _jsx(StatusIndicator, { status: getStatusType(), label: getStatusLabel(), message: state.message }) }), state.warning && (_jsx(Box, { marginBottom: 1, children: _jsxs(Text, { color: "yellow", children: ["\u26A0 ", state.warning] }) })), state.buildCount > 0 && (_jsx(Box, { marginLeft: 2, marginBottom: 1, children: _jsxs(Text, { dimColor: true, children: ["Builds: ", state.buildCount, state.lastBuildTime
                             ? ` | Last build: ${state.lastBuildTime}ms`
-                            : '', signed ? ' | Signed mode' : ''] }) })), _jsx(Box, { marginLeft: 2, marginBottom: 1, children: _jsxs(Text, { dimColor: true, children: [localizedText(manifest.name), " v", manifest.version] }) }), deploy && devProperties && (_jsx(Box, { marginLeft: 2, marginBottom: 1, children: _jsxs(Text, { dimColor: true, children: ["Target: ", devProperties.domain, "/", devProperties.siteName, "/", devProperties.addonName] }) })), state.status === 'error' && state.error && (_jsx(Box, { flexDirection: "column", marginTop: 1, children: _jsx(Text, { color: "red", children: state.error }) })), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [state.status === 'error' && onRetryCredentials && (_jsx(Text, { dimColor: true, children: "Press r to retry with new credentials" })), onBack ? (_jsx(Text, { dimColor: true, children: "Press q or Esc to return to menu (Ctrl+C to stop process)" })) : (_jsx(Text, { dimColor: true, children: "Press Ctrl+C to stop" }))] })] }));
+                            : '', signed ? ' | Signed mode' : ''] }) })), _jsx(Box, { marginLeft: 2, marginBottom: 1, children: _jsxs(Text, { dimColor: true, children: [localizedText(manifest.name), " v", version] }) }), deploy && devProperties && (_jsx(Box, { marginLeft: 2, marginBottom: 1, children: _jsxs(Text, { dimColor: true, children: ["Target: ", devProperties.domain, "/", devProperties.siteName, "/", devProperties.addonName] }) })), state.status === 'error' && state.error && (_jsx(Box, { flexDirection: "column", marginTop: 1, children: _jsx(Text, { color: "red", children: state.error }) })), _jsxs(Box, { marginTop: 1, flexDirection: "column", children: [state.status === 'error' && onRetryCredentials && (_jsx(Text, { dimColor: true, children: "Press r to retry with new credentials" })), onBack ? (_jsx(Text, { dimColor: true, children: "Press q or Esc to return to menu (Ctrl+C to stop process)" })) : (_jsx(Text, { dimColor: true, children: "Press Ctrl+C to stop" }))] })] }));
 }
 export const devCommand = {
     name: 'dev',

package/dist/components/SetupFlow.js

@@ -1,7 +1,7 @@
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 import { useState, useEffect } from 'react';
 import { Box, Text, useInput } from 'ink';
-import { getAppType, localizedText, migrateLegacyPassword, } from '../utils/project-detection.js';
+import { getAppType, localizedText, migrateLegacyPassword, getPackageJsonSyncChanges, syncDevPropertiesToPackageJson, readSvcConfig, writeSvcConfig, } from '../utils/project-detection.js';
 import { ProcessRunner } from '../utils/process-runner.js';
 import { ProcessOutputComponent } from './ProcessOutput.js';
 import { StatusIndicator } from './StatusIndicator.js';
@@ -11,6 +11,8 @@ export function SetupFlow({ project, onReload, onComplete }) {
     const [step, setStep] = useState('check-node-modules');
     const [runner, setRunner] = useState(null);
     const [commandStatus, setCommandStatus] = useState('running');
+    const [syncChanges, setSyncChanges] = useState([]);
+    const [syncDecision, setSyncDecision] = useState(false);
     const appType = getAppType(project.manifest);
     // Auto-advance through checks
     useEffect(() => {
@@ -28,13 +30,32 @@ export function SetupFlow({ project, onReload, onComplete }) {
                     setStep('confirm-password-migration');
                 }
                 else {
-                    setStep('check-signing-properties');
+                    setStep('check-package-sync');
                 }
             }
             else {
                 setStep('confirm-dev-setup');
             }
         }
+        else if (step === 'check-package-sync') {
+            const preference = readSvcConfig(project.root).syncPackageJson;
+            const properties = project.devProperties;
+            const changes = preference !== false && properties
+                ? getPackageJsonSyncChanges(project.root, properties)
+                : [];
+            if (changes.length === 0 || !properties) {
+                setStep('check-signing-properties');
+            }
+            else if (preference === true) {
+                syncDevPropertiesToPackageJson(project.root, properties);
+                onReload();
+                setStep('check-signing-properties');
+            }
+            else {
+                setSyncChanges(changes);
+                setStep('confirm-package-sync');
+            }
+        }
         else if (step === 'check-signing-properties') {
             if (project.hasSigningProperties) {
                 setStep('show-info');
@@ -87,6 +108,26 @@ export function SetupFlow({ project, onReload, onComplete }) {
                 // The file was rewritten (plaintext stripped, password moved to
                 // keychain) — re-detect so hasLegacyPassword/password reflect that.
                 onReload();
+                setStep('check-package-sync');
+            }
+            else if (input === 'n' || input === 'N') {
+                setStep('check-package-sync');
+            }
+        }
+        else if (step === 'confirm-package-sync') {
+            if (['y', 'Y', 'n', 'N'].includes(input)) {
+                const accepted = input.toLowerCase() === 'y';
+                if (accepted && project.devProperties) {
+                    syncDevPropertiesToPackageJson(project.root, project.devProperties);
+                    onReload();
+                }
+                setSyncDecision(accepted);
+                setStep('confirm-save-sync-choice');
+            }
+        }
+        else if (step === 'confirm-save-sync-choice') {
+            if (input === 'y' || input === 'Y') {
+                writeSvcConfig(project.root, { syncPackageJson: syncDecision });
                 setStep('check-signing-properties');
             }
             else if (input === 'n' || input === 'N') {
@@ -109,7 +150,7 @@ export function SetupFlow({ project, onReload, onComplete }) {
                 // password) populate in memory — otherwise the rest of this flow and
                 // the menu would see stale state until the CLI is restarted.
                 onReload();
-                setStep('check-signing-properties');
+                setStep('check-package-sync');
             }, onCancel: () => setStep('check-signing-properties') }));
     }
     // Setup Signing Properties Form
@@ -137,6 +178,16 @@ export function SetupFlow({ project, onReload, onComplete }) {
     if (step === 'confirm-password-migration') {
         return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Box, { marginBottom: 1, children: _jsx(Text, { bold: true, color: "cyan", children: "Sitevision CLI" }) }), _jsx(Box, { marginBottom: 1, children: _jsx(Text, { color: "yellow", children: "\u26A0 Plaintext password found in .dev_properties.json" }) }), _jsxs(Box, { marginBottom: 1, flexDirection: "column", children: [_jsx(Text, { children: "Move it to the OS keychain and remove it from the file? (y/n)" }), _jsx(Text, { dimColor: true, children: "Recommended \u2014 storing passwords in project files is insecure." })] })] }));
     }
+    // Confirm package.json sync
+    if (step === 'confirm-package-sync') {
+        return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Box, { marginBottom: 1, children: _jsx(Text, { bold: true, color: "cyan", children: "Sitevision CLI" }) }), _jsx(Box, { marginBottom: 1, children: _jsx(Text, { color: "yellow", children: "\u26A0 package.json is out of sync with .dev_properties.json" }) }), _jsx(Box, { marginBottom: 1, flexDirection: "column", marginLeft: 2, children: syncChanges.map(change => (_jsxs(Box, { children: [_jsx(Text, { color: change.from === undefined ? 'green' : 'yellow', children: change.from === undefined ? '+ ' : '~ ' }), _jsxs(Text, { bold: true, children: [change.key, ": "] }), change.from !== undefined && (_jsxs(Text, { dimColor: true, children: [change.from, " \u2192 "] })), _jsx(Text, { children: change.to })] }, change.key))) }), _jsxs(Box, { marginBottom: 1, flexDirection: "column", children: [_jsx(Text, { children: "Update package.json from .dev_properties.json? (y/n)" }), _jsx(Text, { dimColor: true, children: "sitevision-scripts reads these fields from package.json." })] })] }));
+    }
+    // Offer to persist the sync decision in .svcconfig
+    if (step === 'confirm-save-sync-choice') {
+        return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Box, { marginBottom: 1, children: _jsx(Text, { bold: true, color: "cyan", children: "Sitevision CLI" }) }), _jsxs(Box, { marginBottom: 1, flexDirection: "column", children: [_jsx(Text, { children: "Remember this choice in .svcconfig? (y/n)" }), _jsx(Text, { dimColor: true, children: syncDecision
+                                ? 'svc will update package.json automatically from now on.'
+                                : 'svc will stop asking about package.json sync.' })] })] }));
+    }
     // Confirm signing setup
     if (step === 'confirm-signing-setup') {
         return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Box, { marginBottom: 1, children: _jsx(Text, { bold: true, color: "cyan", children: "Sitevision CLI" }) }), _jsx(Box, { marginBottom: 1, children: _jsx(Text, { color: "yellow", children: "\u26A0 signing credentials not configured" }) }), _jsx(Box, { marginBottom: 1, children: _jsx(Text, { children: "Signing credentials are required for signing apps on developer.sitevision.se" }) }), _jsx(Box, { marginBottom: 1, children: _jsx(Text, { children: "Would you like to set up signing credentials? (y/n)" }) })] }));

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

@@ -69,6 +69,14 @@ export declare function buildImportEndpointUrl(domain: string, siteName: string,
 export declare class ManifestParseError extends Error {
     constructor(manifestPath: string, cause: unknown);
 }
+/**
+ * Read manifest.json from its supported locations (root, static/, src/).
+ * Throws ManifestParseError on malformed JSON.
+ */
+export declare function readManifest(cwd: string): {
+    manifestPath: string;
+    manifest: SitevisionManifest;
+} | null;
 /**
  * Detect if the current directory is a Sitevision project
  */
@@ -94,6 +102,32 @@ export declare function readDevProperties(projectRoot: string): DevProperties |
  * it is held in the OS keychain instead.
  */
 export declare function writeDevProperties(projectRoot: string, properties: DevProperties): void;
+/**
+ * CLI preferences stored in .svcconfig at the project root. Unknown keys are
+ * preserved on write so hand-edited entries survive.
+ */
+export interface SvcConfig {
+    syncPackageJson?: boolean;
+    [key: string]: unknown;
+}
+export declare function readSvcConfig(projectRoot: string): SvcConfig;
+export declare function writeSvcConfig(projectRoot: string, updates: SvcConfig): void;
+export interface PackageJsonSyncChange {
+    key: string;
+    from?: string;
+    to: string;
+}
+/**
+ * Which of the shared fields package.json is missing or disagrees on, relative
+ * to the given dev properties. Reads package.json from disk — an earlier
+ * `npm install` in the same session may have rewritten it.
+ */
+export declare function getPackageJsonSyncChanges(projectRoot: string, properties: DevProperties): PackageJsonSyncChange[];
+/**
+ * Copy the shared fields from dev properties into package.json, preserving the
+ * file's existing indentation and trailing newline.
+ */
+export declare function syncDevPropertiesToPackageJson(projectRoot: string, properties: DevProperties): boolean;
 /**
  * Move a plaintext password from .dev_properties.json into the OS keychain and
  * strip it from the file. Returns true if the password was migrated.

package/dist/utils/project-detection.js

@@ -167,38 +167,44 @@ export class ManifestParseError extends Error {
         this.name = 'ManifestParseError';
     }
 }
+/**
+ * Read manifest.json from its supported locations (root, static/, src/).
+ * Throws ManifestParseError on malformed JSON.
+ */
+export function readManifest(cwd) {
+    const manifestPaths = [
+        path.join(cwd, 'manifest.json'),
+        path.join(cwd, 'static', 'manifest.json'),
+        path.join(cwd, 'src', 'manifest.json'),
+    ];
+    for (const manifestPath of manifestPaths) {
+        if (!fs.existsSync(manifestPath)) {
+            continue;
+        }
+        // Manifests may contain comments (Sitevision's own docs show them), so
+        // parse as JSONC.
+        try {
+            return {
+                manifestPath,
+                manifest: parseJsonc(fs.readFileSync(manifestPath, 'utf-8')),
+            };
+        }
+        catch (error) {
+            throw new ManifestParseError(manifestPath, error);
+        }
+    }
+    return null;
+}
 /**
  * Detect if the current directory is a Sitevision project
  */
 export function detectProject(cwd = process.cwd()) {
     try {
-        // Look for manifest.json in multiple locations (current, static/, src/)
-        const manifestPaths = [
-            path.join(cwd, 'manifest.json'),
-            path.join(cwd, 'static', 'manifest.json'),
-            path.join(cwd, 'src', 'manifest.json'),
-        ];
-        let manifestPath = null;
-        let manifest = null;
-        for (const p of manifestPaths) {
-            if (fs.existsSync(p)) {
-                manifestPath = p;
-                // Manifests may contain comments (Sitevision's own docs show them), so
-                // parse as JSONC. A still-unparseable manifest is a real, fixable
-                // error — surface it rather than silently reporting "Not a Sitevision
-                // project".
-                try {
-                    manifest = parseJsonc(fs.readFileSync(p, 'utf-8'));
-                }
-                catch (error) {
-                    throw new ManifestParseError(p, error);
-                }
-                break;
-            }
-        }
-        if (!manifest || !manifestPath) {
+        const found = readManifest(cwd);
+        if (!found) {
             return null;
         }
+        const { manifestPath, manifest } = found;
         // Check for package.json
         const packageJsonPath = path.join(cwd, 'package.json');
         if (!fs.existsSync(packageJsonPath)) {
@@ -326,6 +332,92 @@ export function writeDevProperties(projectRoot, properties) {
     const { password: _password, ...persisted } = properties;
     fs.writeFileSync(devPropertiesPath, JSON.stringify(persisted, null, 2));
 }
+export function readSvcConfig(projectRoot) {
+    try {
+        return parseJsonc(fs.readFileSync(path.join(projectRoot, '.svcconfig'), 'utf-8'));
+    }
+    catch {
+        return {};
+    }
+}
+export function writeSvcConfig(projectRoot, updates) {
+    const merged = { ...readSvcConfig(projectRoot), ...updates };
+    fs.writeFileSync(path.join(projectRoot, '.svcconfig'), JSON.stringify(merged, null, 2) + '\n');
+}
+// =============================================================================
+// PACKAGE.JSON SYNC
+// =============================================================================
+/**
+ * Fields duplicated between .dev_properties.json and package.json, where
+ * sitevision-scripts reads them under different names.
+ */
+const PACKAGE_JSON_SYNC_KEYS = [
+    { packageKey: 'developmentDomain', devKey: 'domain' },
+    { packageKey: 'siteName', devKey: 'siteName' },
+    { packageKey: 'addonName', devKey: 'addonName' },
+];
+function readPackageJson(projectRoot) {
+    try {
+        return JSON.parse(fs.readFileSync(path.join(projectRoot, 'package.json'), 'utf-8'));
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Which of the shared fields package.json is missing or disagrees on, relative
+ * to the given dev properties. Reads package.json from disk — an earlier
+ * `npm install` in the same session may have rewritten it.
+ */
+export function getPackageJsonSyncChanges(projectRoot, properties) {
+    const packageJson = readPackageJson(projectRoot);
+    if (!packageJson)
+        return [];
+    const changes = [];
+    for (const { packageKey, devKey } of PACKAGE_JSON_SYNC_KEYS) {
+        const to = properties[devKey];
+        if (typeof to !== 'string' || to === '')
+            continue;
+        const from = packageJson[packageKey];
+        if (from !== to) {
+            changes.push(from === undefined
+                ? { key: packageKey, to }
+                : { key: packageKey, from, to });
+        }
+    }
+    return changes;
+}
+/**
+ * Copy the shared fields from dev properties into package.json, preserving the
+ * file's existing indentation and trailing newline.
+ */
+export function syncDevPropertiesToPackageJson(projectRoot, properties) {
+    const packageJsonPath = path.join(projectRoot, 'package.json');
+    let raw;
+    try {
+        raw = fs.readFileSync(packageJsonPath, 'utf-8');
+    }
+    catch {
+        return false;
+    }
+    let packageJson;
+    try {
+        packageJson = JSON.parse(raw);
+    }
+    catch {
+        return false;
+    }
+    for (const { packageKey, devKey } of PACKAGE_JSON_SYNC_KEYS) {
+        const value = properties[devKey];
+        if (typeof value === 'string' && value !== '') {
+            packageJson[packageKey] = value;
+        }
+    }
+    const indent = /^(?<indent>[\t ]+)/m.exec(raw)?.groups?.['indent'] ?? '\t';
+    const newline = raw.endsWith('\n') ? '\n' : '';
+    fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, indent) + newline);
+    return true;
+}
 /**
  * Move a plaintext password from .dev_properties.json into the OS keychain and
  * strip it from the file. Returns true if the password was migrated.

package/package.json

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

package/readme.md

@@ -126,6 +126,29 @@ Create this file in your project root for deployment configuration:
 }
 ```
 
+### Keeping `package.json` in sync
+
+`sitevision-scripts` reads `developmentDomain`, `siteName` and `addonName`
+from `package.json`, which duplicates three fields of
+`.dev_properties.json`. When they disagree — or when a fresh setup has just
+written `.dev_properties.json` — `svc` shows the differences and offers to
+update `package.json` from `.dev_properties.json`. Nothing is written without
+confirmation, and `.dev_properties.json` is always the source of truth for
+the copy. Existing indentation and unrelated fields are left alone.
+
+After answering, `svc` offers to remember the choice in a `.svcconfig` file
+in the project root:
+
+```json
+{
+	"syncPackageJson": true
+}
+```
+
+With `true`, `svc` updates `package.json` automatically without asking; with
+`false`, the check is skipped entirely. Delete the key (or the file) to be
+asked again. The file contains no secrets, so it is safe to commit.
+
 ### Password storage
 
 Passwords are stored in the OS-native secret store (macOS Keychain, Windows