create-blocklet 0.4.81 → 0.5.1

package/README.md

@@ -34,8 +34,8 @@ Currently supported template presets include:
 **dapp**
 
 - `react`
-- `vue3 + vite`
-- `vue2 + @vue/cli`
+- `vue3`
+- `vue2`
 - `solid-js`
 - `svelte`
 - `next.js`
@@ -44,8 +44,8 @@ Currently supported template presets include:
 **static**
 
 - `react`
-- `vue3 + vite`
-- `vue2 + @vue/cli`
+- `vue3`
+- `vue2`
 - `solid-js`
 - `svelte`
 - `website powered by blocklet pages`

package/{templates/docsite → common}/scripts/bump-version.mjs

@@ -5,11 +5,15 @@ import { $, chalk, fs } from 'zx';
 execSync('bumpp --no-tag --no-commit --no-push package.json', { stdio: 'inherit' });
 
 const { version } = await fs.readJSON('package.json');
+await fs.writeFileSync('version', version);
 
-let newChangelog = '';
+console.log(chalk.greenBright(`[info]: start to modify blocklet version to ${version}`));
+await $`blocklet version ${version}`;
+console.log(chalk.greenBright('[info]: blocklet version modified.'));
 
+let newChangelog = '';
 try {
-  const gitRes = await $`git log --pretty=format:"- %s" "master"...HEAD`;
+  const gitRes = await $`git log --pretty=format:"- %s" "main"...HEAD`;
   newChangelog = gitRes.stdout.trim();
 } catch {
   console.error(chalk.redBright('Could not get git log, please write changelog manually.'));
@@ -29,5 +33,3 @@ console.log(`\nNow you can make adjustments to ${chalk.cyan('CHANGELOG.md')}. Th
 process.stdin.setRawMode(true);
 process.stdin.resume();
 process.stdin.on('data', process.exit.bind(process, 0));
-
-await fs.writeFileSync('version', version);

package/index.js

@@ -8,7 +8,6 @@ import { cd, argv, fs, YAML, chalk, path } from 'zx';
 import ora from 'ora';
 import prompts from 'prompts';
 import * as envfile from 'envfile';
-import getPort from 'get-port';
 
 import { echoBrand, echoDocument } from './lib/arcblock.js';
 import { getUser } from './lib/index.js';
@@ -63,11 +62,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,
+  // },
   {
     name: 'react-static',
     display: '[static] react',
@@ -80,12 +80,12 @@ const templates = [
   },
   {
     name: 'vue-static',
-    display: '[static] vue3 + vite',
+    display: '[static] vue3',
     color: green,
   },
   {
     name: 'vue2-static',
-    display: '[static] vue2 + @vue/cli',
+    display: '[static] vue2',
     color: green,
   },
   {
@@ -121,8 +121,6 @@ const renameFiles = {
   _npmrc: '.npmrc',
 };
 
-const excludeFiles = ['.github', '.husky', '.vscode', '.editorconfig', '_gitignore', '_npmrc', 'version']
-
 async function init() {
   const { version } = await fs.readJSONSync(path.resolve(__dirname, 'package.json'));
   await echoBrand({ version });
@@ -155,7 +153,8 @@ async function init() {
           type: () => (!fs.existsSync(targetDir) || isEmpty(targetDir) ? null : 'confirm'),
           name: 'overwrite',
           message: () =>
-            `${targetDir === '.' ? 'Current directory' : `Target directory "${targetDir}"`
+            `${
+              targetDir === '.' ? 'Current directory' : `Target directory "${targetDir}"`
             } is not empty. Remove existing files and continue?`,
         },
         {
@@ -177,38 +176,38 @@ async function init() {
         ...(inputTemplateName
           ? []
           : [
-            {
-              type: 'autocompleteMultiselect',
-              name: 'templateNames',
-              message: 'Choose one or more blocklet templates:',
-              choices: templates.map((template) => {
-                const templateColor = template.color;
-                return {
-                  title: templateColor(template.display),
-                  value: template.name,
-                };
-              }),
-              min: 1,
-              suggest: (input, choices) => Promise.resolve(choices.filter((i) => i.title.includes(input))),
-            },
-            {
-              type: (templateNames = []) => {
-                return templateNames.length > 1 ? 'select' : null;
-              },
-              name: 'mainBlocklet',
-              message: 'Please choose the main blocklet',
-              //
-              choices: (templateNames = []) =>
-                templateNames.map((templateName) => {
-                  const template = templates.find((x) => x.name === templateName);
+              {
+                type: 'autocompleteMultiselect',
+                name: 'templateNames',
+                message: 'Choose one or more blocklet templates:',
+                choices: templates.map((template) => {
+                  const templateColor = template.color;
                   return {
-                    title: template.display,
+                    title: templateColor(template.display),
                     value: template.name,
                   };
                 }),
-              initial: 1,
-            },
-          ]),
+                min: 1,
+                suggest: (input, choices) => Promise.resolve(choices.filter((i) => i.title.includes(input))),
+              },
+              {
+                type: (templateNames = []) => {
+                  return templateNames.length > 1 ? 'select' : null;
+                },
+                name: 'mainBlocklet',
+                message: 'Please choose the main blocklet',
+                //
+                choices: (templateNames = []) =>
+                  templateNames.map((templateName) => {
+                    const template = templates.find((x) => x.name === templateName);
+                    return {
+                      title: template.display,
+                      value: template.name,
+                    };
+                  }),
+                initial: 1,
+              },
+            ]),
         {
           type: 'text',
           name: 'authorName',
@@ -285,19 +284,38 @@ async function init() {
   for (const templateName of templateNames) {
     const templateDir = path.join(__dirname, `templates/${templateName}`);
     const finalTemplateName = `${name}-${templateName}`;
+    // TODO: 需要把 common file copy 的逻辑移除，不同的 template 之间的差异越来越多，就会需要越来越多特殊处理的代码，违背了初衷，移除这部分逻辑可能是更好的选择
+    // copy common files
+    (() => {
+      const commonDir = path.join(__dirname, 'common');
+      const commonFiles = fs.readdirSync(commonDir);
+      for (const file of commonFiles) {
+        // 如果选择多个模板，每个子 package 中 只会包含必要的 文件
+        if (mainBlocklet && !['screenshots', 'public', 'logo.png', '.prettierrc', 'LICENSE'].includes(file)) {
+          continue;
+        }
+        // html-staic 和 xmark 相关的模板不添加 .husky
+        if (fuzzyQuery(['html-static', 'website', 'docsite'], templateName) && ['.husky'].includes(file)) {
+          // eslint-disable-next-line no-continue
+          continue;
+        }
+        const targetPath = renameFiles[file]
+          ? path.join(root, mainBlocklet ? `blocklets/${templateName}` : '', renameFiles[file])
+          : path.join(root, mainBlocklet ? `blocklets/${templateName}` : '', file);
+
+        copy(path.join(commonDir, file), targetPath);
+      }
+    })();
     // copy template files
     (() => {
       // 过滤掉 template-info.json 文件
       let files = fs.readdirSync(templateDir).filter((file) => file !== 'template-info.json');
-      // 如果选择了多个模板，每个子 package 中应该过滤掉一些文件
-      if (mainBlocklet) {
-        files = files.filter((file) => !fuzzyQuery(excludeFiles, file));
-      }
       for (const file of files) {
         write(file, null, templateDir, templateName);
       }
+      // 如果选择了多个模板，每个子 package 中的 bump-version.mjs 文件
       if (mainBlocklet) {
-        fs.removeSync(path.join(root, `blocklets/${templateName}`, 'scripts/bump-version.mjs'))
+        fs.removeSync(path.join(root, `blocklets/${templateName}`, 'scripts/bump-version.mjs'));
       }
     })();
 
@@ -317,30 +335,6 @@ async function init() {
       templateName
     );
 
-    let randomPort;
-    if (fuzzyQuery(['dapp'], templateName)) {
-      randomPort = await getPort();
-    }
-    modifyEnv(
-      (env) => {
-        if (randomPort) {
-          env.API_PORT = randomPort;
-        }
-        if (!fuzzyQuery(['website'], templateName)) {
-          if (fuzzyQuery(['react'], templateName)) {
-            env.REACT_APP_TITLE = finalTemplateName;
-          } else if (fuzzyQuery(['vue', 'website'], templateName)) {
-            env.VITE_APP_TITLE = finalTemplateName;
-          } else {
-            env.APP_TITLE = finalTemplateName;
-          }
-        }
-        return env;
-      },
-      templateDir,
-      templateName
-    );
-
     // patch blocklet author
     modifyBlockletYaml(
       async (yamlConfig) => {
@@ -535,13 +529,13 @@ 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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-blocklet",
-  "version": "0.4.81",
+  "version": "0.5.1",
   "exports": "./index.js",
   "type": "module",
   "repository": "git@github.com:blocklet/create-blocklet.git",
@@ -29,14 +29,13 @@
     "test:run": "vitest run"
   },
   "dependencies": {
-    "@arcblock/did": "^1.17.23",
-    "@ocap/mcrypto": "^1.17.23",
-    "@ocap/util": "^1.17.23",
+    "@arcblock/did": "^1.18.6",
+    "@ocap/mcrypto": "^1.18.6",
+    "@ocap/util": "^1.18.6",
     "boxen": "^6.2.1",
     "ejs": "^3.1.8",
     "envfile": "^6.18.0",
     "figlet": "^1.5.2",
-    "get-port": "^6.1.2",
     "gradient-string": "^2.0.2",
     "jdenticon": "^3.2.0",
     "ora": "^6.1.2",
@@ -47,7 +46,7 @@
   },
   "devDependencies": {
     "@arcblock/eslint-config-base": "0.2.2",
-    "eslint": "^8.25.0",
+    "eslint": "^8.26.0",
     "prettier": "^2.7.1",
     "vitest": "^0.19.1"
   }

package/templates/docsite/package.json

@@ -15,10 +15,10 @@
     "bump-version": "zx scripts/bump-version.mjs"
   },
   "dependencies": {
-    "@xmark/cli": "^2.4.83",
-    "@xmark/theme-docs": "^2.4.83",
-    "zx": "^7.1.1",
+    "@xmark/cli": "^2.4.85",
+    "@xmark/theme-docs": "^2.4.85",
+    "bumpp": "^8.2.1",
     "rimraf": "^3.0.2",
-    "bumpp": "^8.2.1"
+    "zx": "^7.1.1"
   }
 }

package/templates/express-api/package.json

@@ -31,20 +31,20 @@
   "license": "ISC",
   "dependencies": {
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@blocklet/sdk": "^1.8.30",
-    "@ocap/client": "^1.17.23",
+    "@blocklet/sdk": "^1.8.33",
+    "@ocap/client": "^1.18.6",
     "dotenv-flow": "^3.2.0",
     "express": "^4.18.2"
   },
   "devDependencies": {
     "@arcblock/eslint-config-base": "^0.2.3",
-    "eslint": "^8.25.0",
+    "bumpp": "^8.2.1",
+    "eslint": "^8.26.0",
     "husky": "^8.0.1",
     "lint-staged": "^12.5.0",
     "nodemon": "^2.0.20",
     "prettier": "^2.7.1",
-    "zx": "^7.1.1",
     "rimraf": "^3.0.2",
-    "bumpp": "^8.2.1"
+    "zx": "^7.1.1"
   }
 }

package/templates/html-static/package.json

@@ -5,7 +5,7 @@
     "dev": "blocklet dev",
     "clean": "node scripts/build-clean.js",
     "bundle": "npm run clean && blocklet bundle --zip --create-release",
-    "deploy": "npm run bundle && blocklet deploy .blocklet/bundle --skip-hooks",
+    "deploy": "npm run bundle && blocklet deploy .blocklet/bundle",
     "deploy:child": "npm run bundle && blocklet deploy .blocklet/bundle --app-did=<%= did %>",
     "dev:child": "blocklet dev --component --app-did=<%= did %>",
     "upload": "npm run bundle && blocklet upload .blocklet/release/blocklet.json",
@@ -15,8 +15,8 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "zx": "^7.1.1",
+    "bumpp": "^8.2.1",
     "rimraf": "^3.0.2",
-    "bumpp": "^8.2.1"
+    "zx": "^7.1.1"
   }
 }

package/templates/monorepo/package.json

@@ -30,4 +30,4 @@
     "prettier": "^2.7.1",
     "zx": "^7.1.1"
   }
-}
+}

