The tool to create artifacts for your assemblies.
Copy only the necessary files and pack them in tar.gz file.
It works much faster than removing unnecessary files and packing with command-line utility tar.
For example, 1 minute vs 10 seconds for project with 20 thousand files (80 Mb).
$ npm install --save tartifacts
const writeArtifacts = require('tartifacts');
const artifacts = [
{
name: 'artifact.tar.gz',
patterns: ['sources/**', '!sources/exlib/**'],
tar: true,
gzip: { level: 9 }
},
{
name: 'artifact-dir',
includes: 'sources/**',
excludes: 'sources/exlib/**',
dotFiles: false // exclude dotfiles, override general settings
}
];
writeArtifacts(artifacts, {
root: './path/to/my-project/', // files of artifacts will be searched from root by artifact patterns,
// for example: ./path/to/my-project/sources/**
destDir: './dest/',
dotFiles: true, // include dotfiles
emptyFiles: true // include empty files
emptyDirs: true // include empty directories
})
.then(() => console.log('Copying and packaging of artifacts completed!'))
.catch(console.error);Search files of artifact by glob patterns and writes them to artifact in fs.
Type: object, object[]
The info about artifacts or one artifact.
Each artifact object has the following fields:
Type: string
The artifact name of file or directory.
Type: string
Default: precess.cwd()
The path to root directory.
The patterns, includes and excludes will be resolved from root.
Type: string
The path to destination directory of artifact.
The dest and name will be resolved from destDir. If destDir is not specified, dest and name will be resolved from root.
Type: string, string[]
Default: []
The paths to files which need to be included or excluded.
Read more about patterns in glob package.
Type: string, string[]
Default: []
The paths to files which need to be included.
Type: string, string[]
Default: []
The paths to files which need to be excluded.
Type: boolean
Default: false
If true, destination directory will be packed to tarball file.
Otherwise files of artifact will be copied to destination directory.
Type: boolean, object
Default: false
If true, tarball file will be gzipped.
To change the compression level pass object with level field.
Type: boolean
Default: false
Follow symlinked files and directories.
Note that this can result in a lot of duplicate references in the presence of cyclic links.
Type: boolean
Default: true
Include dotfiles.
Type: boolean
Default: true
Include empty files.
Type: boolean
Default: true
Include empty directories.
Type: object
Allows you to configure settings for write artifacts.
The options specify general settings for all artifacts:
MIT © Andrew Abramov