@harytempgit01/simplepkg 0.2.0

package/README.md

@@ -0,0 +1,63 @@
+# simplepkg
+
+A small utility npm package with string helpers, IDs, validation, and a CLI.
+
+## Install
+
+```sh
+npm install simplepkg
+```
+
+## Usage
+
+```js
+import {
+  createId,
+  createSlug,
+  greet,
+  parsePackageInput,
+  summarizeText
+} from "simplepkg";
+
+console.log(greet("World"));
+// Hello, World!
+
+console.log(createSlug("Simple NPM Package!"));
+// simple-npm-package
+
+console.log(createId("Simple Package"));
+// simple-package_V1StGXR8_Z
+
+console.log(summarizeText("  A package   helper with spacing  ", 18));
+// A package helper...
+
+console.log(parsePackageInput({ name: "Simple Package", tags: ["npm", "cli"] }));
+```
+
+## CLI
+
+After install, use the binary:
+
+```sh
+simplepkg greet TanStack
+simplepkg slug "Simple NPM Package!"
+simplepkg id "Simple Package"
+simplepkg summary "A long piece of text to shorten" --max 16
+simplepkg inspect --name "Simple Package" --tag npm cli
+```
+
+## Scripts
+
+```sh
+npm install
+npm run build
+npm run run -- greet TanStack
+npm test
+```
+
+## Package Layout
+
+- `src/index.js`: package exports
+- `src/cli.js`: CLI source
+- `dist/`: publishable build output
+- `test/`: Node test runner coverage

package/dist/cli.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+import chalk from "chalk";
+import { Command } from "commander";
+
+import { createId, createSlug, greet, parsePackageInput, summarizeText } from "./index.js";
+
+const program = new Command();
+
+program
+  .name("simplepkg")
+  .description("Small utility CLI for the simplepkg npm package")
+  .version("0.2.0");
+
+program
+  .command("greet")
+  .description("Print a friendly greeting")
+  .argument("[name]", "name to greet", "World")
+  .action((name) => {
+    console.log(chalk.green(greet(name)));
+  });
+
+program
+  .command("slug")
+  .description("Create a URL-safe slug")
+  .argument("<text>", "text to slugify")
+  .action((text) => {
+    console.log(createSlug(text));
+  });
+
+program
+  .command("id")
+  .description("Create a short prefixed ID")
+  .argument("[prefix]", "ID prefix", "pkg")
+  .action((prefix) => {
+    console.log(createId(prefix));
+  });
+
+program
+  .command("summary")
+  .description("Trim whitespace and shorten text")
+  .argument("<text>", "text to summarize")
+  .option("-m, --max <number>", "maximum output length", "80")
+  .action((text, options) => {
+    console.log(summarizeText(text, Number.parseInt(options.max, 10)));
+  });
+
+program
+  .command("inspect")
+  .description("Validate package-like input and print derived data")
+  .requiredOption("-n, --name <name>", "package name")
+  .option("-d, --description <description>", "package description", "")
+  .option("-t, --tag <tag...>", "package tags")
+  .action((options) => {
+    const result = parsePackageInput({
+      name: options.name,
+      description: options.description,
+      tags: options.tag ?? []
+    });
+
+    console.log(JSON.stringify(result, null, 2));
+  });
+
+if (process.argv.length <= 2) {
+  program.outputHelp();
+  process.exit(0);
+}
+
+program.parse();

package/dist/index.js

@@ -0,0 +1,69 @@
+import { nanoid } from "nanoid";
+import slugify from "slugify";
+import { z } from "zod";
+
+const displayNameSchema = z.string().trim().min(1).default("World");
+
+export function greet(name = "World") {
+  if (typeof name !== "string") {
+    throw new TypeError("name must be a string");
+  }
+
+  const displayName = displayNameSchema.catch("World").parse(name);
+  return `Hello, ${displayName}!`;
+}
+
+export function createSlug(value, options = {}) {
+  if (typeof value !== "string") {
+    throw new TypeError("value must be a string");
+  }
+
+  return slugify(value, {
+    lower: true,
+    strict: true,
+    trim: true,
+    ...options
+  });
+}
+
+export function createId(prefix = "pkg") {
+  if (typeof prefix !== "string") {
+    throw new TypeError("prefix must be a string");
+  }
+
+  const cleanPrefix = createSlug(prefix || "pkg") || "pkg";
+  return `${cleanPrefix}_${nanoid(10)}`;
+}
+
+export function summarizeText(text, maxLength = 80) {
+  if (typeof text !== "string") {
+    throw new TypeError("text must be a string");
+  }
+
+  if (!Number.isInteger(maxLength) || maxLength < 1) {
+    throw new RangeError("maxLength must be a positive integer");
+  }
+
+  const normalized = text.replace(/\s+/g, " ").trim();
+  if (normalized.length <= maxLength) {
+    return normalized;
+  }
+
+  return `${normalized.slice(0, Math.max(0, maxLength - 1)).trimEnd()}...`;
+}
+
+export function parsePackageInput(input) {
+  const schema = z.object({
+    name: z.string().trim().min(1),
+    description: z.string().trim().optional().default(""),
+    tags: z.array(z.string().trim().min(1)).optional().default([])
+  });
+
+  const parsed = schema.parse(input);
+
+  return {
+    ...parsed,
+    slug: createSlug(parsed.name),
+    id: createId(parsed.name)
+  };
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@harytempgit01/simplepkg",
+  "version": "0.2.0",
+  "description": "A small utility npm package with string helpers, IDs, validation, and a CLI.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "simplepkg": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/harytempgit01/SimplePkg.git"
+  },
+  "keywords": [
+    "cli",
+    "helpers",
+    "npm",
+    "package",
+    "slug"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "nanoid": "^5.0.7",
+    "slugify": "^1.6.6",
+    "zod": "^3.23.8"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "node scripts/build.js",
+    "dev": "node src/cli.js",
+    "run": "node dist/cli.js",
+    "start": "npm run build && npm run run",
+    "test": "node --test"
+  }
+}