@uiscore/cli 0.1.5

package/README.md

@@ -0,0 +1,151 @@
+# @uiscore/cli
+
+CLI for pulling UIScore registry components into an existing project.
+
+At the moment the CLI supports:
+
+- `uiscore init`
+- `uiscore add <name>`
+
+Current registry item verified end-to-end:
+
+- `button`
+- `alert`
+- `avatar`
+
+## Install
+
+Run without installing globally:
+
+```bash
+npx @uiscore/cli init
+npx @uiscore/cli add button
+```
+
+Or install it globally:
+
+```bash
+npm install -g @uiscore/cli
+uiscore init
+uiscore add button
+```
+
+## How It Works
+
+`uiscore add <name>` does four things:
+
+1. Reads `uiscore.config.json` from the current project.
+2. Downloads the registry item JSON from `registryUrl`.
+3. Writes component files into your project.
+4. Installs the dependencies listed by that registry item.
+
+If the registry item contains CSS variables, the CLI also writes them into the configured styles file.
+
+## Commands
+
+### `uiscore init`
+
+Creates `uiscore.config.json` in the current project root.
+
+Example:
+
+```bash
+uiscore init
+```
+
+Generated config:
+
+```json
+{
+  "registryUrl": "https://core.uiscore.io/registry/{name}.json",
+  "sourceRoot": "src/shared/ui",
+  "stylesPath": "src/shared/ui/styles/uiscore.css"
+}
+```
+
+### `uiscore add <name>`
+
+Downloads a component from the configured registry and writes it into the current project.
+
+Example:
+
+```bash
+uiscore add button
+```
+
+Optional overwrite mode:
+
+```bash
+uiscore add button --overwrite
+```
+
+## Config
+
+Create or edit `uiscore.config.json` in the target project root:
+
+```json
+{
+  "registryUrl": "https://core.uiscore.io/registry/{name}.json",
+  "sourceRoot": "src/shared/ui",
+  "stylesPath": "src/shared/ui/styles/uiscore.css"
+}
+```
+
+### Fields
+
+- `registryUrl`: URL template for registry items. `{name}` is replaced with the component name.
+- `sourceRoot`: base directory inside the target project where generated files are written.
+- `stylesPath`: file where UIScore CSS variables are written.
+
+## Example Flow
+
+In a consumer project:
+
+```bash
+npx @uiscore/cli init
+```
+
+Update `uiscore.config.json` if you use a custom registry domain.
+
+Then:
+
+```bash
+npx @uiscore/cli add button
+```
+
+After that, import your generated styles once in the app entrypoint or root layout:
+
+```ts
+import "@/shared/ui/styles/uiscore.css";
+```
+
+The CLI does not inject this import automatically.
+
+## Notes
+
+- Node `18+` is required.
+- Existing files are not overwritten unless you pass `--overwrite`.
+- The CLI currently assumes registry items already contain final file contents.
+- Registry hosting and npm publishing are separate concerns:
+  - `@uiscore/cli` is the CLI package.
+  - your registry JSON files can live on any public HTTPS domain.
+
+## Development
+
+Build:
+
+```bash
+npm run build
+```
+
+Type-check:
+
+```bash
+npm run lint:types
+```
+
+Pack locally:
+
+```bash
+npm pack
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/index.js

@@ -0,0 +1,223 @@
+#!/usr/bin/env node
+
+// src/commands/add.ts
+import { existsSync as existsSync3, mkdirSync, readFileSync as readFileSync2, writeFileSync } from "fs";
+import path3 from "path";
+import { spawnSync } from "child_process";
+
+// src/config.ts
+import { existsSync, readFileSync } from "fs";
+import path from "path";
+var DEFAULT_CONFIG = {
+  registryUrl: "https://core.uiscore.io/registry/{name}.json",
+  sourceRoot: "src/shared/ui",
+  stylesPath: "src/shared/ui/styles/uiscore.css"
+};
+function getConfigPath(cwd) {
+  return path.join(cwd, "uiscore.config.json");
+}
+function loadConfig(cwd) {
+  const configPath = getConfigPath(cwd);
+  if (!existsSync(configPath)) {
+    return DEFAULT_CONFIG;
+  }
+  const rawConfig = readFileSync(configPath, "utf8");
+  const parsed = JSON.parse(rawConfig);
+  return {
+    registryUrl: parsed.registryUrl ?? DEFAULT_CONFIG.registryUrl,
+    sourceRoot: parsed.sourceRoot ?? DEFAULT_CONFIG.sourceRoot,
+    stylesPath: parsed.stylesPath ?? DEFAULT_CONFIG.stylesPath
+  };
+}
+
+// src/utils/logger.ts
+function info(message) {
+  console.log(message);
+}
+function warn(message) {
+  console.warn(message);
+}
+function error(message) {
+  console.error(message);
+}
+
+// src/utils/package-manager.ts
+import { existsSync as existsSync2 } from "fs";
+import path2 from "path";
+function detectPackageManager(cwd) {
+  if (process.env.npm_config_user_agent?.includes("pnpm")) {
+    return "pnpm";
+  }
+  if (process.env.npm_config_user_agent?.includes("yarn")) {
+    return "yarn";
+  }
+  if (existsSync2(path2.join(cwd, "pnpm-lock.yaml"))) {
+    return "pnpm";
+  }
+  if (existsSync2(path2.join(cwd, "yarn.lock"))) {
+    return "yarn";
+  }
+  if (existsSync2(path2.join(cwd, "package-lock.json"))) {
+    return "npm";
+  }
+  return "npm";
+}
+function dependencyInstallArgs(packageManager, dependencies) {
+  if (packageManager === "pnpm") {
+    return ["add", ...dependencies];
+  }
+  if (packageManager === "yarn") {
+    return ["add", ...dependencies];
+  }
+  return ["install", ...dependencies];
+}
+
+// src/commands/add.ts
+async function runAddCommand(options) {
+  const config = loadConfig(options.cwd);
+  const url = config.registryUrl.replace("{name}", options.name);
+  info(`Fetching ${url}`);
+  const response = await fetch(url);
+  if (!response.ok) {
+    throw new Error(`Failed to fetch registry item: ${response.status} ${response.statusText}`);
+  }
+  const item = await response.json();
+  if (!item.files?.length) {
+    throw new Error(`Registry item "${options.name}" has no files.`);
+  }
+  const writtenFiles = [];
+  for (const file of item.files) {
+    const outputPath = path3.join(options.cwd, config.sourceRoot, file.target);
+    if (existsSync3(outputPath) && !options.overwrite) {
+      warn(`Skipped existing file: ${path3.relative(options.cwd, outputPath)}`);
+      continue;
+    }
+    mkdirSync(path3.dirname(outputPath), { recursive: true });
+    writeFileSync(outputPath, file.content, "utf8");
+    writtenFiles.push(path3.relative(options.cwd, outputPath));
+  }
+  if (item.cssVars?.light) {
+    writeCssVars({
+      cwd: options.cwd,
+      stylesPath: config.stylesPath,
+      cssVars: item.cssVars.light
+    });
+  }
+  if (item.dependencies?.length) {
+    const packageManager = detectPackageManager(options.cwd);
+    const installArgs = dependencyInstallArgs(packageManager, item.dependencies);
+    info(`Installing dependencies with ${packageManager}...`);
+    const installResult = spawnSync(packageManager, installArgs, {
+      cwd: options.cwd,
+      stdio: "inherit",
+      shell: process.platform === "win32"
+    });
+    if (installResult.status !== 0) {
+      throw new Error("Dependency installation failed.");
+    }
+  }
+  if (!writtenFiles.length) {
+    warn("No files were written.");
+    return;
+  }
+  info("Installed files:");
+  for (const filePath of writtenFiles) {
+    info(`- ${filePath}`);
+  }
+  info(`Import your generated styles once if needed: ${config.stylesPath}`);
+}
+function writeCssVars({
+  cwd,
+  stylesPath,
+  cssVars
+}) {
+  const outputPath = path3.join(cwd, stylesPath);
+  mkdirSync(path3.dirname(outputPath), { recursive: true });
+  const existing = existsSync3(outputPath) ? readFileSync2(outputPath, "utf8") : "";
+  const markerStart = "/* uiscore:tokens:start */";
+  const markerEnd = "/* uiscore:tokens:end */";
+  const nextBlock = buildCssVarBlock(cssVars, markerStart, markerEnd);
+  if (!existing) {
+    writeFileSync(outputPath, nextBlock, "utf8");
+    return;
+  }
+  if (existing.includes(markerStart) && existing.includes(markerEnd)) {
+    const updated = existing.replace(
+      new RegExp(`${escapeForRegExp(markerStart)}[\\s\\S]*?${escapeForRegExp(markerEnd)}`),
+      nextBlock.trimEnd()
+    );
+    writeFileSync(outputPath, `${updated.trimEnd()}
+`, "utf8");
+    return;
+  }
+  writeFileSync(outputPath, `${existing.trimEnd()}
+
+${nextBlock}`, "utf8");
+}
+function buildCssVarBlock(cssVars, markerStart, markerEnd) {
+  const vars = Object.entries(cssVars).map(([key, value]) => `  --${key}: ${value};`).join("\n");
+  return `${markerStart}
+:root {
+${vars}
+}
+${markerEnd}
+`;
+}
+function escapeForRegExp(value) {
+  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+
+// src/commands/init.ts
+import { existsSync as existsSync4, mkdirSync as mkdirSync2, writeFileSync as writeFileSync2 } from "fs";
+import path4 from "path";
+function runInitCommand(cwd) {
+  const configPath = getConfigPath(cwd);
+  if (existsSync4(configPath)) {
+    warn(`Config already exists: ${configPath}`);
+    return;
+  }
+  mkdirSync2(path4.dirname(configPath), { recursive: true });
+  writeFileSync2(configPath, `${JSON.stringify(DEFAULT_CONFIG, null, 2)}
+`, "utf8");
+  info(`Created ${configPath}`);
+  info("Update registryUrl before running `uiscore add` if needed.");
+}
+
+// src/index.ts
+async function main() {
+  const [, , command, ...args] = process.argv;
+  const cwd = process.cwd();
+  if (!command || command === "--help" || command === "-h") {
+    printHelp();
+    return;
+  }
+  if (command === "init") {
+    runInitCommand(cwd);
+    return;
+  }
+  if (command === "add") {
+    const name = args.find((arg) => !arg.startsWith("-"));
+    const overwrite = args.includes("--overwrite");
+    if (!name) {
+      throw new Error("Missing component name. Usage: uiscore add <name>");
+    }
+    await runAddCommand({
+      cwd,
+      name,
+      overwrite
+    });
+    return;
+  }
+  throw new Error(`Unknown command: ${command}`);
+}
+function printHelp() {
+  info("UIScore CLI");
+  info("");
+  info("Commands:");
+  info("  uiscore init");
+  info("  uiscore add <name> [--overwrite]");
+}
+main().catch((err) => {
+  error(err instanceof Error ? err.message : "Unknown error");
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@uiscore/cli",
+  "version": "0.1.5",
+  "description": "CLI for installing UIScore registry components into projects.",
+  "type": "module",
+  "bin": {
+    "uiscore": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --target node18",
+    "dev": "tsx src/index.ts",
+    "lint:types": "tsc --noEmit",
+    "pack:local": "npm pack",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^22.15.17",
+    "tsup": "^8.5.1",
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3"
+  }
+}