package/templates/monorepo/scripts/bump-version.mjs

@@ -1,27 +1,25 @@
 /* eslint-disable no-console */
 import { execSync } from 'child_process';
-import { $, chalk, fs, path, YAML } from 'zx';
+import { $, chalk, fs, path } from 'zx';
+
+const cwd = process.cwd(); // 获取脚本执行目录
 
 // or use pnpm to bump version: `pnpm -r --filter {packages/*, themes/*} -- pnpm version`
 execSync('bumpp package.json blocklets/*/package.json', { stdio: 'inherit' });
 
 const { version } = await fs.readJSON('package.json');
+await fs.writeFileSync('version', version);
 
-(async () => {
-  console.log(chalk.greenBright(`[info]: start to modify blocklets version to ${version}`));
-  const dirPath = path.join(__dirname, '../blocklets');
-  let pathList = await fs.readdirSync(dirPath);
-  pathList = pathList.map((item) => `${dirPath}/${item}/blocklet.yml`);
-  for (const ymlPath of pathList) {
-    const blockletYaml = await fs.readFileSync(ymlPath, 'utf8');
-    const yamlConfig = YAML.parse(blockletYaml);
-    yamlConfig.version = version;
-    fs.writeFileSync(ymlPath, YAML.stringify(yamlConfig, 2));
-  }
-  console.log(chalk.greenBright('[info]: all blocklets version modified.'));
-})();
+console.log(chalk.greenBright(`[info]: start to modify blocklets version to ${version}`));
+const dirPath = path.join(__dirname, '../blocklets');
+let pathList = await fs.readdirSync(dirPath);
+pathList = pathList.map((item) => `${dirPath}/${item}`);
+for (const ymlDir of pathList) {
+  await $`cd ${ymlDir} && blocklet version ${version}`;
+}
+console.log(chalk.greenBright('[info]: all blocklets version modified.'));
 
