create-esmx 3.0.0-rc.104

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Esmx Team
+
+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,52 @@
+<div align="center">
+  <img src="https://esmx.dev/logo.svg?t=2025" width="120" alt="Esmx Logo" />
+  <h1>create-esmx</h1>
+  
+  <div>
+    <a href="https://www.npmjs.com/package/create-esmx">
+      <img src="https://img.shields.io/npm/v/create-esmx.svg" alt="npm version" />
+    </a>
+    <a href="https://github.com/esmnext/esmx/actions/workflows/build.yml">
+      <img src="https://github.com/esmnext/esmx/actions/workflows/build.yml/badge.svg" alt="Build" />
+    </a>
+    <a href="https://esmx.dev/coverage/">
+      <img src="https://img.shields.io/badge/coverage-live%20report-brightgreen" alt="Coverage Report" />
+    </a>
+    <a href="https://nodejs.org/">
+      <img src="https://img.shields.io/node/v/@esmx/core.svg" alt="node version" />
+    </a>
+    <a href="https://bundlephobia.com/package/create-esmx">
+      <img src="https://img.shields.io/bundlephobia/minzip/create-esmx" alt="size" />
+    </a>
+  </div>
+  
+  <p>A scaffold tool for creating Esmx projects</p>
+  
+  <p>
+    English | <a href="https://github.com/esmnext/esmx/blob/master/packages/create-esmx/README.zh-CN.md">中文</a>
+  </p>
+</div>
+
+## Features
+
+- Interactive command-line interface
+- Support for multiple project templates
+- Complete TypeScript support
+- Automatic project structure configuration
+
+## Usage
+
+```bash
+# Using npm
+npm create esmx@latest my-project
+
+# Using yarn
+yarn create esmx my-project
+
+# Using pnpm
+pnpm create esmx my-project
+```
+
+## License
+
+MIT © Esmx Team 

package/README.zh-CN.md

@@ -0,0 +1,52 @@
+<div align="center">
+  <img src="https://esmx.dev/logo.svg?t=2025" width="120" alt="Esmx Logo" />
+  <h1>create-esmx</h1>
+  
+  <div>
+    <a href="https://www.npmjs.com/package/create-esmx">
+      <img src="https://img.shields.io/npm/v/create-esmx.svg" alt="npm version" />
+    </a>
+    <a href="https://github.com/esmnext/esmx/actions/workflows/build.yml">
+      <img src="https://github.com/esmnext/esmx/actions/workflows/build.yml/badge.svg" alt="Build" />
+    </a>
+    <a href="https://esmx.dev/coverage/">
+      <img src="https://img.shields.io/badge/coverage-live%20report-brightgreen" alt="Coverage Report" />
+    </a>
+    <a href="https://nodejs.org/">
+      <img src="https://img.shields.io/node/v/@esmx/core.svg" alt="node version" />
+    </a>
+    <a href="https://bundlephobia.com/package/create-esmx">
+      <img src="https://img.shields.io/bundlephobia/minzip/create-esmx" alt="size" />
+    </a>
+  </div>
+  
+  <p>用于创建 Esmx 项目的脚手架工具</p>
+  
+  <p>
+    <a href="https://github.com/esmnext/esmx/blob/master/packages/create-esmx/README.md">English</a> | 中文
+  </p>
+</div>
+
+## 功能特性
+
+- 交互式命令行界面
+- 支持多种项目模板
+- 完整的 TypeScript 支持
+- 自动配置项目结构
+
+## 安装使用
+
+```bash
+# 使用 npm
+npm create esmx@latest my-project
+
+# 使用 yarn
+yarn create esmx my-project
+
+# 使用 pnpm
+pnpm create esmx my-project
+```
+
+## 许可证
+
+MIT © Esmx Team 

package/dist/cli.d.ts

@@ -0,0 +1,5 @@
+import type { CliOptions } from './types';
+/**
+ * Main function to create a project
+ */
+export declare function cli(options?: CliOptions): Promise<void>;

package/dist/cli.integration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli.integration.test.mjs

