@plugin-light/cli 1.0.2

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 novlan1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# 本地发布
+
+<p align="center">
+  <img src="https://img.shields.io/npm/dw/@plugin-light/plugin-light-cli">
+  <img src="https://img.shields.io/npm/unpacked-size/@plugin-light/plugin-light-cli">
+  <img src="https://img.shields.io/npm/v/@plugin-light/plugin-light-cli">
+  <img src="https://img.shields.io/npm/l/@plugin-light/plugin-light-cli">
+  <img src="https://img.shields.io/github/last-commit/novlan1/plugin-light">
+  <img src="https://img.shields.io/github/created-at/novlan1/plugin-light">
+</p>
+
+可以在 `nodejs` 或 `bash` 中使用。
+
+# 如何使用
+
+安装
+
+```bash
+pnpm add @plugin-light/cli -D
+```
+
+在 `nodejs` 中使用
+
+```ts
+const { PUBLISH_SCRIPT: publishUtil } = require('@plugin-light/cli');
+
+publishUtil [prod|test]
+```
+
+在 `bash` 中使用
+
+```bash
+# 工具暴露 light-cli 命令
+npx light-cli publish `[prod|test]`
+```
+
+## 默认值
+
+```ts
+export const DEFAULT_PUBLISH_OPTIONS = {
+  port: '3005',
+  method: 'POST',
+  path: '/web-publish/publish',
+} as const;
+```
+
+## 环境变量
+
+| 变量                         | 对应名称 |
+| ---------------------------- | -------- |
+| VUE_APP_LOCAL_PUBLISH_HOST   | host     |
+| VUE_APP_LOCAL_PUBLISH_PORT   | port     |
+| VUE_APP_LOCAL_PUBLISH_METHOD | method   |
+| VUE_APP_LOCAL_PUBLISH_PATH   | path     |
+
+## 更新日志
+
+[点此查看](./CHANGELOG.md)

package/bin/cli.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+const { program } = require('commander');
+
+const { innerPublish } = require('../lib/index');
+const { version } = require('../package.json');
+
+const VALID_ENV_LIST = ['test', 'prod', 'devcloud'];
+
+program
+  .name('light-cli')
+  .description('CLI for plugin-light')
+  .version(version);
+
+
+program.command('publish')
+  .description('Publish to server with bash script')
+  .option('-e, --env <string>', 'publish environment')
+  .action((options) => {
+    const { env = 'test' } = options;
+    console.log('[env] ', env);
+
+    if (VALID_ENV_LIST.indexOf(env) === -1) {
+      console.error('[publish] failed. env 参数不合法，请检查！');
+      return;
+    }
+
+    innerPublish({
+      publishEnv: env,
+    });
+  });
+
+program.parse();
+
+

package/lib/config.d.ts

@@ -0,0 +1,5 @@
+export declare const DEFAULT_PUBLISH_OPTIONS: {
+    readonly port: "3005";
+    readonly method: "POST";
+    readonly path: "/web-publish/publish";
+};

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { innerPublish } from './publish-inner';
+export declare const PUBLISH_SCRIPT: string;

package/lib/index.js

@@ -0,0 +1,31 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var shared = require('@plugin-light/shared');
+var tComm = require('t-comm');
+
+const DEFAULT_PUBLISH_OPTIONS = {
+    port: '3005',
+    method: 'POST',
+    path: '/web-publish/publish',
+};
+
+function innerPublish({ publishEnv, host, port = DEFAULT_PUBLISH_OPTIONS.port, method = DEFAULT_PUBLISH_OPTIONS.method, path = DEFAULT_PUBLISH_OPTIONS.path, }) {
+    if (!host && publishEnv !== 'devcloud') {
+        console.log('请从环境变量注入 `host`，如 process.env.VUE_APP_LOCAL_PUBLISH_HOST');
+        return;
+    }
+    tComm.localPublish({
+        host,
+        port,
+        method,
+        path,
+        publishEnv,
+    });
+}
+
+const PUBLISH_SCRIPT = shared.getLoaderFile(__dirname);
+
+exports.PUBLISH_SCRIPT = PUBLISH_SCRIPT;
+exports.innerPublish = innerPublish;

package/lib/loader.d.ts

@@ -0,0 +1 @@
+export default function main(): void;