-console.log(`\nNow you can make adjustments to ${chalk.cyan('CHANGELOG.md')}. Then press enter to continue.`);
+await $`cd ${cwd}`;
 
 let newChangelog = '';
 
@@ -47,5 +45,3 @@ console.log(`\nNow you can make adjustments to ${chalk.cyan('CHANGELOG.md')}. Th
 process.stdin.setRawMode(true);
 process.stdin.resume();
 process.stdin.on('data', process.exit.bind(process, 0));
-
-await fs.writeFileSync('version', version);

package/templates/nextjs-dapp/package.json

@@ -28,12 +28,12 @@
     ]
   },
   "dependencies": {
-    "@arcblock/did-auth": "^1.17.23",
+    "@arcblock/did-auth": "^1.18.6",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@blocklet/sdk": "^1.8.30",
-    "@ocap/client": "^1.17.23",
-    "@ocap/mcrypto": "^1.17.23",
-    "@ocap/wallet": "^1.17.23",
+    "@blocklet/sdk": "^1.8.33",
+    "@ocap/client": "^1.18.6",
+    "@ocap/mcrypto": "^1.18.6",
+    "@ocap/wallet": "^1.18.6",
     "dotenv-flow": "^3.2.0",
     "express": "^4.18.2",
     "next": "12.2.3",
@@ -41,14 +41,14 @@
     "react-dom": "18.2.0"
   },
   "devDependencies": {
+    "bumpp": "^8.2.1",
     "eslint": "8.20.0",
     "eslint-config-next": "12.2.3",
     "husky": "^8.0.1",
     "lint-staged": "^12.5.0",
     "nodemon": "^2.0.20",
     "npm-run-all": "^4.1.5",
-    "zx": "^7.1.1",
     "rimraf": "^3.0.2",
-    "bumpp": "^8.2.1"
+    "zx": "^7.1.1"
   }
 }

package/templates/react-dapp/api/dev.js

@@ -0,0 +1,4 @@
+const { setupClient } = require('vite-plugin-blocklet');
+const { server, app } = require('./index');
+
+setupClient(app, server);

package/templates/react-dapp/api/index.js

@@ -16,36 +16,34 @@ app.set('trust proxy', true);
 app.use(cookieParser());
 app.use(express.json({ limit: '1 mb' }));
 app.use(express.urlencoded({ extended: true, limit: '1 mb' }));
+app.use(cors());
 
 const router = express.Router();
 router.use('/api', require('./routes'));
+app.use(router);
 
-const isDevelopment = process.env.NODE_ENV === 'development';
 const isProduction = process.env.NODE_ENV === 'production' || process.env.ABT_NODE_SERVICE_ENV === 'production';
 
 if (isProduction) {
-  app.use(cors());
+  const staticDir = path.resolve(__dirname, '../dist');
   app.use(compression());
-
-  const staticDir = path.resolve(process.env.BLOCKLET_APP_DIR, 'dist');
   app.use(express.static(staticDir, { maxAge: '30d', index: false }));
-  app.use(router);
   app.use(fallback('index.html', { root: staticDir }));
 
-  app.use((req, res) => {
-    res.status(404).send('404 NOT FOUND');
-  });
   app.use((err, req, res) => {
     logger.error(err.stack);
     res.status(500).send('Something broke!');
   });
-} else {
-  app.use(router);
 }
 
-const port = (isDevelopment ? parseInt(process.env.API_PORT, 10) : parseInt(process.env.BLOCKLET_PORT, 10)) || 3030;
+const port = parseInt(process.env.BLOCKLET_PORT, 10);
 
-app.listen(port, (err) => {
+const server = app.listen(port, (err) => {
   if (err) throw err;
   logger.info(`> ${name} v${version} ready on ${port}`);
 });
+
+module.exports = {
+  app,
+  server,
+};

package/templates/react-dapp/index.html

@@ -6,7 +6,6 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" />
     <meta name="theme-color" content="#4F6AF5" />
     <meta name="description" content="Web site created using create-blocklet" />
-    <title><%- title %></title>
   </head>
   <body>
     <noscript> You need to enable JavaScript to run this app. </noscript>

package/templates/react-dapp/package.json

@@ -6,9 +6,7 @@
     "eject": "vite eject",
     "lint": "eslint src api --ext .mjs,.js,.jsx,.ts,.tsx",
     "lint:fix": "npm run lint -- --fix",
-    "start": "npm-run-all --parallel start:*",
-    "start:client": "vite --host",
-    "start:api": "cross-env NODE_ENV=development nodemon api/index.js -w api",
+    "start": "cross-env NODE_ENV=development nodemon api/dev.js -w api",
     "clean": "node scripts/build-clean.js",
     "bundle": "npm run bundle:client && npm run bundle:api",
     "bundle:client": "vite build",
@@ -42,12 +40,12 @@
     ]
   },
   "dependencies": {
-    "@arcblock/did-auth": "^1.17.23",
+    "@arcblock/did-auth": "^1.18.6",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@blocklet/sdk": "^1.8.30",
-    "@ocap/client": "^1.17.23",
-    "@ocap/mcrypto": "^1.17.23",
-    "@ocap/wallet": "^1.17.23",
+    "@blocklet/sdk": "^1.8.33",
+    "@ocap/client": "^1.18.6",
+    "@ocap/mcrypto": "^1.18.6",
+    "@ocap/wallet": "^1.18.6",
     "axios": "^0.27.2",
     "compression": "^1.7.4",
     "cookie-parser": "^1.4.6",
@@ -58,24 +56,23 @@
     "express-history-api-fallback": "^2.2.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-router-dom": "^6.4.2",
+    "react-router-dom": "^6.4.3",
     "rimraf": "^3.0.2"
   },
   "devDependencies": {
     "@arcblock/eslint-config": "^0.2.3",
-    "@vitejs/plugin-react": "^2.1.0",
+    "@vitejs/plugin-react": "^2.2.0",
     "bumpp": "^8.2.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.25.0",
+    "eslint": "^8.26.0",
     "husky": "^8.0.1",
     "lint-staged": "^12.5.0",
     "node-polyfill-webpack-plugin": "^2.0.1",
     "nodemon": "^2.0.20",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.7.1",
-    "vite": "^3.1.8",
-    "vite-plugin-blocklet": "^0.4.81",
-    "vite-plugin-html": "^3.2.0",
+    "vite": "^3.2.2",
+    "vite-plugin-blocklet": "^0.5.1",
     "vite-plugin-svgr": "^2.2.2",
     "zx": "^7.1.1"
   }

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

@@ -1,36 +1,11 @@
-import { defineConfig, loadEnv } from 'vite';
+import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
-import { createHtmlPlugin } from 'vite-plugin-html';
 import { createBlockletPlugin } from 'vite-plugin-blocklet';
 import svgr from 'vite-plugin-svgr';
 
 // https://vitejs.dev/config/
-export default defineConfig(async ({ mode }) => {
-  const envMap = loadEnv(mode, process.cwd(), '');
-  const apiPort = envMap.API_PORT || 3030;
-  const apiPrefix = `${process.env.BLOCKLET_DEV_MOUNT_POINT || ''}/api`;
-
+export default defineConfig(() => {
   return {
-    plugins: [
-      react(),
-      createHtmlPlugin({
-        minify: true,
-        inject: {
-          data: {
-            title: envMap.APP_TITLE,
-          },
-        },
-      }),
-      createBlockletPlugin(),
-      svgr(),
-    ],
-    server: {
-      proxy: {
-        [apiPrefix]: {
-          target: `http://127.0.0.1:${apiPort}`,
-          rewrite: (path) => path.replace(apiPrefix, '/api'), // rewrite path when blocklet dev
-        },
-      },
-    },
+    plugins: [react(), createBlockletPlugin(), svgr()],
   };
 });

package/templates/react-gun-dapp/api/dev.js

@@ -0,0 +1,4 @@
+const { setupClient } = require('vite-plugin-blocklet');
+const { server, app } = require('./index');
+
+setupClient(app, server);