create-blocklet 0.7.8 → 0.8.0

package/common/.github/workflows/main.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - master
 
 jobs:
   Deploy:
@@ -13,20 +14,22 @@ jobs:
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - name: Set yarn cache
-        uses: c-hive/gha-yarn-cache@v2
-
-      - name: Install dependencies
-        run: yarn
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
 
       - name: Blocklet workflow
         uses: blocklet/action-workflow@v1
         with:
           skip-upload: false
           skip-deploy: false
-          bundle-command: yarn bundle
+          bundle-command: pnpm bundle
           store-endpoint: ${{ secrets.STORE_ENDPOINT }}
           store-access-token: ${{ secrets.STORE_ACCESS_TOKEN }}
           server-endpoint: ${{ secrets.SERVER_ENDPOINT }}

package/common/.prettierrc

@@ -2,7 +2,7 @@
   "printWidth": 120,
   "useTabs": false,
   "tabWidth": 2,
-  "trailingComma": "es5",
+  "trailingComma": "all",
   "bracketSameLine": true,
   "semi": true,
   "singleQuote": true

package/common/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018-2020 ArcBlock
+Copyright 2018-2024 ArcBlock
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/common/_gitignore

@@ -14,6 +14,7 @@ build
 dist
 dist-ssr
 .blocklet
+.next
 
 # local env files
 *.local

package/common/scripts/build-clean.mjs

@@ -0,0 +1,7 @@
+/* eslint-disable no-console */
+
+import { rimrafSync } from 'rimraf';
+
+console.log('clean .blocklet folder');
+rimrafSync('.blocklet');
+console.log('clean .blocklet folder done!');

package/index.js

