create-blocklet 0.4.79 → 0.4.81

package/README.md

@@ -53,6 +53,7 @@ Currently supported template presets include:
 - `html`
 
 **api**
+
 - `express`
 
 ## Community Templates
@@ -74,12 +75,15 @@ npx degit user/blocklet#main my-blocklet
 ```
 
 ## Development
+
 Use `node /pathToCreateBlockletRepo/index.js` to create a blocklet, or you can use
-``` bash
+
+```bash
 ln -s /pathToCreateBlockletRepo/index.js /usr/local/bin/cb
 
 cb
 ```
+
 to create a blocklet
 
 ## Docs

package/index.js

@@ -121,6 +121,8 @@ 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 });
@@ -153,8 +155,7 @@ 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?`,
         },
         {
@@ -176,39 +177,38 @@ async function init() {
         ...(inputTemplateName
           ? []
           : [
-              {
-                type: 'autocompleteMultiselect',
-                name: 'templateNames',
-                message: 'Choose one or more blocklet templates:',
-                choices: templates.map((template) => {
-                  const templateColor = template.color;
+            {
+              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);
                   return {
-                    title: templateColor(template.display),
+                    title: 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);
-                    return {
-                      title: template.display,
-                      value: template.name,
-                    };
-                  }),
-                initial: 1,
-              },
-            ]),
+              initial: 1,
+            },
+          ]),
         {
           type: 'text',
           name: 'authorName',
@@ -267,17 +267,17 @@ async function init() {
   console.log(`\nScaffolding project in ${cyan(root)}`);
 
   const scaffoldSpinner = ora('Creating project...').start();
-  // name 是用户输入的项目名称，当有
+  // name 是用户输入的项目名称
   const name = packageName || targetDir;
 
-  // 如果选中了多个则说明时 monorepo 类型的模板
+  // 如果选中了多个则说明是 monorepo 类型的模板
   if (mainBlocklet) {
     await checkLerna();
     await checkYarn();
     const monorepoDir = path.join(__dirname, 'templates', 'monorepo');
     const monorepoFiles = fs.readdirSync(monorepoDir);
     for (const file of monorepoFiles) {
-      const targetPath = path.join(root, renameFiles[file]||file);
+      const targetPath = path.join(root, renameFiles[file] || file);
       copy(path.join(monorepoDir, file), targetPath);
     }
   }
@@ -285,36 +285,20 @@ 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;
-        }
-        // xmark 相关的模板不添加 .husky
-        if (fuzzyQuery(['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 文件
-      const files = fs.readdirSync(templateDir).filter((file) => file !== '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);
       }
+      if (mainBlocklet) {
+        fs.removeSync(path.join(root, `blocklets/${templateName}`, 'scripts/bump-version.mjs'))
+      }
     })();
 
     modifyPackage(
@@ -385,6 +369,9 @@ async function init() {
             } else if (templateName.includes('static')) {
               pkg.scripts.bundle = ejs.render(pkg.scripts.bundle, { did });
             }
+            if (mainBlocklet) {
+              delete pkg.scripts['bump-version'];
+            }
             // 如果用户选了多个模板，为其他应用配置好 dev:child 和 deploy:child
             if (mainBlocklet && templateName !== mainBlocklet) {
               const mainBlockletDid = toBlockletDid(`${name}-${mainBlocklet}`);
@@ -517,7 +504,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(`make init`));
+        console.log(blue(`npm run init`));
       } else {
         console.log(blue(`${defaultAgent === 'yarn' ? 'yarn' : `${defaultAgent} install`}`));
         console.log(cyan('blocklet dev'));
@@ -548,13 +535,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/lib/utils.js

@@ -1,4 +1,4 @@
-import { fs, path, $, echo, chalk } from 'zx';
+import { fs, path, $, echo, chalk, which } from 'zx';
 
 $.verbose = false;
 
@@ -64,9 +64,18 @@ export function fuzzyQuery(list = [], keyWord = '') {
   return arr.length > 0;
 }
 
+export async function checkCLIInstall(name) {
+  try {
+    await which(name);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
 export async function checkLerna() {
-  const checkResult = await $`type lerna >/dev/null 2>&1 || echo "false"`;
-  if (checkResult.stdout.trim() === 'false') {
+  const learn = await checkCLIInstall('lerna');
+  if (!learn) {
     console.log(`\n ${chalk.cyan('install lerna...')}`);
     const output = await $`npm install -g lerna`;
     echo(output);
@@ -74,8 +83,8 @@ export async function checkLerna() {
 }
 
 export async function checkYarn() {
-  const checkResult = await $`type yarn >/dev/null 2>&1 || echo "false"`;
-  if (checkResult.stdout.trim() === 'false') {
+  const yarn = await checkCLIInstall('yarn');
+  if (!yarn) {
     console.log(`\n ${chalk.cyan('install yarn...')}`);
     const output = await $`npm install -g yarn`;
     echo(output);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-blocklet",
-  "version": "0.4.79",
+  "version": "0.4.81",
   "exports": "./index.js",
   "type": "module",
   "repository": "git@github.com:blocklet/create-blocklet.git",

package/templates/docsite/package.json

@@ -5,16 +5,20 @@
   "scripts": {
     "dev": "blocklet dev",
     "start": "xmark start",
-    "clean": "rm -rf .blocklet && rm -rf node_modules/.vite",
+    "clean": "node scripts/build-clean.js",
     "build": "xmark build",
     "bundle": "npm run clean && xmark build && blocklet bundle --zip --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 %>"
+    "dev:child": "blocklet dev --component --app-did=<%= did %>",
+    "bump-version": "zx scripts/bump-version.mjs"
   },
   "dependencies": {
     "@xmark/cli": "^2.4.83",
-    "@xmark/theme-docs": "^2.4.83"
+    "@xmark/theme-docs": "^2.4.83",
+    "zx": "^7.1.1",
+    "rimraf": "^3.0.2",
+    "bumpp": "^8.2.1"
   }
 }

package/templates/docsite/scripts/build-clean.js

@@ -0,0 +1,6 @@
+const rimraf = require('rimraf');
+
+console.log('clean .blocklet folder && node_modules/.vite');
+rimraf.sync('.blocklet');
+rimraf.sync('node_modules/.vite');
+console.log('clean .blocklet folder  && node_modules/.vite done!');

package/templates/express-api/.editorconfig

@@ -0,0 +1,23 @@
+# For more information about the properties used in
+# this file, please see the EditorConfig documentation:
+# http://editorconfig.org/
+#
+# Sensible EditorConfig defaults
+# https://gist.github.com/matijs/662bf45dd4ec37b3a068
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Make sure package.json always uses 2 spaces to indent
+[{package.json}]
+indent_size = 2
+indent_style = space
+
+[{makefile, Makefile}]
+indent_style = tab

package/templates/express-api/.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  Deploy:
+    runs-on: ubuntu-latest
+
+    if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Set yarn cache
+        uses: c-hive/gha-yarn-cache@v2
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Blocklet workflow
+        uses: blocklet/action-workflow@v1
+        with:
+          skip-upload: false
+          skip-deploy: false
+          bundle-command: yarn bundle
+          store-endpoint: ${{ secrets.STORE_ENDPOINT }}
+          store-access-token: ${{ secrets.STORE_ACCESS_TOKEN }}
+          server-endpoint: ${{ secrets.SERVER_ENDPOINT }}
+          server-access-key: ${{ secrets.SERVER_ACCESS_KEY }}
+          server-access-secret: ${{ secrets.SERVER_ACCESS_SECRET }}
+          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/templates/express-api/.github/workflows/pr-title.yml

@@ -0,0 +1,21 @@
+name: 'Lint PR Title'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+    branches:
+      - main
+      - dev
+      - master
+
+jobs:
+  lint-title:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ArcBlock/action-lint-pull-request-title@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/templates/express-api/.github/workflows/version-check.yml

@@ -0,0 +1,20 @@
+name: 'Version Check'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+    branches:
+      - main
+      - master
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: action-version-check
+        uses: arcblock/action-version-check@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/templates/express-api/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 120,
+  "useTabs": false,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "bracketSameLine": true,
+  "semi": true,
+  "singleQuote": true
+}

package/templates/express-api/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018-2020 ArcBlock
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/templates/express-api/_gitignore

@@ -0,0 +1,28 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+.pnp
+.pnp.js
+.DS_Store
+node_modules
+
+# testing
+coverage
+
+# production
+build
+dist
+dist-ssr
+.blocklet
+
+# local env files
+*.local
+
+# Log files
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*

package/templates/express-api/_npmrc

@@ -0,0 +1,3 @@
+## force pnpm to hoist
+shamefully-hoist=true
+strict-peer-dependencies=false

package/templates/express-api/package.json

@@ -8,13 +8,14 @@
     "lint:fix": "npm run lint -- --fix",
     "dev": "blocklet dev",
     "start": "NODE_ENV=development nodemon api/index.js -w api",
-    "clean": "rm -rf .blocklet",
+    "clean": "node scripts/build-clean.js",
     "bundle": "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",
     "deploy:child": "npm run bundle && blocklet deploy .blocklet/bundle --app-did=<%= did %>",
     "dev:child": "blocklet dev --component --app-did=<%= did %>",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "bump-version": "zx scripts/bump-version.mjs"
   },
   "lint-staged": {
     "*.{mjs,js,ts}": [
@@ -41,6 +42,9 @@
     "husky": "^8.0.1",
     "lint-staged": "^12.5.0",
     "nodemon": "^2.0.20",
-    "prettier": "^2.7.1"
+    "prettier": "^2.7.1",
+    "zx": "^7.1.1",
+    "rimraf": "^3.0.2",
+    "bumpp": "^8.2.1"
   }
 }

package/templates/express-api/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

package/templates/express-api/scripts/bump-version.mjs

@@ -0,0 +1,33 @@
+/* eslint-disable no-console */
+import { execSync } from 'child_process';
+import { $, chalk, fs } from 'zx';
+
+execSync('bumpp --no-tag --no-commit --no-push package.json', { stdio: 'inherit' });
+
+const { version } = await fs.readJSON('package.json');
+
+let newChangelog = '';
+
+try {
+  const gitRes = await $`git log --pretty=format:"- %s" "master"...HEAD`;
+  newChangelog = gitRes.stdout.trim();
+} catch {
+  console.error(chalk.redBright('Could not get git log, please write changelog manually.'));
+}
+
+const now = new Date();
+const currentDate = `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()}`;
+const title = `## ${version} (${currentDate})`;
+
+await fs.ensureFile('CHANGELOG.md');
+const oldChangelog = await fs.readFile('CHANGELOG.md', 'utf8');
+const changelog = [title, newChangelog, oldChangelog].filter((item) => !!item).join('\n\n');
+await fs.writeFile('CHANGELOG.md', changelog);
+
+console.log(`\nNow you can make adjustments to ${chalk.cyan('CHANGELOG.md')}. Then press enter to continue.`);
+
+process.stdin.setRawMode(true);
+process.stdin.resume();
+process.stdin.on('data', process.exit.bind(process, 0));
+
+await fs.writeFileSync('version', version);

