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

package/dist/utils/i18n.js

@@ -103,6 +103,20 @@ const sv = {
     'switch pane': 'byt panel',
     tabs: 'flikar',
     help: 'hjälp',
+    // Help guide
+    'Typing filters the app list. ↑↓ move, Enter selects the app and moves focus to the content pane. Action keys such as d or p only work there; in the navigator they search.': 'Skriv för att filtrera applistan. ↑↓ flyttar, Enter väljer appen och flyttar fokus till innehållspanelen. Åtgärdstangenter som d eller p fungerar bara där; i navigatorn söker de.',
+    'The last row is Workspace settings: the shared root config that every app inherits.': 'Sista raden är Arbetsytans inställningar: den delade rotkonfigurationen som alla appar ärver.',
+    "The root .dev_properties.json shared by every app, with the root package.json defaults underneath. Fill in site, auth and environments once; an app's own config overrides only what differs.": 'Rotens .dev_properties.json som delas av alla appar, med rotens package.json som standardvärden under. Fyll i webbplats, autentisering och miljöer en gång; en apps egen konfig skriver bara över det som skiljer.',
+    'Same keys as the Config tab: Enter edits and saves, Esc cancels, ←→ or space cycles choices.': 'Samma tangenter som Konfig-fliken: Enter redigerar och sparar, Esc avbryter, ←→ eller mellanslag bläddrar bland val.',
+    'Each status line names the key that fixes it: i installs dependencies, e opens Config, y syncs package.json, / sets up signing.': 'Varje statusrad anger tangenten som åtgärdar den: i installerar beroenden, e öppnar Konfig, y synkar package.json, / sätter upp signering.',
+    'The badge in the top bar is the active environment: green for the base, yellow for others, red for production. v cycles it.': 'Märket i toppraden är den aktiva miljön: grönt för basen, gult för övriga, rött för produktion. v växlar.',
+    'Values come in layers and the source is shown next to each: your local .dev_properties.json wins, shared package.json values sit underneath, and in a workspace the root config underneath that. Environments add on top of the base and override only what differs.': 'Värden kommer i lager och källan visas bredvid varje: din lokala .dev_properties.json vinner, delade värden i package.json ligger under, och i en arbetsyta rotkonfigurationen under det. Miljöer läggs ovanpå basen och skriver bara över det som skiljer.',
+    'Enter edits and saves a field, Esc cancels, ←→ or space cycles choices, Ctrl+O lists the addons on the site. y copies shared values into package.json for the team.': 'Enter redigerar och sparar ett fält, Esc avbryter, ←→ eller mellanslag bläddrar bland val, Ctrl+O listar webbplatsens tillägg. y kopierar delade värden till package.json för teamet.',
+    'Passwords and secrets go to the OS keychain, never to a file. Leave them empty to be asked on each run.': 'Lösenord och hemligheter sparas i nyckelringen, aldrig i en fil. Lämna dem tomma för att bli tillfrågad varje gång.',
+    "The versions uploaded to the addon on the active environment's site, the domain in the top bar. v switches environment.": 'Versionerna som laddats upp till tillägget på den aktiva miljöns webbplats, domänen i toppraden. v byter miljö.',
+    '↑↓ select, a activates the selected version, r refreshes. Production deploys activate on their own.': '↑↓ väljer, a aktiverar vald version, r uppdaterar. Produktionsdriftsättningar aktiverar själva.',
+    'Output from build, sign, deploy, dev and watch for the selected app. Dev and watch keep running while you switch apps; K stops them.': 'Utdata från build, sign, deploy, dev och watch för vald app. Dev och watch fortsätter köra medan du byter app; K stoppar dem.',
+    '↑↓ scroll, PgUp/PgDn page, f jumps to the end, x toggles line wrap.': '↑↓ scrollar, PgUp/PgDn bläddrar sida, f hoppar till slutet, x växlar radbrytning.',
     "What's new": 'Nyheter',
     'changelog for every release': 'ändringslogg för varje version',
     Changelog: 'Ändringslogg',
@@ -188,6 +202,38 @@ const sv = {
     'required for signed deploys': 'krävs för signerad driftsättning',
     'blank = prompt each run': 'tomt = fråga varje gång',
     SIGNING: 'SIGNERING',
+    MANIFEST: 'MANIFEST',
+    // New app
+    'Name of the new app': 'Namn på den nya appen',
+    'Create it in folder': 'Skapa den i mappen',
+    'Other folder…': 'Annan mapp…',
+    'Type a name for the app, for example my-new-app.': 'Skriv ett namn på appen, till exempel min-nya-app.',
+    'Try "{suggestion}".': 'Prova "{suggestion}".',
+    "An app name can't have spaces.": 'Ett appnamn kan inte innehålla mellanslag.',
+    "An app name can't contain {chars}: it becomes the folder, the package name and the app id.": 'Ett appnamn kan inte innehålla {chars}: det blir mappen, paketnamnet och appens id.',
+    'Lowercase is safer: npm expects it, and "{name}" and "{lower}" are one folder on macOS and Windows but two on Linux. Try "{suggestion}", or press Enter again to keep "{name}".': 'Gemener är säkrare: npm förväntar sig det, och "{name}" och "{lower}" är samma mapp på macOS och Windows men två på Linux. Prova "{suggestion}", eller tryck Enter igen för att behålla "{name}".',
+    'Start the name with a letter or a digit.': 'Börja namnet med en bokstav eller en siffra.',
+    '{dir} already exists. Pick another name, or keep it and choose a different folder next.': '{dir} finns redan. Välj ett annat namn, eller behåll det och välj en annan mapp i nästa steg.',
+    'creating {app}: installing, questions follow': 'skapar {app}: installerar, frågor kommer strax',
+    'The scaffolder could not be run from here': 'Verktyget kunde inte köras härifrån',
+    'creating {app} failed, see the log': 'kunde inte skapa {app}, se loggen',
+    '{app} created in {dir}': '{app} skapad i {dir}',
+    '{app} created': '{app} skapad',
+    'Create the addon "{addon}" on {domain} now?': 'Skapa tillägget "{addon}" på {domain} nu?',
+    '↑↓ move · Space toggle · Enter submit · Esc cancel': '↑↓ flytta · Mellanslag markera · Enter skicka · Esc avbryt',
+    'App id': 'App-id',
+    Version: 'Version',
+    Name: 'Namn',
+    Description: 'Beskrivning',
+    Author: 'Författare',
+    'Help URL': 'Hjälp-URL',
+    'Not saved: {label} is required.': 'Inte sparat: {label} krävs.',
+    'Identifier of the app in Sitevision; it also names the zip. Changing it makes the next deploy a new app instead of an update.': 'Appens identifierare i Sitevision; den namnger också zip-filen. Ändras den blir nästa driftsättning en ny app i stället för en uppdatering.',
+    'Version of the app. Id and version together identify an upload, so bump it to deploy a new version instead of overwriting the current one.': 'Appens version. Id och version identifierar tillsammans en uppladdning, så höj den för att driftsätta en ny version i stället för att skriva över den nuvarande.',
+    'Name shown when importing and administering the app in the Sitevision editor. A multilingual manifest needs at least English.': 'Namnet som visas när appen importeras och administreras i Sitevisions redigerare. Ett flerspråkigt manifest behöver minst engelska.',
+    'Short description shown next to the name in the Sitevision editor.': 'Kort beskrivning som visas bredvid namnet i Sitevisions redigerare.',
+    'Who made the app, shown in the Sitevision editor.': 'Vem som gjort appen, visas i Sitevisions redigerare.',
+    "Link to the app's documentation, shown in the Sitevision editor.": 'Länk till appens dokumentation, visas i Sitevisions redigerare.',
     ENVIRONMENT: 'MILJÖ',
     'Environment name': 'Miljönamn',
     Production: 'Produktion',

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.30",
+	"version": "1.0.0-beta.32",
 	"license": "MIT",
 	"bin": {
 		"svc": "dist/cli.js"