❤
npm
Sign UpSign In

leek-cli

0.2.0 • Public • Published

leek 命令行工具

简介

基于webpack开发的打包工具，为了避免webpack的复杂配置针对公司多页面架构，
以及 React + webpack + Nodejs的开发栈，如果是简单项目只需在进行init操作，配置基础的
dll 包含的依赖包就可以完成配置

功能说明

在工具是针对多页面的React架构进行开发的，如果项目非该结构，建议直接使用webpack配置， 使用这个工具反而增加了复杂度，虽然也可以满足需求

项目结构(实例)：

----project
    ----dist
    ----doc
    ----client  前端代码
        ----config     项目使用配置
        ----doc     项目说明文档
        ----scripts     项目可能用到的脚本
        ----src     项目源代码
            ----common      包含项目通用的代码
                ----page    项目的模板
                    ----layout1     模板
                        ----assets      模板用到资源
                        ----layout.tpl      模板
                        ----layout.js       模板执行的脚本
                        ----layout.scss     模板使用样式文件
                    ----layout2
                ----static      通用的资源，样式库、字体、第三方类库
                ----ui      项目中通用的 React 组件
                ----widget      项目使用的通用 widget
                    ----wgt1      
                        ----wgt.tpl     模板
                    ----wgt2
            ----module1     项目模块
                ----page        模块中的页面
                    ----page1       页面
                        ----assets      页面使用的资源     
                        ----page.tpl    页面模板
                        ----page.js     页面使用脚本
                        ----page.scss   页面用到的样式文件
                    ----page2
                ----ui
                ----widget
            ----module2
        ----vendor
        ----package.json
        ----yarn.lock
    ----src
    ----package.json
    ----yarn.lock
  1. 支持对指定的模块进行自定义配置
  2. 支持对指定页面进行自定义配置
  3. 支持对现有配置进行覆盖，需要在配置中完全自定义，如果自定义会覆盖现有的所有配置
  4. 支持在server 目录 和 client 目录下进行运行命令

约束：

  1. 原则上每个页面下面只能有一个js、jsx、ts、tsx文件， 一个样式文件
  2. 页面用使用到资源需要用过js文件来进行引用
  3. 每个项目只能配置一个 dll配置
  4. 每个项目有一个基础的配置，可以对某些指定的模块进行配置

文件说明：

项目的配置文件默认为: .leek.config.js
项目生成一文件会放在: .leekConfig/

自定义webpack 配置 需要修改 .leekConfig/webpack/
webpack配置文件命名：webpack.config.[模块名].[页面名].js

安装

使用
npm install -g leek-cli
yarn global add leek-cli

使用

leek                    默认命令
leek init               初始化项目
leek server             服务端命令
leek server build       构建服务端代码
leek server start       启动服务
leek bundle             构建前端代码
leek bundle all         构建前端所有模块
leek debug              调试前端模块 暂未实现

命令实例：



        :::            ::::::::::     ::::::::::     :::    :::
        :+:            :+:            :+:            :+:   :+:
        +:+            +:+            +:+            +:+  +:+
        +#+            +#++:++#       +#++:++#       +#++:++
        +#+            +#+            +#+            +#+  +#+
        #+#            #+#            #+#            #+#   #+#
        ##########     ##########     ##########     ###    ###

    ===============================================================

    当前版本: 0.0.8
    Leek cli 为leek项目提供快捷易用的命令

命令:
    bundle                                        打包客户端资源
    debug                                         调试应用
    init                                          初始化leek项目
    server                                        后端node服务
选项:
    -v, --version                                 显示当前版本
    -h, --help                                    帮助说明

配置模板

参考 leek-config-boilerplate 项目

开发说明

整个工具命令行是一个树状结构

root 命令 
    ---- 命令1
        ---- 命令1-1
        ---- 命令1-2
    ---- 命令2 
    ---- 命令3

每一个命令都对应一个动作，每个动作可以接受指定的参数 参数通过 -[opt] 或则 --[opt] 传入

通常情况下这样没问题，但是有些特殊的参数对应的是一些命令比如 leek -v 或者 leek -h 并不是root跟命令，而是输入 leek的版本号 或者 打印 leek 版本信息

另外 对于正常命令会通过命令树 找对对应的指令并且配置响应的参数，会尽量找最深的命令配置，如果没有找到则说明输入有误。

配置例子：

const path = require('path');
// const 