@@ -0,0 +1,238 @@
+import { existsSync, readFileSync } from "node:fs";
+import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+import { cli } from "./cli.mjs";
+import { getAvailableTemplates } from "./template.mjs";
+async function createTempDir(prefix = "esmx-test-") {
+  return mkdtemp(join(tmpdir(), prefix));
+}
+async function cleanupTempDir(tempDir) {
+  try {
+    await rm(tempDir, { recursive: true, force: true });
+  } catch (error) {
+    console.warn(`Failed to cleanup temp directory: ${tempDir}`, error);
+  }
+}
+async function verifyProjectStructure(projectPath, projectName) {
+  expect(existsSync(projectPath)).toBe(true);
+  expect(existsSync(join(projectPath, "src"))).toBe(true);
+  const requiredFiles = [
+    "package.json",
+    "tsconfig.json",
+    "README.md",
+    "src/entry.node.ts"
+  ];
+  for (const file of requiredFiles) {
+    expect(existsSync(join(projectPath, file))).toBe(true);
+    if (!existsSync(join(projectPath, file))) {
+      throw new Error(`Missing required file: ${file}`);
+    }
+  }
+  const entryClientTs = join(projectPath, "src/entry.client.ts");
+  expect(existsSync(entryClientTs)).toBe(true);
+  if (!existsSync(entryClientTs)) {
+    throw new Error("Missing required file: src/entry.client.ts");
+  }
+  const packageJson = JSON.parse(
+    readFileSync(join(projectPath, "package.json"), "utf-8")
+  );
+  const typeCheckCommands = ["vue-tsc --noEmit", "tsc --noEmit"];
+  const typeGenCommands = [
+    "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir dist/src && tsc-alias -p tsconfig.json --outDir dist/src",
+    "tsc --declaration --emitDeclarationOnly --outDir dist/src && tsc-alias -p tsconfig.json --outDir dist/src"
+  ];
+  expect(packageJson).toMatchObject({
+    name: projectName,
+    type: "module",
+    private: true,
+    scripts: {
+      dev: "esmx dev",
+      build: "esmx build",
+      preview: "esmx preview",
+      start: "esmx start"
+    },
+    dependencies: {
+      "@esmx/core": expect.any(String)
+    },
+    devDependencies: {
+      typescript: expect.any(String),
+      "@types/node": expect.any(String),
+      "tsc-alias": expect.any(String)
+    }
+  });
+  expect(packageJson.scripts["lint:type"]).toBeOneOf(typeCheckCommands);
+  expect(packageJson.scripts["build:type"]).toBeOneOf(typeGenCommands);
+  const tsconfig = JSON.parse(
+    readFileSync(join(projectPath, "tsconfig.json"), "utf-8")
+  );
+  expect(tsconfig).toMatchObject({
+    compilerOptions: {
+      module: "ESNext",
+      moduleResolution: "node",
+      target: "ESNext",
+      strict: true,
+      baseUrl: ".",
+      paths: {
+        [`${projectName}/src/*`]: ["./src/*"],
+        [`${projectName}/*`]: ["./*"]
+      }
+    },
+    include: ["src"],
+    exclude: ["dist", "node_modules"]
+  });
+  const readmeContent = readFileSync(join(projectPath, "README.md"), "utf-8");
+  expect(readmeContent.length).toBeGreaterThan(0);
+  expect(readmeContent).toContain(projectName);
+}
+describe("create-esmx CLI integration tests", () => {
+  let tmpDir;
+  beforeEach(async () => {
+    tmpDir = await createTempDir();
+  });
+  afterEach(async () => {
+    await cleanupTempDir(tmpDir);
+  });
+  it("should create project with all available templates", async () => {
+    const templates = getAvailableTemplates();
+    expect(templates.length).toBeGreaterThan(0);
+    for (const template of templates) {
+      const projectName = `test-${template.folder}`;
+      const projectPath = join(tmpDir, projectName);
+      await cli({
+        argv: [projectName, "--template", template.folder],
+        cwd: tmpDir,
+        userAgent: "npm/test"
+      });
+      await verifyProjectStructure(projectPath, projectName);
+    }
+  });
+  it("should handle --force parameter correctly", async () => {
+    const projectPath = join(tmpDir, "test-project");
+    await cli({
+      argv: ["test-project", "--template", "vue2-csr"],
+      cwd: tmpDir,
+      userAgent: "npm/test"
+    });
+    expect(existsSync(join(projectPath, "package.json"))).toBe(true);
+    await cli({
+      argv: ["test-project", "--template", "vue2-csr", "--force"],
+      cwd: tmpDir,
+      userAgent: "npm/test"
+    });
+    expect(existsSync(join(projectPath, "package.json"))).toBe(true);
+    expect(existsSync(join(projectPath, "src"))).toBe(true);
+    expect(existsSync(join(projectPath, "src/entry.client.ts"))).toBe(true);
+    expect(existsSync(join(projectPath, "src/entry.node.ts"))).toBe(true);
+    expect(existsSync(join(projectPath, "src/entry.server.ts"))).toBe(true);
+    expect(existsSync(join(projectPath, "src/create-app.ts"))).toBe(true);
+  });
+  it("should show help information", async () => {
+    const originalLog = console.log;
+    const logOutput = [];
+    console.log = (...args) => {
+      logOutput.push(args.join(" "));
+    };
+    try {
+      await cli({
+        argv: ["--help"],
+        cwd: tmpDir,
+        userAgent: "npm/test"
+      });
+      const output = logOutput.join("\n");
+      expect(output).toContain("Usage");
+      expect(output).toContain("Options");
+      expect(output).toContain("Examples");
+    } finally {
+      console.log = originalLog;
+    }
+  });
+  it("should show version information", async () => {
+    const originalLog = console.log;
+    const logOutput = [];
+    console.log = (...args) => {
+      logOutput.push(args.join(" "));
+    };
+    try {
+      await cli({
+        argv: ["--version"],
+        cwd: tmpDir,
+        userAgent: "npm/test"
+      });
+      const output = logOutput.join("\n");
+      expect(output).toMatch(/^\d+\.\d+\.\d+/);
+    } finally {
+      console.log = originalLog;
+    }
+  });
+  it("should handle creating directory when target directory does not exist", async () => {
+    const projectPath = join(tmpDir, "non-existent-parent", "test-project");
+    await cli({
+      argv: [
+        "non-existent-parent/test-project",
+        "--template",
+        "vue2-csr"
+      ],
+      cwd: tmpDir,
+      userAgent: "npm/test"
+    });
+    expect(existsSync(projectPath)).toBe(true);
+    expect(existsSync(join(projectPath, "package.json"))).toBe(true);
+    expect(existsSync(join(projectPath, "src"))).toBe(true);
+  });
+  it("should handle force overwrite for non-empty directory", async () => {
+    const projectPath = join(tmpDir, "test-project");
+    await mkdir(projectPath, { recursive: true });
+    await writeFile(
+      join(projectPath, "existing-file.txt"),
+      "existing content"
+    );
+    await cli({
+      argv: ["test-project", "--template", "vue2-csr", "--force"],
+      cwd: tmpDir,
+      userAgent: "npm/test"
+    });
+    expect(existsSync(join(projectPath, "package.json"))).toBe(true);
+    expect(existsSync(join(projectPath, "src"))).toBe(true);
+  });
+  it("should handle force overwrite in current directory", async () => {
+    const testFile = join(tmpDir, "existing-file.txt");
+    await writeFile(testFile, "existing content");
+    await cli({
+      argv: [".", "--template", "vue2-csr", "--force"],
+      cwd: tmpDir,
+      userAgent: "npm/test"
+    });
+    expect(existsSync(join(tmpDir, "package.json"))).toBe(true);
+    expect(existsSync(join(tmpDir, "src"))).toBe(true);
+    expect(existsSync(join(tmpDir, "src/entry.client.ts"))).toBe(true);
+  });
+  it('should create project in current directory when target is "."', async () => {
+    await cli({
+      argv: [".", "--template", "vue2-csr"],
+      cwd: tmpDir,
+      userAgent: "npm/test"
+    });
+    expect(existsSync(join(tmpDir, "package.json"))).toBe(true);
+    expect(existsSync(join(tmpDir, "src"))).toBe(true);
+    expect(existsSync(join(tmpDir, "src/entry.client.ts"))).toBe(true);
+  });
+  it("should handle various project name formats", async () => {
+    const testCases = [
+      "simple-name",
+      "nested/project-name",
+      "deep/nested/project-name"
+    ];
+    for (const projectName of testCases) {
+      const projectPath = join(tmpDir, projectName);
+      await cli({
+        argv: [projectName, "--template", "vue2-csr"],
+        cwd: tmpDir,
+        userAgent: "npm/test"
+      });
+      expect(existsSync(projectPath)).toBe(true);
+      expect(existsSync(join(projectPath, "package.json"))).toBe(true);
+    }
+  });
+});

