feat: Added homebrew, git, git-lfs, examples, aws-profile, aws-cli

Author: kevinwang5658

src/resources/aws-cli/cli/aws-cli.ts

@@ -4,6 +4,7 @@ import fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 
+import { exampleAwsCliConfigs } from '../examples.js';
 import Schema from './aws-cli-schema.json';
 
 export interface AwsCliConfig extends StringIndexedObject {
@@ -17,6 +18,9 @@ export class AwsCliResource extends Resource<AwsCliConfig> {
   getSettings(): ResourceSettings<AwsCliConfig> {
     return {
       schema: Schema,
+      exampleConfigs: {
+        ...exampleAwsCliConfigs,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       id: 'aws-cli',
     };

src/resources/aws-cli/examples.ts

@@ -0,0 +1,21 @@
+import { ExampleConfigs } from '@codifycli/plugin-core';
+
+export const exampleAwsCliConfigs: ExampleConfigs = {
+  example1: {
+    title: 'Install AWS CLI and configure a profile',
+    description: 'Install the AWS CLI and set up a default profile with credentials — a complete AWS setup from scratch.',
+    configs: [
+      {
+        type: 'aws-cli',
+      },
+      {
+        type: 'aws-profile',
+        profile: 'default',
+        awsAccessKeyId: '<Replace me here!>',
+        awsSecretAccessKey: '<Replace me here!>',
+        region: 'us-east-1',
+        output: 'json',
+      },
+    ]
+  },
+}

src/resources/aws-cli/profile/aws-profile.ts

@@ -14,6 +14,7 @@ import * as fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 
+import { exampleAwsCliConfigs } from '../examples.js';
 import Schema from './aws-profile-schema.json'
 import { CSVCredentialsTransformation } from './csv-credentials-transformation.js';
 
@@ -47,23 +48,6 @@ const exampleProfile: ExampleConfig = {
   }]
 }
 
-const exampleWithCli: ExampleConfig = {
-  title: 'Install AWS CLI and configure a profile',
-  description: 'Install the AWS CLI and set up a default profile with credentials — a complete AWS setup from scratch.',
-  configs: [
-    {
-      type: 'aws-cli',
-    },
-    {
-      type: 'aws-profile',
-      profile: 'default',
-      awsAccessKeyId: '<Replace me here!>',
-      awsSecretAccessKey: '<Replace me here!>',
-      region: 'us-east-1',
-      output: 'json',
-    },
-  ]
-}
 
 export class AwsProfileResource extends Resource<AwsProfileConfig> {
 
@@ -73,7 +57,7 @@ export class AwsProfileResource extends Resource<AwsProfileConfig> {
       defaultConfig,
       exampleConfigs: {
         example1: exampleProfile,
-        example2: exampleWithCli,
+        example2: exampleAwsCliConfigs.example1,
       },
       operatingSystems: [OS.Darwin, OS.Linux],
       dependencies: ['aws-cli'],

src/resources/git/git/git-resource.ts

@@ -1,4 +1,4 @@
-import { Resource, ResourceSettings, SpawnStatus, Utils, getPty } from '@codifycli/plugin-core';
+import { ExampleConfig, Resource, ResourceSettings, SpawnStatus, Utils, getPty } from '@codifycli/plugin-core';
 import { OS, StringIndexedObject } from '@codifycli/schemas';
 
 import { GitEmailParameter } from './git-email-paramater.js';
@@ -11,10 +11,23 @@ export interface GitConfig extends StringIndexedObject {
   // TODO: Allow upgrading git to the latest version in the future. This means installing git using homebrew
 }
 
+const exampleConfig: ExampleConfig = {
+  title: 'Configure global git identity',
+  description: 'Set the global git username and email used for all commits on this machine.',
+  configs: [{
+    type: 'git',
+    email: 'you@example.com',
+    username: 'Your Name',
+  }]
+}
+
 export class GitResource extends Resource<GitConfig> {
   getSettings(): ResourceSettings<GitConfig> {
     return {
       id: 'git',
+      exampleConfigs: {
+        example1: exampleConfig,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       removeStatefulParametersBeforeDestroy: true,

src/resources/git/lfs/git-lfs.ts

@@ -1,4 +1,4 @@
-import { getPty, Resource, ResourceSettings, SpawnStatus, Utils } from '@codifycli/plugin-core';
+import { ExampleConfig, getPty, Resource, ResourceSettings, SpawnStatus, Utils } from '@codifycli/plugin-core';
 import { OS, ResourceConfig } from '@codifycli/schemas';
 import * as os from 'node:os';
 
@@ -8,11 +8,30 @@ export interface GitLfsConfig extends ResourceConfig {
   // TODO: Add --system option for installing.
 }
 
+const exampleWithRepo: ExampleConfig = {
+  title: 'Install Git LFS and clone a repository',
+  description: 'Install Git LFS and clone a repository that uses LFS for large file storage.',
+  configs: [
+    {
+      type: 'git-lfs',
+    },
+    {
+      type: 'git-repository',
+      repository: 'git@github.com:org/repo-with-lfs.git',
+      directory: '~/projects/repo-with-lfs',
+      dependsOn: ['git-lfs'],
+    },
+  ]
+}
+
 export class GitLfsResource extends Resource<GitLfsConfig> {
   getSettings(): ResourceSettings<GitLfsConfig> {
     return {
       id: 'git-lfs',
-      operatingSystems: [OS.Darwin],
+      exampleConfigs: {
+        example1: exampleWithRepo,
+      },
+      operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       dependencies: ['homebrew'],
     }

src/resources/git/wait-github-ssh-key/wait-github-ssh-key.ts

@@ -6,6 +6,7 @@ import {
   getPty
 } from '@codifycli/plugin-core';
 import { OS, ResourceConfig } from '@codifycli/schemas';
+import { exampleSshConfigs } from '../../ssh/examples.js';
 import fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
@@ -16,6 +17,9 @@ export class WaitGithubSshKey extends Resource<WaitGithubSshKeyConfig> {
   getSettings(): ResourceSettings<WaitGithubSshKeyConfig> {
     return {
       id: 'wait-github-ssh-key',
+      exampleConfigs: {
+        example1: exampleSshConfigs.example2,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       dependencies: [
         'ssh-key',

src/resources/homebrew/homebrew.ts

@@ -1,5 +1,6 @@
 import {
   CreatePlan,
+  ExampleConfig,
   FileUtils,
   Resource,
   ResourceSettings,
@@ -26,13 +27,43 @@ export interface HomebrewConfig extends ResourceConfig {
   onlyPlanUserInstalled: boolean
 }
 
+const defaultConfig: Partial<HomebrewConfig> = {
+  formulae: [],
+  casks: [],
+}
+
+const exampleFormulae: ExampleConfig = {
+  title: 'Install common CLI tools',
+  description: 'Install Homebrew and a set of essential command-line utilities for development.',
+  configs: [{
+    type: 'homebrew',
+    formulae: ['git', 'wget', 'jq', 'ripgrep', 'tree', 'htop'],
+    casks: [],
+  }]
+}
+
+const exampleWithCasks: ExampleConfig = {
+  title: 'Install CLI tools and GUI apps',
+  description: 'Install Homebrew with developer CLI tools and popular GUI applications via casks.',
+  configs: [{
+    type: 'homebrew',
+    formulae: ['git', 'wget', 'jq', 'ripgrep'],
+    casks: ['visual-studio-code', 'iterm2', 'google-chrome'],
+  }]
+}
+
 export class HomebrewResource extends Resource<HomebrewConfig> {
 
   override getSettings(): ResourceSettings<HomebrewConfig> {
     return {
       schema: HomebrewSchema,
       operatingSystems: [OS.Darwin, OS.Linux],
       id: 'homebrew',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleFormulae,
+        example2: exampleWithCasks,
+      },
       parameterSettings: {
         taps: { type: 'stateful', definition: new TapsParameter(), order: 1 },
         formulae: { type: 'stateful', definition: new FormulaeParameter(), order: 2 },

src/resources/ssh/examples.ts

@@ -36,7 +36,7 @@ export const exampleSshConfigs: ExampleConfigs = {
         "dependsOn": ["ssh-config"]
       },
       {
-        "type": 'git-repository',
+        "type": 'git-repositories',
         "parentDirectory": '~/projects',
         "repositories": ['<Replace me here!>', '<Replace me here!>']
       }