terrafaker 0.0.6 → 0.0.8

package/README.md

@@ -18,17 +18,53 @@ Obviously, you shouldn't use this tool to try to generate real production infras
 - Generate git repos with multiple files (and optionally push them to GitHub)
 - Bulk clone and delete generated repos by prefix
 
-### Supported providers and resources
+`terrafaker` can be used to randomly generate a file or repo of files like this:
+
+```tf
+provider "aws" {
+  region = "ap-northeast-1"
+}
+
+resource "aws_instance" "awful_tan_squirrel" {
+  ami           = "ami-11060228d352"
+  instance_type = "m8a.metal-48xl"
+  tags = {
+    Environment = "Dev"
+    Service     = "service"
+  }
+}
+
+resource "aws_lambda_function" "irresponsible_lavender_elephant" {
+  ami           = "ami-3934ae468a90"
+  runtime       = "python3.13"
+  handler       = "exports.run"
+  function_name = "run"
+  memory_size   = 8960
+  role          = "arn:aws:iam::0c23f323cc2f:mfa/gummy_lavender_fox"
+  tags = {
+    Environment = "Dev"
+    Service     = "service"
+  }
+}
+```
+
+### Supported IAC providers and resources
+
+- Terraform
+    - AWS
+        - Compute instances
+        - Functions
+    - GCP
+        - Compute instances
+        - Functions
+    - Azure
+        - Compute instances
+        - Functions
 
