overload-cli v1.0.1

overload-cli

一个生成骨架屏的 cli

快速开始

sudo npm install -g puppeteer --unsafe-perm=true
sudo npm install -g overload-cli

sudo overload-cli start skeleton.config.js

About skeleton.config.js

interface SkeletonConfigRoute {
  path: string; // 页面路径
  query?: { [props: string]: string }; // 访问当前页面需要拼接的页面参数
  clip?: { // skeleton 生成时的截取视口
    x: number;
    y: number;
    width: number;
    height: number;
  };
  cookies?: SkeletonConfigCookie[]; // 访问当前页面需要带的 cookie
  excludes?: string[]; // 生成 skeleton 时，页面上需要过滤（不显示在 skeleton 中）的元素（填 className）
  focusTag?: { // 生成 skeleton 时，页面上部分需要强行使用其他元素的转化模式的元素（ex：<p> 标签实现了 <button> 的样式，正常情况下 cli 只会识别它为文本，并转化为文本的样式，这时就需要把当前 <p> 元素的 className 填入下述 singleBlock 的数组中，来生成正确的 <button> 样式的 skeleton）
    singleBlock?: string[];
  };
}

interface SkeletonConfig {
  isMobile?: boolean; // true 表示 h5 端，false 表示 pc 端（默认为 true）
  rootID: string; // 需要生成的根结点 id
  originUrl: string; // 应用根地址
  routes: SkeletonConfigRoute[]; // 应用的不同页面规则 
  routeMode?: 'hash' | 'history'; // 应用路由模式，默认 hash
}

const skeletonConfig: SkeletonConfig = {};
module.exports = skeletonConfig;

config 示例

module.exports = {
  isMobile: true,
  rootID: 'root',
  originUrl: 'https://a.com/test/dist/',
  routeMode: 'hash',
  routes: [
    {
      path: '/about',
      query: { im: 'about' },
    },
    {
      path: '/home',
      query: { im: 'home' },
      cookies: [
        { name: 'uid', value: '1234', domain: 'a.com' },
      ],
    }
  ],
};

最终产物

在当前 cli 运行目录下，会新建一个「overload-cli-output」的文件夹，包含如下内容：

• runtime-script.html：内容可以直接全量复制，放置到我们自己应用的 html 文件的 root 根结点中，用来针对 「html 返回后」 - 「script解析完毕，对 root 元素内容进行 render」之间 时间段的页面占位；
• 如果需要针对 「发起接口请求」-「业务数据返回，render 到页面完毕」之间 时间段进行页面占位，使用 runtime-script 肯定不合时宜，可以直接使用对应页面的 jpeg 图片；