terrafaker 0.0.7 → 0.0.8

package/dist/utilities/generators/repo-generator.js

@@ -1,12 +1,12 @@
+import { mkdir } from "node:fs/promises";
 import path from "node:path";
-import { FileGenerator } from "./file-generator.js";
-import { randomMemorableSlug } from "./generator-utils.js";
 import { $ } from "zx";
-import { mkdir } from "node:fs/promises";
 import { success } from "../string-utils.js";
+import { FileGenerator } from "./file-generator.js";
+import { randomMemorableSlug } from "./generator-utils.js";
 class RepoGenerator {
     static async generate(options) {
-        const { provider, prefix = "tf_", format, fileCount = 3, resourceCount, quiet, tags, } = options;
+        const { fileCount = 3, format, prefix = "tf_", provider, quiet, resourceCount, tags, } = options;
         const directory = path.resolve(process.cwd(), options.directory ?? ".");
         const repoName = `${prefix}${randomMemorableSlug()}`;
         const repoPath = path.join(directory, repoName);
@@ -16,9 +16,9 @@ class RepoGenerator {
         for (let i = 0; i < fileCount; i++) {
             FileGenerator.generate({
                 directory: repoPath,
+                format,
                 provider,
                 resourceCount,
-                format,
                 tags,
             });
         }

package/dist/utilities/github.js

@@ -1,4 +1,27 @@
-import { execSync } from "node:child_process";
-const listRepos = () => JSON.parse(execSync(`gh repo list --json name,nameWithOwner`).toString());
-const stringifyRepos = (repos) => repos.map((repo) => `- ${repo.nameWithOwner}`).join("\n");
-export { listRepos, stringifyRepos };
+import { $ } from "zx";
+class GitHub {
+    static async cloneRepo(options) {
+        const { directory, repo } = options;
+        await $ `gh repo clone ${repo.fullName} ${directory}`;
+    }
+    static async deleteRepo(options) {
+        const { repo } = options;
+        await $ `gh repo delete ${repo.fullName} --yes`;
+    }
+    static async listRepos() {
+        const response = await $ `gh repo list --json name,nameWithOwner`;
+        const repos = JSON.parse(response.toString());
+        return normalizeRepos(repos);
+    }
+    static async pushRepo(options) {
+        const { isPublic, path } = options;
+        await $ `cd ${path} && gh repo create --source . ${isPublic ? "--public" : "--private"} --push`;
+    }
+}
+function normalizeRepos(repos) {
+    return repos.map((repo) => ({
+        fullName: repo.nameWithOwner,
+        name: repo.name,
+    }));
+}
+export { GitHub };

package/dist/utilities/gitlab.js

@@ -0,0 +1,29 @@
+import { $ } from "zx";
+class GitLab {
+    static async cloneRepo(options) {
+        const { directory, repo } = options;
+        await $ `glab repo clone ${repo.fullName} ${directory}`;
+    }
+    static async deleteRepo(options) {
+        const { repo } = options;
+        await $ `glab repo delete ${repo.fullName} --yes`;
+    }
+    static async listRepos() {
+        const response = await $ `glab repo list --output json`;
+        const repos = JSON.parse(response.toString());
+        return normalizeRepos(repos);
+    }
+    static async pushRepo(options) {
+        const { isPublic, path } = options;
+        await $ `cd ${path} && glab repo create ${isPublic ? "--public" : "--private"} && git push --set-upstream origin main`;
+    }
+}
+function normalizeRepos(repos) {
+    return repos
+        .filter((repo) => repo.marked_for_deletion_on == null)
+        .map((repo) => ({
+        fullName: repo.path_with_namespace,
+        name: repo.name,
+    }));
+}
+export { GitLab };

package/dist/utilities/repo-utils.js

@@ -0,0 +1,6 @@
+class RepoUtils {
+    static stringifyRepos(repos) {
+        return repos.map((repo) => `- ${repo.fullName}`).join("\n");
+    }
+}
+export { RepoUtils };

package/dist/utilities/tag-utils.js

@@ -1,6 +1,6 @@
 import { randomMemorableSlug } from "./generators/generator-utils.js";
 import { warn } from "./string-utils.js";
-const parseTagString = (tagString) => {
+const parseTags = (tagString) => {
     const csvTags = tagString.split(",").map((value) => value.trim());
     const tags = csvTags.reduce((accumulated, csvTag) => {
         const [tag, value] = csvTag.split(":");
@@ -15,4 +15,4 @@ const parseTagString = (tagString) => {
 const stringifyTags = (tags) => Object.entries(tags)
     .map(([key, value]) => `${key}:${value}`)
     .join(",");
-export { parseTagString, stringifyTags };
+export { parseTags, stringifyTags };

package/oclif.manifest.json

@@ -46,8 +46,8 @@
           "multiple": false,
           "options": [
             "aws",
-            "gcp",
-            "azure"
+            "azure",
+            "gcp"
           ],
           "type": "option"
         },
@@ -93,27 +93,6 @@
         "file.js"
       ]
     },
-    "generate": {
-      "aliases": [],
-      "args": {},
-      "description": "Commands for generating terraform files.",
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hidden": true,
-      "hiddenAliases": [],
-      "id": "generate",
-      "pluginAlias": "terrafaker",
-      "pluginName": "terrafaker",
-      "pluginType": "core",
-      "strict": true,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "generate",
-        "index.js"
-      ]
-    },
     "generate:repo": {
       "aliases": [],
       "args": {},
@@ -138,13 +117,13 @@
           "type": "option"
         },
         "create-remote": {
-          "description": "Create and push a remote GitHub repo. Requires the `gh` CLI to be installed. To install, run `brew install gh`.",
+          "description": "Create and push a remote repo. Requires the `gh` or `glab` CLI to be installed. To install, run `brew install gh|glab`.",
           "name": "create-remote",
           "allowNo": false,
           "type": "boolean"
         },
         "directory": {
-          "description": "Directory to generate the repo(s) in",
+          "description": "Directory to create the repo(s) in",
           "name": "directory",
           "default": ".",
           "hasDynamicHelp": false,
@@ -191,8 +170,8 @@
           "multiple": false,
           "options": [
             "aws",
-            "gcp",
-            "azure"
+            "azure",
+            "gcp"
           ],
           "type": "option"
         },
@@ -227,6 +206,18 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "vcs-provider": {
+          "description": "Remote version control system to interact with",
+          "name": "vcs-provider",
+          "default": "github",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "github",
+            "gitlab"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -244,31 +235,21 @@
         "repo.js"
       ]
     },
-    "gh:clone-repos": {
+    "util:format-psv": {
       "aliases": [],
-      "args": {},
-      "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`.",
-      "flags": {
-        "directory": {
-          "description": "Directory to clone the repo(s) in",
-          "name": "directory",
-          "default": ".",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "prefix": {
-          "description": "Prefix for the repos to clone, such as 'tf_'",
-          "name": "prefix",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+      "args": {
+        "psv": {
+          "description": "Pipe-separated value to format into a string array, i.e. 'm5.large | m5.xlarge | m5.2xlarge'.\nIf 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\tm5.large | m5.xlarge | m5.2xlarge'",
+          "name": "psv",
+          "required": true
         }
       },
+      "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.",
+      "flags": {},
       "hasDynamicHelp": false,
+      "hidden": true,
       "hiddenAliases": [],
-      "id": "gh:clone-repos",
+      "id": "util:format-psv",
       "pluginAlias": "terrafaker",
       "pluginName": "terrafaker",
       "pluginType": "core",
@@ -277,49 +258,56 @@
       "relativePath": [
         "dist",
         "commands",
-        "gh",
-        "clone-repos.js"
+        "util",
+        "format-psv.js"
       ]
     },
-    "gh:delete-repos": {
+    "util:format-tsv": {
       "aliases": [],
-      "args": {},
-      "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`.\n\nIf the deletion fails, you may need to refresh your CLI permissions with `gh auth refresh -s delete_repo`",
+      "args": {
+        "tsv": {
+          "description": "Tab-separated value to format into a string array, i.e. 'c4d-standard-2\t2\t7\tNo\tUp to 10\tN/A'.\nIf the string is multiple lines (which it generally is), the specified column index from each line will be placed in the array.",
+          "name": "tsv",
+          "required": true
+        }
+      },
+      "description": "Utility command for formatting a TSV (tab-separated value) into an array. Primarily used for parsing data from the GCP docs.",
       "flags": {
-        "prefix": {
-          "description": "Prefix for the repos to delete, such as 'tf_'",
-          "name": "prefix",
-          "required": true,
+        "index": {
+          "char": "i",
+          "description": "Column index to pull from each line.",
+          "name": "index",
+          "default": 0,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         }
       },
       "hasDynamicHelp": false,
+      "hidden": true,
       "hiddenAliases": [],
-      "id": "gh:delete-repos",
+      "id": "util:format-tsv",
       "pluginAlias": "terrafaker",
       "pluginName": "terrafaker",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
         "commands",
-        "gh",
-        "delete-repos.js"
+        "util",
+        "format-tsv.js"
       ]
     },
-    "gh": {
+    "util": {
       "aliases": [],
       "args": {},
-      "description": "Utility commands that wrap the `gh` CLI. Requires the `gh` CLI to be installed. To install, run `brew install gh`.",
+      "description": "Miscellaneous utility commands.",
       "flags": {},
       "hasDynamicHelp": false,
       "hidden": true,
       "hiddenAliases": [],
-      "id": "gh",
+      "id": "util",
       "pluginAlias": "terrafaker",
       "pluginName": "terrafaker",
       "pluginType": "core",
@@ -328,25 +316,35 @@
       "relativePath": [
         "dist",
         "commands",
-        "gh",
+        "util",
         "index.js"
       ]
     },
-    "util:format-psv": {
+    "gh:repo:clone": {
       "aliases": [],
-      "args": {
-        "psv": {
-          "description": "Pipe-separated value to format into a string array, i.e. 'm5.large | m5.xlarge | m5.2xlarge'.\nIf 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\tm5.large | m5.xlarge | m5.2xlarge'",
-          "name": "psv",
-          "required": true
+      "args": {},
+      "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`.",
+      "flags": {
+        "directory": {
+          "description": "Directory to create the repo(s) in",
+          "name": "directory",
+          "default": ".",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "prefix": {
+          "description": "Prefix for the repos, such as 'tf_'",
+          "name": "prefix",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
-      "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.",
-      "flags": {},
       "hasDynamicHelp": false,
-      "hidden": true,
       "hiddenAliases": [],
-      "id": "util:format-psv",
+      "id": "gh:repo:clone",
       "pluginAlias": "terrafaker",
       "pluginName": "terrafaker",
       "pluginType": "core",
@@ -355,35 +353,66 @@
       "relativePath": [
         "dist",
         "commands",
-        "util",
-        "format-psv.js"
+        "gh",
+        "repo",
+        "clone.js"
       ]
     },
-    "util:format-tsv": {
+    "gh:repo:delete": {
       "aliases": [],
-      "args": {
-        "tsv": {
-          "description": "Tab-separated value to format into a string array, i.e. 'c4d-standard-2\t2\t7\tNo\tUp to 10\tN/A'.\nIf the string is multiple lines (which it generally is), the specified column index from each line will be placed in the array.",
-          "name": "tsv",
-          "required": true
+      "args": {},
+      "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`.\n\nIf the deletion fails, you may need to refresh your CLI permissions with `gh auth refresh -s delete_repo`",
+      "flags": {
+        "prefix": {
+          "description": "Prefix for the repos, such as 'tf_'",
+          "name": "prefix",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
-      "description": "Utility command for formatting a TSV (tab-separated value) into an array. Primarily used for parsing data from the GCP docs.",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "gh:repo:delete",
+      "pluginAlias": "terrafaker",
+      "pluginName": "terrafaker",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "gh",
+        "repo",
+        "delete.js"
+      ]
+    },
+    "glab:repo:clone": {
+      "aliases": [],
+      "args": {},
+      "description": "Clones repos from your GitLab account, useful for pulling down generated repos for manual modifications. Requires the `glab` CLI to be installed. To install, run `brew install glab`.",
       "flags": {
-        "index": {
-          "char": "i",
-          "description": "Column index to pull from each line.",
-          "name": "index",
-          "default": 0,
+        "directory": {
+          "description": "Directory to create the repo(s) in",
+          "name": "directory",
+          "default": ".",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "prefix": {
+          "description": "Prefix for the repos, such as 'tf_'",
+          "name": "prefix",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         }
       },
       "hasDynamicHelp": false,
-      "hidden": true,
       "hiddenAliases": [],
-      "id": "util:format-tsv",
+      "id": "glab:repo:clone",
       "pluginAlias": "terrafaker",
       "pluginName": "terrafaker",
       "pluginType": "core",
@@ -392,19 +421,28 @@
       "relativePath": [
         "dist",
         "commands",
-        "util",
-        "format-tsv.js"
+        "glab",
+        "repo",
+        "clone.js"
       ]
     },
-    "util": {
+    "glab:repo:delete": {
       "aliases": [],
       "args": {},
-      "description": "Miscellaneous utility commands.",
-      "flags": {},
+      "description": "Deletes repos from your GitLab account, useful for cleaning up generated test data. Requires the `glab` CLI to be installed. To install, run `brew install glab`.",
+      "flags": {
+        "prefix": {
+          "description": "Prefix for the repos, such as 'tf_'",
+          "name": "prefix",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
-      "hidden": true,
       "hiddenAliases": [],
-      "id": "util",
+      "id": "glab:repo:delete",
       "pluginAlias": "terrafaker",
       "pluginName": "terrafaker",
       "pluginType": "core",
@@ -413,10 +451,11 @@
       "relativePath": [
         "dist",
         "commands",
-        "util",
-        "index.js"
+        "glab",
+        "repo",
+        "delete.js"
       ]
     }
   },
-  "version": "0.0.7"
+  "version": "0.0.8"
 }

package/package.json

@@ -23,7 +23,9 @@
         "@types/node": "24.10.3",
         "eslint": "9.39.1",
         "eslint-plugin-collation": "1.5.0",
+        "eslint-plugin-perfectionist": "5.3.1",
         "eslint-plugin-vitest": "0.5.4",
+        "hcl2-parser": "1.0.3",
         "oclif": "4.22.54",
         "prettier": "3.6.1",
         "shx": "0.3.4",
@@ -42,7 +44,11 @@
     ],
     "homepage": "https://github.com/brandongregoryscott/terrafaker",
     "keywords": [
-        "oclif"
+        "terraform",
+        "infrastructure",
+        "infra",
+        "infrastructure-as-code",
+        "faker"
     ],
     "license": "Apache-2.0",
     "main": "dist/index.js",
@@ -63,19 +69,19 @@
     "scripts": {
         "build": "npm run clean && tsc --project tsconfig.build.json",
         "build:watch": "npm run clean && tsc --watch",
-        "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
+        "clean": "shx rm -rf dist tsconfig.tsbuildinfo oclif.manifest.json",
         "format": "prettier . --check",
         "format:fix": "prettier . --write",
         "generate:manifest": "oclif manifest",
-        "generate:readme": "oclif readme && prettier README.md --write",
+        "generate:readme": "oclif readme && oclif readme --readme-path COMMANDS.md && prettier {README,COMMANDS}.md --write",
         "lint": "eslint",
         "lint:fix": "eslint --fix",
         "postbuild": "npm run generate:manifest && npm run generate:readme",
         "prepack": "npm run build",
         "test": "vitest",
-        "version": "npm run generate:readme && git add README.md"
+        "version": "npm run generate:readme && git add {README,COMMANDS}.md"
     },
     "type": "module",
     "types": "dist/index.d.ts",
-    "version": "0.0.7"
+    "version": "0.0.8"
 }

package/dist/commands/generate/index.js

@@ -1,9 +0,0 @@
-import { BaseCommand } from "../../utilities/base-command.js";
-class Generate extends BaseCommand {
-    static hidden = true;
-    static description = "Commands for generating terraform files.";
-    async run() {
-        await this.showHelp();
-    }
-}
-export { Generate };

package/dist/commands/gh/clone-repos.js

@@ -1,46 +0,0 @@
-import { Flags } from "@oclif/core";
-import { execSync } from "node:child_process";
-import { confirm } from "@inquirer/prompts";
-import { isEmpty } from "lodash-es";
-import path from "node:path";
-import { listRepos, stringifyRepos } from "../../utilities/github.js";
-import { BaseCommand } from "../../utilities/base-command.js";
-import { HelpMessages } from "../../enums/help-messages.js";
-class CloneRepos extends BaseCommand {
-    static description = `Clones repos from your Github account, useful for pulling down generated repos for manual modifications. ${HelpMessages.RequiresGhCli}`;
-    static flags = {
-        directory: Flags.string({
-            description: "Directory to clone the repo(s) in",
-            default: ".",
-        }),
-        prefix: Flags.string({
-            description: "Prefix for the repos to clone, such as 'tf_'",
-            required: true,
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(CloneRepos);
-        const { prefix } = flags;
-        const allRepos = listRepos();
-        const repos = allRepos.filter((repo) => repo.name.startsWith(prefix));
-        if (isEmpty(repos)) {
-            this.log(`Repos found:\n${stringifyRepos(allRepos)}`);
-            this.log(`No repos found with prefix '${prefix}'`);
-            this.exit();
-        }
-        this.log(`Repos to clone:\n${stringifyRepos(repos)}`);
-        const confirmation = await confirm({
-            message: "Continue with cloning these repos?",
-        });
-        if (!confirmation) {
-            return;
-        }
-        repos.forEach((repo) => {
-            const directory = path.resolve(process.cwd(), flags.directory, repo.name);
-            execSync(`gh repo clone ${repo.nameWithOwner} ${directory}`, {
-                stdio: "inherit",
-            });
-        });
-    }
-}
-export { CloneRepos };

package/dist/commands/gh/delete-repos.js

@@ -1,41 +0,0 @@
-import { Command, Flags } from "@oclif/core";
-import { execSync } from "node:child_process";
-import { confirm } from "@inquirer/prompts";
-import { isEmpty } from "lodash-es";
-import { listRepos, stringifyRepos } from "../../utilities/github.js";
-import { HelpMessages } from "../../enums/help-messages.js";
-class DeleteRepos extends Command {
-    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: Flags.string({
-            description: "Prefix for the repos to delete, such as 'tf_'",
-            required: true,
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(DeleteRepos);
-        const { prefix } = flags;
-        const allRepos = listRepos();
-        const repos = allRepos.filter((repo) => repo.name.startsWith(prefix));
-        if (isEmpty(repos)) {
-            this.log(`Repos found:\n${stringifyRepos(allRepos)}`);
-            this.log(`No repos found with prefix '${prefix}'`);
-            this.exit();
-        }
-        this.log(`Repos to delete:\n${stringifyRepos(repos)}`);
-        const confirmation = await confirm({
-            message: "Continue with deletion of these repos?",
-        });
-        if (!confirmation) {
-            return;
-        }
-        repos.forEach((repo) => {
-            execSync(`gh repo delete ${repo.nameWithOwner} --yes`, {
-                stdio: "inherit",
-            });
-        });
-    }
-}
-export { DeleteRepos };

package/dist/commands/gh/index.js

@@ -1,10 +0,0 @@
-import { BaseCommand } from "../../utilities/base-command.js";
-import { HelpMessages } from "../../enums/help-messages.js";
-class Gh extends BaseCommand {
-    static hidden = true;
-    static description = `Utility commands that wrap the \`gh\` CLI. ${HelpMessages.RequiresGhCli}`;
-    async run() {
-        await this.showHelp();
-    }
-}
-export { Gh };