package/lib/loader.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var tComm = require('t-comm');
+
+const DEFAULT_PUBLISH_OPTIONS = {
+    port: '3005',
+    method: 'POST',
+    path: '/web-publish/publish',
+};
+
+function innerPublish({ publishEnv, host, port = DEFAULT_PUBLISH_OPTIONS.port, method = DEFAULT_PUBLISH_OPTIONS.method, path = DEFAULT_PUBLISH_OPTIONS.path, }) {
+    if (!host && publishEnv !== 'devcloud') {
+        console.log('请从环境变量注入 `host`，如 process.env.VUE_APP_LOCAL_PUBLISH_HOST');
+        return;
+    }
+    tComm.localPublish({
+        host,
+        port,
+        method,
+        path,
+        publishEnv,
+    });
+}
+
+function getPublishEnv() {
+    const args = process.argv.slice(2);
+    const publishEnv = args[0];
+    return publishEnv;
+}
+function main() {
+    innerPublish({
+        publishEnv: getPublishEnv(),
+        host: process.env.VUE_APP_LOCAL_PUBLISH_HOST || '',
+        port: process.env.VUE_APP_LOCAL_PUBLISH_PORT || DEFAULT_PUBLISH_OPTIONS.port,
+        method: process.env.VUE_APP_LOCAL_PUBLISH_METHOD || DEFAULT_PUBLISH_OPTIONS.method,
+        path: process.env.VUE_APP_LOCAL_PUBLISH_PATH || DEFAULT_PUBLISH_OPTIONS.path,
+    });
+}
+main();
+
+module.exports = main;

package/lib/loader.prod.js

@@ -0,0 +1 @@
+"use strict";var s=require("t-comm");const o="3005",e="POST",t="/web-publish/publish";function _(){!function({publishEnv:_,host:P,port:p=o,method:h=e,path:c=t}){P||"devcloud"===_?s.localPublish({host:P,port:p,method:h,path:c,publishEnv:_}):console.log("请从环境变量注入 `host`，如 process.env.VUE_APP_LOCAL_PUBLISH_HOST")}({publishEnv:process.argv.slice(2)[0],host:process.env.VUE_APP_LOCAL_PUBLISH_HOST||"",port:process.env.VUE_APP_LOCAL_PUBLISH_PORT||o,method:process.env.VUE_APP_LOCAL_PUBLISH_METHOD||e,path:process.env.VUE_APP_LOCAL_PUBLISH_PATH||t})}_(),module.exports=_;

package/lib/publish-inner.d.ts

@@ -0,0 +1,7 @@
+export declare function innerPublish({ publishEnv, host, port, method, path, }: {
+    publishEnv: string;
+    host: string;
+    port?: string;
+    method?: string;
+    path?: string;
+}): void;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@plugin-light/cli",
+  "version": "1.0.2",
+  "homepage": "https://novlan1.github.io/docs/plugin-light/zh/plugin-light-cli.html",
+  "bugs": {
+    "url": "https://github.com/novlan1/plugin-light/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/novlan1/plugin-light"
+  },
+  "license": "MIT",
+  "author": "novlan1",
+  "main": "./lib/index",
+  "bin": {
+    "light-cli": "./bin/cli.js"
+  },
+  "files": [
+    "script/",
+    "lib/",
+    "bin"
+  ],
+  "dependencies": {
+    "t-comm": "^1.5.40",
+    "@plugin-light/shared": "^1.0.0"
+  },
+  "scripts": {
+    "build": "rm -rf lib && rollup -c",
+    "bump": "node ../../script/monorepo/version-simple $PWD",
+    "changelog": "node ../../script/monorepo/changelog $PWD",
+    "release": "node ../../script/monorepo/release $PWD"
+  }
+}

package/script/docs-demo/helper.js

