yehle 0.0.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 - PRESENT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,183 @@
+<div align="center">
+  <img src="https://cdn.rohit.build/oss/yehle/logo.png" alt="Yehle" style="width: 30%; margin: auto" />
+</div>
+
+<br />
+
+<div align="center">
+  <p align="center" style="width: 80%; margin: auto">
+    <img alt="Status" src="https://img.shields.io/github/actions/workflow/status/agrawal-rohit/yehle/ci.yml">
+    <img alt="Sonar Coverage" src="https://img.shields.io/sonar/coverage/agrawal-rohit_yehle?server=https%3A%2F%2Fsonarcloud.io">
+    <img alt="Downloads" src="https://img.shields.io/npm/dt/yehle">
+    <img alt="Biome" src="https://img.shields.io/badge/code_style-biome-60a5fa">
+    <img alt="License" src="https://img.shields.io/github/license/agrawal-rohit/yehle" />
+  </p>
+</div>
+
+<div align="center">
+  <p>✨ An opinionated <strong>scaffolding CLI</strong> for modern developers ✨</p>
+</div>
+
+<br />
+
+<div align="center">
+    <img src="https://cdn.rohit.build/oss/yehle/preview.gif" alt="Yehle Preview" style="margin: auto" />
+</div>
+
+<br />
+
+`yehle` is a CLI command for scaffolding modern software projects by taking caring of common [yak-shaving](https://softwareengineering.stackexchange.com/a/388236) operations through opinionated templates and tooling configurations. I found myself spending a frustrating amount of time configuring every new library, monorepo, or microservice with _"just the right tooling setup"_ before I could start writing the logic that's actually fun. Add on the fact that different languages serve a particular use-case better than others _(with each language having it's own tooling ecosystem that keeps evolving)_ - the inevitable duplication of work was too annoying to deal with everyday.
+
+## Table of Contents
+
+* [Features](#features)
+* [Supported Languages](#supported-languages)
+  * [Typescript](#typescript)
+* [Usage](#usage)
+  * [Requirements](#requirements)
+  * [Quickstart](#quickstart)
+  * [Examples](#examples)
+* [Commands Reference](#commands-reference)
+  * [`package`](#package)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Features
+
+`yehle` sets you up with several best practices adopted in modern software development with pre-configured tooling that should cover most use-cases. `yehle` achieves this through:
+
+* Automatic dependency upgrades using [dependabot][]
+* Automatic builds, tests, and releases with [github actions][github-actions]
+* Automatically generated Readme with badges through [shields.io][shields]
+* Automatically generated MIT license with [spdx][spdx-license-list]
+* Automatically generated community files _(contribution guidelines, issue templates, and pull request checklists)_
+* A pre-configured [release process](#CONTRIBUTING.md#release-process) for preview and production releases
+* Sensible [templates][] for common use cases encountered in modern development
+
+[github-actions]: https://github.com/features/actions
+[shields]: https://shields.io/
+[spdx-license-list]: https://github.com/sindresorhus/spdx-license-list
+[templates]: templates/
+[dependabot]: https://github.com/dependabot
+
+## Supported Languages
+
+In addition to the general tooling listed above, `yehle` also configures language-specific tooling to enable unit testing, type-safety, consistent code linting/formatting, and _much more_. It currently supports the following languages:
+
+### Typescript
+
+Great choice when building for the web _(UI libraries and frameworks for the browser. Can also be a good server-side language when executed in a JS runtime like [node][], [bun][], or [deno][])_.
+
+* Unit testing with [vitest][] and test quality checks using [stryker][]
+* Commit linting with [commitlint][]
+* Pre-commit checks with [husky][]
+* Pre-configured package bundling using [tsdown][]
+* Fast and disk-efficient dependency management using [pnpm][]
+* Type-safety using [typescript][]
+* Rapid utility-first styling and theme management using [tailwindcss][]
+* Code linting and formatting with [biome][]
+* Automated changelog generation using [git-cliff][]
+* Tag-driven releases with version management and package publishing to [npm][]
+
+[vitest]: https://vitest.dev/
+[stryker]: https://stryker-mutator.io/
+[commitlint]: https://github.com/marionebl/commitlint
+[husky]: https://github.com/typicode/husky
+[biome]: https://biomejs.dev/
+[tailwindcss]: https://tailwindcss.com/
+[git-cliff]: https://git-cliff.org/
+[typescript]: https://github.com/microsoft/TypeScript
+[node]: https://nodejs.org
+[bun]: https://bun.sh/
+[deno]: https://deno.com/
+[tsdown]: https://tsdown.dev/
+[npm]: https://www.npmjs.com/
+[pnpm]: https://pnpm.io/
+[npx]: https://www.npmjs.com/package/npx
+
+> [!NOTE]
+> Support for other languages is still in the works
+
+## Usage
+
+### Requirements
+
+[Node.js v20+][node]
+
+### Quickstart
+
+The easiest way to start is to call the CLI through [npx][] to generate a new project from one of the provided templates:
+
+```bash
+npx yehle <resource>
+```
+
+> [!IMPORTANT]
+> Some workflows in the generated projects may require repository secrets to be set in the GitHub project _(Settings → Secrets and variables → Actions)_. Additionally, ensure that "Allow GitHub Actions to create and approve pull requests" is checked in Settings → Actions → General. Make sure to set them to prevent [github action][github-actions] failures before releasing your code out in the world.
+
+`yehle` uses a simple tag-driven release workflow for stress-free delivery _(This same workflow is configured for projects generated with `yehle`)_. See the [release process](CONTRIBUTING.md#release-process) section in [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+### Examples
+
+#### Create a public NPM package
+
+```bash
+npx yehle package \
+  --name my-package \
+  --lang typescript \
+  --template default \
+  --public
+```
+
+#### Create a private internal Typescript library
+
+```bash
+npx yehle package \
+  --name internal-utils \
+  --lang typescript \
+  --template default
+```
+
+## Commands Reference
+
+#### <span id="package"></span>`package`
+
+Generate a new `package` for one of the [supported languages](#supported-languages) with sensible defaults, development best practices, and release workflows.
+If you're new to `yehle`, I would recommend using the interactive CLI for a guided experience.
+
+```bash
+npx yehle package
+```
+
+Once you're acquainted, you can skip through most prompts by providing the values through the CLI flags directly.
+
+  ```bash
+  npx yehle package \
+    --name my-lib \
+    --lang typescript \
+    --template default \
+    --public
+  ```
+
+**Supported Flags**
+
+- `--name <project-name>`: Name of the package
+- `--lang <language>`: Programming language that the package is built for _(for example, `typescript`)_.
+- `--template <template-name>`: The starter template for this package _(for example, `default`, `react`, etc.)_
+- `--public`: Whether the package should be optimised for publishing and contributions _(sets up public registry configuration, release workflows, and community files for open-source collaboration)_.
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to report issues, propose changes, and submit pull requests.
+
+If you create a project with `yehle`, you can show support by adding this badge to your README:
+
+![Made with Yehle](https://img.shields.io/badge/made_with-yehle-d52b79)
+
+```html
+<a href="https://github.com/agrawal-rohit/yehle"><img alt="Made with Yehle" src="https://img.shields.io/badge/made_with-yehle-d52b79"></a>
+```
+
+## License
+
+[MIT](LICENSE) © [Rohit Agrawal](https://rohit.build/)

package/bin/cli.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+const { default: logger } = require("../dist/cli/logger.js");
+const mod = require("../dist/index.js");
+const run = mod && (mod.default || mod);
+
+Promise.resolve(run()).catch((err) => {
+	logger.error(err);
+});

package/dist/cli/animated-intro.js

@@ -0,0 +1,135 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.animatedIntro = animatedIntro;
+const node_readline_1 = __importDefault(require("node:readline"));
+const chalk_1 = __importDefault(require("chalk"));
+const utils_1 = require("consola/utils");
+const utils_2 = require("../core/utils");
+const logger_1 = require("./logger");
+async function animatedIntro(msg = [], { title = "Yehle", stdout = process.stdout, frameDelayMs = 150, } = {}) {
+    const messages = Array.isArray(msg) ? msg : [msg];
+    // minimal TTY wiring (ESC to end, Ctrl+C to abort)
+    const rl = node_readline_1.default.createInterface({
+        input: process.stdin,
+        escapeCodeTimeout: 50,
+    });
+    node_readline_1.default.emitKeypressEvents(process.stdin, rl);
+    if (process.stdin.isTTY)
+        process.stdin.setRawMode(true);
+    const onKeypress = (_, key) => {
+        if (key?.ctrl && key?.name === "c") {
+            cleanup();
+            process.exit(0);
+        }
+        if (key?.name === "escape") {
+            cleanup();
+        }
+    };
+    process.stdin.on("keypress", onKeypress);
+    const cleanup = () => {
+        if (process.stdin.isTTY)
+            process.stdin.setRawMode(false);
+        process.stdin.off("keypress", onKeypress);
+        rl.close();
+        renderer.finish();
+    };
+    /* ---------------- layout constants ---------------- */
+    const label = chalk_1.default.bold((0, logger_1.primaryText)(`${title}`));
+    const GAP = "  ";
+    const LEFT_WIDTH = 13;
+    const TOP = "╭─────┬─────╮";
+    const BOT = "╰─────┴─────╯";
+    // fixed-height renderer
+    const renderer = createFixedHeightRenderer(stdout, 4);
+    /* ---------------- rune set (simple only) ---------------- */
+    const RUNES = ["*", "+", "x", "o"]; // <— simplified set
+    const COLORS = [chalk_1.default.cyan, chalk_1.default.red, chalk_1.default.yellow, chalk_1.default.green, chalk_1.default.blue];
+    function randomRune() {
+        // Math.random() is safe here as it's used for visual animation, not cryptographic purposes
+        const r = RUNES[Math.floor(Math.random() * RUNES.length)];
+        const c = COLORS[Math.floor(Math.random() * COLORS.length)];
+        return c(r);
+    }
+    const center5 = (token) => {
+        const raw = (0, utils_1.stripAnsi)(token);
+        const t = raw.length > 5 ? raw.slice(0, 5) : raw;
+        const pad = 5 - t.length;
+        const left = Math.floor(pad / 2);
+        const right = pad - left;
+        return " ".repeat(left) + token + " ".repeat(right);
+    };
+    const makeMid = (leftToken, rightToken) => `│${center5(leftToken)}│${center5(rightToken)}│`; // 13 cols total
+    function buildLines(l1, r1, l2, r2, rightTitle, rightMsg, rightWidth) {
+        const left = [TOP, makeMid(l1, r1), makeMid(l2, r2), BOT];
+        const paddedRight = ["", rightTitle, rightMsg, ""];
+        const padLeft = (s) => s + " ".repeat(Math.max(0, LEFT_WIDTH - (0, utils_1.stripAnsi)(s).length));
+        const padRight = (s) => s + " ".repeat(Math.max(0, rightWidth - (0, utils_1.stripAnsi)(s).length));
+        return left.map((row, i) => padLeft(row) + GAP + padRight(paddedRight[i]));
+    }
+    for (const message of messages) {
+        const resolvedMessage = Array.isArray(message)
+            ? await Promise.all(message)
+            : await message;
+        const words = Array.isArray(resolvedMessage)
+            ? resolvedMessage
+            : String(resolvedMessage).split(" ");
+        const finalMsg = words.join(" ");
+        const columns = Math.max(40, stdout.columns || 80);
+        const maxRight = Math.max(10, columns - LEFT_WIDTH - GAP.length - 2);
+        const rightTitle = (0, utils_2.truncate)(label, maxRight);
+        const rightMsgFinal = (0, utils_2.truncate)(finalMsg, maxRight);
+        const RIGHT_WIDTH = Math.max((0, utils_1.stripAnsi)(rightTitle).length, (0, utils_1.stripAnsi)(rightMsgFinal).length);
+        const spoken = [];
+        for (const word of ["", ...words]) {
+            if (word)
+                spoken.push(word);
+            // random, per-quadrant picks for a neutral, living feel
+            const l1 = randomRune();
+            const r1 = randomRune();
+            const l2 = randomRune();
+            const r2 = randomRune();
+            const msgNow = (0, utils_2.truncate)(spoken.join(" "), maxRight);
+            const lines = buildLines(l1, r1, l2, r2, rightTitle, msgNow, RIGHT_WIDTH);
+            renderer.paint(lines);
+            await (0, utils_2.sleep)(frameDelayMs);
+        }
+        // final calm frame: simple, balanced layout
+        const lines = buildLines(chalk_1.default.cyanBright("*"), chalk_1.default.redBright("+"), chalk_1.default.yellowBright("x"), chalk_1.default.greenBright("o"), rightTitle, rightMsgFinal, RIGHT_WIDTH);
+        renderer.paint(lines);
+        await (0, utils_2.sleep)(200);
+    }
+    cleanup();
+}
+/* ---------------- fixed-height renderer ---------------- */
+function createFixedHeightRenderer(out, height) {
+    let initialized = false;
+    return {
+        paint(lines) {
+            if (!initialized) {
+                for (let i = 0; i < height; i++) {
+                    if (i)
+                        out.write("\n");
+                    out.write(lines[i]);
+                }
+                initialized = true;
+                return;
+            }
+            out.write(`\x1b[${height - 1}F`);
+            for (let i = 0; i < height; i++) {
+                out.write("\x1b[2K");
+                out.write(lines[i]);
+                if (i < height - 1)
+                    out.write("\n");
+            }
+        },
+        finish() {
+            if (initialized)
+                out.write("\n");
+            initialized = false;
+        },
+    };
+}
+exports.default = animatedIntro;

package/dist/cli/logger.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = exports.dangerHighlight = exports.defaultText = exports.primaryText = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const animated_intro_1 = __importDefault(require("./animated-intro"));
+// Log colors
+const primaryText = (message) => chalk_1.default.hex("#d52b79")(message);
+exports.primaryText = primaryText;
+const defaultText = (message) => chalk_1.default.grey(message);
+exports.defaultText = defaultText;
+const dangerHighlight = (message) => chalk_1.default.bgRed(message);
+exports.dangerHighlight = dangerHighlight;
+/** Logger utilities for the CLI. */
+class Logger {
+    /**
+     * Prints an introductory message.
+     * @param message - The introductory message to display.
+     */
+    async intro(message) {
+        await (0, animated_intro_1.default)(message);
+    }
+    /**
+     * Prints an error message with a red background prefix and exits the process with code 1.
+     * @param message - The error message to display.
+     */
+    error(message) {
+        console.log();
+        console.error(`${(0, exports.dangerHighlight)(" error ")} ${message}`);
+        console.log();
+        process.exit(1);
+    }
+    /**
+     * Prints an end message with a red background prefix and exits the process with code 0.
+     * @param message - The end message to display.
+     */
+    end(message) {
+        console.log();
+        console.error(`${(0, exports.dangerHighlight)(" end ")} ${message}`);
+        console.log();
+        process.exit(0);
+    }
+}
+exports.Logger = Logger;
+const logger = new Logger();
+exports.default = logger;

package/dist/cli/prompts.js

@@ -0,0 +1,95 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.textInput = textInput;
+exports.selectInput = selectInput;
+exports.multiselectInput = multiselectInput;
+exports.confirmInput = confirmInput;
+const consola_1 = __importDefault(require("consola"));
+const logger_1 = __importDefault(require("./logger"));
+/**
+ * Handles cancellation when the prompt is canceled.
+ * Checks if the provided value is the cancel symbol and logs the cancellation message.
+ * @param value - The value returned from the prompt to check for cancellation.
+ */
+function handleCancel(value) {
+    if (typeof value === "symbol" && value === Symbol.for("cancel")) {
+        logger_1.default.end("Operation canceled");
+    }
+}
+/** Prompt for a text input (with optional validation and default).
+ * @param message - The prompt message to display.
+ * @param opts - Optional configuration options for the prompt, including validation.
+ * @param defaultValue - Optional default value for the input.
+ */
+async function textInput(message, opts = {}, defaultValue) {
+    const raw = await consola_1.default.prompt(message, {
+        type: "text",
+        initial: defaultValue,
+        cancel: "symbol",
+        ...opts,
+    });
+    if (opts.required && !raw)
+        logger_1.default.error("Package name is required");
+    handleCancel(raw);
+    return raw.trim();
+}
+/**
+ * Prompt for a single selection from a list of options.
+ * User may type the number (1..n) or the exact value.
+ * @param message - The prompt message to display.
+ * @param opts - Optional configuration options for the select prompt.
+ * @param defaultValue - Optional default selected value.
+ */
+async function selectInput(message, opts, defaultValue) {
+    opts = opts ?? { options: [] };
+    const value = await consola_1.default.prompt(message, {
+        type: "select",
+        initial: defaultValue,
+        cancel: "symbol",
+        ...opts,
+    });
+    handleCancel(value);
+    return value;
+}
+/** Prompt for multiple selections (comma-separated indices or values).
+ * @param message - The prompt message to display.
+ * @param opts - Optional configuration options for the multiselect prompt.
+ * @param defaultValues - Optional array of default selected values.
+ */
+async function multiselectInput(message, opts, defaultValues) {
+    opts = opts ?? { options: [] };
+    const values = await consola_1.default.prompt(message, {
+        type: "multiselect",
+        initial: defaultValues,
+        cancel: "symbol",
+        ...opts,
+    });
+    handleCancel(values);
+    return values;
+}
+/** Prompt for a boolean confirmation (yes/no).
+ * @param message - The prompt message to display.
+ * @param opts - Optional configuration options for the confirm prompt.
+ * @param defaultValue - Optional default boolean value.
+ */
+async function confirmInput(message, opts, defaultValue) {
+    opts = opts ?? {};
+    const res = await consola_1.default.prompt(message, {
+        type: "confirm",
+        initial: defaultValue,
+        cancel: "symbol",
+        ...opts,
+    });
+    handleCancel(res);
+    return Boolean(res);
+}
+const prompts = {
+    textInput,
+    selectInput,
+    multiselectInput,
+    confirmInput,
+};
+exports.default = prompts;

package/dist/cli/tasks.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.task = task;
+exports.conditionalTask = conditionalTask;
+exports.runWithTasks = runWithTasks;
+const listr2_1 = require("listr2");
+const logger_1 = require("./logger");
+/**
+ * Create a subtask.
+ * @param title - Task title.
+ * @param task - Task function.
+ * @returns A subtask object.
+ */
+function task(title, task) {
+    return { title, task };
+}
+/**
+ * Helper to conditionally include a subtask in a task list.
+ * @param condition - Include the subtask when true; exclude when false.
+ * @param subtask - The subtask to conditionally include.
+ * @returns Array with the subtask if condition is true; otherwise an empty array.
+ */
+function conditionalTask(condition, subtask) {
+    return condition ? [subtask] : [];
+}
+/**
+ * Run multiple subtasks grouped under a single goal using listr2.
+ * Provides a clean, stylized task list with collapsed errors.
+ * @param goalTitle - Overall goal title (e.g., "Preparing package").
+ * @param subtasks - Array of subtasks to run.
+ * @param opts - Optional rendering behavior.
+ */
+async function runWithTasks(goalTitle, task, subtasks = [], opts = {}) {
+    const tasks = new listr2_1.Listr([
+        {
+            title: (0, logger_1.primaryText)(goalTitle),
+            task: async (_ctx, _task) => {
+                if (task) {
+                    await task();
+                    return;
+                }
+                const subTasks = subtasks.map(({ title, task: run }) => ({
+                    title: (0, logger_1.defaultText)(title),
+                    task: async () => {
+                        await run();
+                    },
+                }));
+                return _task.newListr(subTasks, {
+                    rendererOptions: {
+                        collapseErrors: opts.collapseErrors ?? true,
+                    },
+                });
+            },
+        },
+    ], {
+        rendererOptions: {
+            collapseErrors: opts.collapseErrors ?? true,
+        },
+    });
+    await tasks.run();
+}
+/** Convenience default export for straightforward importing. */
+const tasks = {
+    runWithTasks,
+    task,
+    conditionalTask,
+};
+exports.default = tasks;

package/dist/core/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IS_LOCAL_MODE = void 0;
+/** When set to "true", use local templates from ./templates; otherwise, fetch from GitHub. */
+exports.IS_LOCAL_MODE = process.env.YEHLE_LOCAL_TEMPLATES === "true";