# 工程创建


本文介绍light开发命令行工具的create指令。

create指令主要用于从无到有的创建一个用于起步的脚手架工程,也就是一个基础的基本的工程,开发者可以在此工程代码的基础上进行自己项目的代码开发。

$ light create -h
  Usage: create [directory]
  
  初始化工程目录结构
  
  Options:
    -t --type <type>                 需要创建的工程类型,默认类型vue
    -d --des <des>                   工程的描述信息
    -v --ver <ver>                   创建的工程的版本信息
    -n --project-name <projectName>  工程的名字
    --force                          是否强制清除已经存在的目录
    --list                           展示当前工具所支持的工程类型(模板类型)
    --id <id>                        设置当前应用关联的id(组件id或者应用id)
    -r --root <root>                 工程的生成路径
    -h, --help                       output usage information

# 参数: --list

--list参数可以用于显示当前工具所支持的基础模板的列表,每种模板都代表可具体的使用场景。

最新版本的lighting工具中支持的基础模板有以下七种:

$ light create --list

当前工具版本:1.30.3
当前支持的模板类型与说明:
api...........................服务端开发工程
app...........................整包上传app开发工程
jsn...........................jsnative技术开发app工程
light.........................light1.x版本应用开发工程
vue...........................light2.x版本应用开发工程
mp............................light2.x小程序模块开发工程
jsn-app.......................整包上传app开发工程,同时支持jsn
full-jsn......................jsnative技术开发app工程,兼容npm运行方式

# 类型选择建议

lighting工具内置的六种模板类型可以方便地帮助开发者起步应用的研发工作,在模板选择上大致可以遵循:

  • 如果是需要研发APP项目,请选择app类型,这是APP的配置工程模板
  • 如果是要研发APP项目中的某一个业务模块,并且使用JSNative开发技术,请选择jsn工程模板
  • 如果是要研发APP项目中的某一个业务模块,并且使用H5开发技术,请选择vue工程模板
  • 如果是要研发小程序项目,请选择mp工程模板

# 参数:-t

-t或者--type用于指定工程模板类型。该参数默认值为:vue。

$ light create -t app

# 参数:-d

-d或者--des用于指定工程描述信息。

$ light create -d 'hello, light'

# 注意事项

如果-d选项的入参中有空格,必须用单引号或者双引号括起来。

# 参数:-v

-v或者--ver用于指定工程初始版本。该参数默认值为:vue。该参数默认值为:0.0.1。

$ light create -v 0.0.1

# 参数:-n

-n或者--project-name用于指定工程项目名称。

$ light create -n lightProject

# 参数:--force

当被指定初始化目录的位置已经存在了对应工程名的资源目录,可以使用--force将已有的目录删除然后创建,避免已经存在的资源干扰新的开发工程。

# 注意事项

目录删除后,不可恢复,请谨慎使用。

$ light create --force

# 参数:--id

--id参数用户指定新创建的开发工程与远程的GMU平台的app项目或者h5组件的关联关系,设置此参数后,此参数的值会写入到project.json中的link_id属性当中。

$ light create --id 1990

# 参数:-r

light工具默认是在命令行所在的当前目录创建light工程,如果此时需要在其他目录作为根目录创建light工程,可以使用-r选项设置最终生成新的开发工程的根目录的位置。

$ light create -r /tmp

# 注意事项

设置目录的位置路径中不能包含空格或者中文字符。