module.exports = {
    "projectType": "react",
    "prefix": "",
    "publicPath": "/static/",
    "dist": "../../dist",
    "clientAlias": "client",
    "isInlineCss": "false",
    "leekConfig": "./.leekConfig/",
    "leekWebpackConfigDir": "{{leekConfig}}/webpack/",
    "leekManifsetDir": "{{leekConfig}}/manifest/",
    "configIn": "client",
    "client": {
        "assetsDir": "./assets/",
        "vendorDir": "vendor/",
        "sourceDir": "./src",
        "cssModulesTypings": false, // 配置是否生成 css module declear文件    ***** New *****
        "dll": {
            "vendors": [
                "core-js",
                "react",
                "react-dom",
                "lodash",
                "axios",
                "antd",
                "history",
                "react-router-dom",
                "mobx",
                "mobx-react",
            ],
            "css": [
                path.resolve(__dirname, './src/common/static/css/base.scss'),
            ],
            sassIncludePaths: [
                path.resolve(__dirname, './src/'),
            ],
            resolve: {},
            module: {},
            plugins: [],
        },
        "common": {
            template: ' ',
            resolve: {
            },
            sassIncludePaths: [
                path.resolve(__dirname, './src/'),
            ],
            module: {},
            plugins: [],
        },
        'base': {
            template: '',
            watchOptions: {},
            resolve: {},
            sassIncludePaths: [
                path.resolve(__dirname, './src/'),
            ],
            module: {},
            plugins: [],
        },
    },
    "server": {
        "relPath": "../../",
        "contentPath": [
            "src/#",
            "package.json"
        ],

    }
}

更新说明

v0.1.4

  1. 添加对css和scss typescript声明文件的自动生成的支持 （并不完善）
  2. 修复commonJSName和commonCSSName的配置

需要优化的内容

  1. webpack 多个实例chuunk id优化 （fixed）
  2. webpack 增加并行编译
  3. 优化typescript 编译
  4. 添加多线程编译
  5. 添加HRM支持
  6. 服务端支持typescript
  7. 支持版本限制
  8. 支持一键初始化
  9. font-size中文字符bug

已知问题

  1. 使用nvm 安装首次 有可能 需要关闭 shell 重新打开
  2. 使用yarn global添加的时候 注意配置 环境变量 export PATH="$PATH:$(yarn global bin)"
  3. 使用taobao npm镜像装 会有一个 包含 Unexpected end of JSON input while parsing near的一个error 参考 https://github.com/npm/npm/issues/19072#issuecomment-395788165
  4. leek 默认包含了开发的很多依赖，安装过程中有些依赖是 托管到 aws 的 可能会安装失败，例如node-sass 碰到这种情况建议多装一次试试

注意事项

  1. 在js直接引用node_modules 下的css文件使用
improt 'e/b.css';

可能在production模式下面引入失败，需要查看一下模块是否是es模块如果是的话，
可能会有sideEffects 配置

参考： https://stackoverflow.com/questions/49160752/what-does-webpack-4-expect-from-a-package-with-sideeffects-false

https://segmentfault.com/a/1190000015689240

解决方法：

1. 添加sass文件 使用 sass文件引用
2. 使用require();
  1. 关于Autoprefixer css前缀问题，需要在package.json 添加指定的browserslist

例如：

"browserslist": [
    "last 1 version",
    "> 1%",
    "maintained node versions",
    "not dead"
  ]
  1. 在typescript 中使用 import * as style from '*.scss' 找不到对应的模块

解决方法： 1. 使用require， 例如： const s = require('*.scss'); 2. 添加typescript 声明文件 *.scss.d.ts 3. 默认忽略 添加

declare module '*.css' {
    interface IClassNames {
      [className: string]: string
    }
    const classNames: IClassNames;
    export = classNames;
}

declare module '*.scss' {
    interface IClassNames {
        [className: string]: string
    }
    const classNames: IClassNames;
    export = classNames;
}
  1. 预编译（相对安全的方案后续支持）

相关链接： https://github.com/Jimdo/typings-for-css-modules-loader/issues/33

Readme

Keywords

Package Sidebar

Install

npm i leek-cli

Repository

gitlab.we.com/we-tech-fe/leek-cli.git

Weekly Downloads

1

Version

0.2.0

License

ISC

Unpacked Size

151 kB

Total Files

29

Last publish

Collaborators

  • liucong
  • shaobin.du
Try on RunKit
Report malware