yogi-scripts

v1.1.0

Published

6 months ago

development and build services of UCF project

Downloads

0High
0Medium
0Low

jwangyangls

server build webpack tool ucf yonyou fe

ucf-scripts

介绍

集成了最新的技术栈包括babel7,autoprefixer,less,postcss,webpack5、高度封装、简化配置、无多余依赖、具有服务启动、开发调试、代理访问、数据模拟、构建资源、自动刷新功能。快速开发UCF微服务工程底层配套工具支撑，详情文档

安装

工具可以依赖UCF项目工程通过scripts运行

使用

通过npm scripts启动

ui模板地址 http://git.yonyou.com/yonyou-ide/tinper-next-packages/next-webapp （ts项目切换为typescript分支）


# 开发启动
$ npm start

# 开发构建
$ npm run build

内置已经集成ucf-scripts的启动

启动方式对比优劣

全局启动和项目内脚本启动区别：

启动方式 | 优点 | 缺点 ---|---|--- 全局启动 | 无需根据项目一次次安装重复依赖npm包节省磁盘空间速度 | 不受项目内工具版本控制，会导致每个开发者环境不统一，出现未知版本错误等脚本启动 | 无需管理全局环境变量、不污染全局变量、随时根据项目内版本更新、可控每一次版本 | 多次项目使用需要反复安装、占用磁盘空间大

项目配置文件说明

UCF微服务前端工程核心配置文件只有一个ucf.config.js下面对配置文件说明：

module.exports = () => {
    return {
        // 启动所有模块，默认这个配置，速度慢的时候使用另外的配置
        // bootList: true,

        // 启动这两个模块，不启动调试，关闭构建
        bootList: [
            "demo-app-org",
            //"demo-app-staff"
        ],
        // tns 接入模式
        // bootName : 统一的 入口文件名称（每个入口模块的src/app.js同级目录内必需包含一个该名称命名的文件）如 bootstrap.js, 
        // bootstrap.js 内容为: import('./app'); 
        // 如未设置添加则默认为 app.js(tns 不会生效);

        bootName: 'bootstrap.js'
        // 代理的配置
        proxy: [
            {
                enable: true,
                headers: {
                    // 与下方url一致
                    "Referer": "http://iuap-meger-demo.test.app.yyuap.com"
                },
                //要代理访问的对方路由
                router: [
                    '/iuap'
                ],
                // pathRewrite: {
                //     '^/api/old-path': '/api/new-path', // rewrite path
                //     '^/api/remove/path': '/path' // remove base path
                // },
                url: 'http://iuap-meger-demo.test.app.yyuap.com'
            }
        ],
        // 静态托管服务
        static: 'ucf-common/src/static',
        // 是否展开静态引用资源
        res_extra: true,
        // 构建资源是否产出SourceMap
        open_source_map: true,
        // 全局环境变量
        global_env: {
            GROBAL_HTTP_CTX: JSON.stringify("/iuap_demo"),
        },
        // 别名配置
        alias: {
            //'ucf-apps': path.resolve(__dirname, 'ucf-apps/')
        },
        // 构建排除指定包
        externals: {
            // tns 下 排除包含以下指定包 需要在模板中手动使用外链的react reactDom Tinper ...

            // "react": "React",
            // "react-dom": "ReactDOM",
            // "@tinper/next-ui": "TinperNext"
        },
        // 调试服务需要运行的插件
        devPlugins: [],
        // 构建服务需要运行的插件
        buildPlugins: [],
        // tns 启动及插件配置
        tnsCfg: {
          // 启用tns
          enabled: true
          // libraryEnv
          // libraryDebug
          // remotePluginEnv
          // remotePluginUrl
          // logFileName
          // ...
        }
    }
}

功能配置节点说明

配置项 | 说明 | 默认值 | 可选值 | 备注 ---|---|---|---|--- bootList | 启动、构建入口配置，true表示所有模块全部启用，数组参数按需模块使用 | true | true,['app-name','app-demo'] | 一般默认开启所有模块的调试和构建，低配置机器或者只需要开发一块模块的话可以选择性的去配置单独启动 bootName | 统一的入口文件名称如 bootstrap.js bootstrap.js 内容为: import('./app');如未设置添加则默认为 app.js(tns 不会生效); | app.js | bootstrap.js | 每个入口模块的src/app.js同级目录内必需包含一个该名称命名的文件 proxy | 开发调试阶段的代理服务配置 | [] | enable:true 是否有效代理,false表示关闭. headers:{} 设置代理请求的消息头. router:['/iuap','wbalone']. url:'proxy.example.com'. 本地请求代理对方服务器地址. pathRewrite:{}URL重写服务. opts:{} 如内置配置无法满足需求，需要单独设置原生配置 http-proxy-middleware. | 数组节点可以配置多条代理服务，通过enable来控制启用哪个，针对一些服务器校验头信息例如：Referer等就需要设置，其他常规的设置工具已经内置，代理路由router表示设置的几个路由访问后会代理到对方服务器上，url就是对方服务器地址 global_env | 程序内公共变量 | null | 同webpack4 { key : value } | 接收K、V格式如：{GROBAL_HTTP_CTX: JSON.stringify("/iuap_demo")} alias | 别名 | null | 同webpack4 {key : value} | 接收K、V格式如：{'ucf-apps': path.resolve(__dirname, 'ucf-apps/')} externals | 排除指定的包用外部变量代理提升打包性能 | null | 同webpack4 { key : value } | 接收K、V格式如：{'tinper-bee': 'TinperBee'} loader | 内置加载器无法处理需要单独去设置处理 | [] | 同webpack4 loader | devPlugins | 开发环境加载的插件 | [] | 同webpack4 plugin | 开发阶段使用的插件 buildPlugins | 生产环境加载的插件 | [] | 同webpack4 plugin | 生产阶段使用的插件 open_source_map | 构建资源生产环境的时候产出sourceMap | true | true,false | - css | css loader的options | undefined | - | 具体参考https://www.npmjs.com/package/css-loader less | less loader的options | undefined | - | 具体参考https://www.npmjs.com/package/less-loader res_extra | 是否展开静态引用资源，用于打包处理字体、图片等资源产出，或者不使用展开资源会打包到css方便管理 | true | true,false | - static | 静态托管服务，不按需打包 | undefined | - | 脚手架内的任意文件夹即可，如：static : 'ucf-common/src/static' babel_presets | babel使用的 presets | undefined | - | 如：require.resolve('@babel/preset-react') babel_plugins | babel的插件 | undefined | 如：require.resolve("babel-plugin-import-bee") scan_root | 自定义文件夹作为扫描微应用入口，原则上是按照./自定义目录/*/src/app.js扫描 | undefined | - dist_root | 输出自定义文件夹 | undefined | - host | 自定义IP、域名启动 | undefined | 支持IPV4、IPV6、域名 postcss_plugins | PostCss Plugin | undefined | - tnsCfg | tns配置 | undefined | - | 默认不启用tns服务器，如需启用需配置 {enabled: true, ...otherTnsPluginOptions}，otherTnsPluginOptions参考@tinper/next-plugin配置 babel_include | babel使用的 incluede | [] | (includes) => includes / array | 当在ie内存在如第三方包代码不兼容情况时可在此配置解决

自动开启浏览器

通过配置npm启动命令：

  "scripts": {
    "start": "ucf-scripts start --homepage=demo-app-org",
    "start:https": "ucf-scripts start --homepage=demo-app-org --https",
    "build": "ucf-scripts build"
  }

tns 接入步骤

UCF内置tns 插件，需要用户在tnsCfg指定插件配置（详见tnsCfg）
UCF内置原默认入口app.js, 需用户指定配置bootName并新建统一的入口名称、以及内容(多入口及在每个app.js同级目录创建新的入口文件，内容均为 import('./app'); );
externals 需要在模板中手动使用外链的react reactDom Tinper （详见tns接入文档 https://yundoc.yonyou.com/view/p/1466219）

版本

2.0.0-beta.15 内部放弃使用 optimize-css-assets-webpack-plugin 变更为css-minimizer-webpack-plugin 打包css
2.0.0-beta.13 增加对于typescript 的支持
2.0.0-beta.12 增加 extensions 参数用于支持扩展extensions
2.0.0-beta.11 babel 增加同时使用esm和commonjs的兼容性，兼容ie11；支持参数babel_include 为function类型
2.0.0-beta.8 css 编译排除 less-loader
2.0.0-beta.7 tns 内置 libraryEnv 默认值
2.0.0-beta.6 支持开发模式支持https启动服务
2.0.0-beta.5 tns 部分文档更新, tns 包升级
2.0.0-beta.4 tns 部分文档更新, fix bug
2.0.0-beta.3 接入tns系统
2.0.0-beta.2 修复背景图片以及一些字体打包问题
2.0.0-beta.1 修复内部包不能被外部全部直接下载问题，修复postcss 警告
2.0.0-beta.0 内置webpack5
1.2.8 增加limit参数，用于设置静态资源大于多少后进行base64转码
1.2.7 修复启动端口冲突的问题
1.2.6 增加less配置参数
1.2.5 增加publicPath={boolen}字段，用于解决需要进行按需加载优化的项目，开启该配置后项目中资源依赖路径将使用 context 字段作为资源依赖公共路径，并且路径依赖由原来的相对路径变为 /开头的绝对路径
1.2.4 支持Less-Loader的JavaScript
1.2.3 增加 postcss_plugins 参数用于支持扩展PostCss Loader的插件机制
1.2.2 解决在使用了context后，静态资源地址不正确的问题以及静态资源根据开发环境不同加载对应的脚本
1.2.1 支持自定义域名、IP绑定参数host、对应文档更新
1.2.0 实现splitChunks参数暴露、版本号锁定
1.1.9 解决启动autoprefixer红色警告的问题
1.1.8 显示文件名和构建时间&新特性实现多级构建源码目录
1.1.7 修复启动或构建执行三次配置文件的问题，修复第一次传递错误环境参数值
1.1.6 增加自定义入口扫描scan_root、自定义输出目录dist_root
1.1.5 支持babel的presets、plugin参数，更新对应使用文档，ucf.config增加babel_presets、babel_plugins
1.1.4 升级clean-webpack-plugin、get-port，去除压缩插件uglifyjs-webpack-plugin使用内置压缩插件terser-webpack-plugin
1.1.3 解决res_extra参数的差异化，现在不管是development还是production都是一致的路径
1.1.2 完善res_extra:true性能优化，只针对构建上线打包的时候生效，拆分公共vendor、js、css
1.1.1 修复静态服务没有设置的错误
1.1.0 增加调试和打包的静态依赖资源展开参数res_extra,增加静态服务功能参数static
1.0.9 修复context不设置构建的时候没有html文件的问题
1.0.8 增加context参数
1.0.7 调整参数变化、输出目录调整ucf-publish、自动清理构建目录
1.0.6 增加portal平台开发环境支持
1.0.5 增加对CSS Loader配置支持
1.0.4 增加CSS Modules支持、自动打开浏览器命令行--homepage
1.0.3 增加注解支持
1.0.2 增加SourceMap参数支持
1.0.1 切换正式环境
1.0.0 完善开发服务、精简配置、容错处理
0.0.x 初步完成开发调试、构建、代理访问

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme