create-soybean 0.6.3 → 0.6.5

package/dist/index.mjs

@@ -0,0 +1,182 @@
+#!/usr/bin/env node
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { green, blue, cyan, lightBlue, reset, red } from 'kolorist';
+import minimist from 'minimist';
+import prompts from 'prompts';
+import { consola } from 'consola';
+
+function formatTargetDir(targetDir) {
+  return targetDir?.trim()?.replace(/\/+$/g, "");
+}
+function isPathEmpty($path) {
+  const files = fs.readdirSync($path);
+  return files.length === 0 || files.length === 1 && files[0] === ".git";
+}
+function isValidPackageName(projectName) {
+  return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(projectName);
+}
+function toValidPackageName(projectName) {
+  return projectName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z\d\-~]+/g, "-");
+}
+function emptyDir(dir) {
+  const isExist = fs.existsSync(dir);
+  if (!isExist) {
+    return;
+  }
+  const files = fs.readdirSync(dir);
+  for (const file of files) {
+    if (file !== ".git") {
+      const filePath = path.resolve(dir, file);
+      fs.rmSync(filePath, { recursive: true, force: true });
+    }
+  }
+}
+function copyDir(srcDir, destDir) {
+  fs.mkdirSync(destDir, { recursive: true });
+  const files = fs.readdirSync(srcDir);
+  for (const file of files) {
+    const srcFile = path.resolve(srcDir, file);
+    const destFile = path.resolve(destDir, file);
+    copy(srcFile, destFile);
+  }
+}
+function copy(src, dest) {
+  const stat = fs.statSync(src);
+  if (stat.isDirectory()) {
+    copyDir(src, dest);
+  } else {
+    fs.copyFileSync(src, dest);
+  }
+}
+
+const templates = [
+  {
+    type: "vue",
+    name: "Vue 3",
+    color: green
+  },
+  {
+    type: "ts-lib",
+    name: "TypeScript library",
+    color: blue
+  },
+  {
+    type: "react",
+    name: "React",
+    color: cyan
+  },
+  {
+    type: "react-native",
+    name: "React Native",
+    color: cyan
+  },
+  {
+    type: "solid",
+    name: "Solid",
+    color: lightBlue
+  }
+];
+const TEMPLATES = templates.map((t) => t.type);
+const renameFiles = {
+  _gitignore: ".gitignore",
+  _eslintrc: ".eslintrc",
+  _npmrc: ".npmrc"
+};
+const defaultTargetDir = "create-soybean-project";
+async function setupCli() {
+  const cwd = process.cwd();
+  const argv = minimist(process.argv.slice(2), { string: ["_"] });
+  const argTargetDir = formatTargetDir(argv._[0]);
+  const argTemplate = argv.template || argv.t;
+  let targetDir = argTargetDir || defaultTargetDir;
+  function getProjectName() {
+    return targetDir === "." ? path.basename(path.resolve()) : targetDir;
+  }
+  let result = null;
+  try {
+    result = await prompts([
+      {
+        type: argTargetDir ? null : "text",
+        name: "projectName",
+        message: reset("Project name:"),
+        initial: defaultTargetDir,
+        onState: (state) => {
+          targetDir = formatTargetDir(state.value) || defaultTargetDir;
+        }
+      },
+      {
+        type: () => !fs.existsSync(targetDir) || isPathEmpty(targetDir) ? null : "confirm",
+        name: "overwrite",
+        message: () => `${targetDir === "." ? "Current directory" : `Target directory "${targetDir}"`} is not empty. Remove existing files and continue?`
+      },
+      {
+        type: (_, { overwrite: overwrite2 }) => {
+          if (overwrite2 === false) {
+            throw new Error(`${red("\u2716")} Operation cancelled`);
+          }
+          return null;
+        },
+        name: "overwriteChecker"
+      },
+      {
+        type: () => isValidPackageName(getProjectName()) ? null : "text",
+        name: "packageName",
+        message: reset("Package name:"),
+        initial: () => toValidPackageName(getProjectName()),
+        validate: (dir) => isValidPackageName(dir) || "Invalid package.json name"
+      },
+      {
+        type: argTemplate && TEMPLATES.includes(argTemplate) ? null : "select",
+        name: "template",
+        message: typeof argTemplate === "string" && !TEMPLATES.includes(argTemplate) ? reset(`"${argTemplate}" isn't a valid template. Please choose from below: `) : reset("Select a template:"),
+        initial: 0,
+        choices: templates.map(({ type, name, color }) => ({
+          title: color(name),
+          value: type
+        }))
+      }
+    ]);
+  } catch (error) {
+    consola.error(error);
+  }
+  if (!result) {
+    return;
+  }
+  const { template, overwrite, packageName } = result;
+  const root = path.join(cwd, targetDir);
+  if (overwrite) {
+    emptyDir(root);
+  } else if (!fs.existsSync(root)) {
+    fs.mkdirSync(root, { recursive: true });
+  }
+  const $template = template || argTemplate;
+  consola.info(`
+Scaffolding project in ${root}...`);
+  const templateDir = path.resolve(fileURLToPath(import.meta.url), "../..", `template-${$template}`);
+  const write = (file, content) => {
+    const targetPath = path.join(root, renameFiles[file] ?? file);
+    if (content) {
+      fs.writeFileSync(targetPath, content);
+    } else {
+      copy(path.join(templateDir, file), targetPath);
+    }
+  };
+  const files = fs.readdirSync(templateDir);
+  for (const file of files.filter((f) => f !== "package.json")) {
+    write(file);
+  }
+  const pkg = JSON.parse(fs.readFileSync(path.join(templateDir, `package.json`), "utf-8"));
+  pkg.name = packageName || getProjectName();
+  write("package.json", `${JSON.stringify(pkg, null, 2)}
+`);
+  const cdProjectName = path.relative(cwd, root);
+  consola.info(`
+Done. Now run:
+`);
+  if (root !== cwd) {
+    consola.info(`  cd ${cdProjectName.includes(" ") ? `"${cdProjectName}"` : cdProjectName}`);
+  }
+}
+setupCli();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-soybean",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "SoybeanJS's command line to create different project templates",
   "author": {
     "name": "Soybean",
@@ -12,12 +12,22 @@
     "registry": "https://registry.npmjs.org/"
   },
   "bin": {
-    "create-soybean": "dist/index.mjs"
+    "create-soybean": "dist/index.mjs",
+    "create-soy": "dist/index.mjs"
   },
   "files": [
-    "dist"
+    "dist",
+    "template-*"
   ],
