feat: Added alias resource and syncthing

Author: kevinwang5658

src/resources/shell/alias/alias-resource.ts

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   getPty,
   ModifyPlan,
   ParameterChange,
@@ -20,10 +21,40 @@ export interface AliasConfig extends StringIndexedObject {
   value: string;
 }
 
+const defaultConfig: Partial<AliasConfig> = {
+  alias: '<Replace me here!>',
+  value: '<Replace me here!>'
+}
+
+const exampleGitAlias: ExampleConfig = {
+  title: 'Git alias',
+  description: 'A single shortcut for a common Git operation.',
+  configs: [{
+    type: 'alias',
+    alias: 'gs',
+    value: 'git status',
+  }]
+}
+
+const exampleSystemAlias: ExampleConfig = {
+  title: 'System alias',
+  description: 'A single alias for a common system task or safer default.',
+  configs: [{
+    type: 'alias',
+    alias: 'rm',
+    value: 'rm -i',
+  }]
+}
+
 export class AliasResource extends Resource<AliasConfig> {
   getSettings(): ResourceSettings<AliasConfig> {
     return {
       id: 'alias',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleGitAlias,
+        example2: exampleSystemAlias,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       parameterSettings: {

src/resources/syncthing/examples.ts

@@ -0,0 +1,41 @@
+import { ExampleConfigs } from '@codifycli/plugin-core';
+
+export const exampleSyncthingConfigs: ExampleConfigs = {
+  example2: {
+    title: 'Example Syncthing setup with two devices',
+    description: 'Install Syncthing, register a peer device, and sync the ~/Documents folder between two machines.',
+    configs: [
+      {
+        type: 'syncthing',
+        launchAtStartup: true,
+        globalAnnounceEnabled: true,
+        localAnnounceEnabled: true,
+        relaysEnabled: true,
+        natEnabled: true,
+        startBrowser: false,
+        urAccepted: -1,
+      },
+      {
+        type: 'syncthing-device',
+        deviceId: '<Replace with peer device ID>',
+        deviceName: 'My Second Machine',
+        addresses: ['dynamic'],
+        autoAcceptFolders: false,
+        paused: false,
+        compression: 'metadata',
+      },
+      {
+        type: 'syncthing-folder',
+        id: 'my-docs',
+        path: '~/Documents',
+        label: 'My Documents',
+        folderType: 'sendreceive',
+        devices: ['<Replace with peer device ID>'],
+        fsWatcherEnabled: true,
+        rescanIntervalS: 3600,
+        maxConflicts: 10,
+        paused: false,
+      },
+    ]
+  },
+}

src/resources/syncthing/syncthing-device.ts

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   ModifyPlan,
   ParameterChange,
   Resource,
@@ -12,6 +13,7 @@ import {
 import { OS } from '@codifycli/schemas';
 
 import { isDaemonRunning } from './syncthing-utils.js';
+import { exampleSyncthingConfigs } from './examples.js';
 
 const schema = z
   .object({
@@ -56,6 +58,27 @@ const schema = z
 
 export type SyncthingDeviceConfig = z.infer<typeof schema>;
 
+const defaultConfig: Partial<SyncthingDeviceConfig> = {
+  addresses: ['dynamic'],
+  autoAcceptFolders: false,
+  paused: false,
+  compression: 'metadata',
+}
+
+const exampleConfig: ExampleConfig = {
+  title: 'Example Syncthing device',
+  description: 'Add a remote peer device by its device ID. Use dynamic addressing for automatic discovery, metadata compression, and auto-accept any folders the peer shares.',
+  configs: [{
+    type: 'syncthing-device',
+    deviceId: '<Replace me here!>',
+    deviceName: 'My Laptop',
+    addresses: ['dynamic'],
+    autoAcceptFolders: true,
+    paused: false,
+    compression: 'metadata',
+  }]
+}
+
 /** Raw JSON shape returned by `syncthing cli config devices <id>` */
 interface RawDevice {
   deviceID: string;
@@ -72,6 +95,11 @@ export class SyncthingDeviceResource extends Resource<SyncthingDeviceConfig> {
   getSettings(): ResourceSettings<SyncthingDeviceConfig> {
     return {
       id: 'syncthing-device',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleConfig,
+        ...exampleSyncthingConfigs
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       dependencies: ['syncthing'],
       schema,

src/resources/syncthing/syncthing-folder.ts

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   ModifyPlan,
   ParameterChange,
   Resource,
@@ -12,6 +13,7 @@ import {
 import { OS } from '@codifycli/schemas';
 
 import { isDaemonRunning } from './syncthing-utils.js';
+import { exampleSyncthingConfigs } from './examples.js';
 
 const FOLDER_TYPES = ['sendreceive', 'sendonly', 'receiveonly', 'receiveencrypted'] as const;
 
@@ -61,6 +63,31 @@ const schema = z
 
 export type SyncthingFolderConfig = z.infer<typeof schema>;
 
+const defaultConfig: Partial<SyncthingFolderConfig> = {
+  folderType: 'sendreceive',
+  fsWatcherEnabled: true,
+  rescanIntervalS: 3600,
+  maxConflicts: 10,
+  paused: false,
+}
+
+const exampleConfig: ExampleConfig = {
+  title: 'Example Syncthing folder',
+  description: 'Share a local directory with one or more peer devices. Uses sendreceive mode so changes flow in both directions, with filesystem watching for fast change detection.',
+  configs: [{
+    type: 'syncthing-folder',
+    id: 'my-docs',
+    path: '~/Documents',
+    label: 'My Documents',
+    folderType: 'sendreceive',
+    devices: ['<Replace with device ID>'],
+    fsWatcherEnabled: true,
+    rescanIntervalS: 3600,
+    maxConflicts: 10,
+    paused: false,
+  }]
+}
+
 /** Raw JSON shape returned by `syncthing cli config folders <id>` */
 interface RawFolder {
   id: string;
@@ -78,6 +105,11 @@ export class SyncthingFolderResource extends Resource<SyncthingFolderConfig> {
   getSettings(): ResourceSettings<SyncthingFolderConfig> {
     return {
       id: 'syncthing-folder',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleConfig,
+        ...exampleSyncthingConfigs
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       dependencies: ['syncthing'],
       schema,

src/resources/syncthing/syncthing.ts

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   ModifyPlan,
   ParameterChange,
   Resource,
@@ -12,6 +13,7 @@ import {
 import { OS } from '@codifycli/schemas';
 
 import { Utils } from '../../utils/index.js';
+import { exampleSyncthingConfigs } from './examples.js';
 import {
   getCliConfigBool,
   getCliConfigNumber,
@@ -74,6 +76,31 @@ const schema = z
 
 export type SyncthingConfig = z.infer<typeof schema>;
 
+const defaultConfig: Partial<SyncthingConfig> = {
+  launchAtStartup: true,
+  globalAnnounceEnabled: true,
+  localAnnounceEnabled: true,
+  relaysEnabled: true,
+  natEnabled: true,
+  startBrowser: false,
+  urAccepted: -1,
+}
+
+const exampleConfig: ExampleConfig = {
+  title: 'Example Syncthing config',
+  description: 'Install Syncthing with sensible defaults: launch at startup, local and global discovery enabled, relays on, no browser auto-open, and usage reporting opted out.',
+  configs: [{
+    type: 'syncthing',
+    launchAtStartup: true,
+    globalAnnounceEnabled: true,
+    localAnnounceEnabled: true,
+    relaysEnabled: true,
+    natEnabled: true,
+    startBrowser: false,
+    urAccepted: -1,
+  }]
+}
+
 // Maps schema key → syncthing CLI config path (without trailing "get/set <value>")
 // Syncthing v2 uses kebab-case subcommands
 const OPTION_CLI_PATHS: Partial<Record<keyof SyncthingConfig, string>> = {
@@ -92,6 +119,11 @@ export class SyncthingResource extends Resource<SyncthingConfig> {
   getSettings(): ResourceSettings<SyncthingConfig> {
     return {
       id: 'syncthing',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleConfig,
+        ...exampleSyncthingConfigs,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {