@vlandoss/starter 0.0.1

package/README.md

@@ -0,0 +1,34 @@
+# ⚡ vland
+
+The CLI to init a new project in Variable Land 👊
+
+## Prerequisites
+
+- Bun >= 1.2.4
+
+## Installation
+
+```sh
+pnpm add -g @vlandoss/starter
+```
+
+It will adds the `vland` to your global workspace
+
+## Usage
+
+> [!NOTE]
+> The documentation is WIP
+
+Run the help command:
+
+```sh
+vland help
+```
+
+## Troubleshooting
+
+To enable debug mode, set the `DEBUG` environment variable to `vland:*` before running *any* command.
+
+```sh
+DEBUG=vland:* vland help
+```

package/bin.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env bun
+import { main } from "./src/main";
+
+main({
+  binDir: __dirname,
+});

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@vlandoss/starter",
+  "version": "0.0.1",
+  "description": "The CLI to init a new project in Variable Land",
+  "homepage": "https://github.com/variableland/dx/tree/main/packages/starter#readme",
+  "bugs": {
+    "url": "https://github.com/variableland/dx/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/variableland/dx.git"
+  },
+  "license": "MIT",
+  "author": "rcrd <rcrd@variable.land>",
+  "type": "module",
+  "module": "src/main.ts",
+  "bin": {
+    "vland": "./bin.ts"
+  },
+  "files": [
+    "bin",
+    "src",
+    "plopfiles",
+    "tsconfig.json"
+  ],
+  "dependencies": {
+    "commander": "13.1.0",
+    "node-plop": "0.32.0",
+    "@vlandoss/clibuddy": "0.0.1",
+    "@vlandoss/loggy": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "scripts": {
+    "typecheck": "rr tsc"
+  }
+}

package/plopfiles/plopfile.ts

@@ -0,0 +1,84 @@
+import path from "node:path";
+import type { NodePlopAPI } from "node-plop";
+import { ConfigService } from "~/services/config";
+
+export default function configPlop(plop: NodePlopAPI) {
+  const baseDir = path.dirname(plop.getPlopfilePath());
+  const configService = new ConfigService(baseDir);
+
+  function atLeastOne(answer: string[]) {
+    if (answer.length === 0) {
+      return "At least one option must be selected";
+    }
+
+    return true;
+  }
+
+  plop.setGenerator("init", {
+    description: "Initialize a project based on a predefined template",
+    prompts: [
+      {
+        type: "list",
+        name: "template",
+        message: "Template:",
+        choices: configService.getTemplateChoices(),
+        validate: atLeastOne,
+      },
+      {
+        type: "input",
+        name: "name",
+        message: "Name:",
+      },
+      {
+        type: "input",
+        name: "description",
+        message: "Description:",
+      },
+    ],
+    actions: [
+      {
+        type: "addMany",
+        destination: ".",
+        base: "templates/#common",
+        templateFiles: ["templates/#common/**"],
+        globOptions: {
+          dot: true,
+        },
+      },
+      {
+        type: "addMany",
+        destination: ".",
+        base: "templates/{{template}}",
+        templateFiles: ["templates/{{template}}/**"],
+        globOptions: {
+          dot: true,
+        },
+      },
+    ],
+  });
+
+  plop.setGenerator("add", {
+    description: "Add config file(s) to a project",
+    prompts: [
+      {
+        type: "checkbox",
+        name: "slugs",
+        message: "Select configs:",
+        choices: configService.getPluginChoices(),
+        validate: atLeastOne,
+      },
+    ],
+    actions: (answers: unknown) => {
+      // @ts-expect-error
+      return answers.slugs.map((slug) => ({
+        type: "addMany",
+        destination: ".",
+        base: `plugins/${slug}`,
+        templateFiles: [`plugins/${slug}/**`],
+        globOptions: {
+          dot: true,
+        },
+      }));
+    },
+  });
+}

package/plopfiles/plugins/changeset/.changeset/README.md.hbs

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/plopfiles/plugins/changeset/.changeset/config.json.hbs

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": ["@changesets/changelog-github", { "repo": "variableland/{{name}}" }],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/plopfiles/plugins/husky/.husky/pre-commit

@@ -0,0 +1,2 @@
+rr test:static --fix-staged
+git update-index --again

package/plopfiles/plugins/husky/.husky/pre-push

@@ -0,0 +1 @@
+pnpm test

package/plopfiles/plugins/mise/mise.toml.hbs

@@ -0,0 +1,2 @@
+[env]
+_.path = ["\{{config_root}}/node_modules/.bin"]

package/plopfiles/plugins/tsup/tsup.config.ts.hbs

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["esm", "cjs"],
+  splitting: false,
+  sourcemap: true,
+  clean: true,
+  dts: true,
+});

package/plopfiles/templates/#common/.gitignore.hbs

@@ -0,0 +1,180 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+.turbo
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
+
+# Bun
+
+*.bun-build

package/plopfiles/templates/#common/README.md.hbs

@@ -0,0 +1,3 @@
+# {{titleCase name}}
+
+{{description}}

package/plopfiles/templates/#common/biome.json.hbs

@@ -0,0 +1,3 @@
+{
+  "extends": ["@vlandoss/biome-config"]
+}

package/plopfiles/templates/basic/package.json.hbs

@@ -0,0 +1,32 @@
+{
+  "name": "@vlandoss/{{name}}",
+  "version": "0.0.0",
+  "private": true,
+  "description": "{{description}}",
+  "homepage": "https://github.com/variableland/{{name}}#readme",
+  "bugs": {
+    "url": "https://github.com/variableland/{{name}}/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/variableland/{{name}}.git"
+  },
+  "license": "MIT",
+  "author": "rcrd <rcrd@variable.land>",
+  "type": "module",
+  "devDependencies": {
+    "@total-typescript/tsconfig": "1.0.4",
+    "@types/bun": "1.2.9",
+    "@vlandoss/biome-config": "latest",
+    "@vlandoss/run-run": "latest"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "packageManager": "pnpm@10.6.4",
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "@biomejs/biome"
+    ]
+  }
+}

package/plopfiles/templates/basic/src/index.ts.hbs

@@ -0,0 +1 @@
+console.log("Hi, from {{name}} 👋");

package/plopfiles/templates/monorepo/package.json.hbs

@@ -0,0 +1,27 @@
+{
+  "name": "@vlandoss/{{name}}",
+  "version": "0.0.0",
+  "private": true,
+  "description": "{{description}}",
+  "homepage": "https://github.com/variableland/{{name}}#readme",
+  "bugs": {
+    "url": "https://github.com/variableland/{{name}}/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/variableland/{{name}}.git"
+  },
+  "license": "MIT",
+  "author": "rcrd <rcrd@variable.land>",
+  "type": "module",
+  "devDependencies": {
+    "@total-typescript/tsconfig": "1.0.4",
+    "@types/bun": "1.2.9",
+    "@vlandoss/biome-config": "latest",
+    "@vlandoss/run-run": "latest"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "packageManager": "pnpm@10.6.4"
+}

package/plopfiles/templates/monorepo/pnpm-workspace.yaml.hbs

@@ -0,0 +1,4 @@
+packages:
+  - packages/*
+onlyBuiltDependencies:
+  - "@biomejs/biome"

package/src/actions/add.ts

@@ -0,0 +1,48 @@
+import { logger } from "~/services/logger";
+import type { TemplateService } from "~/services/types";
+import type { AnyAction } from "./types";
+
+type CreateOptions = {
+  templateService: TemplateService;
+};
+
+type ExecuteOptions = {
+  slugs: string[];
+};
+
+const GENERATOR_ID = "add";
+
+export class AddAction implements AnyAction<ExecuteOptions> {
+  #templateService: TemplateService;
+
+  constructor({ templateService }: CreateOptions) {
+    this.#templateService = templateService;
+  }
+
+  async execute(options: ExecuteOptions) {
+    const debug = logger.subdebug("add-action");
+
+    debug("execute options: %O", options);
+
+    const bypassArr = this.#getBypassArr(options);
+
+    await this.#templateService.generate({
+      bypassArr,
+      generatorId: GENERATOR_ID,
+    });
+
+    logger.success("Added successfully 🎉");
+  }
+
+  #getBypassArr(options: ExecuteOptions) {
+    const { slugs } = options;
+
+    const bypassArr: string[] = [];
+
+    if (slugs.length) {
+      bypassArr[0] = slugs.join(",");
+    }
+
+    return bypassArr;
+  }
+}

package/src/actions/init.ts

@@ -0,0 +1,69 @@
+import type { ShellService } from "@vlandoss/clibuddy";
+import { logger } from "~/services/logger";
+import type { TemplateService } from "~/services/types";
+import type { AnyAction } from "./types";
+
+type ExecuteOptions = {
+  template?: string;
+  git: boolean;
+  destBasePath: string;
+};
+
+type CreateOptions = {
+  templateService: TemplateService;
+  shellService: ShellService;
+};
+
+const GENERATOR_ID = "init";
+
+export class InitAction implements AnyAction<ExecuteOptions> {
+  #templateService: TemplateService;
+  #shellService: ShellService;
+
+  constructor({ templateService, shellService }: CreateOptions) {
+    this.#templateService = templateService;
+    this.#shellService = shellService;
+  }
+
+  async execute(options: ExecuteOptions) {
+    const { destBasePath, git } = options;
+
+    const debug = logger.subdebug("init-action");
+
+    debug("execute options: %O", options);
+
+    const bypassArr = this.#getBypassArr(options);
+
+    await this.#templateService.generate({
+      bypassArr,
+      generatorId: GENERATOR_ID,
+    });
+
+    logger.success("Project generated 🎉");
+
+    const $ = this.#shellService.$;
+    const $$ = $.quiet({ cwd: destBasePath });
+
+    if (git) {
+      logger.start("Creating git repository");
+
+      await $$`git init`;
+      // NOTE: git commit -am failed, not sure why
+      await $$`git add . && git commit -m "initial commit"`;
+
+      logger.success("Git repository created");
+    }
+  }
+
+  #getBypassArr(options: ExecuteOptions) {
+    const { template } = options;
+
+    const bypassArr: string[] = [];
+
+    if (template) {
+      bypassArr[0] = template;
+    }
+
+    return bypassArr;
+  }
+}

package/src/actions/types.ts

@@ -0,0 +1,3 @@
+export type AnyAction<T> = {
+  execute: (options: T) => Promise<void>;
+};

package/src/main.ts

@@ -0,0 +1,12 @@
+import { type Options, createProgram } from "./program";
+import { logger } from "./services/logger";
+
+export async function main(options: Options) {
+  try {
+    const program = await createProgram(options);
+    await program.parseAsync();
+  } catch (error) {
+    logger.error("Cannot run main successfully", error);
+    process.exit(1);
+  }
+}

package/src/program/commands/add.ts

@@ -0,0 +1,40 @@
+import { cwd } from "@vlandoss/clibuddy";
+import { Argument, Option, createCommand } from "commander";
+import { AddAction } from "~/actions/add";
+import type { ContextValue } from "~/services/ctx";
+import { logger } from "~/services/logger";
+import { createPlopTemplateService } from "~/services/template";
+
+type AddOptions = {
+  dest: string;
+  force: boolean;
+};
+
+export function createAddCommand(ctx: ContextValue) {
+  return createCommand("add")
+    .description("add config files to a project 📁")
+    .addArgument(new Argument("[slug...]", "the config slugs to pick").choices(ctx.config.getPluginChoices()))
+    .addOption(new Option("-d, --dest <string>", "destination path to create folder (default: cwd)"))
+    .addOption(new Option("-f, --force", "override existing files").default(false))
+    .action(async function addAction(slugs: string[], options: AddOptions) {
+      try {
+        const { dest: destBasePath = cwd, force } = options;
+
+        const templateService = await createPlopTemplateService({
+          force,
+          destBasePath,
+          basePath: ctx.binPkg.dirPath,
+        });
+
+        const addAction = new AddAction({
+          templateService,
+        });
+
+        await addAction.execute({ slugs });
+      } catch (error) {
+        logger.error(error);
+        process.exit(1);
+      }
+    })
+    .addHelpText("afterAll", "\nUnder the hood, this command uses Plop.js to generate the project.");
+}

package/src/program/commands/init.ts

@@ -0,0 +1,47 @@
+import { cwd } from "@vlandoss/clibuddy";
+import { Argument, Option, createCommand } from "commander";
+import { InitAction } from "~/actions/init";
+import type { ContextValue } from "~/services/ctx";
+import { logger } from "~/services/logger";
+import { createPlopTemplateService } from "~/services/template";
+
+type InitOptions = {
+  dest: string;
+  git: boolean;
+  force: boolean;
+};
+
+export function createInitCommand(ctx: ContextValue) {
+  return createCommand("init")
+    .description("init a new project 🚀")
+    .addArgument(new Argument("[template]", "the template to use").choices(ctx.config.getTemplateChoices()))
+    .addOption(new Option("-d, --dest [string]", "destination path to create folder (default: cwd)"))
+    .addOption(new Option("--no-git", "skip to create a git repository").default(true))
+    .addOption(new Option("-f, --force", "override existing files").default(false))
+    .action(async function initAction(template: string | undefined, options: InitOptions) {
+      try {
+        const { dest: destBasePath = cwd, force } = options;
+
+        const templateService = await createPlopTemplateService({
+          force,
+          destBasePath,
+          basePath: ctx.binPkg.dirPath,
+        });
+
+        const initAction = new InitAction({
+          templateService,
+          shellService: ctx.shell,
+        });
+
+        await initAction.execute({
+          template,
+          destBasePath,
+          ...options,
+        });
+      } catch (error) {
+        logger.error(error);
+        process.exit(1);
+      }
+    })
+    .addHelpText("afterAll", "\nUnder the hood, this command uses Plop.js to generate the project.");
+}

package/src/program/index.ts

@@ -0,0 +1,20 @@
+import { getVersion } from "@vlandoss/clibuddy";
+import { Command } from "commander";
+import { createContext } from "~/services/ctx";
+import { createAddCommand } from "./commands/add";
+import { createInitCommand } from "./commands/init";
+import { BANNER_TEXT } from "./ui";
+
+export type Options = {
+  binDir: string;
+};
+
+export async function createProgram(options: Options) {
+  const ctx = await createContext(options.binDir);
+
+  return new Command("vland")
+    .version(getVersion(ctx.binPkg), "-v, --version")
+    .addHelpText("before", BANNER_TEXT)
+    .addCommand(createInitCommand(ctx))
+    .addCommand(createAddCommand(ctx));
+}

package/src/program/ui.ts

@@ -0,0 +1,7 @@
+import { colors } from "@vlandoss/clibuddy";
+
+const UI_LOGO = `⚡ ${colors.blueBright("V")} ${colors.redBright("L")} ${colors.greenBright("A")} ${colors.blueBright("N")} ${colors.redBright("D")}`;
+
+const COMPANY_LOGO = `${colors.redBright("Variable Land")} 👊`;
+
+export const BANNER_TEXT = `${UI_LOGO}: The CLI to init a new project in ${COMPANY_LOGO}\n`;

package/src/services/config.ts

@@ -0,0 +1,28 @@
+import fs from "node:fs";
+import { join } from "node:path";
+
+export class ConfigService {
+  #baseDir: string;
+
+  constructor(baseDir = "") {
+    this.#baseDir = baseDir;
+  }
+
+  getPluginChoices() {
+    const folderPath = this.#getPlopFolderDir("plugins");
+    return fs.readdirSync(folderPath).sort();
+  }
+
+  getTemplateChoices() {
+    const folderPath = this.#getPlopFolderDir("templates");
+
+    return fs
+      .readdirSync(folderPath)
+      .filter((folder) => !folder.startsWith("#"))
+      .sort();
+  }
+
+  #getPlopFolderDir(folder: string) {
+    return join(this.#baseDir, join("plopfiles", folder));
+  }
+}

package/src/services/ctx.ts

@@ -0,0 +1,38 @@
+import fs from "node:fs";
+import { type PkgService, type ShellService, createPkgService, createShellService } from "@vlandoss/clibuddy";
+import { ConfigService } from "./config";
+import { logger } from "./logger";
+
+export type ContextValue = {
+  binPkg: PkgService;
+  config: ConfigService;
+  shell: ShellService;
+};
+
+export async function createContext(binDir: string): Promise<ContextValue> {
+  const debug = logger.subdebug("create-context-value");
+
+  const binPath = fs.realpathSync(binDir);
+
+  debug("bin path %s", binPath);
+
+  const binPkg = await createPkgService(binPath);
+
+  if (!binPkg) {
+    throw new Error("Could not find bin package.json");
+  }
+
+  debug("bin pkg info %O", binPkg.info());
+
+  const config = new ConfigService(binDir);
+
+  const shell = createShellService({
+    localBaseBinPath: [binDir],
+  });
+
+  return {
+    binPkg,
+    config,
+    shell,
+  };
+}

package/src/services/logger.ts

@@ -0,0 +1,5 @@
+import { createLoggy } from "@vlandoss/loggy";
+
+export const logger = createLoggy({
+  namespace: "vland",
+});

package/src/services/template.ts

@@ -0,0 +1,64 @@
+import { join } from "node:path";
+import type { NodePlopAPI } from "node-plop";
+import nodePlop from "node-plop";
+import { logger } from "./logger";
+import type { GenerateOptions, TemplateService } from "./types";
+
+type CreateOptions = {
+  basePath: string;
+  destBasePath: string;
+  force: boolean;
+};
+
+export class PlopTemplateService implements TemplateService {
+  #plop: NodePlopAPI;
+
+  constructor(plop: NodePlopAPI) {
+    this.#plop = plop;
+  }
+
+  async generate(options: GenerateOptions) {
+    const { generatorId, bypassArr } = options;
+
+    const debug = logger.subdebug("plop-template-service:generate");
+
+    debug("generate options: %O", options);
+
+    const generator = this.#plop.getGenerator(generatorId);
+
+    const answers = await generator.runPrompts(bypassArr);
+
+    debug("generator answers: %O", answers);
+
+    const results = await generator.runActions(answers);
+
+    debug("generator results: %O", results);
+
+    if (results.failures.length > 0) {
+      throw new Error("Can't generate files");
+    }
+
+    return { answers };
+  }
+}
+
+const PLOP_CONFIG_PATH = join("plopfiles", "plopfile.ts");
+
+export async function createPlopTemplateService(options: CreateOptions) {
+  const { force, destBasePath } = options;
+
+  const debug = logger.subdebug("create-plop-template-service");
+
+  debug("options: %O", options);
+
+  const configPath = join(options.basePath, PLOP_CONFIG_PATH);
+
+  debug("plop config path:", configPath);
+
+  const plop = await nodePlop(configPath, {
+    force,
+    destBasePath,
+  });
+
+  return new PlopTemplateService(plop);
+}

package/src/services/types.ts

@@ -0,0 +1,12 @@
+export type GenerateOptions = {
+  generatorId: string;
+  bypassArr?: string[];
+};
+
+export type GenerateResult<T> = {
+  answers: T;
+};
+
+export type TemplateService = {
+  generate: <R>(options: GenerateOptions) => Promise<GenerateResult<R>>;
+};

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["@total-typescript/tsconfig/bundler/no-dom/app"],
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "~/*": ["./src/*"],
+      "@vlandoss/*": ["../../packages/*/src"]
+    }
+  }
+}