A backup utility written in pure TypeScript.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Installing for instructions on getting a production ready product.
git clone https://github.com/rugglcon/jsbackup cd jsbackup npm install nvm use // this ensures you're always using a supported version of node npm test
nodejs are the only requirements.
Install locally from
npm install jsbackup
Install globally from
npm install -g jsbackup
Or install from the cloned repo:
npm run dev
# providing files to the program$ jsbackup -c out.tar.gz file1.txt file2.txt# extracting files$ jsbackup -x out.tar.gz
;// compresses a list of files// Promise chaining examplecompressFiles'foo.tar.gz', 'foo.txt'.then.catch;// using async/awaitawait compressFiles'foo.tar.gz', 'foo.txt';// extracts a tarball// Promise chaining exampleextractTarball'foo.tar.gz'.then.catch;// using async/awaitawait extractTarball'foo.tar.gz';
Running the tests
jest is used to test
jsbackup. To run the automated test suites, run
- Support more types of compression (
- Extraction goes along with those
- Support extracting to a specific directory
- Support extracting more than 1 file at a time
Don't really have many guidelines yet, just make sure to be descriptive in any issue submissions (i.e. please provide OS,
npm version, and possibly what kind of shell environment you're using. Any other information you could provide would be helpful as well) and remember to run the tests before submitting a PR, and to add tests for any features you might add to the project.
- Connor Ruggles
This project is licensed under the MIT License - see the LICENSE file for details
tarnpm package for providing the brunt of the work
- all contributors to Nodejs, npm, TypeScript, VSCode, jest, and all other tools that are used to create projects just like this