@@ -0,0 +1,180 @@
+const fs = require('fs');
+const path = require('path');
+
+const { mkDirsSync, getPureCompName, execCommand } = require('t-comm');
+
+const { getActPageDir, COMP_PREFIX, IS_INNER_DOCS } = require('../utils/utils');
+
+let gComponentConfig;
+
+const PATH_MAP = {
+  DOC_PATH: `./${IS_INNER_DOCS ? 'docs/' : ''}docs/components/press`,
+  DOC_EN_PATH: `./${IS_INNER_DOCS ? 'docs/' : ''}docs/en/components/press`,
+  DEMO_PATH: './src/pages/',
+  COMPONENT_DIR: './src/packages',
+};
+
+const FILENAME_MAP = {
+  LOCAL_DOC_NAME: 'README.md',
+  LOCAL_DOC_EN_NAME: 'README.en-US.md',
+  LOCAL_DEMO_NAME: 'demo.vue',
+};
+
+
+/**
+ * 获取组件文件夹
+ */
+function getComps() {
+  const dirs = fs.readdirSync(PATH_MAP.COMPONENT_DIR);
+
+  const comps = dirs
+    .filter((dir) => {
+      const vuePath = path.resolve(PATH_MAP.COMPONENT_DIR, dir, `${dir}.vue`);
+      const vueListPath = path.resolve(PATH_MAP.COMPONENT_DIR, dir, `${dir}-list.vue`);
+      return fs.existsSync(vuePath) || fs.existsSync(vueListPath);
+    })
+    .map(dir => ({
+      path: path.resolve(PATH_MAP.COMPONENT_DIR, dir),
+      name: dir,
+    }));
+  return comps;
+}
+
+/**
+ * 获取组件附近的文档列表
+ */
+function getLocalDocOrDemo(comps, postfix) {
+  const docs = comps
+    .filter((comp) => {
+      const { path: dir } = comp;
+      const readmePath = path.resolve(dir, postfix);
+      return fs.existsSync(readmePath);
+    })
+    .map((comp) => {
+      const { path: dir } = comp;
+      return {
+        ...comp,
+        path: path.resolve(dir, postfix),
+      };
+    });
+  return docs;
+}
+
+/**
+ * 移动文档
+ */
+function moveDocs(cb) {
+  const comps = getComps();
+  const docs = getLocalDocOrDemo(comps, FILENAME_MAP.LOCAL_DOC_NAME);
+  const docsEn = getLocalDocOrDemo(comps, FILENAME_MAP.LOCAL_DOC_EN_NAME);
+  const docsPath =  path.resolve(PATH_MAP.DOC_PATH);
+  const docsEnPath =  path.resolve(PATH_MAP.DOC_EN_PATH);
+
+  execCommand(`rm -rf ${docsPath}`, process.cwd(), 'inherit');
+  console.log(`>>> 已删除：${docsPath}`);
+  execCommand(`rm -rf ${docsEnPath}`, process.cwd(), 'inherit');
+  console.log(`>>> 已删除：${docsEnPath}\n`);
+
+
+  console.log(`>> 共有${docs.length}个组件文档`);
+  console.log(`>> 共有${docsEn.length}个英文组件文档\n`);
+
+  for (const doc of docs) {
+    const { path: dir, name } = doc;
+    const data = fs.readFileSync(dir, {
+      encoding: 'utf-8',
+    });
+
+    writeCompDoc(data, name, PATH_MAP.DOC_PATH);
+  }
+  for (const doc of docsEn) {
+    const { path: dir, name } = doc;
+    const data = fs.readFileSync(dir, {
+      encoding: 'utf-8',
+    });
+
+    writeCompDoc(data, name, PATH_MAP.DOC_EN_PATH);
+  }
+
+  if (typeof cb === 'function') {
+    cb();
+  }
+}
+
+
+/**
+ * 将文档写入docs目录
+ */
+function writeCompDoc(data, name, docPath) {
+  console.log(`>> 正在写入 ${name} 文档...`);
+  if (!fs.existsSync(docPath)) {
+    mkDirsSync(docPath);
+  }
+  fs.writeFileSync(path.resolve(docPath, `${name}.md`), data, {
+    encoding: 'utf-8',
+  });
+}
+
+
+/**
+ * 将demo写入pages目录
+ */
+function writeCompDemo(data, name) {
+  const pureName = getPureCompName(name, COMP_PREFIX);
+  const demoPath = `${PATH_MAP.DEMO_PATH}${getActPageDir(pureName, gComponentConfig)}`;
+
+  console.log(`>> 正在写入 ${pureName} demo...`);
+  if (!fs.existsSync(demoPath)) {
+    mkDirsSync(demoPath);
+  }
+  const dir = path.resolve(
+    demoPath,
+    pureName,
+  );
+
+  if (!fs.existsSync(dir)) {
+    mkDirsSync(dir);
+  }
+  fs.writeFileSync(path.resolve(dir, `${pureName}.vue`), data, {
+    encoding: 'utf-8',
+  });
+}
+
+
+function moveDemo(cb, config, options) {
+  if (Array.isArray(options?.toDeleteDirs)) {
+    options.toDeleteDirs.forEach((dir) => {
+      console.log(`>>> 已删除：${dir}\n`);
+      execCommand(`rm -rf ${dir}`, process.cwd(), 'inherit');
+    });
+  }
+  const comps = getComps();
+  const demos = getLocalDocOrDemo(comps, FILENAME_MAP.LOCAL_DEMO_NAME);
+
+  console.log(`>> 共有${demos.length}个组件demo\n`);
+
+  if (config) {
+    gComponentConfig = config;
+  }
+
+  for (const doc of demos) {
+    const { path: dir, name } = doc;
+    const data = fs.readFileSync(dir, {
+      encoding: 'utf-8',
+    });
+
+    writeCompDemo(data, name);
+  }
+
+  if (typeof cb === 'function') {
+    cb();
+  }
+}
+
+
+module.exports = {
+  moveDocs,
+  moveDemo,
+};
+
+

