Description
This module provides a gitzip command that creates zip file ignoring files from .gitignore file.
If the source folder doesn't contain .gitignore then all files will be zipped.
Useful to share the current changes while working on git repository. It complements the git archive where you don't need to commit or stash the changes to create untracked changed file.
🤐 gitzip alternatives and similar modules
Based on the "Compression" category.
Alternatively, view 🤐 gitzip alternatives based on common mentions on social networks and blogs.
-
-
#<Sawyer::Resource:0x00007f6e5cf44ee0>
JavaScript library to zip and unzip files supporting multi-core compression, compression streams, zip64, split files and encryption. -
-
SurveyJS - Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of 🤐 gitzip or a related project?
|
WorkOS - The modern identity platform for B2B SaaS
sponsored
workos.com
|
Popular Comparisons
|
InfluxDB - Power Real-Time Data Analytics at Scale
sponsored
www.influxdata.com
|
README
:zipper_mouth_face: gitzip
This module provides a gitzip command that creates zip file ignoring files from .gitignore file.
If the source folder doesn't contain .gitignore then all files will be zipped.
:bulb: Useful to share the current changes while working on git repository. It complements the git archive where you don't need to commit or stash the changes to create untracked changed file.
Global command line usage
npm install -g gitzip
go to the folder you want to zip and run
gitzip
This will generate submission.zip
Command line usage within package.json scripts
npm install --save-dev gitzip
package.json:
{
//...
"scripts": {
"build" "...",
"zip": "gitzip -d bundle.zip -s build/*",
"upload": "....",
"deploy": "npm run build && npm run zip && npm run upload"
}
}
Programmatic usage from within Node.js
var zip = require('gitzip');
zip({
source: 'build/*',
destination: './destination.zip',
exclude: ['destination.zip'],
include: ['.git']
}).then(function() {
console.log('all done!');
}).catch(function(err) {
console.error(err.stack);
process.exit(1);
});
Options
source[-s]
* Type: `string`
* Default: `.` current directory
Path to files and folders to include in the zip file. String or Array of Strings. Defaults to current path.
destination
* Type: `string`
* Default: `submission.zip` at current directory
Path to generated .zip file. Defaults to submission.zip in current path.
exclude
* Type: `string[]`
Array of strings of file pattern to exclude from zip
include
* Type: `string[]`
Array of strings of file pattern to include in zip.
Note, include has more precedence than exclude
Node Version
Node 8 or greater
## License
This software is released under the terms of the MIT license.
*Note that all licence references and agreements mentioned in the 🤐 gitzip README section above
are relevant to that project's source code only.