@@ -33,6 +33,7 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const cwd = process.cwd();
 
 const templates = [
+  // dapp
   {
     name: 'react-dapp',
     display: '[dapp] react + express.js',
@@ -58,11 +59,11 @@ const templates = [
     display: '[dapp] vue3 + express.js',
     color: green,
   },
-  {
-    name: 'vue2-dapp',
-    display: '[dapp] vue2 + express.js',
-    color: green,
-  },
+  // {
+  //   name: 'vue2-dapp',
+  //   display: '[dapp] vue2 + express.js',
+  //   color: green,
+  // },
   {
     name: 'svelte-dapp',
     display: '[dapp] svelte + express.js',
@@ -73,11 +74,12 @@ const templates = [
     display: '[dapp] next.js',
     color: blue,
   },
-  {
-    name: 'react-gun-dapp',
-    display: '[dapp] react + gun.js + express.js',
-    color: blue,
-  },
+  // {
+  //   name: 'react-gun-dapp',
+  //   display: '[dapp] react + gun.js + express.js',
+  //   color: blue,
+  // },
+  // static
   {
     name: 'react-static',
     display: '[static] react',
@@ -93,11 +95,11 @@ const templates = [
     display: '[static] vue3',
     color: green,
   },
-  {
-    name: 'vue2-static',
-    display: '[static] vue2',
-    color: green,
-  },
+  // {
+  //   name: 'vue2-static',
+  //   display: '[static] vue2',
+  //   color: green,
+  // },
   {
     name: 'svelte-static',
     display: '[static] svelte',
@@ -108,6 +110,7 @@ const templates = [
     display: '[static] html',
     color: blue,
   },
+  // api
   {
     name: 'express-api',
     display: '[api] express.js',
@@ -120,7 +123,7 @@ const templates = [
   },
 ];
 
-//see: https://github.com/npm/npm/issues/3763
+// see: https://github.com/npm/npm/issues/3763
 const renameFiles = {
   _gitignore: '.gitignore',
   _npmrc: '.npmrc',
@@ -145,13 +148,14 @@ async function init() {
 
   let targetDir = argv._[0] ? String(argv._[0]) : undefined;
   const inputTemplateName = argv.template;
-  const connectUrl = argv.connectUrl;
+  const connectUrl = argv?.connectUrl;
   const inputDid = argv.did;
   const checkRes = checkDid(inputDid);
   if (typeof checkRes === 'string') {
     console.error(checkRes);
     return;
-  } else if (checkRes !== true) {
+  }
+  if (checkRes !== true) {
     console.error(`Invalid blocklet did: ${inputDid}`);
     return;
   }
@@ -255,7 +259,7 @@ async function init() {
         onCancel: () => {
           throw new Error(`${red('✖')} Operation cancelled`);
         },
-      }
+      },
     );
   } catch (cancelled) {
     console.error(cancelled.message);
@@ -333,6 +337,7 @@ async function init() {
       for (const file of commonFiles) {
         // 如果选择多个模板，每个子 package 中 只会包含必要的 文件
         if (mainBlocklet && !['screenshots', 'public', 'logo.png', '.prettierrc', 'LICENSE'].includes(file)) {
+          // eslint-disable-next-line no-continue
           continue;
         }
         // html-staic 和 xmark 相关的模板不添加 .husky
@@ -350,7 +355,7 @@ async function init() {
     // copy template files
     (() => {
       // 过滤掉 template-info.json 文件
-      let files = fs.readdirSync(templateDir).filter((file) => file !== 'template-info.json');
+      const files = fs.readdirSync(templateDir).filter((file) => file !== 'template-info.json');
       for (const file of files) {
         write(file, null, templateDir, templateName);
       }
@@ -365,7 +370,7 @@ async function init() {
         pkg.name = mainBlocklet ? finalTemplateName : name;
       },
       templateDir,
-      templateName
+      templateName,
     );
     modifyBlockletYaml(
       (yamlConfig) => {
@@ -373,20 +378,21 @@ async function init() {
         yamlConfig.title = mainBlocklet ? templateName : name;
       },
       templateDir,
-      templateName
+      templateName,
     );
 
     // patch blocklet author
     modifyBlockletYaml(
-      async (yamlConfig) => {
+      (yamlConfig) => {
         yamlConfig.author.name = authorName;
         yamlConfig.author.email = authorEmail;
       },
       templateDir,
-      templateName
+      templateName,
     );
 
     // patch did
+    // eslint-disable-next-line no-inner-declarations, require-await
     async function patchDid() {
       const did = didList[index];
       modifyBlockletYaml(
@@ -394,7 +400,7 @@ async function init() {
           yamlConfig.did = did;
         },
         templateDir,
-        templateName
+        templateName,
       );
       modifyPackage(
         (pkg) => {
@@ -422,12 +428,13 @@ async function init() {
           }
         },
         templateDir,
-        templateName
+        templateName,
       );
       // disabled random logo
       // const pngIcon = toDidIcon(did, undefined, true);
       // fs.writeFileSync(path.join(root, 'logo.png'), pngIcon);
     }
+    // eslint-disable-next-line no-await-in-loop
     await patchDid();
   }
 
@@ -462,7 +469,7 @@ async function init() {
     await initGitRepo(root);
 
     let defaultAgent = 'npm';
-    let agentList = ['npm', 'yarn', 'pnpm'];
+    const agentList = ['npm', 'yarn', 'pnpm'];
 
     // switch (templateNames) {
     //   case 'react':
@@ -493,7 +500,7 @@ async function init() {
             padding: 1,
             margin: 1,
             float: 'center',
-          })
+          }),
         );
         hasStart = true;
         execSync('blocklet dev', { stdio: 'inherit' });
@@ -540,7 +547,7 @@ async function init() {
       // console.log(dim('\n  start it later by:\n'));
       if (root !== cwd) console.log(blue(`  cd ${bold(related)}`));
       if (mainBlocklet) {
-        console.log(blue(`npm run init`));
+        console.log(blue('npm run init'));
       } else {
         console.log(blue(`${defaultAgent === 'yarn' ? 'yarn' : `${defaultAgent} install`}`));
         console.log(cyan('blocklet dev'));
@@ -571,20 +578,21 @@ async function init() {
     return null;
   }
 
-  function modifyPackage(modifyFn = () => {}, templateDir, templateName) {
+  function modifyPackage(modifyFn = () => {}, templateDir = '', templateName = '') {
     const pkg = JSON.parse(read('package.json', templateName));
     modifyFn(pkg);
     write('package.json', JSON.stringify(pkg, null, 2), templateDir, templateName);
   }
 
-  function modifyBlockletYaml(modifyFn = () => {}, templateDir, templateName) {
+  function modifyBlockletYaml(modifyFn = () => {}, templateDir = '', templateName = '') {
     const blockletYaml = read('blocklet.yml', templateName);
     const yamlConfig = YAML.parse(blockletYaml);
     modifyFn(yamlConfig);
     write('blocklet.yml', YAML.stringify(yamlConfig, 2), templateDir, templateName);
   }
 
-  function modifyEnv(modifyFn = (...args) => ({ ...args }), templateDir, templateName) {
+  // eslint-disable-next-line no-unused-vars
+  function modifyEnv(modifyFn = (...args) => ({ ...args }), templateDir = '', templateName = '') {
     const envContent = read('.env', templateName);
     if (envContent) {
       const env = envfile.parse(envContent);

package/lib/arcblock.js

@@ -25,7 +25,7 @@ export function echoBrand({ version = '' }) {
   });
 }
 export function echoDocument() {
-  const url = 'https://developer.blocklet.io/docs/';
+  const url = 'https://www.arcblock.io/docs/blocklet-developer';
   let msg;
   if (terminalLink.isSupported) {
     msg = green(terminalLink(`Documentation: ${url}`, url));

package/lib/constant.js

@@ -1 +1,2 @@
+/* eslint-disable import/prefer-default-export */
 export const BLOCKLET_COMMAND = 'blocklet';

package/lib/did.js

@@ -18,7 +18,7 @@ export function toDidIcon(did, size = 200, isPng = false) {
   return isPng ? jdenticon.toPng(did, size) : jdenticon.toSvg(did, size);
 }
 
-export async function getBlockletDidList(monikerList = [], connectUrl) {
+export async function getBlockletDidList(monikerList = [], connectUrl = '') {
   try {
     let command = `${BLOCKLET_COMMAND} init`;
     if (monikerList.length > 0) {
@@ -28,6 +28,7 @@ export async function getBlockletDidList(monikerList = [], connectUrl) {
     }
 
     if (connectUrl) {
+      // eslint-disable-next-line no-unused-vars
       command += ` --connectUrl=${connectUrl}`;
     }
     const runCommand = new Promise((resolve, reject) => {

package/lib/git.js

@@ -4,15 +4,6 @@ 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');
@@ -22,18 +13,6 @@ export async function isGitInstalled() {
   }
 }
 
-export async function initGitRepo(root) {
-  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() {
   try {
     const { stdout: name } = await $`git config user.name`;
@@ -46,3 +25,24 @@ export async function getUserInfo() {
     };
   }
 }
+
+async function canInitGit() {
+  const isInstalled = await isGitInstalled();
+  const gitInfo = await getUserInfo();
+  if (isInstalled && gitInfo.name && gitInfo.email) {
+    return true;
+  }
+  return false;
+}
+
+export async function initGitRepo(root) {
+  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')}`);
+  }
+}

package/lib/server.js

@@ -4,7 +4,16 @@ import { BLOCKLET_COMMAND } from './constant.js';
 
 $.verbose = false;
 
-export async function trimServerOutputVersion(output = '', command) {
+export async function getServerVersion() {
+  try {
+    const { stdout: output } = await $`${BLOCKLET_COMMAND} --version`;
+    return output.trim();
+  } catch (e) {
+    return '0.0.0';
+  }
+}
+
+export async function trimServerOutputVersion(output = '', command = '') {
   // 调用 blocklet 命令时，都会在第一行先打印一个 blocklet [command] [version] 的信息，需要把这个信息 trim 掉
   const version = await getServerVersion();
   if (command) {
@@ -23,15 +32,6 @@ export async function checkServerInstalled() {
   }
 }
 
-export async function getServerVersion() {
-  try {
-    const { stdout: output } = await $`${BLOCKLET_COMMAND} --version`;
-    return output.trim();
-  } catch (e) {
-    return '0.0.0';
-  }
-}
-
 export async function getServerStatus() {
   try {
     const { stdout: output } = await $`${BLOCKLET_COMMAND} server status`;

package/lib/utils.js

@@ -6,6 +6,7 @@ $.verbose = false;
 export function copy(src, dest) {
   const stat = fs.statSync(src);
   if (stat.isDirectory()) {
+    // eslint-disable-next-line no-use-before-define
     copyDir(src, dest);
   } else {
     fs.copySync(src, dest);
@@ -56,7 +57,7 @@ export function emptyDir(dir) {
 
 export function fuzzyQuery(list = [], keyWord = '') {
   const arr = [];
-  for (var i = 0; i < list.length; i++) {
+  for (let i = 0; i < list.length; i++) {
     if (keyWord.includes(list[i])) {
       arr.push(list[i]);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-blocklet",
-  "version": "0.7.8",
+  "version": "0.8.0",
   "exports": "./index.js",
   "type": "module",
   "repository": "git@github.com:blocklet/create-blocklet.git",
@@ -23,31 +23,31 @@
   },
   "homepage": "https://github.com/blocklet/create-blocklet/tree/main#readme",
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint index.js lib test",
     "test": "NODE_ENV=development vitest",
     "test:ui": "vitest --ui",
     "test:run": "vitest run"
   },
   "dependencies": {
-    "@arcblock/did": "^1.18.108",
-    "@ocap/mcrypto": "^1.18.108",
-    "@ocap/util": "^1.18.108",
-    "boxen": "^6.2.1",
-    "ejs": "^3.1.9",
-    "envfile": "^6.22.0",
+    "@arcblock/did": "^1.18.124",
+    "@ocap/mcrypto": "^1.18.124",
+    "@ocap/util": "^1.18.124",
+    "boxen": "^7.1.1",
+    "ejs": "^3.1.10",
+    "envfile": "^7.1.0",
     "figlet": "^1.7.0",
     "gradient-string": "^2.0.2",
-    "jdenticon": "^3.2.0",
-    "ora": "^6.3.1",
+    "jdenticon": "^3.3.0",
+    "ora": "^8.0.1",
     "prompts": "^2.4.2",
-    "semver": "^7.5.4",
+    "semver": "^7.6.2",
     "terminal-link": "^3.0.0",
-    "zx": "7.2.3"
+    "zx": "^8.1.3"
   },
   "devDependencies": {
-    "@arcblock/eslint-config-base": "0.2.4",
-    "eslint": "^8.56.0",
-    "prettier": "^3.1.1",
-    "vitest": "^1.1.0"
+    "@arcblock/eslint-config-base": "^0.3.2",
+    "eslint": "^8.57.0",
+    "prettier": "^3.3.2",
+    "vitest": "^1.6.0"
   }
 }

package/templates/express-api/README.md

@@ -31,14 +31,14 @@ This blocklet is a dapp project, which means this is a full-stack application. I
 
    Blocklet needs blocklet server as a dependency. So you need to install it first.
    `npm install -g @blocklet/cli`
-   See details in [https://developer.blocklet.io/docs/en/quick-start/blocklet-server#use-the-binary-distribution](https://developer.blocklet.io/docs/en/quick-start/blocklet-server#use-the-binary-distribution)
+   See details in [https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli](https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli)
 
 2. Init blocklet server & start blocklet server
 
    Before starting an blocklet server, you need to init blocklet server.
    `blocklet server init --mode=debug`
    `blocklet server start`
-   See details in [https://developer.blocklet.io/docs/en/quick-start/blocklet-server](https://developer.blocklet.io/docs/en/quick-start/blocklet-server)
+   See details in [https://www.arcblock.io/docs/blocklet-developer/getting-started](https://www.arcblock.io/docs/blocklet-developer/getting-started)
 
 3. Go to the project directory `cd [name]`
 4. Install dependencies: `npm install` or `yarn`
@@ -138,7 +138,7 @@ After developing a blocklet, you may need to bundle it. Use `npm run bundle` com
 ## Learn More
 
 - Full specification of `blocklet.yml`: [https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md](https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md)
-- Full document of Blocklet Server & blocklet development: [https://developer.blocklet.io/docs/en](https://developer.blocklet.io/docs/en)
+- Full document of Blocklet Server & blocklet development: [https://www.arcblock.io/docs/blocklet-developer](https://www.arcblock.io/docs/blocklet-developer)
 
 ## License
 

package/templates/express-api/api/hooks/pre-start.js

@@ -25,9 +25,10 @@ const ensureAccountDeclared = async () => {
 (async () => {
   try {
     await ensureAccountDeclared();
+    logger.info(`${name} pre-start successfully`);
     process.exit(0);
   } catch (err) {
-    logger.error(`${name} pre-start error`, err.message);
+    logger.error(`${name} pre-start error`, err);
     process.exit(1);
   }
 })();

package/templates/express-api/api/index.js

@@ -1,22 +1,11 @@
 const express = require('express');
-const env = require('./libs/env');
 
 const app = express();
 
 const port = process.env.BLOCKLET_PORT || process.env.PORT || 3030;
 
 app.get('/', (req, res) => {
-  res.send(`
-<div style="display:flex;flex-direction:column;align-items:center;padding:64px 0;">
-<h1 style="margin:64px 0;">
-  <span style="display:inline-block;padding:8px 24px;background:#1dc1c7;color:#fff;">Blocklet</span>
-  <span style="color:#777;">+ Express</span>
-</h1>
-<pre>
-${JSON.stringify(env, null, 2)}
-</pre>
-</div>
-  `);
+  res.send('Hello Blocklet!');
 });
 
 app.listen(port, () => {

package/templates/express-api/blocklet.yml

@@ -13,7 +13,7 @@ author:
 repository:
   type: git
   url: 'git+https://github.com/blocklet/create-blocklet.git'
-specVersion: 1.1.1
+specVersion: 1.2.8
 version: 0.1.0
 logo: logo.png
 files:

package/templates/express-api/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "express",
+  "name": "template-express-api",
   "version": "0.1.0",
   "description": "",
   "main": "api/index.js",
@@ -8,13 +8,13 @@
     "lint:fix": "npm run lint -- --fix",
     "dev": "blocklet dev",
     "start": "NODE_ENV=development nodemon api/index.js -w api",
-    "clean": "node scripts/build-clean.js",
-    "bundle": "npm run clean && blocklet bundle --zip --create-release",
+    "clean": "node scripts/build-clean.mjs",
+    "bundle": "npm run clean && blocklet bundle --compact --create-release",
     "deploy": "npm run bundle && blocklet deploy .blocklet/bundle",
     "upload": "npm run bundle && blocklet upload .blocklet/release/blocklet.json",
     "deploy:child": "npm run bundle && blocklet deploy .blocklet/bundle --app-did=<%= did %>",
     "dev:child": "blocklet dev --component --app-did=<%= did %>",
-    "prepare": "husky install",
+    "prepare": "npx simple-git-hooks",
     "bump-version": "zx --quiet scripts/bump-version.mjs"
   },
   "lint-staged": {
@@ -31,20 +31,23 @@
   "license": "ISC",
   "dependencies": {
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@blocklet/sdk": "^1.16.20",
-    "@ocap/client": "^1.18.108",
-    "dotenv-flow": "^3.3.0",
-    "express": "^4.18.2"
+    "@blocklet/sdk": "^1.16.28",
+    "@ocap/client": "^1.18.124",
+    "dotenv-flow": "^4.1.0",
+    "express": "^4.19.2"
   },
   "devDependencies": {
-    "@arcblock/eslint-config-base": "^0.2.4",
-    "bumpp": "^8.2.1",
-    "eslint": "^8.56.0",
-    "husky": "^8.0.3",
-    "lint-staged": "^12.5.0",
-    "nodemon": "^3.0.2",
-    "prettier": "^3.1.1",
-    "rimraf": "^3.0.2",
-    "zx": "^7.2.3"
+    "@arcblock/eslint-config-base": "^0.3.2",
+    "bumpp": "^9.4.1",
+    "eslint": "^8.57.0",
+    "lint-staged": "^15.2.7",
+    "nodemon": "^3.1.4",
+    "prettier": "^3.3.2",
+    "rimraf": "^5.0.7",
+    "simple-git-hooks": "^2.11.1",
+    "zx": "^8.1.3"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
   }
 }

package/templates/express-api/template-info.json

@@ -1,11 +1,14 @@
 {
   "name": "express-api",
-  "desc": { "en": "A server-side API application built on Express", "zh": "一个基于 Express 构建的服务端 API 应用" },
+  "desc": {
+    "en": "A server-side API application built on Express",
+    "zh": "一个基于 Express 构建的服务端 API 应用"
+  },
   "displayName": "Express API",
   "blockletType": "dapp",
   "composable": true,
   "framework": "Express",
   "languages": "JavaScript",
   "useCase": "Server Side Application",
-  "author": "ZhangHan"
-}
+  "author": "Blocklet"
+}