Class jake.PackageTask
- Defined in: package_task.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
jake.PackageTask(name, version, definition)
Instantiating a PackageTask creates a number of Jake
Tasks that make packaging and distributing your software easy.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Equivalent to the '-C' command for the `tar` and `jar`
commands.
|
|
|
Specifies the files and directories to include in the
package-archive.
|
|
|
The shell-command to use for creating jar archives.
|
|
|
Can be set to point the `jar` utility at a manifest
file to use in a .jar archive.
|
|
|
The name of the project
|
|
|
If set to true, uses the `jar` utility to create
a .jar archive of the pagckage
|
|
|
If set to true, uses the `tar` utility to create
a gzip .tgz archive of the pagckage
|
|
|
If set to true, uses the `tar` utility to create
a bzip2 .bz2 archive of the pagckage
|
|
|
If set to true, uses the `zip` utility to create
a .zip archive of the pagckage
|
|
|
The list of files and directories to include in the
package-archive
|
|
|
The shell-command to use for creating tar archives.
|
|
|
The project version-string
|
|
|
The shell-command to use for creating zip archives.
|
Class Detail
jake.PackageTask(name, version, definition)
Instantiating a PackageTask creates a number of Jake
Tasks that make packaging and distributing your software easy.
var t = new jake.PackageTask('rous', 'v' + version, function () {
var files = [
'Capfile'
, 'Jakefile'
, 'README.md'
, 'package.json'
, 'app/*'
, 'bin/*'
, 'config/*'
, 'lib/*'
, 'node_modules/*'
];
this.packageFiles.include(files);
this.packageFiles.exclude('node_modules/foobar');
this.needTarGz = true;
});
- Parameters:
- {String} name
- The name of the project
- {String} version
- The current project version (will be appended to the project-name in the package-archive
- {Function} definition
- Defines the contents of the package, and format of the package-archive. Will be executed on the instantiated PackageTask (i.e., 'this', will be the PackageTask instance), to set the various instance-propertiess.
Field Detail
archiveChangeDir
Equivalent to the '-C' command for the `tar` and `jar`
commands. ("Change to this directory before adding files.")
archiveContentDir
Specifies the files and directories to include in the
package-archive. If unset, this will default to the main package
directory -- i.e., name + version.
jarCommand
The shell-command to use for creating jar archives.
manifestFile
Can be set to point the `jar` utility at a manifest
file to use in a .jar archive. If unset, one will be automatically
created by the `jar` utility. This path should be relative to the
root of the package directory (this.packageDir above, likely 'pkg')
name
The name of the project
needJar
If set to true, uses the `jar` utility to create
a .jar archive of the pagckage
needTar
If set to true, uses the `tar` utility to create
a gzip .tgz archive of the pagckage
needTarBz2
If set to true, uses the `tar` utility to create
a bzip2 .bz2 archive of the pagckage
needZip
If set to true, uses the `zip` utility to create
a .zip archive of the pagckage
packageFiles
The list of files and directories to include in the
package-archive
tarCommand
The shell-command to use for creating tar archives.
version
The project version-string
zipCommand
The shell-command to use for creating zip archives.