返回一个独一无二的与给定通配符模式所匹配的所有文件或目录路径数组。这个方法接收一个逗号分割的通配符模式或者数组形式的通配符模式参数。如果路径匹配模式以!
开头,与模式所匹配的结果就会从返回的数组中排除。模式是按顺序处理的,所以包含和排除在数组中出现的顺序是非常重要的。
init.expand([options, ] patterns)
init.filesToCopy
返回一个包含待复制文件的对象,每个文件都包含了源文件的绝对路径和目标文件的相对路径,并按照rename.json
(如果存在)中的规则进行重命名(或者忽略)。
var files = init.filesToCopy(props);
/* files === { '.gitignore': 'template/root/.gitignore',
'.jshintrc': 'template/root/.jshintrc',
'Gruntfile.js': 'template/root/Gruntfile.js',
'README.md': 'template/root/README.md',
'test/test_test.js': 'template/root/test/name_test.js' } */
init.getFile
获取单一的任务文件路径。
init.getFile(filepath[, ...])
init.getTemplates
返回一个包含所有可用模板的对象。
init.getTemplates()
init.initSearchDirs
在初始化目录中搜索初始化模板。template
是指模板的位置。还包括~/.grunt-init
和grunt-init中的核心初始化任务。
init.initSearchDirs([filename])
init.process
启动程序并提示开始输入。
init.process(options, prompts, done)
init.process({}, [
// Prompt for these values
init.prompt('name'),
init.prompt('description'),
init.prompt('version')
], function(err, props) {
// All finished, do something with the properties
});
init.prompt
给用户一个提示,并让用户输入自己选择的值。
init.prompt(name[, default])
init.prompts
此对象包含了所有提示信息。
var prompts = init.prompts;
init.readDefaults
读取任务文件中(如果存在)读取JSON格式的默认值,并将它们合并到一个数据对象中。
init.readDefaults(filepath[, ...])
init.renames
模板的重命名规则。
var renames = init.renames;
// renames === { 'test/name_test.js': 'test/{%= name %}_test.js' }
init.searchDirs
搜索模板的目录数组。
var dirs = init.searchDirs;
/* dirs === [ '/Users/shama/.grunt-init',
'/usr/local/lib/node_modules/grunt-init/templates' ] */
init.srcpath
根据文件名搜索初始化模板路径并返回一个绝对路径。
init.srcpath(filepath[, ...])
init.userDir
返回用户模板目录的绝对路径。
var dir = init.userDir();
// dir === '/Users/shama/.grunt-init'
init.writePackageJSON
在目标目录中保存一个package.json
文件。回调函数可以用于后置处理属性的添加/移除/其他操作。
init.writePackageJSON(filename, props[, callback])
内置提示
author_email
用于package.json
中的作者邮箱地址。默认情况下会尝试从用户的git配置中找到一个默认值。
author_name
用于package.json
中的作者全名和版权信息。也会尝试从用户的git配置中找到一个默认值。
author_url
package.json
中的用于公开作者个人网站的URL。
bin
项目根目录中cli脚本的相对路径。
bugs
用于项目问题跟踪的公开URL。如果项目有一个Github仓库,将自动指向项目Github的问题跟踪模块(issue)。
description
项目的描述。通常在package.json
或者README文件中。
grunt_version
项目所需的有效Grunt版本范围定义。
homepage
指向项目首页的公开URL。如果此项目使用的是github仓库,那么,默认是Github仓库的url。
jquery_version
如果是jQuery项目,它表示项目所需的jQuery版本。必须是一个有效的版本范围定义。
licenses
项目许可协议证书。多个许可协议证书使用空格分割,内置的许可协议有:MIT
、MPL-2.0
、GPL-2.0
和Apache-2.0
。默认是MIT
协议。可以使用init.addLicenseFiles方法添加自定义许可协议证书。
main
项目的主入口。默认是lib
目录已项目名称命名的文件。
name
项目名称。在项目模版中将会大量使用,默认指向当前工作目录。
node_version
项目所需的Node.js版本。必须是一个有效的版本范围定义。
npm_test
项目中运行测试的命令,默认情况下是grunt
。
repository
项目的git仓库。默认是一个猜测的github url。
title
适合大家识别的项目名称。默认是原始项目名称,并且经过过滤,适合大家识别。
version
项目的版本号。默认是第一个有效的语义版本号:0.1.0
。
标签:Grunt
相关阅读 >>
更多相关阅读请进入《Grunt》频道 >>

Vue.js 设计与实现 基于Vue.js 3 深入解析Vue.js 设计细节
本书对 Vue.js 3 技术细节的分析非常可靠,对于需要深入理解 Vue.js 3 的用户会有很大的帮助。——尤雨溪,Vue.js作者