kirby-deploy 0.0.5 → 0.2.0

package/dist/cli.js

@@ -4,11 +4,11 @@
 import { runMain } from "citty";
 
 // src/commands/main.ts
-import { defineCommand as defineCommand3 } from "citty";
-import consola8 from "consola";
-import { colors as colors5 } from "consola/utils";
+import { defineCommand as defineCommand4 } from "citty";
+import consola9 from "consola";
+import { colors as colors6 } from "consola/utils";
 import { readFileSync } from "fs";
-import { join as join5, relative } from "path/posix";
+import { join as join6, relative } from "path/posix";
 import { cwd as cwd2 } from "process";
 
 // src/config.ts
@@ -34,7 +34,8 @@ var FolderStructureSchema = object({
   media: string(),
   accounts: string(),
   sessions: string(),
-  cache: string()
+  cache: string(),
+  site: string()
 });
 var ConfigSchema = object({
   host: string(),
@@ -73,7 +74,8 @@ var loadConfig = async () => {
     parse(ConfigSchema, config);
   } catch (e) {
     const issues = flatten(e).nested;
-    const info = Object.entries(issues).map(([key, messages]) => `  - ${key} (${messages.join(", ")})`).join("\n");
+    if (!issues) return null;
+    const info = Object.entries(issues).map(([key, messages = []]) => `  - ${key} (${messages.join(", ")})`).join("\n");
     consola.error(`Invalid properties in ${configFile}
 ${info}`);
     return null;
@@ -86,7 +88,8 @@ ${info}`);
       media: "public/media",
       accounts: "storage/accounts",
       sessions: "storage/sessions",
-      cache: "storage/cache"
+      cache: "storage/cache",
+      site: "site"
     };
   } else if (config.folderStructure === "flat") {
     folderStructure = {
@@ -94,7 +97,8 @@ ${info}`);
       media: "site/media",
       accounts: "site/accounts",
       sessions: "site/sessions",
-      cache: "site/cache"
+      cache: "site/cache",
+      site: "site"
     };
   } else {
     folderStructure = config.folderStructure;
@@ -139,8 +143,7 @@ var cat = (file, { host, user, password, lftpSettings }) => {
   const child = isWindows ? spawnSync("wsl", ["lftp", "-c", commands.join("; ")], {
     encoding: "utf-8"
   }) : spawnSync("lftp", ["-c", commands.join("; ")], { encoding: "utf-8" });
-  if (child.stderr)
-    consola2.error(child.stderr);
+  if (child.stderr) consola2.error(child.stderr);
   return child.stdout;
 };
 
@@ -169,8 +172,7 @@ var mirror = (source, destination, flags, { lftpSettings, host, user, password,
   let hasErrors = false;
   let hasChanges = false;
   const handleData = (data) => {
-    if (verbose)
-      consola3.log(`${colors.bgBlue(" LFTP ")} ${data}
+    if (verbose) consola3.log(`${colors.bgBlue(" LFTP ")} ${data}
 `);
     data.toString().split("\n").forEach((line) => {
       let match = null;
@@ -220,8 +222,7 @@ import * as readline from "node:readline";
 var upperFirst = (string2) => string2.charAt(0).toUpperCase() + string2.slice(1);
 var isGit = () => existsSync(join(cwd(), ".git"));
 var getBranch = () => {
-  if (!isGit())
-    return;
+  if (!isGit()) return;
   const { stderr, stdout } = spawnSync2("git", ["branch", "--show-current"], {
     encoding: "utf-8"
   });
@@ -301,8 +302,7 @@ var sync = async (source, mode, config) => {
       return false;
     }
     const shouldContinue = await confirm(`Apply changes to ${targetName}?`);
-    if (!shouldContinue)
-      return false;
+    if (!shouldContinue) return false;
     consola5.log("");
   }
   consola5.log("Apply changes...\n");
@@ -344,8 +344,7 @@ import { colors as colors3 } from "consola/utils";
 import { join as join3 } from "path/posix";
 var syncAccounts = async (mode) => {
   const config = await loadConfig();
-  if (!config)
-    return;
+  if (!config) return;
   const { accounts } = config.folderStructure;
   const source = `./${accounts}/`;
   const branch = getBranch();
@@ -381,8 +380,7 @@ import { colors as colors4 } from "consola/utils";
 import { join as join4 } from "path/posix";
 var syncContent = async (mode) => {
   const config = await loadConfig();
-  if (!config)
-    return;
+  if (!config) return;
   const { content } = config.folderStructure;
   const source = `./${content}/`;
   const branch = getBranch();
@@ -410,17 +408,50 @@ var syncContent = async (mode) => {
 var contentPush = defineCommand2({ run: () => syncContent("push") });
 var contentPull = defineCommand2({ run: () => syncContent("pull") });
 
+// src/commands/languages.ts
+import { defineCommand as defineCommand3 } from "citty";
+import consola8 from "consola";
+import { colors as colors5 } from "consola/utils";
+import { join as join5 } from "path/posix";
+var syncLanguages = async (mode) => {
+  const config = await loadConfig();
+  if (!config) return;
+  const { site } = config.folderStructure;
+  const source = `./${site}/languages/`;
+  const branch = getBranch();
+  const displaySource = colors5.magenta(
+    `${source}${branch ? colors5.cyan(` (${branch})`) : ""}`
+  );
+  const displayDestination = colors5.magenta(
+    join5(config.host, config.remoteDir, source)
+  );
+  const direction = mode === "pull" ? "from" : "to";
+  consola8.log(
+    `\u{1F511} ${upperFirst(mode)} ${displaySource} ${direction} ${displayDestination}
+`
+  );
+  return sync(source, mode, {
+    ...config,
+    // User provided includes/excludes can only be used in the main command
+    // because they are relative to the base directory, so we reset them.
+    exclude: [],
+    excludeGlob: [".*", ".*/"],
+    include: [],
+    includeGlob: []
+  });
+};
+var languagesPush = defineCommand3({ run: () => syncLanguages("push") });
+var languagesPull = defineCommand3({ run: () => syncLanguages("pull") });
+
 // src/commands/main.ts
-var main = defineCommand3({
+var main = defineCommand4({
   run: async ({ rawArgs, cmd }) => {
     const [firstArg] = rawArgs;
     const subCommands = Object.keys(cmd.subCommands ?? {});
     const isSubCommand = subCommands.includes(firstArg);
-    if (isSubCommand)
-      return;
+    if (isSubCommand) return;
     const config = await loadConfig();
-    if (!config)
-      return;
+    if (!config) return;
     const { folderStructure } = config;
     const exclude = [
       ...config.exclude,
@@ -429,17 +460,18 @@ var main = defineCommand3({
       `^${relative(cwd2(), folderStructure.media)}`,
       `^${relative(cwd2(), folderStructure.accounts)}`,
       `^${relative(cwd2(), folderStructure.sessions)}`,
-      `^${relative(cwd2(), folderStructure.cache)}`
+      `^${relative(cwd2(), folderStructure.cache)}`,
+      `^${relative(cwd2(), join6(folderStructure.site, "languages"))}`
     ];
     const excludeGlob = [...config.excludeGlob, ".*", ".*/"];
     const include = config.include;
     const includeGlob = [...config.includeGlob, ".htaccess", ".vite/"];
     const branch = getBranch();
-    const displaySource = branch ? colors5.cyan(` ${branch} `) : " ";
-    const displayDestination = colors5.magenta(
-      join5(config.host, config.remoteDir)
+    const displaySource = branch ? colors6.cyan(` ${branch} `) : " ";
+    const displayDestination = colors6.magenta(
+      join6(config.host, config.remoteDir)
     );
-    consola8.log(`\u{1F680} Deploy${displaySource}to ${displayDestination}
+    consola9.log(`\u{1F680} Deploy${displaySource}to ${displayDestination}
 `);
     if (config.checkComposerLock) {
       const localComposerLock = readFileSync("./composer.lock", {
@@ -449,7 +481,7 @@ var main = defineCommand3({
       const skipVendor = localComposerLock === remoteComposerLock;
       if (skipVendor) {
         exclude.push("^vendor/", "^kirby/");
-        consola8.info("Skipping vendor\n");
+        consola9.info("Skipping vendor\n");
       }
     }
     await sync("./", "push", {
@@ -464,7 +496,9 @@ var main = defineCommand3({
     ["content-push"]: contentPush,
     ["content-pull"]: contentPull,
     ["accounts-push"]: accountsPush,
-    ["accounts-pull"]: accountsPull
+    ["accounts-pull"]: accountsPull,
+    ["languages-push"]: languagesPush,
+    ["languages-pull"]: languagesPull
   }
 });
 

package/dist/index.d.ts

@@ -1,82 +1,34 @@
 import * as valibot from 'valibot';
-import { Output } from 'valibot';
+import { InferInput } from 'valibot';
 
 declare const ConfigSchema: valibot.ObjectSchema<{
-    host: valibot.StringSchema<string>;
-    user: valibot.StringSchema<string>;
-    password: valibot.StringSchema<string>;
-    url: valibot.OptionalSchema<valibot.StringSchema<string>, undefined, string | undefined>;
-    token: valibot.OptionalSchema<valibot.StringSchema<string>, undefined, string | undefined>;
-    remoteDir: valibot.OptionalSchema<valibot.StringSchema<string>, undefined, string | undefined>;
-    folderStructure: valibot.OptionalSchema<valibot.UnionSchema<(valibot.LiteralSchema<"flat", "flat"> | valibot.LiteralSchema<"public", "public"> | valibot.ObjectSchema<{
-        content: valibot.StringSchema<string>;
-        media: valibot.StringSchema<string>;
-        accounts: valibot.StringSchema<string>;
-        sessions: valibot.StringSchema<string>;
-        cache: valibot.StringSchema<string>;
-    }, undefined, {
-        content: string;
-        media: string;
-        accounts: string;
-        sessions: string;
-        cache: string;
-    }>)[], "flat" | "public" | {
-        content: string;
-        media: string;
-        accounts: string;
-        sessions: string;
-        cache: string;
-    }>, undefined, "flat" | "public" | {
-        content: string;
-        media: string;
-        accounts: string;
-        sessions: string;
-        cache: string;
-    } | undefined>;
-    checkComposerLock: valibot.OptionalSchema<valibot.BooleanSchema<boolean>, undefined, boolean | undefined>;
-    callWebhooks: valibot.OptionalSchema<valibot.BooleanSchema<boolean>, undefined, boolean | undefined>;
-    dryRun: valibot.OptionalSchema<valibot.BooleanSchema<boolean>, undefined, boolean | undefined>;
-    verbose: valibot.OptionalSchema<valibot.BooleanSchema<boolean>, undefined, boolean | undefined>;
-    parallel: valibot.OptionalSchema<valibot.NumberSchema<number>, undefined, number | undefined>;
-    exclude: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<string>, string[]>, undefined, string[] | undefined>;
-    excludeGlob: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<string>, string[]>, undefined, string[] | undefined>;
-    include: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<string>, string[]>, undefined, string[] | undefined>;
-    includeGlob: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<string>, string[]>, undefined, string[] | undefined>;
-    lftpSettings: valibot.OptionalSchema<valibot.RecordSchema<valibot.StringSchema<string>, valibot.AnySchema<any>, {
-        [x: string]: any;
-    }>, undefined, {
-        [x: string]: any;
-    } | undefined>;
-    lftpFlags: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<string>, string[]>, undefined, string[] | undefined>;
-}, undefined, {
-    host: string;
-    user: string;
-    password: string;
-    url?: string | undefined;
-    token?: string | undefined;
-    remoteDir?: string | undefined;
-    folderStructure?: "flat" | "public" | {
-        content: string;
-        media: string;
-        accounts: string;
-        sessions: string;
-        cache: string;
-    } | undefined;
-    checkComposerLock?: boolean | undefined;
-    callWebhooks?: boolean | undefined;
-    dryRun?: boolean | undefined;
-    verbose?: boolean | undefined;
-    parallel?: number | undefined;
-    exclude?: string[] | undefined;
-    excludeGlob?: string[] | undefined;
-    include?: string[] | undefined;
-    includeGlob?: string[] | undefined;
-    lftpSettings?: {
-        [x: string]: any;
-    } | undefined;
-    lftpFlags?: string[] | undefined;
-}>;
-type Config = Output<typeof ConfigSchema>;
+    readonly host: valibot.StringSchema<undefined>;
+    readonly user: valibot.StringSchema<undefined>;
+    readonly password: valibot.StringSchema<undefined>;
+    readonly url: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+    readonly token: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+    readonly remoteDir: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+    readonly folderStructure: valibot.OptionalSchema<valibot.UnionSchema<[valibot.LiteralSchema<"flat", undefined>, valibot.LiteralSchema<"public", undefined>, valibot.ObjectSchema<{
+        readonly content: valibot.StringSchema<undefined>;
+        readonly media: valibot.StringSchema<undefined>;
+        readonly accounts: valibot.StringSchema<undefined>;
+        readonly sessions: valibot.StringSchema<undefined>;
+        readonly cache: valibot.StringSchema<undefined>;
+        readonly site: valibot.StringSchema<undefined>;
+    }, undefined>], undefined>, never>;
+    readonly checkComposerLock: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+    readonly callWebhooks: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+    readonly dryRun: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+    readonly verbose: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+    readonly parallel: valibot.OptionalSchema<valibot.NumberSchema<undefined>, never>;
+    readonly exclude: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
+    readonly excludeGlob: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
+    readonly include: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
+    readonly includeGlob: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
+    readonly lftpSettings: valibot.OptionalSchema<valibot.RecordSchema<valibot.StringSchema<undefined>, valibot.AnySchema, undefined>, never>;
+    readonly lftpFlags: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
+}, undefined>;
+type Config = InferInput<typeof ConfigSchema>;
 
 declare const defineConfig: (config: Config) => {
     host: string;
@@ -91,6 +43,7 @@ declare const defineConfig: (config: Config) => {
         accounts: string;
         sessions: string;
         cache: string;
+        site: string;
     } | undefined;
     checkComposerLock?: boolean | undefined;
     callWebhooks?: boolean | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kirby-deploy",
-  "version": "0.0.5",
+  "version": "0.2.0",
   "main": "./dist/index.js",
   "type": "module",
   "bin": {
@@ -11,16 +11,16 @@
   "license": "MIT",
   "devDependencies": {
     "@prettier/plugin-php": "^0.22.2",
-    "@types/node": "^20.11.19",
-    "prettier": "^3.2.5",
-    "tsup": "^8.0.2",
-    "typescript": "^5.3.3"
+    "@types/node": "^20.16.10",
+    "prettier": "^3.3.3",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.2"
   },
   "dependencies": {
-    "c12": "^1.8.0",
+    "c12": "^2.0.0",
     "citty": "^0.1.6",
     "consola": "^3.2.3",
-    "valibot": "^0.28.1"
+    "valibot": "^0.42.1"
   },
   "scripts": {
     "build": "tsup src/index.ts src/cli.ts --format esm --dts",

package/src/commands/languages.ts

@@ -0,0 +1,40 @@
+import { defineCommand } from 'citty'
+import consola from 'consola'
+import { colors } from 'consola/utils'
+import { join } from 'path/posix'
+import { loadConfig } from '../config'
+import { sync } from '../sync'
+import { getBranch, upperFirst } from '../utils'
+
+const syncLanguages = async (mode: 'pull' | 'push') => {
+  const config = await loadConfig()
+  if (!config) return
+
+  const { site } = config.folderStructure
+  const source = `./${site}/languages/`
+
+  const branch = getBranch()
+  const displaySource = colors.magenta(
+    `${source}${branch ? colors.cyan(` (${branch})`) : ''}`,
+  )
+  const displayDestination = colors.magenta(
+    join(config.host, config.remoteDir, source),
+  )
+  const direction = mode === 'pull' ? 'from' : 'to'
+  consola.log(
+    `🔑 ${upperFirst(mode)} ${displaySource} ${direction} ${displayDestination}\n`,
+  )
+
+  return sync(source, mode, {
+    ...config,
+    // User provided includes/excludes can only be used in the main command
+    // because they are relative to the base directory, so we reset them.
+    exclude: [],
+    excludeGlob: ['.*', '.*/'],
+    include: [],
+    includeGlob: [],
+  })
+}
+
+export const languagesPush = defineCommand({ run: () => syncLanguages('push') })
+export const languagesPull = defineCommand({ run: () => syncLanguages('pull') })

package/src/commands/main.ts

@@ -10,6 +10,7 @@ import { sync } from '../sync'
 import { getBranch } from '../utils'
 import { accountsPull, accountsPush } from './accounts'
 import { contentPull, contentPush } from './content'
+import { languagesPull, languagesPush } from './languages'
 
 export const main = defineCommand({
   run: async ({ rawArgs, cmd }) => {
@@ -32,6 +33,7 @@ export const main = defineCommand({
       `^${relative(cwd(), folderStructure.accounts)}`,
       `^${relative(cwd(), folderStructure.sessions)}`,
       `^${relative(cwd(), folderStructure.cache)}`,
+      `^${relative(cwd(), join(folderStructure.site, 'languages'))}`,
     ]
     const excludeGlob = [...config.excludeGlob, '.*', '.*/']
     const include = config.include
@@ -67,7 +69,11 @@ export const main = defineCommand({
   subCommands: {
     ['content-push']: contentPush,
     ['content-pull']: contentPull,
+
     ['accounts-push']: accountsPush,
     ['accounts-pull']: accountsPull,
+
+    ['languages-push']: languagesPush,
+    ['languages-pull']: languagesPull,
   },
 })

package/src/config.ts

@@ -19,8 +19,9 @@ export const loadConfig = async (): Promise<ConfigResolved | null> => {
     parse(ConfigSchema, config)
   } catch (e: any) {
     const issues = flatten<typeof ConfigSchema>(e).nested
+    if (!issues) return null
     const info = Object.entries(issues)
-      .map(([key, messages]) => `  - ${key} (${messages.join(', ')})`)
+      .map(([key, messages = []]) => `  - ${key} (${messages.join(', ')})`)
       .join('\n')
     consola.error(`Invalid properties in ${configFile}\n${info}`)
     return null
@@ -37,6 +38,7 @@ export const loadConfig = async (): Promise<ConfigResolved | null> => {
       accounts: 'storage/accounts',
       sessions: 'storage/sessions',
       cache: 'storage/cache',
+      site: 'site',
     }
   } else if (config.folderStructure === 'flat') {
     // 'flat' structure is the default.
@@ -46,6 +48,7 @@ export const loadConfig = async (): Promise<ConfigResolved | null> => {
       accounts: 'site/accounts',
       sessions: 'site/sessions',
       cache: 'site/cache',
+      site: 'site',
     }
   } else {
     folderStructure = config.folderStructure

package/src/types.ts

@@ -1,8 +1,8 @@
 import {
-  Output,
   any,
   array,
   boolean,
+  InferInput,
   literal,
   number,
   object,
@@ -18,9 +18,10 @@ export const FolderStructureSchema = object({
   accounts: string(),
   sessions: string(),
   cache: string(),
+  site: string(),
 })
 
-export type FolderStructure = Output<typeof FolderStructureSchema>
+export type FolderStructure = InferInput<typeof FolderStructureSchema>
 
 export const ConfigSchema = object({
   host: string(),
@@ -45,7 +46,7 @@ export const ConfigSchema = object({
   lftpFlags: optional(array(string())),
 })
 
-export type Config = Output<typeof ConfigSchema>
+export type Config = InferInput<typeof ConfigSchema>
 
 type ConfigWithDefaults = Pick<Config, 'url' | 'token'> &
   Required<Omit<Config, 'url' | 'token'>>