feat: Added example and defaults for path, aliases, ssh-config

Author: kevinwang5658

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

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   ModifyPlan,
   ParameterChange,
   RefreshContext,
@@ -36,13 +37,52 @@ export const schema = z.object({
   .describe('Aliases resource. Can be used to manage multiple aliases');
 
 export type AliasesConfig = z.infer<typeof schema>;
+
+const defaultConfig: Partial<AliasesConfig> = {
+  aliases: [],
+}
+
+const exampleGitAliases: ExampleConfig = {
+  title: 'Git aliases',
+  description: 'Common shortcuts for everyday Git workflows - checking status, staging, committing, pushing, and viewing history.',
+  configs: [{
+    type: 'aliases',
+    aliases: [
+      { alias: 'gs', value: 'git status' },
+      { alias: 'ga', value: 'git add .' },
+      { alias: 'gc', value: 'git commit -m' },
+      { alias: 'gp', value: 'git push origin HEAD' },
+      { alias: 'gl', value: 'git log --oneline --graph --decorate' },
+    ],
+  }]
+}
+
+const exampleSystemAliases: ExampleConfig = {
+  title: 'System and safety shortcuts',
+  description: 'Handy aliases for common system tasks and safer defaults - clearing the screen, confirming deletions, and checking disk and process usage.',
+  configs: [{
+    type: 'aliases',
+    aliases: [
+      { alias: 'c', value: 'clear' },
+      { alias: 'rm', value: 'rm -i' },
+      { alias: 'dfh', value: 'df -h' },
+      { alias: 'psg', value: 'ps aux | grep -v grep | grep' },
+    ],
+  }]
+}
+
 export class AliasesResource extends Resource<AliasesConfig> {
   private readonly ALIAS_DECLARATION_REGEX = /^\s*alias\s+([A-Z_a-z][\w-]*)\s*=\s*(["']?)(.+?)\2\s*(?:#.*)?$/gm;
   readonly filePaths = Utils.getShellRcFiles()
 
   getSettings(): ResourceSettings<AliasesConfig> {
     return {
       id: 'aliases',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleGitAliases,
+        example2: exampleSystemAliases,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {

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

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   getPty,
   ModifyPlan,
   ParameterChange,
@@ -25,13 +26,31 @@ export interface PathConfig extends StringIndexedObject {
   declarationsOnly: boolean;
 }
 
+const defaultConfig: Partial<PathConfig> = {
+  paths: [],
+  declarationsOnly: true,
+}
+
+const exampleConfig: ExampleConfig = {
+  title: 'Example path config',
+  configs: [{
+    type: 'path',
+    paths: ['~/.local', '~/bin'],
+    declarationsOnly: true,
+  }]
+}
+
 export class PathResource extends Resource<PathConfig> {
   private readonly PATH_DECLARATION_REGEX = /((export PATH=)|(path+=\()|(path=\())(.+?)[\n;]/g;
   private readonly filePaths = Utils.getShellRcFiles()
 
   getSettings(): ResourceSettings<PathConfig> {
     return {
       id: 'path',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleConfig,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       parameterSettings: {

src/resources/ssh/examples.ts

@@ -1,7 +1,7 @@
 import { ExampleConfigs } from '@codifycli/plugin-core';
 
 export const exampleSshConfigs: ExampleConfigs = {
-  example1: {
+  example2: {
     title: 'Example git ssh setup',
     configs: [
       {

src/resources/ssh/ssh-config.ts

@@ -1,4 +1,5 @@
 import {
+  ExampleConfig,
   getPty,
   Resource,
   ResourceSettings
@@ -39,17 +40,34 @@ const defaultConfig: Partial<SshConfig> = {
     Host: "*",
     AddKeysToAgent: true,
     UseKeychain: true,
-    IdentityFile: "~/.ssh/id_ed25519",
+    IdentityFile: "<Replace me here!>",
     IgnoreUnknown: "UseKeychain"
   }]
 }
 
+const exampleConfig: ExampleConfig = {
+  title: 'Example ssh config',
+  configs: [{
+    type: 'ssh-config',
+    hosts: [{
+      Host: "*",
+      AddKeysToAgent: true,
+      UseKeychain: true,
+      IdentityFile: "~/.ssh/id_ed25519",
+      IgnoreUnknown: "UseKeychain"
+    }]
+  }]
+}
+
 export class SshConfigFileResource extends Resource<SshConfig> {
   getSettings(): ResourceSettings<SshConfig> {
     return {
       id: 'ssh-config',
       defaultConfig,
-      exampleConfigs: exampleSshConfigs,
+      exampleConfigs: {
+        example1: exampleConfig,
+        ...exampleSshConfigs
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       isSensitive: true,