Merge pull request #373 from blocklet/fix/name-validate

fix(create-blocklet): validate project name compliance before creation
blocklet · Dec 2, 2024 · bc58969 · bc58969
2 parents 8c3483a + 38e87f3
commit bc58969
Show file tree

Hide file tree

Showing 28 changed files with 80 additions and 39 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.9.14 (2024-12-2)
+
+- fix(create-blocklet): validate project name compliance before creation(#372)
+
 ## 0.9.13 (2024-11-13)
 
 - chore(deps): update deps

diff --git a/README.md b/README.md
@@ -37,3 +37,18 @@ TBD
 pnpm install
 
 ```
+
+## Run the command
+
+```bash
+node packages/create-app/index.js test-demo
+```
+
+## Change Blocklet Server Command
+
+Change the file `packages/create-app/lib/constant.js`
+
+```
+// your command alias
+export const BLOCKLET_COMMAND = 'bn';
+```
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "create-blocklet",
   "private": true,
-  "version": "0.9.13",
+  "version": "0.9.14",
   "description": "",
   "keywords": [],
   "author": "",

diff --git a/packages/create-app/index.js b/packages/create-app/index.js
@@ -1,29 +1,30 @@
 #!/usr/bin/env node
 
-import ejs from 'ejs';
+import { isValid, toTypeInfo, types } from '@arcblock/did';
 import boxen from 'boxen';
-import { fileURLToPath } from 'url';
 import { execSync } from 'child_process';
-import { cd, argv, fs, YAML, chalk, path } from 'zx';
+import ejs from 'ejs';
+import * as envfile from 'envfile';
 import ora from 'ora';
 import prompts from 'prompts';
-import { isValid, toTypeInfo, types } from '@arcblock/did';
-import * as envfile from 'envfile';
+import { fileURLToPath } from 'url';
+import { argv, cd, chalk, fs, path, YAML } from 'zx';
 
 import { echoBrand, echoDocument } from './lib/arcblock.js';
-import { getUser } from './lib/index.js';
-import { checkServerInstalled, checkServerRunning, checkSatisfiedVersion, getServerDirectory } from './lib/server.js';
 import { getBlockletDidList } from './lib/did.js';
 import { initGitRepo } from './lib/git.js';
+import { getUser } from './lib/index.js';
+import { checkSatisfiedVersion, checkServerInstalled, checkServerRunning, getServerDirectory } from './lib/server.js';
 import {
+  checkLerna,
+  checkYarn,
   copy,
   emptyDir,
+  fuzzyQuery,
   isEmpty,
+  isValidName,
   isValidPackageName,
   toValidPackageName,
-  fuzzyQuery,
-  checkLerna,
-  checkYarn,
 } from './lib/utils.js';
 
 const { yellow, red, green, cyan, blue, bold } = chalk;
@@ -247,18 +248,21 @@ async function init() {
 
   let result = {};
   const authorInfo = await getUser();
+  const transferName = toValidPackageName(defaultProjectName);
 
   try {
     result = await prompts(
       [
         {
-          type: targetDir && !['.', './'].includes(targetDir) ? null : 'text',
+          type: isValidName(defaultProjectName) && targetDir && !['.', './'].includes(targetDir) ? null : 'text',
           name: 'projectName',
           message: 'Project name:',
-          initial: defaultProjectName,
+          initial: transferName,
           onState: (state) => {
-            projectName = state.value.trim() || defaultProjectName;
+            projectName = state.value.trim() || transferName;
           },
+          validate: (value) =>
+            isValidName(value) ? true : 'Please enter a valid project name, only a~z, A~Z, 0~9, - and _ are allowed.',
         },
         {
           type: () => (!fs.existsSync(targetDir) || isEmpty(targetDir) ? null : 'confirm'),

diff --git a/packages/create-app/lib/utils.js b/packages/create-app/lib/utils.js
@@ -11,6 +11,10 @@ export function copy(src, dest) {
   }
 }
 
+export function isValidName(name) {
+  return /^[a-zA-Z0-9][-a-zA-Z0-9_]{2,128}$/.test(name);
+}
+
 export function isValidPackageName(projectName) {
   return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(projectName);
 }

diff --git a/packages/create-app/package.json b/packages/create-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-blocklet",
-  "version": "0.9.13",
+  "version": "0.9.14",
   "exports": "./index.js",
   "type": "module",
   "repository": "[email protected]:blocklet/create-blocklet.git",

diff --git a/packages/create-app/templates/did-connect-dapp/package.json b/packages/create-app/templates/did-connect-dapp/package.json
@@ -77,7 +77,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/did-wallet-dapp/package.json b/packages/create-app/templates/did-wallet-dapp/package.json
@@ -52,7 +52,7 @@
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
     "vite-node": "^2.1.1",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-require": "^1.2.14",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^8.1.8"

diff --git a/packages/create-app/templates/react-dapp-ts/package.json b/packages/create-app/templates/react-dapp-ts/package.json
@@ -81,7 +81,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.6.2",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/react-dapp/package.json b/packages/create-app/templates/react-dapp/package.json
@@ -71,7 +71,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/react-gun-dapp/package.json b/packages/create-app/templates/react-gun-dapp/package.json
@@ -71,7 +71,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/react-static/package.json b/packages/create-app/templates/react-static/package.json
@@ -52,7 +52,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/solidjs-dapp/package.json b/packages/create-app/templates/solidjs-dapp/package.json
@@ -36,7 +36,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-solid": "^2.10.2",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/solidjs-static/package.json b/packages/create-app/templates/solidjs-static/package.json
@@ -32,7 +32,7 @@
     "simple-git-hooks": "^2.11.1",
     "solid-js": "^1.9.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-solid": "^2.10.2",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/svelte-dapp/package.json b/packages/create-app/templates/svelte-dapp/package.json
@@ -44,7 +44,7 @@
     "simple-git-hooks": "^2.11.1",
     "svelte": "^4.2.19",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "zx": "^8.1.8"
   },
   "lint-staged": {

diff --git a/packages/create-app/templates/svelte-static/package.json b/packages/create-app/templates/svelte-static/package.json
@@ -25,7 +25,7 @@
     "simple-git-hooks": "^2.11.1",
     "svelte": "^4.2.19",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "zx": "^8.1.8"
   },
   "lint-staged": {

diff --git a/packages/create-app/templates/todo-list-example/package.json b/packages/create-app/templates/todo-list-example/package.json
@@ -96,7 +96,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.6.2",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/vue-dapp/package.json b/packages/create-app/templates/vue-dapp/package.json
@@ -49,7 +49,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vue": "^3.5.10",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/vue-static/package.json b/packages/create-app/templates/vue-static/package.json
@@ -30,7 +30,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vue": "^3.5.10",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/vue-ts-static/package.json b/packages/create-app/templates/vue-ts-static/package.json
@@ -39,7 +39,7 @@
     "taze": "^0.16.9",
     "typescript": "^5.6.2",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vue-tsc": "^2.1.6",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/vue2-dapp/package.json b/packages/create-app/templates/vue2-dapp/package.json
@@ -48,7 +48,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vue": "^2.7.16",
     "zx": "^8.1.8"
   },

diff --git a/packages/create-app/templates/vue2-static/package.json b/packages/create-app/templates/vue2-static/package.json
@@ -30,7 +30,7 @@
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "vite": "^5.4.8",
-    "vite-plugin-blocklet": "^0.9.13",
+    "vite-plugin-blocklet": "^0.9.14",
     "vue": "^2.7.16",
     "zx": "^8.1.8"
   },

diff --git a/plugins/vite-plugin-blocklet/package.json b/plugins/vite-plugin-blocklet/package.json
@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-blocklet",
   "type": "module",
-  "version": "0.9.13",
+  "version": "0.9.14",
   "description": "",
   "main": "index.js",
   "files": [

diff --git a/plugins/vite-plugin-wss-hmr/package.json b/plugins/vite-plugin-wss-hmr/package.json
@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-wss-hmr",
   "type": "module",
-  "version": "0.9.13",
+  "version": "0.9.14",
   "description": "",
   "main": "index.js",
   "exports": {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/version b/version
@@ -1 +1 @@
-0.9.13
+0.9.14
diff --git a/website/docs/blocklet.yml b/website/docs/blocklet.yml
@@ -13,7 +13,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/create-blocklet.git
 specVersion: 1.2.8
-version: 0.9.13
+version: 0.9.14
 logo: logo.png
 files:
   - logo.png

diff --git a/website/pages/blocklet.yml b/website/pages/blocklet.yml
@@ -13,7 +13,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/create-blocklet.git
 specVersion: 1.2.8
-version: 0.9.13
+version: 0.9.14
 logo: logo.png
 files:
   - logo.png