1.8.0 • Published 4 years ago
prvjs v1.8.0
Privateaser JavaScript shared code
Architect: Raphaël
Installation
Published version:
// package.json
{
"dependencies": {
"prvjs": "git@bitbucket.org:privateaser/prvjs.git@TAG"
}
}
To use the local dev version:
$ cd ~/projects/prvjs
$ npm link
$ cd ~/projects/my-project
$ npm install # installs the published version
$ npm link prvjs # overrides with the local version
Structure
- dist/ Transpiled version (aka IE 10 compatible) of the code
- node_modules/ (ignored) will be filled by npm
- src/ Source code. Can use any "modern" ES2015+ features
Usage
import {LazyStore} from 'prvjs/util/lazy-store.js'
Don't import into your apps the code inside the "/src" directory !
Contributing
Start a branch for your feature and merge to master
after the usual review process.
You should update the code in the src
directory. There, you can use any "modern" ES2015+ features
Once ready :
- Install de dependencies
npm install
- Build the ES5 (aka IE11 compatible) version with
npm run build
- Commit your code AND the compiled version (in the root)
- Publish your changes by tagging a commit on master
vX.Y.Z
, upgrading the appropriate number (major, minor or hotfix), then do a bump commit tovX.Y.Z-dev
.