create-waku 0.4.9 → 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Daishi Kato
+
+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/package.json

@@ -1,5 +1,34 @@
 {
   "name": "create-waku",
-  "version": "0.4.9",
-  "bin": "./cli.js"
-}
+  "version": "0.5.0",
+  "author": "Daishi Kato",
+  "contributors": [
+    "Vasu Singh"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dai-shi/waku.git"
+  },
+  "bin": "./dist/cli.js",
+  "files": [
+    "src",
+    "dist",
+    "template"
+  ],
+  "type": "commonjs",
+  "dependencies": {
+    "fs-extra": "^11.1.1",
+    "kolorist": "^1.8.0",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.1",
+    "@types/prompts": "^2.4.4",
+    "esbuild": "0.19.2"
+  },
+  "scripts": {
+    "start": "node dist/cli.js",
+    "template": "cp -r ../../examples template/",
+    "build": "esbuild src/* --bundle --platform=node --outdir=dist"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,174 @@
+#!/usr/bin/env node
+
+import fs from "node:fs";
+import path from "node:path";
+// FIXME what's the proper fix?
+// eslint-disable-next-line import/no-named-as-default
+import prompts from "prompts";
+import { red, green, bold } from "kolorist";
+// FIXME why @types/fs-extra doesn't work?
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import fse from "fs-extra/esm";
+
+function isValidPackageName(projectName: string) {
+  return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
+    projectName,
+  );
+}
+
+function toValidPackageName(projectName: string) {
+  return projectName
+    .trim()
+    .toLowerCase()
+    .replace(/\s+/g, "-")
+    .replace(/^[._]/, "")
+    .replace(/[^a-z0-9-~]+/g, "-");
+}
+
+// if the dir is empty or not exist
+function canSafelyOverwrite(dir: string) {
+  return !fs.existsSync(dir) || fs.readdirSync(dir).length === 0;
+}
+
+async function init() {
+  let targetDir = "";
+  const defaultProjectName = "waku-project";
+
+  const CHOICES = fs.readdirSync("template");
+  let result: {
+    packageName: string;
+    shouldOverwrite: string;
+    chooseProject: string;
+  };
+
+  try {
+    result = await prompts(
+      [
+        {
+          name: "projectName",
+          type: "text",
+          message: "Project Name",
+          initial: defaultProjectName,
+          onState: (state: any) =>
+            (targetDir = String(state.value).trim() || defaultProjectName),
+        },
+        {
+          name: "shouldOverwrite",
+          type: () => (canSafelyOverwrite(targetDir) ? null : "confirm"),
+          message: `${targetDir} is not empty. Remove existing files and continue?`,
+        },
+        {
+          name: "overwriteChecker",
+          type: (values: any) => {
+            if (values === false) {
+              throw new Error(red("✖") + " Operation cancelled");
+            }
+            return null;
+          },
+        },
+        {
+          name: "packageName",
+          type: () => (isValidPackageName(targetDir) ? null : "text"),
+          message: "Package name",
+          initial: () => toValidPackageName(targetDir),
+          validate: (dir: string) =>
+            isValidPackageName(dir) || "Invalid package.json name",
+        },
+        {
+          name: "chooseProject",
+          type: "select",
+          message: "Choose a starter template",
+          choices: [
+            { title: "basic-template", value: CHOICES[0] },
+            { title: "async-template", value: CHOICES[1] },
+            { title: "promise-template", value: CHOICES[2] },
+          ],
+        },
+      ],
+      {
+        onCancel: () => {
+          throw new Error(red("✖") + " Operation cancelled");
+        },
+      },
+    );
+  } catch (cancelled) {
+    if (cancelled instanceof Error) {
+      console.log(cancelled.message);
+    }
+    process.exit(1);
+  }
+
+  const { packageName, shouldOverwrite, chooseProject } = result;
+
+  const root = path.resolve(targetDir);
+
+  if (shouldOverwrite) {
+    fse.emptyDirSync(root);
+  } else if (!fs.existsSync(root)) {
+    fs.mkdirSync(root, { recursive: true });
+  }
+
+  const pkg = {
+    name: packageName ?? toValidPackageName(targetDir),
+    version: "0.0.0",
+  };
+
+  console.log("Setting up project...");
+
+  const templateRoot = path.join(__dirname, "../template");
+  const templateDir = path.resolve(templateRoot, chooseProject);
+
+  // Read existing package.json from the root directory
+  const packageJsonPath = path.join(root, "package.json");
+
+  // Read new package.json from the template directory
+  const newPackageJsonPath = path.join(templateDir, "package.json");
+  const newPackageJson = JSON.parse(
+    fs.readFileSync(newPackageJsonPath, "utf-8"),
+  );
+
+  fse.copySync(templateDir, root);
+
+  fs.writeFileSync(
+    packageJsonPath,
+    JSON.stringify(
+      {
+        ...newPackageJson,
+        ...pkg,
+      },
+      null,
+      2,
+    ),
+  );
+
+  const manager = process.env.npm_config_user_agent ?? "";
+  const packageManager = /pnpm/.test(manager)
+    ? "pnpm"
+    : /yarn/.test(manager)
+    ? "yarn"
+    : "npm";
+
+  const commandsMap = {
+    install: {
+      pnpm: "pnpm install",
+      yarn: "yarn",
+      npm: "npm install",
+    },
+    dev: {
+      pnpm: "pnpm dev",
+      yarn: "yarn dev",
+      npm: "npm run dev",
+    },
+  };
+
+  console.log(`\nDone. Now run:\n`);
+  console.log(`${bold(green(`cd ${targetDir}`))}`);
+  console.log(`${bold(green(commandsMap.install[packageManager]))}`);
+  console.log(`${bold(green(commandsMap.dev[packageManager]))}`);
+  console.log();
+}
+
+init().catch((e) => {
+  console.error(e);
+});

package/cli.js

@@ -1,46 +0,0 @@
-#!/usr/bin/env node
-
-const path = require("node:path");
-const fs = require("node:fs");
-const https = require("node:https");
-
-const dirName = "waku-example";
-
-if (fs.existsSync(dirName)) {
-  console.error(`Directory "${dirName}" already exists!`);
-  process.exit(1);
-}
-
-const baseUrl =
-  "https://raw.githubusercontent.com/dai-shi/waku/v0.13.0/examples/01_counter/";
-
-const files = `
-package.json
-tsconfig.json
-src/main.tsx
-src/entries.ts
-src/index.html
-src/components/App.tsx
-src/components/Counter.tsx
-`
-  .split(/\s/)
-  .filter((file) => file);
-
-const getFiles = (index = 0) => {
-  const file = files[index];
-  if (!file) return;
-  const destFile = path.join(dirName, file.replace("/", path.sep));
-  fs.mkdirSync(path.dirname(destFile), { recursive: true });
-  https.get(baseUrl + file, (res) => {
-    res.pipe(fs.createWriteStream(destFile));
-    res.on("end", () => getFiles(index + 1));
-  });
-};
-
-getFiles();
-
-process.on("exit", (code) => {
-  if (!code) {
-    console.info(`Done! Change directory "${dirName}"`);
-  }
-});