package/dist/cli.mjs

@@ -0,0 +1,166 @@
+import {
+  cancel,
+  intro,
+  isCancel,
+  note,
+  outro,
+  select,
+  text
+} from "@clack/prompts";
+import minimist from "minimist";
+import color from "picocolors";
+import { createProjectFromTemplate } from "./project.mjs";
+import { getAvailableTemplates, getEsmxVersion } from "./template.mjs";
+import { formatProjectName, getCommand } from "./utils/index.mjs";
+function showHelp(userAgent) {
+  const createCmd = getCommand("create", userAgent);
+  console.log(`
+${color.reset(color.bold(color.blue("\u{1F680} Create Esmx Project")))}
+
+${color.bold("Usage:")}
+  ${createCmd} [project-name]
+  ${createCmd} [project-name] [options]
+
+${color.bold("Options:")}
+  -t, --template <template>    Template to use (default: vue2-csr)
+  -n, --name <name>            Project name or path
+  -f, --force                  Force overwrite existing directory
+  -h, --help                   Show help information
+  -v, --version                Show version number
+
+${color.bold("Examples:")}
+  ${createCmd} my-project
+  ${createCmd} my-project -t vue2-csr
+  ${createCmd} my-project --force
+  ${createCmd} . -f -t vue2-csr
+
+${color.bold("Available Templates:")}
+${getAvailableTemplates().map((t) => `  ${t.folder.padEnd(25)} ${t.description}`).join("\n")}
+
+For more information, visit: ${color.cyan("https://esmx.dev")}
+`);
+}
+async function getProjectName(argName, positionalName) {
+  const providedName = argName || positionalName;
+  if (providedName) {
+    return providedName;
+  }
+  const projectName = await text({
+    message: "Project name or path:",
+    placeholder: "my-esmx-project",
+    validate: (value) => {
+      if (!value.trim()) {
+        return "Project name or path is required";
+      }
+      if (!/^[a-zA-Z0-9_./@-]+$/.test(value.trim())) {
+        return "Project name or path should only contain letters, numbers, hyphens, underscores, dots, and slashes";
+      }
+    }
+  });
+  return String(projectName).trim();
+}
+async function getTemplateType(argTemplate) {
+  const availableTemplates = getAvailableTemplates();
+  if (argTemplate && availableTemplates.some((t) => t.folder === argTemplate)) {
+    return argTemplate;
+  }
+  const options = availableTemplates.map((t) => ({
+    label: color.reset(color.gray(`${t.folder} - `) + color.bold(t.name)),
+    value: t.folder,
+    hint: t.description
+  }));
+  const template = await select({
+    message: "Select a template:",
+    options
+  });
+  return String(template);
+}
+export async function cli(options = {}) {
+  const { argv, cwd, userAgent, version } = options;
+  const commandLineArgs = argv || process.argv.slice(2);
+  const workingDir = cwd || process.cwd();
+  const parsedArgs = minimist(commandLineArgs, {
+    string: ["template", "name"],
+    boolean: ["help", "version", "force"],
+    alias: {
+      t: "template",
+      n: "name",
+      f: "force",
+      h: "help",
+      v: "version"
+    }
+  });
+  if (parsedArgs.help) {
+    showHelp(userAgent);
+    return;
+  }
+  if (parsedArgs.version) {
+    console.log(getEsmxVersion());
+    return;
+  }
+  console.log();
+  intro(
+    color.reset(
+      color.bold(color.blue("\u{1F680} Welcome to Esmx Project Creator!"))
+    )
+  );
+  const projectNameInput = await getProjectName(
+    parsedArgs.name,
+    parsedArgs._[0]
+  );
+  if (isCancel(projectNameInput)) {
+    cancel("Operation cancelled");
+    return;
+  }
+  let name;
+  let root;
+  if (parsedArgs.name && parsedArgs._[0]) {
+    name = parsedArgs.name;
+    root = formatProjectName(parsedArgs._[0], workingDir).root;
+  } else {
+    const result = formatProjectName(projectNameInput, workingDir);
+    name = result.name;
+    root = result.root;
+  }
+  const templateType = await getTemplateType(parsedArgs.template);
+  if (isCancel(templateType)) {
+    cancel("Operation cancelled");
+    return;
+  }
+  const installCommand = getCommand("install", userAgent);
+  const devCommand = getCommand("dev", userAgent);
+  const buildCommand = getCommand("build", userAgent);
+  const startCommand = getCommand("start", userAgent);
+  const buildTypeCommand = getCommand("build:type", userAgent);
+  const lintTypeCommand = getCommand("lint:type", userAgent);
+  await createProjectFromTemplate(
+    root,
+    templateType,
+    workingDir,
+    parsedArgs.force,
+    {
+      projectName: name,
+      esmxVersion: version || getEsmxVersion(),
+      installCommand,
+      devCommand,
+      buildCommand,
+      startCommand,
+      buildTypeCommand,
+      lintTypeCommand
+    }
+  );
+  const installCmd = installCommand;
+  const devCmd = devCommand;
+  const targetDirForDisplay = projectNameInput === "." ? "." : projectNameInput;
+  const steps = [
+    projectNameInput !== "." ? `cd ${targetDirForDisplay}` : null,
+    installCmd,
+    `git init ${color.gray("(optional)")}`,
+    devCmd
+  ].filter(Boolean);
+  const nextSteps = steps.map((step, index) => {
+    return color.reset(`${index + 1}. ${color.cyan(step)}`);
+  });
+  note(nextSteps.join("\n"), "Next steps");
+  outro(color.reset(color.green("Happy coding! \u{1F389}")));
+}