+  "dependencies": {
+    "consola": "^3.2.3",
+    "kolorist": "1.8.0",
+    "minimist": "1.2.8",
+    "prompts": "^2.4.2"
+  },
   "devDependencies": {
+    "@types/minimist": "^1.2.2",
+    "@types/prompts": "^2.4.4",
     "typescript": "5.1.6",
     "unbuild": "1.2.1"
   },

package/template-react/_eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "soybeanjs/react"
+}

package/template-react/_gitignore

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+!.vscode/launch.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+package-lock.json
+yarn.lock

package/template-react/_npmrc

@@ -0,0 +1,2 @@
+registry=https://registry.npmmirror.com/
+shamefully-hoist=true

package/template-react/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "template-react",
+  "version": "0.6.5",
+  "scripts": {}
+}

package/template-react-native/_eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "soybeanjs/react-native"
+}

package/template-react-native/_gitignore

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+!.vscode/launch.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+package-lock.json
+yarn.lock

package/template-react-native/_npmrc

@@ -0,0 +1,2 @@
+registry=https://registry.npmmirror.com/
+shamefully-hoist=true

package/template-react-native/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "template-react-native",
+  "version": "0.6.5",
+  "scripts": {}
+}

package/template-solid/_eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "soybeanjs/solid"
+}

package/template-solid/_gitignore

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+!.vscode/launch.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+package-lock.json
+yarn.lock

package/template-solid/_npmrc

@@ -0,0 +1,2 @@
+registry=https://registry.npmmirror.com/
+shamefully-hoist=true

package/template-solid/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "template-solid",
+  "version": "0.6.5",
+  "scripts": {}
+}

package/template-ts-lib/.vscode/extensions.json

@@ -0,0 +1,17 @@
+{
+  "recommendations": [
+    "antfu.unocss",
+    "dbaeumer.vscode-eslint",
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode",
+    "formulahendry.auto-complete-tag",
+    "formulahendry.auto-close-tag",
+    "formulahendry.auto-rename-tag",
+    "kisstkondoros.vscode-gutter-preview",
+    "mariusalchimavicius.json-to-ts",
+    "mhutchie.git-graph",
+    "sdras.vue-vscode-snippets",
+    "vue.volar",
+    "vue.vscode-typescript-vue-plugin"
+  ]
+}

package/template-ts-lib/.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "TS debugger",
+      "skipFiles": ["<node_internals>/**"],
+      "runtimeArgs": ["--loader", "tsx"],
+      "program": "${relativeFile}"
+    }
+  ]
+}