-- AWS
-    - Compute instances
-    - Functions
-- GCP
-    - Compute instances
-    - Functions
-- Azure
-    - Compute instances
-    - Functions
+### Supported VCS providers
+
+- GitHub ([`brew install gh`](https://cli.github.com/))
+- GitLab ([`brew install glab`](https://docs.gitlab.com/cli/))
 
 ## Issues
 
@@ -36,221 +72,24 @@ If you find a bug, feel free to [open up an issue](https://github.com/brandongre
 
 If you would like to see a feature, and it isn't [already documented](https://github.com/brandongregoryscott/terrafaker/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement), feel free to open up a new issue and describe the desired behavior.
 
-<!-- prettier-ignore-start -->
-<!-- toc -->
-* [terrafaker](#terrafaker)
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
+- [terrafaker](#terrafaker)
+- [Usage](#usage)
+- [Commands](./COMMANDS.md)
 
 # Usage
 
 <!-- usage -->
+
 ```sh-session
 $ npm install -g terrafaker
 $ terrafaker COMMAND
 running command...
 $ terrafaker (--version)
-terrafaker/0.0.6 darwin-arm64 node-v24.8.0
+terrafaker/0.0.8 darwin-arm64 node-v24.8.0
 $ terrafaker --help [COMMAND]
 USAGE
   $ terrafaker COMMAND
 ...
 ```
-<!-- usagestop -->
-
-# Commands
-
-<!-- commands -->
-* [`terrafaker generate file`](#terrafaker-generate-file)
-* [`terrafaker generate repo`](#terrafaker-generate-repo)
-* [`terrafaker gh clone-repos`](#terrafaker-gh-clone-repos)
-* [`terrafaker gh delete-repos`](#terrafaker-gh-delete-repos)
-* [`terrafaker help [COMMAND]`](#terrafaker-help-command)
-
-## `terrafaker generate file`
-
-Generates a terraform file.
-
-```
-USAGE
-  $ terrafaker generate file [--chaos-tags | --tags <value> | --no-tags] [-f] [--name <value>] [--provider
-    aws|gcp|azure] [-q] [--resource-count <value>]
-
-FLAGS
-  -f, --[no-]format
-      Format the output terraform files. Requires `terraform` to be in your $PATH.
-
-  -q, --quiet
-      Suppress the logging output.
-
-  --chaos-tags
-      Generate random tag keys & values
-
-  --name=<value>
-      Name for the generated file, which must end in .tf
-
-  --no-tags
-      Disable any tag generation
-
-  --provider=<option>
-      Cloud provider to generate resources for
-      <options: aws|gcp|azure>
-
-  --resource-count=<value>
-      [default: 3] Number of resources per file to generate
-
-  --tags=<value>
-      [default: Environment:Dev,Service:service] Custom tags to use for generated resources. Should be a comma-separated
-      list of tag names to generate random values for, or tag names with values delimited by a colon.
-
-      Examples:
-
-      Specify just tag keys to have a random value generated.
-      --tags Service,Team → {"Service":"(random value)","Team":"(random value)"}
-
-      Specify value for a key with the : delimiter. This can be mixed with just keys that are randomly generated.
-      --tags Service:web-app,Team → {"Service":"web-app","Team":"(random value)"}
-      --tags Service:web-app,Team:core → {"Service":"web-app","Team":"core"}
-
-      When specifying a key or value that has a space in it, the entire tag string needs to be quoted.
-      --tags "Service:my awesome web app,Team Name:The Core Team" → {"Service":"my awesome web app","Team Name":"The Core
-      Team"}
-
-DESCRIPTION
-  Generates a terraform file.
-```
-
-_See code: [src/commands/generate/file.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.6/src/commands/generate/file.ts)_
-
-## `terrafaker generate repo`
-
-Generates repo(s) with multiple terraform files.
-
-```
-USAGE
-  $ terrafaker generate repo [--chaos-tags | --tags <value> | --no-tags] [--count <value>] [--create-remote]
-    [--directory <value>] [--file-count <value>] [-f] [--prefix <value>] [--provider aws|gcp|azure] [--public] [-q]
-    [--resource-count <value>]
-
-FLAGS
-  -f, --[no-]format
-      Format the output terraform files. Requires `terraform` to be in your $PATH.
-
-  -q, --quiet
-      Suppress the logging output.
-
-  --chaos-tags
-      Generate random tag keys & values
-
-  --count=<value>
-      [default: 1] Number of repos to generate
-
-  --create-remote
-      Create and push a remote GitHub repo. Requires the `gh` CLI to be installed. To install, run `brew install gh`.
-
-  --directory=<value>
-      [default: .] Directory to generate the repo(s) in
-
-  --file-count=<value>
-      [default: 3] Number of files per repo to generate
-
-  --no-tags
-      Disable any tag generation
-
-  --prefix=<value>
-      [default: tf_] Prefix for repo names, useful for quickly identifying generated content
-
-  --provider=<option>
-      Cloud provider to generate resources for
-      <options: aws|gcp|azure>
-
-  --public
-      Whether the remote repo(s) created are public.
-
-  --resource-count=<value>
-      [default: 3] Number of resources per file to generate
-
-  --tags=<value>
-      [default: Environment:Dev,Service:service] Custom tags to use for generated resources. Should be a comma-separated
-      list of tag names to generate random values for, or tag names with values delimited by a colon.
-
-      Examples:
-
-      Specify just tag keys to have a random value generated.
-      --tags Service,Team → {"Service":"(random value)","Team":"(random value)"}
-
-      Specify value for a key with the : delimiter. This can be mixed with just keys that are randomly generated.
-      --tags Service:web-app,Team → {"Service":"web-app","Team":"(random value)"}
-      --tags Service:web-app,Team:core → {"Service":"web-app","Team":"core"}
-
-      When specifying a key or value that has a space in it, the entire tag string needs to be quoted.
-      --tags "Service:my awesome web app,Team Name:The Core Team" → {"Service":"my awesome web app","Team Name":"The Core
-      Team"}
-
-DESCRIPTION
-  Generates repo(s) with multiple terraform files.
-```
-
-_See code: [src/commands/generate/repo.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.6/src/commands/generate/repo.ts)_
-
-## `terrafaker gh clone-repos`
-
-Clones repos from your Github account, useful for pulling down generated repos for manual modifications. Requires the `gh` CLI to be installed. To install, run `brew install gh`.
-
-```
-USAGE
-  $ terrafaker gh clone-repos --prefix <value> [--directory <value>]
-
-FLAGS
-  --directory=<value>  [default: .] Directory to clone the repo(s) in
-  --prefix=<value>     (required) Prefix for the repos to clone, such as 'tf_'
-
-DESCRIPTION
-  Clones repos from your Github account, useful for pulling down generated repos for manual modifications. Requires the
-  `gh` CLI to be installed. To install, run `brew install gh`.
-```
-
-_See code: [src/commands/gh/clone-repos.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.6/src/commands/gh/clone-repos.ts)_
 
-## `terrafaker gh delete-repos`
-
-Deletes repos from your Github account, useful for cleaning up generated test data. Requires the `gh` CLI to be installed. To install, run `brew install gh`.
-
-```
-USAGE
-  $ terrafaker gh delete-repos --prefix <value>
-
-FLAGS
-  --prefix=<value>  (required) Prefix for the repos to delete, such as 'tf_'
-
-DESCRIPTION
-  Deletes repos from your Github account, useful for cleaning up generated test data. Requires the `gh` CLI to be
-  installed. To install, run `brew install gh`.
-
-  If the deletion fails, you may need to refresh your CLI permissions with `gh auth refresh -s delete_repo`
-```
-
-_See code: [src/commands/gh/delete-repos.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.6/src/commands/gh/delete-repos.ts)_
-
-## `terrafaker help [COMMAND]`
-
-Display help for terrafaker.
-
-```
-USAGE
-  $ terrafaker help [COMMAND...] [-n]
-
-ARGUMENTS
-  [COMMAND...]  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for terrafaker.
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
-<!-- commandsstop -->
-<!-- prettier-ignore-end -->
+<!-- usagestop -->

package/dist/commands/generate/file.js

@@ -1,9 +1,9 @@
 import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../utilities/base-command.js";
 import { chaosTagsFlag, formatFlag, getTagsOption, noTagsFlag, providerFlag, quietFlag, resourceCountFlag, tagsFlag, } from "../../utilities/flags.js";
-import { formatTfFileName, success } from "../../utilities/string-utils.js";
-import { randomProvider } from "../../utilities/generators/generator-utils.js";
 import { FileGenerator } from "../../utilities/generators/file-generator.js";
+import { randomProvider } from "../../utilities/generators/generator-utils.js";
+import { formatTfFileName, success } from "../../utilities/string-utils.js";
 class File extends BaseCommand {
     static description = "Generates a terraform file.";
     static flags = {
@@ -20,15 +20,15 @@ class File extends BaseCommand {
     };
     async run() {
         const { flags } = await this.parse(File);
-        const { name, quiet, format, "resource-count": resourceCount } = flags;
+        const { format, name, quiet, "resource-count": resourceCount } = flags;
         const tags = getTagsOption(flags);
         const provider = flags.provider ?? randomProvider();
         const fileName = formatTfFileName(name ?? "main.tf");
         FileGenerator.generate({
             fileName,
+            format,
             provider,
             resourceCount,
-            format,
             tags,
         });
         if (!quiet) {

package/dist/commands/generate/repo.js

@@ -1,48 +1,48 @@
 import { Flags } from "@oclif/core";
 import path from "node:path";
-import { BaseCommand } from "../../utilities/base-command.js";
-import { chaosTagsFlag, formatFlag, getTagsOption, noTagsFlag, providerFlag, quietFlag, resourceCountFlag, tagsFlag, } from "../../utilities/flags.js";
-import { $ } from "zx";
 import { HelpMessages } from "../../enums/help-messages.js";
+import { VcsProviders } from "../../enums/vcs-providers.js";
+import { BaseCommand } from "../../utilities/base-command.js";
+import { chaosTagsFlag, directoryFlag, formatFlag, getTagsOption, noTagsFlag, providerFlag, quietFlag, resourceCountFlag, tagsFlag, vcsProviderFlag, } from "../../utilities/flags.js";
 import { RepoGenerator } from "../../utilities/generators/repo-generator.js";
+import { GitHub } from "../../utilities/github.js";
+import { GitLab } from "../../utilities/gitlab.js";
 import { success } from "../../utilities/string-utils.js";
 class Repo extends BaseCommand {
     static description = "Generates repo(s) with multiple terraform files.";
     static flags = {
         "chaos-tags": chaosTagsFlag,
         count: Flags.integer({
-            description: "Number of repos to generate",
             default: 1,
+            description: "Number of repos to generate",
         }),
         "create-remote": Flags.boolean({
-            description: `Create and push a remote GitHub repo. ${HelpMessages.RequiresGhCli}`,
-        }),
-        directory: Flags.string({
-            description: "Directory to generate the repo(s) in",
-            default: ".",
+            description: `Create and push a remote repo. ${HelpMessages.RequiresVcsCLI}`,
         }),
+        directory: directoryFlag,
         "file-count": Flags.integer({
-            description: "Number of files per repo to generate",
             default: 3,
+            description: "Number of files per repo to generate",
         }),
         format: formatFlag,
         "no-tags": noTagsFlag,
         prefix: Flags.string({
-            description: "Prefix for repo names, useful for quickly identifying generated content",
             default: "tf_",
+            description: "Prefix for repo names, useful for quickly identifying generated content",
         }),
         provider: providerFlag,
         public: Flags.boolean({
-            description: "Whether the remote repo(s) created are public.",
             default: false,
+            description: "Whether the remote repo(s) created are public.",
         }),
         quiet: quietFlag,
         "resource-count": resourceCountFlag,
         tags: tagsFlag(),
+        "vcs-provider": vcsProviderFlag,
     };
     async run() {
         const { flags } = await this.parse(Repo);
-        const { format, prefix, count, public: isPublic, quiet, "resource-count": resourceCount, "file-count": fileCount, "create-remote": createRemote, } = flags;
+        const { count, "create-remote": createRemote, "file-count": fileCount, format, prefix, public: isPublic, quiet, "resource-count": resourceCount, "vcs-provider": vcsProvider, } = flags;
         const tags = getTagsOption(flags);
         const provider = flags.provider;
         const directory = path.resolve(process.cwd(), flags.directory);
@@ -53,12 +53,19 @@ class Repo extends BaseCommand {
                 format,
                 prefix,
                 provider,
-                resourceCount,
                 quiet,
+                resourceCount,
                 tags,
             });
             if (createRemote) {
-                await $ `gh repo create ${name} --source ${path} ${isPublic ? "--public" : "--private"} --push`;
+                switch (vcsProvider) {
+                    case VcsProviders.GitHub:
+                        await GitHub.pushRepo({ isPublic, path });
+                        break;
+                    case VcsProviders.GitLab:
+                        await GitLab.pushRepo({ isPublic, path });
+                        break;
+                }
                 if (!quiet) {
                     this.log(success(`Successfully pushed '${name}'`));
                 }

package/dist/commands/gh/repo/clone.js

@@ -0,0 +1,22 @@
+import { HelpMessages } from "../../../enums/help-messages.js";
+import { BaseCommand } from "../../../utilities/base-command.js";
+import { directoryFlag, requiredPrefixFlag } from "../../../utilities/flags.js";
+import { GitHub } from "../../../utilities/github.js";
+class Clone extends BaseCommand {
+    static description = `Clones repos from your GitHub account, useful for pulling down generated repos for manual modifications. ${HelpMessages.RequiresGhCli}`;
+    static flags = {
+        directory: directoryFlag,
+        prefix: requiredPrefixFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(Clone);
+        const { directory, prefix } = flags;
+        await this.cloneRepos({
+            cloneRepo: GitHub.cloneRepo,
+            directory,
+            listRepos: GitHub.listRepos,
+            prefix,
+        });
+    }
+}
+export { Clone };

package/dist/commands/gh/repo/delete.js

@@ -0,0 +1,22 @@
+import { HelpMessages } from "../../../enums/help-messages.js";
+import { BaseCommand } from "../../../utilities/base-command.js";
+import { requiredPrefixFlag } from "../../../utilities/flags.js";
+import { GitHub } from "../../../utilities/github.js";
+class Delete extends BaseCommand {
+    static description = `Deletes repos from your GitHub account, useful for cleaning up generated test data. ${HelpMessages.RequiresGhCli}
+
+If the deletion fails, you may need to refresh your CLI permissions with \`gh auth refresh -s delete_repo\``;
+    static flags = {
+        prefix: requiredPrefixFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(Delete);
+        const { prefix } = flags;
+        await this.deleteRepos({
+            deleteRepo: GitHub.deleteRepo,
+            listRepos: GitHub.listRepos,
+            prefix,
+        });
+    }
+}
+export { Delete };

package/dist/commands/glab/repo/clone.js

@@ -0,0 +1,22 @@
+import { HelpMessages } from "../../../enums/help-messages.js";
+import { BaseCommand } from "../../../utilities/base-command.js";
+import { directoryFlag, requiredPrefixFlag } from "../../../utilities/flags.js";
+import { GitLab } from "../../../utilities/gitlab.js";
+class Clone extends BaseCommand {
+    static description = `Clones repos from your GitLab account, useful for pulling down generated repos for manual modifications. ${HelpMessages.RequiresGlabCli}`;
+    static flags = {
+        directory: directoryFlag,
+        prefix: requiredPrefixFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(Clone);
+        const { directory, prefix } = flags;
+        await this.cloneRepos({
+            cloneRepo: GitLab.cloneRepo,
+            directory,
+            listRepos: GitLab.listRepos,
+            prefix,
+        });
+    }
+}
+export { Clone };

package/dist/commands/glab/repo/delete.js

@@ -0,0 +1,20 @@
+import { HelpMessages } from "../../../enums/help-messages.js";
+import { BaseCommand } from "../../../utilities/base-command.js";
+import { requiredPrefixFlag } from "../../../utilities/flags.js";
+import { GitLab } from "../../../utilities/gitlab.js";
+class Delete extends BaseCommand {
+    static description = `Deletes repos from your GitLab account, useful for cleaning up generated test data. ${HelpMessages.RequiresGlabCli}`;
+    static flags = {
+        prefix: requiredPrefixFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(Delete);
+        const { prefix } = flags;
+        await this.deleteRepos({
+            deleteRepo: GitLab.deleteRepo,
+            listRepos: GitLab.listRepos,
+            prefix,
+        });
+    }
+}
+export { Delete };

package/dist/commands/util/format-psv.js

@@ -4,15 +4,15 @@ import { BaseCommand } from "../../utilities/base-command.js";
 import { stringifySingleLineArray } from "../../utilities/collection-utils.js";
 const EXAMPLE_INSTANCE_TYPES = ["m5.large", "m5.xlarge", "m5.2xlarge"];
 class FormatPsv extends BaseCommand {
-    static hidden = true;
-    static description = "Utility command for formatting a PSV (pipe-separated value) into an array or object with array values. Primarily used for parsing data from the AWS docs.";
     static args = {
         psv: Args.string({
-            required: true,
             description: `Pipe-separated value to format into a string array, i.e. '${EXAMPLE_INSTANCE_TYPES.join(" | ")}'.
 If the string is multiple lines, it will be formatted into an object where the key is the first column before a tab, i.e. 'M5\t${EXAMPLE_INSTANCE_TYPES.join(" | ")}'`,
+            required: true,
         }),
     };
+    static description = "Utility command for formatting a PSV (pipe-separated value) into an array or object with array values. Primarily used for parsing data from the AWS docs.";
+    static hidden = true;
     async run() {
         const { args } = await this.parse(FormatPsv);
         const { psv } = args;

package/dist/commands/util/format-tsv.js

@@ -1,25 +1,25 @@
 import { Args, Flags } from "@oclif/core";
+import { compact } from "lodash-es";
 import { BaseCommand } from "../../utilities/base-command.js";
 import { stringifySingleLineArray } from "../../utilities/collection-utils.js";
-import { compact } from "lodash-es";
 const EXAMPLE = `c4d-standard-2	2	7	No	Up to 10	N/A`;
 class FormatTsv extends BaseCommand {
-    static hidden = true;
+    static args = {
+        tsv: Args.string({
+            description: `Tab-separated value to format into a string array, i.e. '${EXAMPLE}'.
+If the string is multiple lines (which it generally is), the specified column index from each line will be placed in the array.`,
+            required: true,
+        }),
+    };
     static description = "Utility command for formatting a TSV (tab-separated value) into an array. Primarily used for parsing data from the GCP docs.";
     static flags = {
         index: Flags.integer({
             char: "i",
-            description: "Column index to pull from each line.",
             default: 0,
+            description: "Column index to pull from each line.",
         }),
     };
-    static args = {
-        tsv: Args.string({
-            required: true,
-            description: `Tab-separated value to format into a string array, i.e. '${EXAMPLE}'.
-If the string is multiple lines (which it generally is), the specified column index from each line will be placed in the array.`,
-        }),
-    };
+    static hidden = true;
     async run() {
         const { args, flags } = await this.parse(FormatTsv);
         const { index } = flags;

package/dist/commands/util/index.js

@@ -1,7 +1,7 @@
 import { BaseCommand } from "../../utilities/base-command.js";
 class Util extends BaseCommand {
-    static hidden = true;
     static description = "Miscellaneous utility commands.";
+    static hidden = true;
     async run() {
         await this.showHelp();
     }