create-blocklet 0.3.2 → 0.3.5

package/index.js

@@ -5,7 +5,7 @@ import boxen from 'boxen';
 import { fileURLToPath } from 'url';
 import { execSync } from 'child_process';
 import { cd, argv, fs, YAML, chalk, path } from 'zx';
-import { startSpinner } from 'zx/experimental';
+import ora from 'ora';
 import prompts from 'prompts';
 import * as envfile from 'envfile';
 
@@ -15,7 +15,7 @@ import { checkServerInstalled, checkServerRunning, checkSatisfiedVersion, getSer
 import { toBlockletDid } from './lib/did.js';
 import { initGitRepo } from './lib/git.js';
 
-const { yellow, red, green, cyan, blue, bold, dim } = chalk;
+const { yellow, red, green, cyan, blue, bold } = chalk;
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -182,12 +182,14 @@ async function init() {
           name: 'authorName',
           message: 'Author name:',
           initial: authorInfo?.name || '',
+          validate: (name) => (name ? true : 'Author name is required'),
         },
         {
           type: 'text',
           name: 'authorEmail',
           message: 'Author email:',
           initial: authorInfo?.email || '',
+          validate: (email) => (email ? true : 'Author email is required'),
         },
       ],
       {
@@ -204,7 +206,7 @@ async function init() {
   // user choice associated with prompts
   const { type, framework, overwrite, packageName, authorName, authorEmail } = result;
 
-  const stopSpinner = startSpinner();
+  await echoDocument();
 
   const root = path.join(cwd, targetDir);
 
@@ -214,17 +216,20 @@ async function init() {
     fs.mkdirSync(root);
   }
 
-  await echoDocument();
-
-  console.log('Checking blocklet server runtime environment...', '\n');
+  const checkSpinner = ora({
+    text: 'Checking blocklet server runtime environment\n',
+  }).start();
 
   const isServerInstalled = await checkServerInstalled();
   const isSatisfiedVersion = await checkSatisfiedVersion();
   const isServerRunning = await checkServerRunning();
+  checkSpinner.succeed('Done');
+
+  console.log(`\nScaffolding project in ${cyan(root)}`);
 
-  console.log(`\n\nScaffolding project in ${root}...`);
+  const scaffoldSpinner = ora('Creating project...').start();
 
-  const templateDir = path.join(__dirname, `template-${type}/${framework}`);
+  const templateDir = path.join(__dirname, `templates/${framework}-${type}`);
   const name = packageName || targetDir;
 
   // copy common files
@@ -305,9 +310,9 @@ async function init() {
     // fs.writeFileSync(path.join(root, 'logo.png'), pngIcon);
   })();
 
+  scaffoldSpinner.succeed('✨  Done. Now run:\n');
+
   const related = path.relative(cwd, root);
-  console.log('\n\n✨  Done. Now run:\n');
-  stopSpinner();
 
   // const pkgManager =
   //   // eslint-disable-next-line no-nested-ternary
@@ -317,19 +322,20 @@ async function init() {
   //     ? 'yarn'
   //     : 'npm';
   try {
-    const { yes } = await prompts(
-      {
-        type: 'confirm',
-        name: 'yes',
-        initial: 'Y',
-        message: 'Install and start it now?',
-      },
-      {
-        onCancel: () => {
-          throw new Error(`${red('✖')} Operation cancelled`);
-        },
-      }
-    );
+    // const { yes } = await prompts(
+    //   {
+    //     type: 'confirm',
+    //     name: 'yes',
+    //     initial: 'Y',
+    //     message: 'Install and start it now?',
+    //   },
+    //   {
+    //     onCancel: () => {
+    //       throw new Error(`${red('✖')} Operation cancelled`);
+    //     },
+    //   }
+    // );
+    const yes = false;
     let hasStart = false;
 
     await initGitRepo(root);
@@ -411,7 +417,7 @@ async function init() {
     }
 
     if (!hasStart) {
-      console.log(dim('\n  start it later by:\n'));
+      // console.log(dim('\n  start it later by:\n'));
       if (root !== cwd) console.log(blue(`  cd ${bold(related)}`));
 
       console.log(blue(`  ${defaultAgent === 'yarn' ? 'yarn' : `${defaultAgent} install`}`));
@@ -463,9 +469,10 @@ async function init() {
       const env = envfile.parse(envContent);
       modifyFn(env);
       write('.env', envfile.stringify(env));
-    } else {
-      console.warn(`\n${yellow('No .env file found, please add one.')}`);
     }
+    // else {
+    //   console.warn(`\n${yellow('No .env file found, please add one.')}`);
+    // }
   }
 }
 

package/lib/did.js

@@ -7,7 +7,7 @@ import { fromPublicKey } from '@arcblock/did';
 const { types } = Mcrypto;
 
 export function toBlockletDid(name) {
-  const pk = toHex(name);
+  const pk = toHex(Buffer.from(typeof name === 'string' ? name.trim() : name));
   return fromPublicKey(pk, { role: types.RoleType.ROLE_ANY });
 }
 

package/lib/git.js

@@ -1,7 +1,18 @@
-import { $, which, cd } from 'zx';
+import { $, which, cd, chalk } from 'zx';
+
+const { yellow } = chalk;
 
 $.verbose = false;
 
+async function canInitGit() {
+  const isInstalled = await isGitInstalled();
+  const gitInfo = await getUserInfo();
+  if (isInstalled && gitInfo.name && gitInfo.email) {
+    return true;
+  }
+  return false;
+}
+
 export async function isGitInstalled() {
   try {
     await which('git');
@@ -12,14 +23,26 @@ export async function isGitInstalled() {
 }
 
 export async function initGitRepo(root) {
-  await cd(root);
-  await $`git init`;
-  await $`git add .`;
-  await $`git commit -m 'init'`;
+  const canInstalled = await canInitGit();
+  if (canInstalled) {
+    await cd(root);
+    await $`git init`;
+    await $`git add .`;
+    await $`git commit -m 'init'`;
+  } else {
+    console.warn(`${yellow('Git is not installed')}`);
+  }
 }
 
 export async function getUserInfo() {
-  const { stdout: name } = await $`git config user.name`;
-  const { stdout: email } = await $`git config user.email`;
-  return { name: name.trim(), email: email.trim() };
+  try {
+    const { stdout: name } = await $`git config user.name`;
+    const { stdout: email } = await $`git config user.email`;
+    return { name: name.trim(), email: email.trim() };
+  } catch {
+    return {
+      name: '',
+      email: '',
+    };
+  }
 }

package/lib/index.js

@@ -1,6 +1,7 @@
 import { $ } from 'zx';
 import { getAuthor } from './npm.js';
 import { getUserInfo } from './git.js';
+import { getUserInfo as getServerUserInfo } from './server.js';
 
 $.verbose = false;
 
@@ -10,10 +11,13 @@ export async function getOutput(cmd) {
 }
 
 export async function getUser() {
-  const npmAuthor = await getAuthor();
-  const gitUser = await getUserInfo();
+  function purifyString(str) {
+    return [undefined, 'undefined', null, 'null'].includes(str) ? '' : str;
+  }
+
+  const [npmAuthor, gitUser, serverUser] = await Promise.all([getAuthor(), getUserInfo(), getServerUserInfo()]);
   return {
-    name: npmAuthor.name || gitUser.name,
-    email: npmAuthor.email || gitUser.email,
+    name: purifyString(serverUser.name) || purifyString(npmAuthor.name) || purifyString(gitUser.name) || '',
+    email: purifyString(serverUser.email) || purifyString(npmAuthor.email) || purifyString(gitUser.email) || '',
   };
 }

package/lib/npm.js

@@ -4,8 +4,15 @@ import { $ } from 'zx';
 $.verbose = false;
 
 export async function getAuthor() {
-  const { stdout: name } = await $`npm config get init.author.name`;
-  const { stdout: email } = await $`npm config get init.author.email`;
+  try {
+    const { stdout: name } = await $`npm config get init.author.name`;
+    const { stdout: email } = await $`npm config get init.author.email`;
 
-  return { name: name.trim(), email: email.trim() };
+    return { name: name?.trim(), email: email?.trim() };
+  } catch {
+    return {
+      name: '',
+      email: '',
+    };
+  }
 }

package/lib/server.js

@@ -13,8 +13,12 @@ export async function checkServerInstalled() {
 }
 
 export async function getServerVersion() {
-  const { stdout: output } = await $`blocklet --version`;
-  return output.trim();
+  try {
+    const { stdout: output } = await $`blocklet --version`;
+    return output.trim();
+  } catch (e) {
+    return '0.0.0';
+  }
 }
 
 export async function getServerStatus() {
@@ -45,3 +49,19 @@ export async function getServerDirectory() {
   const directory = matchStr.replace(/Blocklet Server Data Directory:[\s]*([\S]+)\/\.abtnode\n/gm, '$1');
   return directory;
 }
+
+export async function getUserInfo() {
+  try {
+    const { stdout: user } = await $`blocklet config get user`;
+    const { stdout: email } = await $`blocklet config get email`;
+    return {
+      user: user?.trim(),
+      email: email?.trim(),
+    };
+  } catch {
+    return {
+      user: '',
+      email: '',
+    };
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-blocklet",
-  "version": "0.3.2",
+  "version": "0.3.5",
   "exports": "./index.js",
   "type": "module",
   "repository": "git@github.com:blocklet/create-blocklet.git",
@@ -13,9 +13,7 @@
     "index.js",
     "common",
     "lib",
-    "template-api",
-    "template-dapp",
-    "template-static"
+    "templates"
   ],
   "engines": {
     "node": ">=16.0.0"
@@ -31,19 +29,20 @@
     "test:run": "vitest run"
   },
   "dependencies": {
-    "@arcblock/did": "^1.14.25",
-    "@ocap/mcrypto": "^1.14.25",
-    "@ocap/util": "^1.14.25",
+    "@arcblock/did": "^1.15.7",
+    "@ocap/mcrypto": "^1.15.7",
+    "@ocap/util": "^1.15.7",
     "boxen": "^6.2.1",
     "ejs": "^3.1.6",
     "envfile": "^6.17.0",
     "figlet": "^1.5.2",
     "gradient-string": "^2.0.0",
     "jdenticon": "^3.1.1",
+    "ora": "^6.1.0",
     "prompts": "^2.4.2",
     "semver": "^7.3.5",
     "terminal-link": "^3.0.0",
-    "zx": "^6.0.6"
+    "zx": "^6.0.7"
   },
   "devDependencies": {
     "@arcblock/eslint-config": "0.1.8",

package/{template-static/blocklet-page → templates/blocklet-page-static}/package.json

@@ -11,6 +11,6 @@
     "upload": "npm run bundle && blocklet upload .blocklet/release/blocklet.json"
   },
   "dependencies": {
-    "@xmark/cli": "^2.0.28"
+    "@xmark/cli": "^2.0.31"
   }
 }

package/{template-api/express → templates/express-api}/blocklet.yml

@@ -33,10 +33,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/{template-dapp/nextjs → templates/nextjs-dapp}/blocklet.yml

@@ -34,10 +34,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/{template-dapp/react → templates/react-dapp}/blocklet.yml

@@ -34,10 +34,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/templates/react-dapp/craco.config.js

@@ -0,0 +1,17 @@
+const port = process.env.BLOCKLET_PORT || process.env.PORT || 8080;
+const dappPort = process.env.APP_PORT || 3030;
+
+module.exports = {
+  devServer: {
+    port,
+    client: {
+      // If you want to development this blocklet without blocklet-server, you can delete next line, otherwise the hot reload will be failed.
+      webSocketURL: 'wss://0.0.0.0/ws',
+    },
+    proxy: {
+      '/api': {
+        target: `http://127.0.0.1:${dappPort}`,
+      },
+    },
+  },
+};

package/{template-dapp/react → templates/react-dapp}/package.json

@@ -2,8 +2,8 @@
   "name": "template-react",
   "version": "0.1.0",
   "scripts": {
-    "dev": "react-scripts start",
-    "build": "react-scripts build",
+    "dev": "craco start",
+    "build": "craco build",
     "eject": "react-scripts eject",
     "lint": "eslint src api --ext .mjs,.js,.jsx,.ts,.tsx",
     "start": "npm-run-all --parallel start:*",
@@ -42,6 +42,7 @@
     "@arcblock/did-auth": "^1.15.2",
     "@arcblock/did-auth-storage-nedb": "^1.6.3",
     "@blocklet/sdk": "^1.7.0",
+    "@craco/craco": "^6.4.3",
     "@ocap/client": "^1.15.2",
     "@ocap/mcrypto": "^1.15.2",
     "@ocap/wallet": "^1.15.2",
@@ -70,7 +71,6 @@
     "eslint-plugin-react": "^7.24.0",
     "eslint-plugin-react-hooks": "^4.2.0",
     "eslint-plugin-unicorn": "^34.0.1",
-    "http-proxy-middleware": "^2.0.4",
     "husky": "^7.0.4",
     "lint-staged": "^12.3.7",
     "nodemon": "^2.0.15",

package/{template-static/react → templates/react-static}/blocklet.yml

@@ -32,10 +32,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/templates/react-static/craco.config.js

@@ -0,0 +1,11 @@
+const port = process.env.BLOCKLET_PORT || process.env.PORT || 8080;
+
+module.exports = {
+  devServer: {
+    port,
+    client: {
+      // If you want to development this blocklet without blocklet-server, you can delete next line, otherwise the hot reload will be failed.
+      webSocketURL: 'wss://0.0.0.0/ws',
+    },
+  },
+};

package/{template-static/react → templates/react-static}/package.json

@@ -2,8 +2,8 @@
   "name": "template-react",
   "version": "0.1.0",
   "scripts": {
-    "dev": "react-scripts start",
-    "build": "react-scripts build",
+    "dev": "craco start",
+    "build": "craco build",
     "eject": "react-scripts eject",
     "lint": "eslint src --ext .mjs,.js,.jsx,.ts,.tsx",
     "start": "npm run dev",
@@ -35,6 +35,7 @@
     ]
   },
   "dependencies": {
+    "@craco/craco": "^6.4.3",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-router-dom": "^6.2.2",

package/{template-dapp/vue → templates/vue-dapp}/blocklet.yml

@@ -34,10 +34,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/{template-dapp/vue → templates/vue-dapp}/package.json

@@ -10,7 +10,7 @@
     "start:api": "NODE_ENV=development nodemon api/index.js -w api",
     "clean": "rm -rf .blocklet",
     "bundle": "npm run bundle:client && npm run bundle:api",
-    "bundle:client": "vite build --base /.blocklet/proxy/<%= did %>",
+    "bundle:client": "vite build --base /.blocklet/proxy/<%= did %>/",
     "bundle:api": "npm run clean && blocklet bundle --zip --create-release",
     "deploy": "npm run bundle && blocklet deploy .blocklet/bundle",
     "upload": "npm run bundle && blocklet upload .blocklet/release/blocklet.json",

package/{template-static/vue → templates/vue-static}/blocklet.yml

@@ -32,10 +32,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/{template-static/vue → templates/vue-static}/package.json

@@ -8,7 +8,7 @@
     "lint": "eslint src --ext .mjs,.js,.vue",
     "serve": "vite preview",
     "clean": "rm -rf .blocklet",
-    "bundle": "npm run clean && vite build --base /.blocklet/proxy/<%= did %> && blocklet bundle --zip --create-release",
+    "bundle": "npm run clean && vite build --base /.blocklet/proxy/<%= did %>/ && blocklet bundle --zip --create-release",
     "deploy": "npm run bundle && blocklet deploy .blocklet/bundle",
     "upload": "npm run bundle && blocklet upload .blocklet/release/blocklet.json",
     "prepare": "husky install"

package/{template-dapp/vue2 → templates/vue2-dapp}/blocklet.yml

@@ -22,6 +22,7 @@ files:
   - blocklet.md
   - screenshots
   - api/hooks/pre-start.js
+  - dist
 interfaces:
   - type: web
     name: publicUrl
@@ -33,10 +34,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/{template-dapp/vue2 → templates/vue2-dapp}/package.json

@@ -11,7 +11,7 @@
     "start:api": "NODE_ENV=development nodemon api/index.js -w api",
     "clean": "rm -rf .blocklet",
     "bundle": "npm run bundle:client && npm run bundle:api",
-    "bundle:client": "PUBLIC_PATH=/.blocklet/proxy/z8ia5PYHKJaG7LxTiKK74YhN1vkVMf7N7VncW",
+    "bundle:client": "PUBLIC_PATH=/.blocklet/proxy/<%= did %> npm run build",
     "bundle:api": "npm run clean && blocklet bundle --zip --create-release",
     "deploy": "npm run bundle && blocklet deploy .blocklet/bundle",
     "upload": "npm run bundle && blocklet upload .blocklet/release/blocklet.json",

package/templates/vue2-dapp/vue.config.js

@@ -0,0 +1,18 @@
+const port = process.env.BLOCKLET_PORT || process.env.PORT || 8080;
+
+module.exports = {
+  publicPath: process.env.PUBLIC_PATH || '/',
+  devServer: {
+    port,
+    allowedHosts: 'all',
+    client: {
+      // If you want to development this blocklet without blocklet-server, you can delete next line, otherwise the hot reload will be failed.
+      webSocketURL: 'wss://0.0.0.0/ws',
+    },
+    proxy: {
+      '/api': {
+        target: 'http://127.0.0.1:3030',
+      },
+    },
+  },
+};

package/{template-static/vue2 → templates/vue2-static}/blocklet.yml

@@ -32,10 +32,9 @@ community: ''
 documentation: ''
 homepage: ''
 license: ''
-charging:
-  price: 0
-  tokens: []
-  shares: []
+payment:
+  price: []
+  share: []
 timeout:
   start: 60
 requirements:

package/templates/vue2-static/vue.config.js

@@ -0,0 +1,13 @@
+const port = process.env.BLOCKLET_PORT || process.env.PORT || 8080;
+
+module.exports = {
+  publicPath: process.env.PUBLIC_PATH || '/',
+  devServer: {
+    port,
+    allowedHosts: 'all',
+    client: {
+      // If you want to development this blocklet without blocklet-server, you can delete next line, otherwise the hot reload will be failed.
+      webSocketURL: 'wss://0.0.0.0/ws',
+    },
+  },
+};

package/template-dapp/react/src/setupProxy.js

@@ -1,12 +0,0 @@
-require('dotenv-flow').config();
-
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-module.exports = (app) => {
-  app.use(
-    '/api',
-    createProxyMiddleware({
-      target: `http://127.0.0.1:${process.env.APP_PORT || 3030}`,
-    })
-  );
-};

package/template-dapp/vue2/vue.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  publicPath: process.env.PUBLIC_PATH || '/',
-  devServer: {
-    proxy: {
-      '/api': {
-        target: 'http://127.0.0.1:3030',
-      },
-    },
-  },
-};

package/template-static/vue2/vue.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  publicPath: process.env.PUBLIC_PATH || '/',
-};