package/templates/express-api/version

@@ -0,0 +1 @@
+0.1.0

package/templates/html-static/.editorconfig

@@ -0,0 +1,23 @@
+# For more information about the properties used in
+# this file, please see the EditorConfig documentation:
+# http://editorconfig.org/
+#
+# Sensible EditorConfig defaults
+# https://gist.github.com/matijs/662bf45dd4ec37b3a068
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Make sure package.json always uses 2 spaces to indent
+[{package.json}]
+indent_size = 2
+indent_style = space
+
+[{makefile, Makefile}]
+indent_style = tab

package/templates/html-static/.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  Deploy:
+    runs-on: ubuntu-latest
+
+    if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Set yarn cache
+        uses: c-hive/gha-yarn-cache@v2
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Blocklet workflow
+        uses: blocklet/action-workflow@v1
+        with:
+          skip-upload: false
+          skip-deploy: false
+          bundle-command: yarn bundle
+          store-endpoint: ${{ secrets.STORE_ENDPOINT }}
+          store-access-token: ${{ secrets.STORE_ACCESS_TOKEN }}
+          server-endpoint: ${{ secrets.SERVER_ENDPOINT }}
+          server-access-key: ${{ secrets.SERVER_ACCESS_KEY }}
+          server-access-secret: ${{ secrets.SERVER_ACCESS_SECRET }}
+          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/templates/html-static/.github/workflows/pr-title.yml

@@ -0,0 +1,21 @@
+name: 'Lint PR Title'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+    branches:
+      - main
+      - dev
+      - master
+
+jobs:
+  lint-title:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ArcBlock/action-lint-pull-request-title@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}