package/template-ts-lib/.vscode/settings.json

@@ -0,0 +1,23 @@
+{
+  "cSpell.words": ["consola", "kolorist"],
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.fontLigatures": true,
+  "editor.formatOnSave": false,
+  "editor.quickSuggestions": {
+    "strings": true
+  },
+  "editor.tabSize": 2,
+  "eslint.validate": ["json"],
+  "files.associations": {
+    "*.env.*": "dotenv",
+    "*.svg": "html",
+    ".*rc": "json"
+  },
+  "files.eol": "\n",
+  "[html][css][less][scss][sass][markdown][yaml][yml][jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  }
+}

package/template-ts-lib/_eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "soybeanjs"
+}

package/template-ts-lib/_gitignore

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+!.vscode/launch.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+package-lock.json
+yarn.lock

package/template-ts-lib/_npmrc

@@ -0,0 +1,2 @@
+registry=https://registry.npmmirror.com/
+shamefully-hoist=true

package/template-ts-lib/build.config.ts

@@ -0,0 +1,11 @@
+import { defineBuildConfig } from 'unbuild';
+
+export default defineBuildConfig({
+  entries: ['src/index'],
+  clean: true,
+  declaration: true,
+  rollup: {
+    emitCJS: true,
+    inlineDependencies: true
+  }
+});

package/template-ts-lib/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "ts-lib-starter",
+  "version": "0.6.5",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pnpm typecheck && unbuild",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "20.4.5",
+    "eslint": "8.45.0",
+    "eslint-config-soybeanjs": "0.5.3",
+    "typescript": "5.1.6",
+    "unbuild": "1.2.1"
+  }
+}

package/template-ts-lib/src/index.ts

@@ -0,0 +1,3 @@
+export function fn() {
+  return 'fn';
+}

package/template-ts-lib/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ESNext",
+    "target": "ESNext",
+    "lib": ["DOM", "ESNext"],
+    "strict": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "jsx": "preserve",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "noUnusedLocals": true,
+    "strictNullChecks": true,
+    "skipLibCheck": true, 
+    "forceConsistentCasingInFileNames": true,
+    "types": ["node"],
+    "paths": {
+      "@/*": ["./src/*"]
+    }    
+  },
+  "exclude": ["node_modules", "dist"]
+}

package/template-vue/.vscode/extensions.json

@@ -0,0 +1,17 @@
+{
+  "recommendations": [
+    "antfu.unocss",
+    "dbaeumer.vscode-eslint",
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode",
+    "formulahendry.auto-complete-tag",
+    "formulahendry.auto-close-tag",
+    "formulahendry.auto-rename-tag",
+    "kisstkondoros.vscode-gutter-preview",
+    "mariusalchimavicius.json-to-ts",
+    "mhutchie.git-graph",
+    "sdras.vue-vscode-snippets",
+    "vue.volar",
+    "vue.vscode-typescript-vue-plugin"
+  ]
+}

package/template-vue/.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "TS debugger",
+      "skipFiles": ["<node_internals>/**"],
+      "runtimeArgs": ["--loader", "tsx"],
+      "program": "${relativeFile}"
+    }
+  ]
+}

package/template-vue/.vscode/settings.json

@@ -0,0 +1,23 @@
+{
+  "cSpell.words": ["consola", "kolorist"],
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.fontLigatures": true,
+  "editor.formatOnSave": false,
+  "editor.quickSuggestions": {
+    "strings": true
+  },
+  "editor.tabSize": 2,
+  "eslint.validate": ["json"],
+  "files.associations": {
+    "*.env.*": "dotenv",
+    "*.svg": "html",
+    ".*rc": "json"
+  },
+  "files.eol": "\n",
+  "[html][css][less][scss][sass][markdown][yaml][yml][jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  }
+}

package/template-vue/README.md

@@ -0,0 +1,40 @@
+# template-vue
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+
+If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+
+1. Disable the built-in TypeScript Extension
+    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+pnpm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+pnpm dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+pnpm build
+```

package/template-vue/_eslintrc

@@ -0,0 +1,11 @@
+{
+  "extends": "soybeanjs/vue",
+  "overrides": [
+    {
+      "files": ["*.vue"],
+      "rules": {
+        "no-undef": "off"
+      }
+    }
+  ]
+}

package/template-vue/_gitignore

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+!.vscode/launch.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+package-lock.json
+yarn.lock

package/template-vue/_npmrc

@@ -0,0 +1,2 @@
+registry=https://registry.npmmirror.com/
+shamefully-hoist=true