package/script/docs-demo/watch.js

@@ -0,0 +1,10 @@
+const gulp = require('gulp');
+
+function watchPackages(cb) {
+  gulp.watch('./src/packages/**/*', gulp.series(cb));
+  console.log('[GULP] 正在监听 packages 文件夹...');
+}
+
+module.exports = {
+  watchPackages,
+};

package/script/generate-component-config/1.docs-sidebar.js

@@ -0,0 +1,48 @@
+const path = require('path');
+
+const { mkDirsSync, hyphenate } = require('t-comm');
+
+const { PATH_MAP, saveJsonToFile } = require('./helper');
+
+
+function writeDocSidebar(componentConfig) {
+  const sidebarConfig = getSidebarConfig(false, componentConfig);
+  const sidebarEnConfig = getSidebarConfig(true, componentConfig);
+
+  mkDirsSync(path.dirname(PATH_MAP.DOC_SIDE_BAR_CONFIG));
+  saveJsonToFile(PATH_MAP.DOC_SIDE_BAR_CONFIG, sidebarConfig);
+  saveJsonToFile(PATH_MAP.DOC_SIDE_BAR_EN_CONFIG, sidebarEnConfig);
+}
+
+
+function getSidebarConfig(isEn, componentConfig) {
+  const keys = Object.keys(componentConfig);
+  const list = keys
+    .map((key) => {
+      const value = componentConfig[key];
+      const { title, name, list } = value;
+
+      const newList = list.map(item => (isEn ? {
+        title: item.name,
+        path: `/en/components/press/press-${hyphenate(item.name)}.md`,
+      } : {
+        title: item.name,
+        subTitle: item.title,
+        path: `/components/press/press-${hyphenate(item.name)}.md`,
+      }));
+
+      return {
+        title: isEn ? name : title,
+        collapsable: false,
+        children: newList,
+      };
+    })
+    .filter(item => item.children.length);
+
+  return { sidebar: list };
+}
+
+
+module.exports = {
+  writeDocSidebar,
+};

package/script/generate-component-config/2.demo-index.js

@@ -0,0 +1,56 @@
+const {
+  DEMO_DIR_MAP,
+} = require('../utils/utils');
+
+const {
+  hyphenate,
+} = require('./generate-entry');
+const { PATH_MAP, saveJsonToFile } = require('./helper');
+
+
+function writeDemoIndexConfig(componentConfig) {
+  const pages = getCompDemoPages(componentConfig);
+  saveJsonToFile(PATH_MAP.DEMO_INDEX_CONFIG, pages);
+}
+
+
+function getCompDemoPages(componentConfig) {
+  const list = Object.keys(componentConfig)
+    .map((key) => {
+      const value = componentConfig[key];
+      const { name, list, showInMP } = value;
+      const newList = list.map(item => ({
+        // name: `${item.name} ${item.title}`,
+        url: getCompUrl(item),
+        navigationStyle: item?.style?.navigationStyle || '',
+        showInMP: showInMP === false || item.showInMP === false ? false : undefined,
+      }));
+
+      return {
+        name,
+        list: newList,
+      };
+    })
+    .filter(item => item.list.length);
+
+
+  return { pages: list };
+}
+
+
+function getCompUrl(comp) {
+  const { name, demoRedirect, subPackage = DEMO_DIR_MAP.PRESS } = comp;
+
+  const demoName = demoRedirect || name;
+  const newName = hyphenate(demoName);
+  const prefix = subPackage;
+  const corePage = `/${prefix}/${newName}/${newName}`;
+  if (demoRedirect) {
+    return `${corePage}?comp=${hyphenate(name)}`;
+  }
+  return corePage;
+}
+
+module.exports = {
+  writeDemoIndexConfig,
+};

package/script/generate-component-config/3.demo-pages.js