package/dist/create.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/create.mjs

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+import { cli } from "./cli.mjs";
+cli().catch((error) => {
+  console.error("Error creating project:", error);
+  process.exit(1);
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { cli } from './cli';
+export { getAvailableTemplates } from './template';
+export type { TemplateInfo } from './types';

package/dist/index.mjs

@@ -0,0 +1,2 @@
+export { cli } from "./cli.mjs";
+export { getAvailableTemplates } from "./template.mjs";

package/dist/project.d.ts

@@ -0,0 +1,5 @@
+import type { TemplateVariables } from './types';
+/**
+ * Create a project from template
+ */
+export declare function createProjectFromTemplate(targetDir: string, templateType: string, workingDir: string, force: boolean, variables: TemplateVariables): Promise<void>;

package/dist/project.mjs

@@ -0,0 +1,46 @@
+import { existsSync, mkdirSync } from "node:fs";
+import { dirname, isAbsolute, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { cancel, confirm, isCancel } from "@clack/prompts";
+import { copyTemplateFiles, isDirectoryEmpty } from "./template.mjs";
+const __dirname = dirname(fileURLToPath(import.meta.url));
+export async function createProjectFromTemplate(targetDir, templateType, workingDir, force, variables) {
+  const templatePath = resolve(__dirname, "../template", templateType);
+  const targetPath = isAbsolute(targetDir) ? targetDir : targetDir === "." ? workingDir : resolve(workingDir, targetDir);
+  if (!existsSync(templatePath)) {
+    throw new Error(`Template "${templateType}" not found`);
+  }
+  if (targetDir !== "." && existsSync(targetPath)) {
+    if (!isDirectoryEmpty(targetPath)) {
+      if (!force) {
+        const shouldOverwrite = await confirm({
+          message: `Directory "${targetDir}" is not empty. Do you want to overwrite it?`
+        });
+        if (isCancel(shouldOverwrite)) {
+          cancel("Operation cancelled");
+          return;
+        }
+        if (!shouldOverwrite) {
+          throw new Error("Operation cancelled by user");
+        }
+      }
+    }
+  } else if (targetDir !== ".") {
+    mkdirSync(targetPath, { recursive: true });
+  }
+  if (targetDir === "." && !isDirectoryEmpty(targetPath)) {
+    if (!force) {
+      const shouldOverwrite = await confirm({
+        message: "Current directory is not empty. Do you want to overwrite existing files?"
+      });
+      if (isCancel(shouldOverwrite)) {
+        cancel("Operation cancelled");
+        return;
+      }
+      if (!shouldOverwrite) {
+        throw new Error("Operation cancelled by user");
+      }
+    }
+  }
+  copyTemplateFiles(templatePath, targetPath, variables);
+}

package/dist/project.test.d.ts

@@ -0,0 +1 @@
+export {};