@begda/static-build

v0.0.18

Published

2 years ago

@begda/静态编译

Downloads

0High
0Medium
0Low

liaohui1080

static-build html-static-build begda

官网

GitHub

项目说明

主要解决在切图时候,无法使用 npm 包管理器下载的资源包.解决各种资源包重复下载问题

实现原理是通过扫描 html 文件里引用的资源文件,然后根据路径 copy 到 dist 文件夹里

主要是针对单纯切图的项目,不需要编译,也能完美的使用 npm 下载的 node_modules 目录下的各种资源包

安装使用

需要 node 开发环境

npm init  #创建package.json 文件
npm i @begda/static-build  #安装 静态html编译
npm i browser-sync  #安装 监听文件变化,自动刷新浏览器

目录结构

- example
     - dist              # 输出目录
     - src
          - ba-assets    #打包的时候会把这个目录的所有文件都copy到 dist目录里
            - css
              - main.css  #tailwind生成的css
          - ba-modules   #包管理器的文件目录
          - index.html   #入口文件
     - begda.config.js   #配置文件
     - package.json
     - tailwind-main.css  #tailwind入口文件
     - tailwind.config.js #tailwind 配置文件

html 引入资源包例子

<html>
    <head>
        <link href="ba-assets/font/iconfont.css" rel="stylesheet" />
        <!--   对页面没影响,就是为了打包时候能带上elementUI字体文件用的 -->
        <link href="ba-modules/node_modules/element-ui/lib/theme-chalk/fonts" rel="stylesheet" />
        <!--   引用自己的写css文件-->
        <link href="ba-assets/css/main.css" rel="stylesheet" />
    </head>
    <body>
        html 内容
        <!-- 引用npm包管理器的js文件-->
        <script src="ba-modules/node_modules/tasktimer/lib/tasktimer.min.js"></script>
        <!-- 引用自己的写js文件-->
        <script src="ba-assets/js/init.js"></script>
    </body>
</html>

begda.config.js 配置说明

极简配置

// 所有配置都是选填的,可以为空,如果不需要改文件夹名字,推荐极简配置
import { defineConfig } from '@begda/static-build';

defineConfig();

完整配置

import { defineConfig } from '@begda/static-build';

defineConfig({
    projectName: projectName || prName(), //项目名称,默认会取package.json的projectName
    entry: '/*.html', //   "/*.html"  '/index.html'  //支持 glob的 目录写法  入口文件
    out: 'dist', //导出文件目录
    src: 'src', //源码
    assets: 'ba-assets', //静态资源文件目录
    commonModules: 'ba-modules', //静态资源文件目录
    bower_components: 'bower_components', //公共静态资源文件目录,如果bower_components 目录没有的话,就用 node_modules目录,因为npm包是必须的
    node_modules: 'node_modules', //npm安装包资源文件目录
    zip: ture || false //是否自动打压缩包, true为自动打包 false 为不打包
});

使用 Tailwindcss

尽量使用高版本的 Tailwindcss
运行命令 npx tailwindcss -i ./tailwind-main.css -o ./src/ba-assets/css/main.css --watch

./tailwind.config.js 配置文件

/** @type {import('tailwindcss').Config} */
module.exports = {
    content: ['./src/**/*.{html,js,vue}'],
    theme: {
        extend: {}
    },
    plugins: []
};

./tailwind-main.css 入口文件

@tailwind base;
@tailwind components;
@tailwind utilities;

./package.json 添加启动命令配置

{
   "scripts": {
    "tailwind:watch": "npx tailwindcss -i ./tailwind-main.css -o ./src/ba-assets/css/main.css --watch"
  },
}

两个包管理目录的重要说明

node_modules
通过 npm 安装的包管理器目录,这个是必须有的,所有依赖都在这里面
bower_components
通过 bower 安装的包管理目录,可以直接通过 url 地址下载包, 有些 js css 包没有在 npm 里面,要用这个直接下载
如果不使用 bower_components 可以不在 begda.config.js 里面配置,默认会直接使用 node_modules 来代替
bower 使用说明

   1. npm i bower -g 全局安装包管理
   1. bower init   创建bower.json 文件
   2  打开bower.json ,把要下载的包 名字和地址 按下面格式 ,添加到 dependencies 属性里面
       "dependencies": {
        "tailwindcss": "https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css",
        "jquery.3.6.1": "https://code.jquery.com/jquery-3.6.1.min.js"
        }
   3. bower install  安装包

运行命令

"build": "node begda.config.js",   #编译切图好的文件,是生成一个文件夹, 可以直接发给同事
"browser-sync:dist": "browser-sync start --server 'dist' --files 'dist'",  #启动生产测试环境浏览器
"browser-sync:src": "browser-sync start --server 'src' --files 'src'",  #启动开发环境浏览器
"说明": "这个可以设置这样的 --files '/**/*.css,/**/*.html,/**/*.js'",
"pnpm-install": "pnpm install --shamefully-hoist",
"tailwind:watch": "npx tailwindcss -i ./tailwind-main.css -o ./src/ba-assets/css/main.css --watch",

源码地址

https://github.com/begda/static-build

演示 demo 在 example 文件夹

demo 目录运行效果在 demo 里运行命令查看
https://github.com/begda/static-build/tree/main/example
demo 使用说明
https://github.com/begda/static-build/blob/main/example/README.md

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

官网