create-lib-workspace 1.0.0

package/README.md

@@ -0,0 +1,118 @@
+# create-lib-workspace
+
+A lightweight CLI tool to instantly scaffold a local development monorepo workspace for custom JavaScript libraries built with Vite.
+
+It automatically sets up a multi-entry library with proper ESM/CJS exports and links it to a static test application using your favorite package manager—completely dependency-free.
+
+## Installation
+
+You can install this tool globally to make it available anywhere on your system, or run it directly without installation.
+
+### 1. Global Installation (Recommended)
+
+Install the CLI globally using your preferred package manager:
+
+```bash
+# Using pnpm
+pnpm add -g create-lib-workspace
+
+# Using npm
+npm install -g create-lib-workspace
+
+# Using yarn
+yarn global add create-lib-workspace
+```
+
+### 2. Run Without Installation
+
+If you prefer not to install the package globally, you can run it on the fly using executors:
+
+```bash
+# Using pnpm dlx
+pnpm dlx create-lib-workspace
+
+# Using npx
+npx create-lib-workspace
+
+# Using yarn dlx
+yarn dlx create-lib-workspace
+```
+
+## Usage
+
+You can run the command completely empty to start the **interactive wizard**, or pre-define arguments inline.
+
+```bash
+# Option A: Interactive Wizard (Recommended)
+create-lib-workspace
+
+# Option B: Inline Arguments
+create-lib-workspace <workspace-name> <lib-name> <package-name> [pnpm|npm|yarn]
+```
+
+### Arguments (Optional if using Wizard)
+
+* **`<workspace-name>`**: The name of the root directory for your project.
+* **`<lib-name>`**: The directory name of the library inside the workspace.
+* **`<package-name>`**: The actual package name for your `package.json` fields (e.g., `@my-scope/my-lib`).
+* **`[package-manager]`**: Force a specific tool (`pnpm`, `npm`, or `yarn`). Defaults to an interactive selection if omitted.
+
+### Example (Inline)
+
+```bash
+create-lib-workspace my-project core-lib @my-org/core pnpm
+```
+
+## ⚠️ Important Note During Setup
+
+During execution, the script delegates project scaffolding to Vite's official creator tool.
+
+1. When prompted by Vite, **select `Vanilla` and `JavaScript`**.
+2. **❌ DO NOT** let Vite install dependencies or run immediately if it prompts you to do so. The script will automatically handle the clean-up, structure generation, and global symlinking right after.
+
+## What is generated?
+
+The tool scaffolds a clean workspace structured as follows:
+
+```text
+my-project/
+├── app/                  # Pure static consumer app
+│   ├── index.html        # Test page
+│   └── main.js           # Imports and tests your library locally
+└── core-lib/             # Your actual Library (Vite-powered)
+    ├── src/
+    │   ├── index.js      # Main entry point
+    │   └── modifiers/    # Secondary entry point sub-module
+    ├── package.json      # Configured with ESM/CJS exports
+    └── vite.config.js    # Pre-configured multi-entry build setup
+```
+
+## Workflow / Local Development
+
+Once the setup completes successfully, the library is automatically symlinked to the test app. You can start developing in real-time using two terminal windows:
+
+### Terminal 1: Library Watcher
+Recompiles your library automatically on every file change. Replace `<pkg>` with your chosen package manager (`pnpm`, `npm`, or `yarn`).
+```bash
+cd my-project/core-lib
+<pkg> run watch
+```
+
+### Terminal 2: Test App Server
+Serves the consumer application so you can see your library in action.
+```bash
+cd my-project/app
+
+# If you used pnpm:
+pnpm dlx vite --open
+
+# If you used npm:
+npx vite --open
+
+# If you used yarn:
+yarn dlx vite --open
+```
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,217 @@
+#!/usr/bin/env node
+
+import { execSync } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import readline from 'readline';
+
+// Helper to create an interactive terminal prompt using built-in readline
+function askQuestion(query) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  return new Promise((resolve) => rl.question(query, (ans) => {
+    rl.close();
+    resolve(ans.trim());
+  }));
+}
+
+async function main() {
+  console.log('\n📦 Welcome to create-lib-workspace\n');
+
+  // Parse inline arguments
+  const args = process.argv.slice(2);
+  let workspaceName = args[0];
+  let libName = args[1];
+  let packageName = args[2];
+  let pkgManager = args[3];
+
+  // Fallback to interactive prompts if arguments are missing
+  if (!workspaceName) {
+    workspaceName = await askQuestion('Enter the workspace directory name (e.g. my-workspace): ');
+    if (!workspaceName) { console.log('❌ Workspace name is required!'); process.exit(1); }
+  }
+
+  if (!libName) {
+    libName = await askQuestion('Enter the library directory name (e.g. core-lib): ');
+    if (!libName) { console.log('❌ Library name is required!'); process.exit(1); }
+  }
+
+  if (!packageName) {
+    packageName = await askQuestion('Enter the npm package name (e.g. @my-org/core): ');
+    if (!packageName) { console.log('❌ Package name is required!'); process.exit(1); }
+  }
+
+  if (!pkgManager) {
+    console.log('\nSelect package manager:\n1) pnpm (Default)\n2) npm\n3) yarn');
+    const choice = await askQuestion('Enter number [1-3]: ');
+    if (choice === '2') pkgManager = 'npm';
+    else if (choice === '3') pkgManager = 'yarn';
+    else pkgManager = 'pnpm';
+  }
+
+  const workspacePath = path.resolve(workspaceName);
+  const appPath = path.join(workspacePath, 'app');
+  const libPath = path.join(workspacePath, libName);
+
+  // 1. Create Workspace & App Structure
+  console.log('\n[1/5] Creating workspace and consumer application...');
+  fs.mkdirSync(appPath, { recursive: true });
+
+  const htmlContent = `<!doctype html>
+<html>
+  <head>
+    <meta charset="UTF-8" />
+    <title>Test App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="./main.js"></script>
+  </body>
+</html>`;
+
+  const mainJsContent = `import { pluck } from "${packageName}";
+import { increaseAllOf, lowerCaseAllOf } from "${packageName}/modifiers";
+
+const users = [
+  { name: 'A', age: 22 },
+  { name: 'B', age: 22 },
+  { name: 'C', age: 22 }
+];
+
+console.log("Plucked Names:", pluck(users, 'name'));
+console.log("Increased Age:", increaseAllOf(users, 'age'));
+console.log("Lowercased Names:", lowerCaseAllOf(users, 'name'));`;
+
+  fs.writeFileSync(path.join(appPath, 'index.html'), htmlContent);
+  fs.writeFileSync(path.join(appPath, 'main.js'), mainJsContent);
+
+  // 2. Run Vite Scaffolding
+  console.log('\n---------------------------------------------------------');
+  console.log('⚠️  ATTENTION / IMPORTANT NOTE:');
+  console.log('Vite will now prompt you to target a framework and a variant.');
+  console.log('1. Please SELECT "Vanilla" and "JavaScript".');
+  console.log('2. ❌ DO NOT let it install dependencies or run immediately!');
+  console.log('---------------------------------------------------------\n');
+
+  try {
+    execSync(`${pkgManager} create vite ${libName} --template vanilla`, {
+      cwd: workspacePath,
+      stdio: 'inherit',
+    });
+  } catch (error) {
+    console.log('❌ Vite scaffolding failed or was aborted.');
+    process.exit(1);
+  }
+
+  // 3. Clean up Vite Boilerplate & Generate Library Sources
+  console.log('\n[2/5] Polishing library structure and writing source files...');
+  fs.rmSync(path.join(libPath, 'src'), { recursive: true, force: true });
+  fs.mkdirSync(path.join(libPath, 'src/modifiers'), { recursive: true });
+
+  // Dynamically fetch the absolute latest Vite version from registry
+  let viteVersion = '5.0.0';
+  try {
+    viteVersion = execSync('npm info vite version', { encoding: 'utf8' }).trim();
+  } catch (e) {
+    // Graceful fallback if no network
+  }
+
+  fs.writeFileSync(path.join(libPath, 'src/index.js'), `export function pluck(collection, field) {\n  return collection.map(item => item[field]);\n}`);
+  fs.writeFileSync(path.join(libPath, 'src/modifiers/increaseAll.js'), `export function increaseAllOf(collection, field) {\n  return collection.map(item => ({\n    ...item,\n    [field]: item[field] + 1\n  }));\n}`);
+  fs.writeFileSync(path.join(libPath, 'src/modifiers/lowerCaseAll.js'), `export function lowerCaseAllOf(collection, field) {\n  return collection.map(item => ({\n    ...item,\n    [field]: String(item[field]).toLowerCase()\n  }));\n}`);
+  fs.writeFileSync(path.join(libPath, 'src/modifiers/index.js'), `import { increaseAllOf } from "./increaseAll.js";\nimport { lowerCaseAllOf } from "./lowerCaseAll.js";\n\nexport { increaseAllOf, lowerCaseAllOf };`);
+
+  // Build custom package.json
+  const libPackageJson = {
+    name: packageName,
+    version: '0.0.0',
+    type: 'module',
+    main: './dist/index.cjs',
+    module: './dist/index.js',
+    exports: {
+      '.': { import: './dist/index.js', require: './dist/index.cjs' },
+      './modifiers': { import: './dist/modifiers.js', require: './dist/modifiers.cjs' },
+    },
+    files: ['dist'],
+    scripts: {
+      dev: 'vite',
+      build: 'vite build',
+      watch: 'vite build --watch',
+    },
+    devDependencies: {
+      vite: `^${viteVersion}`,
+    },
+  };
+
+  fs.writeFileSync(path.join(libPath, 'package.json'), JSON.stringify(libPackageJson, null, 2));
+
+  // Build custom vite.config.js
+  const viteConfigContent = `import { defineConfig } from "vite";
+import { resolve, dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: {
+        index: resolve(__dirname, "src/index.js"),
+        modifiers: resolve(__dirname, "src/modifiers/index.js")
+      },
+      name: "Lib",
+      formats: ["esm", "cjs"],
+      fileName: (format, entryName) => {
+        const ext = format === "esm" ? "js" : "cjs";
+        return \`\${entryName}.\${ext}\`;
+      }
+    }
+  }
+});`;
+  fs.writeFileSync(path.join(libPath, 'vite.config.js'), viteConfigContent);
+
+  // 4. Installing and Linking Dependencies
+  console.log(`\n[3/5] Installing library dependencies via ${pkgManager}...`);
+  execSync(`${pkgManager} install`, { cwd: libPath, stdio: 'inherit' });
+
+  console.log('\n[4/5] Linking library globally and attaching to the test application...');
+  if (pkgManager === 'npm') {
+    execSync('npm link', { cwd: libPath, stdio: 'ignore' });
+    execSync('npm init -y', { cwd: appPath, stdio: 'ignore' });
+    execSync(`npm link ${packageName}`, { cwd: appPath, stdio: 'ignore' });
+  } else if (pkgManager === 'yarn') {
+    execSync('yarn link --global', { cwd: libPath, stdio: 'ignore' });
+    execSync('yarn init -y', { cwd: appPath, stdio: 'ignore' });
+    execSync(`yarn link ${packageName}`, { cwd: appPath, stdio: 'ignore' });
+  } else {
+    execSync('pnpm link --global', { cwd: libPath, stdio: 'ignore' });
+    execSync('pnpm init', { cwd: appPath, stdio: 'ignore' });
+    execSync(`pnpm link --global ${packageName}`, { cwd: appPath, stdio: 'ignore' });
+  }
+
+  // 5. Initial Library Build
+  console.log('\n[5/5] Running initial library build...');
+  execSync(`${pkgManager} run build`, { cwd: libPath, stdio: 'inherit' });
+
+  // Define package executor instructions
+  let execCmd = 'pnpm dlx';
+  if (pkgManager === 'npm') execCmd = 'npx';
+  if (pkgManager === 'yarn') execCmd = 'yarn dlx';
+
+  console.log('\n=========================================================');
+  console.log(' 🎉 Setup successfully completed!');
+  console.log('=========================================================');
+  console.log(' To get started, open two terminals:\n');
+  console.log(' Terminal 1 (Library Watcher):');
+  console.log(`   cd ${workspaceName}/${libName} && ${pkgManager} run watch\n`);
+  console.log(' Terminal 2 (Test App Server):');
+  console.log(`   cd ${workspaceName}/app && ${execCmd} vite (--open)`);
+  console.log('=========================================================\n');
+}
+
+main().catch((err) => {
+  console.error('An unexpected error occurred:', err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,22 @@
+{
+	"name": "create-lib-workspace",
+	"version": "1.0.0",
+	"type": "module",
+	"bin": {
+		"create-lib-workspace": "./index.js"
+	},
+	"files": [
+		"index.js"
+	],
+	"license": "MIT",
+	
+	"keywords": [
+		"cli",
+		"vite",
+		"library",
+		"workspace",
+		"scaffold"
+	],
+	"author": "BarbWire-1 aka Barbara Kälin"
+
+}