0.1.2 • Published 6 years ago

@plume/core v0.1.2

Weekly downloads
-
License
GPL-3.0
Repository
github
Last release
6 years ago

core

core module

核心模块类,包含了核心事务initialdependentsdevbuild,cli 任务注册入口registerCli以及公用配置common config

子模块应当继承此类,并复写核心事务,添加相应的配置清单。

Properties

config

是通用的默认配置选项,不同的 mode 模块,需要根据此配置项扩展

nametypedesc
modestring项目模式,根据不同的 mode 库,由@plume/cli自动添加,不可编辑
pathsobject各种目录的配置对象
optionsobject通用的配置选项

paths

nametypedefaultdesc
rootstringprocess.cwd()项目根目录,默认为创建的项目目录
srcstring{root}/src开发目录
outputstring{root}/dist打包输出目录
assetsstring{dist}/assets静态资源目录

options

nametypedefaultdesc
portnumber8080开发服务器端口号
cssModestringcsscss 模式,影响打包时候对 css 的处理 可选值:css | sass | less | none
styledComponentsbooleanfalse是否启用 styled-components
cssModulesbooleanfalse是否启用 cssModules,影响打包时对 css 的处理 可选值:true | false

Methods

initial

方法签名:cli_config: Object => void

cli_config 为 cli 传入的配置项

功能:此方法需要处理新建项目的目录构建、配置文件构建等项目初始化构建的工作。

备注:

dependents

方法签名:cli_config: Object => {dev: string[], prod:string[]}

功能:返回一个包含了项目所有依赖的名称的对象。在构建项目时,会被自动安装。

nametypedesc
devstring[]开发依赖
prodstring[]生产依赖

备注:

  • 默认不返回任何值
  • 如果选择不自动安装依赖,当项目创建完毕后,会提示安装依赖项。

dev

方法签名:plume_config: object => void

plume_config 为 plume 的配置文件对象,当使用 cli 工具执行plume-cli dev时,会查找当前项目目录下的 plume.config.js 文件,并生成配置文件对象

功能:执行项目开发时的一些操作,例如配置 webpack、启动开发服务器等。

备注:

  • 默认为空方法

build

方法签名:plume_config: object => void

plume_config 为 plume 的配置文件对象,当使用 cli 工具执行plume-cli build时,会查找当前项目目录下的 plume.config.js 文件,并生成配置文件对象

功能:执行项目打包构建时的一些操作,例如配置 webpack、打包输出等。

备注:

  • 默认为空方法

registerCli

方法签名:program => void

program 是Commander的实例,具体可以参考Commander.js 官方教程

功能: 处理要注册的 command

备注:

  • 默认为空方法

getConfig

方法签名:(config_path: string, cwd: string) => plume_config

config_path 为手动指定的 config 配置文件地址,可以是绝对路径或相对路径。如果是相对路径,则相对于 cwd 指定的目录搜索

cwd 为当前目录地址,默认为 process.cwd()返回的路径。在此目录下搜索plume.config.js文件

功能:获取当前的plume_config配置

0.1.2

6 years ago

0.1.1

6 years ago

0.1.0

6 years ago

0.0.24

6 years ago

0.0.23

6 years ago

0.0.22

6 years ago

0.0.21

6 years ago

0.0.20

6 years ago

0.0.19

6 years ago

0.0.18

6 years ago

0.0.16

6 years ago

0.0.15

6 years ago

0.0.14

6 years ago

0.0.13

6 years ago

0.0.12

6 years ago

0.0.11

6 years ago

0.0.10

6 years ago

0.0.9

6 years ago

0.0.8

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago