Skip to content

j3812549/tiancai-mpa-ejs-hot-webpack-cli

Repository files navigation

**** # tiancai-mpa-ejs-hot-webpack-cli

概述:带热更新的多页面可模块化的脚手架工具、请求同时支持SEO和AJax、支持SCSS编写

仓库

安装:

git clone https://github.com/j3812549/tiancai-mpa-ejs-hot-webpack-cli.git

快速开始:

git clone https://github.com/j3812549/tiancai-mpa-ejs-hot-webpack-cli.git
cd ./tiancai-mpa-ejs-hot-webpack-cli
npm install
npm run dev

命令和选项:

  1. npm run dev 开发环境运行
  2. npm run prod 生产环境运行

目录树


│  app.js // node server
├─config
│      index.js
│      webpack.base.config.js // webpack共用文件
│      webpack.dev.config.js // dev环境webpack配置文件
│      webpack.prod.config.js // prod环境webpack配置文件
│
├─dist // webpack打包文件
├─loader
│      autoLoadFiles.js // 处理多页面自动引入生产的loader
├─plugins
│      resolveEjsPlugin.js // 处理正式环境打包ejs的plugin
├─routes // 服务端路由
└─src // 主要开发的目录
    ├─api
    ├─assets
    ├─entry // 入口文件,在此目录下编写JS文件会在sass、view目录下自动生产对应的scss、ejs文件
    ├─sass
    └─view // 存放ejs的地方
│ register_data.js // 处理SEO渲染的JS文件

使用限制

​ 为实现热更新并与其他插件不进行冲突的情况下、自定义了一部分语法,以下为各文件编写时的注意事项

  • EJS
    使用公共的组件模块的语法
    <%= require('./header.ejs')() %>
    
    使用代码逻辑块
        错误示范
        <% if (user) { %>
          <h2><%= user.name %></h2>
        <% } %>
        正确示范
        [[ if (user) { ]]
          <h2>{{ user.name }}></h2>
        [[ } ]]
    
    输出值
    <div>{{ name }}</div>
    
    不支持EJS使用本地资源引入
    <img src="@/static/1.png"/>
    
    正确的引入方式
    .icon-image { background-image: url('@/static/1.png') }
    <div class="icon-image"></div>
    
    

使用

  1. 在src/entry目录下创建[key].js,会在sass、view目录下自动生产对应的scss、ejs文件
  2. 在sass下编写css
  3. 在view下编写ejs

SEO

​ 使用配置文件/src/register_data.js搭配ejs可支持SEO。

// src/register_data.js

// 本文件禁用'@'
import { test } from './api/index'

export default {
  // index对应的为src/view/index[key].ejs的文件
  index: async () => {
     const data = await test() // 支持远程请求
     return { title: data }
  },
  // index: {
  //  title: 'xxx'
  // },
}
// src/view/index.ejs
...
<body>
	<div>{{ title }}</div>
</body>
...

配置项

// config/index.js
module.exports = {
  port: 3501, // 服务启动的端口
  build_ext: '.ejs', // 需要打包成html改为html,但是需要一些额外处理,请自己结合实际情况来调试
  publicModules: ['@/assets/common.js', '@/assets/common.scss'], // 配置公共模块
  assetsPublicPath: '/' // 静态文件打包的路径配置
}

环境变量

通过process.env.MODE_ENV获取不同的环境变量

// development and production
console.log('process.env.MODE_ENV', process.env.MODE_ENV)

模块化引入变量丢失问题

需按照此方法给组件载入变量

  // index.ejs
  <div>
    [[ var video_list = item.list ]]
    <%= require('./list.ejs')() %>
  </div>
  // list.ejs
<div class="video_list-box">
  [[ video_list.forEach(function(item) { ]]
  <div>item.src</div>
  [[]]
</div>

动态路由

// 当type页面存在时, 会将:id识别为动态参数,并且丢到register_data.js作为参数处理
<a href="/type/{{ item.id }}"  class="type-item">{{ item.name }}</a>

// register_data.js

  type: async (opt) => {
    console.log('id', opt.id)
  }

同理,URLPrams也可以通过opt取到

自定义模板

在根目录创建ejs-template.ejs,在src/entry创建js,会根据此模板生成ejs

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>tiancai-mpa-ejs-hot-webpack-cli</title>
</head>

<body>
  <div>自定义生产模板</div>
</html>

已知问题

  1. 修改register_data.js不会触发热更新 答:因为采用了两套热更新混用方案导致,采用nodemon监听除src目录下文件,因为register_data.js在src目录下不会触发nodemon的热更新,需要手动重新node服务。

  2. 关于新引入ejs模块样式丢失问题 答:也需要手动重启node服务

  3. Error: ENOENT: no such file or directory, open 答:需要根目录下创建dist文件夹

作者

[email protected]

About

简单带热更新多页面的脚手架工具

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published