pg-testdb-template

pg-testdb-template

Richard Wen
[e-mail]

Command line tool for creating a pg-testdb template file

Install

• Install Node.js (v6.0.0+)
• Install pg-testdb via npm
• Install pg-testdb-template via npm

npm install pg-testdb --save-dev
npm install pg-testdb-template -g

For the latest developer version, see Developer Install.

Usage

Create a template file named pg-testdb-template.js for the pg-testdb package in the current directory:

pg-testdb-template

Create a template file named pg_tests.js in the current directory:

pg-testdb-template pg_tests.js

For help, use:

pg-testdb-template --help

Developer Notes

Developer Install

Install the latest developer version with npm from github:

npm install git+https://github.com/rrwen/pg-testdb-template

Install from git cloned source:

• Ensure git is installed
• Clone into current path
• Install via npm

git clone https://github.com/rrwen/pg-testdb-template
cd pg-testdb-template
npm install

Tests

• Clone into current path git clone https://github.com/rrwen/pg-testdb-template
• Enter into folder cd pg-testdb-template
• Ensure tape and moment are available
• Run tests
• Results are saved to ./tests/log with each file corresponding to a version tested

npm install
npm test

Upload to Github

• Ensure git is installed
• Inside the pg-testdb-template folder, add all files and commit changes
• Push to github

git add .
git commit -a -m "Generic update"
git push

Upload to npm

• Update the version in package.json
• Run tests and check for OK status
• Login to npm
• Publish to npm

npm test
npm login
npm publish

Implementation

The npm core package fs was used to copy a template from the pg-testdb-template install directory to the user's current directory:

• Create a read stream with var read = fs.createReadStream('template.js');
• Create a write stream with var write = fs.createWriteStream('copy.js');
• Pipe the read stream to the write stream read.pipe(write);