kirby-deploy 0.0.3 → 0.0.5

package/dist/cli.js

@@ -78,9 +78,10 @@ var loadConfig = async () => {
 ${info}`);
     return null;
   }
+  let folderStructure;
   config.folderStructure ??= "flat";
   if (config.folderStructure === "public") {
-    config.folderStructure = {
+    folderStructure = {
       content: "content",
       media: "public/media",
       accounts: "storage/accounts",
@@ -88,17 +89,20 @@ ${info}`);
       cache: "storage/cache"
     };
   } else if (config.folderStructure === "flat") {
-    config.folderStructure = {
+    folderStructure = {
       content: "content",
       media: "site/media",
       accounts: "site/accounts",
       sessions: "site/sessions",
       cache: "site/cache"
     };
+  } else {
+    folderStructure = config.folderStructure;
   }
-  config = {
+  const configResolved = {
     remoteDir: "./",
     dryRun: true,
+    verbose: false,
     parallel: 10,
     checkComposerLock: true,
     callWebhooks: true,
@@ -107,13 +111,14 @@ ${info}`);
     include: [],
     includeGlob: [],
     ...config,
+    folderStructure,
     lftpSettings: {
       "ftp:ssl-force": true,
       ...config.lftpSettings
     },
     lftpFlags: ["--parallel=10", "--dereference", ...config.lftpFlags ?? []]
   };
-  return config;
+  return configResolved;
 };
 
 // src/lftp/cat.ts
@@ -254,8 +259,17 @@ var callWebhook = async (url, token) => {
 var sync = async (source, mode, config) => {
   const reverse = mode === "push";
   const targetName = mode === "push" ? "remote" : "local";
-  const webhook = `${config.url}/plugin-kirby-deploy`;
+  const webhookBase = `${config.url}/plugin-kirby-deploy`;
+  const shouldCallWebhooks = mode === "push" && config.callWebhooks;
   const destination = source === "./" ? config.remoteDir : `./${join2(config.remoteDir, source)}`;
+  if (shouldCallWebhooks && !config.token) {
+    consola5.error("token needed to call webhooks");
+    return false;
+  }
+  if (shouldCallWebhooks && !config.url) {
+    consola5.error("url needed to call webhooks");
+    return false;
+  }
   const flags = [
     "--continue",
     "--only-newer",
@@ -292,8 +306,9 @@ var sync = async (source, mode, config) => {
     consola5.log("");
   }
   consola5.log("Apply changes...\n");
-  if (config.callWebhooks)
-    await callWebhook(`${webhook}/start`, config.token);
+  if (shouldCallWebhooks) {
+    await callWebhook(`${webhookBase}/start`, config.token);
+  }
   let hasChanges, hasErrors;
   try {
     ;
@@ -307,8 +322,8 @@ var sync = async (source, mode, config) => {
     consola5.error(e);
     return false;
   } finally {
-    if (config.callWebhooks) {
-      await callWebhook(`${webhook}/finish`, config.token);
+    if (shouldCallWebhooks) {
+      await callWebhook(`${webhookBase}/finish`, config.token);
     }
   }
   if (!hasChanges) {
@@ -418,7 +433,7 @@ var main = defineCommand3({
     ];
     const excludeGlob = [...config.excludeGlob, ".*", ".*/"];
     const include = config.include;
-    const includeGlob = [...config.includeGlob, ".htaccess"];
+    const includeGlob = [...config.includeGlob, ".htaccess", ".vite/"];
     const branch = getBranch();
     const displaySource = branch ? colors5.cyan(` ${branch} `) : " ";
     const displayDestination = colors5.magenta(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kirby-deploy",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "main": "./dist/index.js",
   "type": "module",
   "bin": {

package/src/commands/main.ts

@@ -35,7 +35,7 @@ export const main = defineCommand({
     ]
     const excludeGlob = [...config.excludeGlob, '.*', '.*/']
     const include = config.include
-    const includeGlob = [...config.includeGlob, '.htaccess']
+    const includeGlob = [...config.includeGlob, '.htaccess', '.vite/']
 
     const branch = getBranch()
     const displaySource = branch ? colors.cyan(` ${branch} `) : ' '

package/src/config.ts

@@ -1,7 +1,7 @@
 import { loadConfig as load } from 'c12'
 import consola from 'consola'
 import { flatten, parse } from 'valibot'
-import { Config, ConfigResolved, ConfigSchema } from './types'
+import { Config, ConfigResolved, ConfigSchema, FolderStructure } from './types'
 
 export const loadConfig = async (): Promise<ConfigResolved | null> => {
   let { config, configFile } = await load<Config>({
@@ -27,9 +27,11 @@ export const loadConfig = async (): Promise<ConfigResolved | null> => {
   }
 
   // Resolve shorthands
+
+  let folderStructure: FolderStructure
   config.folderStructure ??= 'flat'
   if (config.folderStructure === 'public') {
-    config.folderStructure = {
+    folderStructure = {
       content: 'content',
       media: 'public/media',
       accounts: 'storage/accounts',
@@ -37,18 +39,22 @@ export const loadConfig = async (): Promise<ConfigResolved | null> => {
       cache: 'storage/cache',
     }
   } else if (config.folderStructure === 'flat') {
-    config.folderStructure = {
+    // 'flat' structure is the default.
+    folderStructure = {
       content: 'content',
       media: 'site/media',
       accounts: 'site/accounts',
       sessions: 'site/sessions',
       cache: 'site/cache',
     }
+  } else {
+    folderStructure = config.folderStructure
   }
 
-  config = {
+  const configResolved = {
     remoteDir: './',
     dryRun: true,
+    verbose: false,
     parallel: 10,
     checkComposerLock: true,
     callWebhooks: true,
@@ -57,12 +63,13 @@ export const loadConfig = async (): Promise<ConfigResolved | null> => {
     include: [],
     includeGlob: [],
     ...config,
+    folderStructure,
     lftpSettings: {
       'ftp:ssl-force': true,
       ...config.lftpSettings,
     },
     lftpFlags: ['--parallel=10', '--dereference', ...(config.lftpFlags ?? [])],
-  }
+  } satisfies ConfigResolved
 
-  return config as ConfigResolved
+  return configResolved
 }

package/src/sync.ts

@@ -11,10 +11,21 @@ export const sync = async (
 ): Promise<boolean> => {
   const reverse = mode === 'push'
   const targetName = mode === 'push' ? 'remote' : 'local'
-  const webhook = `${config.url}/plugin-kirby-deploy`
+  const webhookBase = `${config.url}/plugin-kirby-deploy`
+  const shouldCallWebhooks = mode === 'push' && config.callWebhooks
   const destination =
     source === './' ? config.remoteDir : `./${join(config.remoteDir, source)}`
 
+  if (shouldCallWebhooks && !config.token) {
+    consola.error('token needed to call webhooks')
+    return false
+  }
+
+  if (shouldCallWebhooks && !config.url) {
+    consola.error('url needed to call webhooks')
+    return false
+  }
+
   const flags = [
     '--continue',
     '--only-newer',
@@ -57,8 +68,10 @@ export const sync = async (
 
   consola.log('Apply changes...\n')
 
+  if (shouldCallWebhooks) {
+    await callWebhook(`${webhookBase}/start`, config.token!)
+  }
   // Make sure the finish hook is called even if an unexpected error occurs.
-  if (config.callWebhooks) await callWebhook(`${webhook}/start`, config.token)
   let hasChanges, hasErrors
   try {
     ;({ hasChanges, hasErrors } = await mirror(
@@ -71,8 +84,8 @@ export const sync = async (
     consola.error(e)
     return false
   } finally {
-    if (config.callWebhooks) {
-      await callWebhook(`${webhook}/finish`, config.token)
+    if (shouldCallWebhooks) {
+      await callWebhook(`${webhookBase}/finish`, config.token!)
     }
   }
 

package/src/types.ts

@@ -47,6 +47,9 @@ export const ConfigSchema = object({
 
 export type Config = Output<typeof ConfigSchema>
 
-export type ConfigResolved = Required<Omit<Config, 'folderStructure'>> & {
+type ConfigWithDefaults = Pick<Config, 'url' | 'token'> &
+  Required<Omit<Config, 'url' | 'token'>>
+
+export type ConfigResolved = Omit<ConfigWithDefaults, 'folderStructure'> & {
   folderStructure: FolderStructure
 }