# auto-skeleton-plugin

> 基于 jsdom 的、自动生成骨架的 Webpack 插件

Latest version **0.0.0-beta.6** (published 2020-08-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install auto-skeleton-plugin
pnpm add auto-skeleton-plugin
yarn add auto-skeleton-plugin
bun add auto-skeleton-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0-beta.6 |
| Published | 2020-08-03 |
| First published | 2020-07-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 30.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 17 |
| Author | CJY0208 |
| Maintainers | cjy0208 |
| Keywords | auto skeleton, webpack, skeleton, spa prerender plugin |

## Links

- npm: https://www.npmjs.com/package/auto-skeleton-plugin
- Repository: https://github.com/CJY0208/auto-skeleton-plugin
- npm.io page: https://npm.io/package/auto-skeleton-plugin

## Dependencies (5)

- [jsdom](https://npm.io/package/jsdom.md) ^15.2.1
- [szfe-tools](https://npm.io/package/szfe-tools.md) ^0.0.0-beta.7
- [html-minifier](https://npm.io/package/html-minifier.md) ^4.0.0
- [promise-limit](https://npm.io/package/promise-limit.md) ^2.7.0
- [@prerenderer/prerenderer](https://npm.io/package/@prerenderer/prerenderer.md) ^0.7.2

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.0.0-beta.6 (latest) — 2020-08-03
- 0.0.0-beta.5 — 2020-07-31
- 0.0.0-beta.4 — 2020-07-31
- 0.0.0-beta.3 — 2020-07-31
- 0.0.0-beta.2 — 2020-07-30
- 0.0.0-beta.1 — 2020-07-30

## README

# AutoSkeletonPlugin

基于 [jsdom](https://github.com/jsdom/jsdom) 的、自动生成骨架的 Webpack 插件，工作方式参考 [prerender-spa-plugin](https://github.com/chrisvfritz/prerender-spa-plugin)

## 工作方式

1. 等待 webpack 完成打包

2. 启动一个本地静态服务器，按配置的 routes，用 jsdom 启动无头浏览器访问打包结果

3. jsdom 中页面完成渲染后，执行 [generateSkeleton](https://github.com/CJY0208/auto-skeleton-plugin/blob/master/src/generateSkeleton.js) 骨架生成方法，将内容转换为骨架

4. 截取当前页面的 innerHTML 作为骨架预渲染结果，输出成 html 文件

5. 根据配置的 staticDir 将 html 文件存进去，over

---

## 基本使用方式

```js
const AutoSkeletonPlugin = require('auto-skeleton-plugin')

module.exports = {
  plugins: [
    ...
    new AutoSkeletonPlugin({
      // Required - The path to the webpack-outputted app to prerender.
      staticDir: paths.appBuild,
      // Required - Routes to render.
      routes: ['/'],
    })
  ]
}
```

---

## 自定义骨架生成过程

目前的生成骨架生成规则比较简陋，需要调整生成过程以适应不同项目

```js
const AutoSkeletonPlugin = require('auto-skeleton-plugin')

module.exports = {
  plugins: [
    ...
    new AutoSkeletonPlugin({
      // Required - The path to the webpack-outputted app to prerender.
      staticDir: paths.appBuild,
      // Required - Routes to render.
      routes: ['/'],
      generateSkeleton(window, route) {
        const { document } = window
        const spinner = document.getElementById('spinner')
        spinner.parentNode.removeChild(spinner)

        return AutoSkeletonPlugin.generateSkeleton(window, route)
      },
    })
  ]
}
```

#### 默认的生成过程

```js
function generateSkeleton(window, route) {
  const { document, Text } = window
  const style = document.createElement('style')
  style.innerHTML = `
    ._ske {
      background: #f2f2f2;
      color: transparent;
      text-decoration: none;
      user-select: none;
      pointer-events: none;
    }
    ._ske_img {
      opacity: 0;
      display: inline-block;
    }
  `
  document.head.appendChild(style)

  // 文字节点
  ;[...document.querySelectorAll('*')]
    .filter(
      (node) =>
        !['script', 'style', 'html', 'body', 'head', 'title'].includes(
          node.tagName.toLowerCase()
        )
    )
    .map((node) => [...node.childNodes].filter((node) => node instanceof Text))
    .flat(Infinity)
    .forEach((node) => {
      let span = document.createElement('span')
      node.parentNode.insertBefore(span, node)
      span.appendChild(node)
      span.classList.add('_ske')
    })
  // 图标节点
  ;[...document.querySelectorAll('*')]
    .filter((node) => ['i'].includes(node.tagName.toLowerCase()))
    .forEach((node) => {
      node.classList.add('_ske')
    })
  // 图片节点
  ;[...document.querySelectorAll('*')]
    .filter((node) => ['img'].includes(node.tagName.toLowerCase()))
    .forEach((node) => {
      let span = document.createElement('span')
      node.parentNode.insertBefore(span, node)
      span.appendChild(node)
      span.classList.add('_ske')
      node.classList.add('_ske_img')
    })
}
```

---
_Source: https://npm.io/package/auto-skeleton-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