@@ -0,0 +1,78 @@
+const fs = require('fs');
+const path = require('path');
+
+const { getPagesJsonCondition } = require('t-comm');
+
+const {
+  DEMO_DIR_MAP,
+} = require('../utils/utils');
+
+const {
+  hyphenate,
+} = require('./generate-entry');
+const { PATH_MAP } = require('./helper');
+
+
+function writeDemoPagesJson(componentConfig, needAct = false) {
+  const pagesJsonConfig = getPagesJsonConfig(componentConfig, needAct);
+  const configPath = path.resolve(process.cwd(), PATH_MAP.DEMO_PAGES_JSON);
+  const data = fs.readFileSync(configPath, {
+    encoding: 'utf-8',
+  });
+  const condition = getPagesJsonCondition(componentConfig);
+  const newData = data
+    .replace(/"subPackages":\s*\[[\s\S]+(?="preloadRule)/m, `"subPackages": ${JSON.stringify(pagesJsonConfig, null, 2)},
+  `)
+    .replace(/"condition":\s*\{[\s\S]+\]\s*\}/, `"condition": ${JSON.stringify(condition, null, 4)}`);
+
+
+  fs.writeFileSync(configPath, newData, {
+    encoding: 'utf-8',
+  });
+}
+
+
+function getPagesJsonConfig(componentConfig) {
+  let list = [];
+  list = Object.values(DEMO_DIR_MAP).map(type => ({
+    root: `pages/${type}`,
+    pages: getPagesJsonPages(componentConfig, type),
+  }));
+
+  list = list.filter(item => item.pages.length);
+
+
+  return list;
+}
+
+
+function getPagesJsonPages(config, subPackage) {
+  const list = Object.values(config)
+    .map((item) => {
+      const { list = [] } = item;
+      const newList = list
+        .filter(item => !item.demoRedirect)
+        .filter(item => (item.subPackage || DEMO_DIR_MAP.PRESS) === subPackage)
+        .map((item) => {
+          const hyphenatedName = hyphenate(item.name);
+
+          return {
+            path: `${hyphenatedName}/${hyphenatedName}`,
+            style: {
+              ...(item.style || {}),
+              navigationBarTitleText: '',
+            },
+          };
+        });
+
+      return newList;
+    })
+    .flat();
+
+  return list;
+}
+
+
+module.exports = {
+  writeDemoPagesJson,
+};

package/script/generate-component-config/4.demo-title.js

@@ -0,0 +1,41 @@
+
+const {
+  hyphenate,
+} = require('./generate-entry');
+const { PATH_MAP, saveJsonToFile } = require('./helper');
+
+
+function getTitleI18nConfig(componentConfig) {
+  const res = {
+    'zh-CN': {},
+    'en-US': {},
+  };
+  Object.keys(componentConfig)
+    .forEach((key) => {
+      const value = componentConfig[key];
+      const { list, name, title } = value;
+
+      res['zh-CN'][name] = title;
+      res['en-US'][name] = name;
+
+      list.forEach((item) => {
+        const hyphenatedName = hyphenate(item.name);
+        res['zh-CN'][hyphenatedName] = `${item.name} ${item.title}`;
+        res['en-US'][hyphenatedName] = `${item.name}`;
+      });
+    });
+
+  return res;
+}
+
+
+function writeDemoTitleI18n(componentConfig) {
+  const title = getTitleI18nConfig(componentConfig);
+
+  saveJsonToFile(PATH_MAP.DEMO_I18N, title);
+}
+
+
+module.exports = {
+  writeDemoTitleI18n,
+};

package/script/generate-component-config/5.build-config.js

@@ -0,0 +1,34 @@
+
+const {
+  hyphenate,
+  getComponentPath,
+} = require('./generate-entry');
+const { PATH_MAP, saveJsonToFile } = require('./helper');
+
+
+function getBuildConfigJson(componentConfig) {
+  const res = {};
+  Object.keys(componentConfig)
+    .forEach((key) => {
+      const value = componentConfig[key];
+      const { list } = value;
+
+
+      list.forEach((item) => {
+        const hyphenatedName = hyphenate(item.name);
+        const compPath = getComponentPath(hyphenatedName);
+        res[hyphenatedName] = `./src/packages/press-${hyphenatedName}/press-${compPath}.vue`;
+      });
+    });
+  return res;
+}
+
+
+function writeBuildConfig(componentConfig) {
+  const json = getBuildConfigJson(componentConfig);
+  saveJsonToFile(PATH_MAP.BUILD_CONFIG, json);
+}
+
+module.exports = {
+  writeBuildConfig,
+};