Lazy VIN Library
A very quick and very dirty library for getting random VINs.
Install via yarn/npm
yarn add lazy-vin-lib
You can import the generated bundle to use the whole library generated by this starter:
This library exposes the following methods:
Returns a quick and dirty 'random' VIN, complete with a North American valid Check Digit.
A simple, quick and dirty 'random' VIN. It is not guaranteed to be valid. ...did I mention it's quick and dirty?
A simple, quick and 'clean' 'random' VIN. It is not guaranteed to be valid. ...did I mention it's quick and clean?
What makes the return value more 'clean' is a randomly generated six digit unique identifier at the end of a given VIN. The aim is to lower the chances of getting a repeat VIN--not eliminate it.
Features Offered by Seed Project
- Zero-setup. After running
npm installthings will setup for you 😉
- RollupJS for multiple optimized bundles following the standard convention and Tree-shaking
- Tests, coverage and interactive watch mode using Jest
- Prettier and TSLint for code formatting and consistency
- Docs automatic generation and deployment to
gh-pages, using TypeDoc
- Automatic types
- Travis integration and Coveralls report
- (Optional) Automatic releases and changelog, using Semantic release, Commitizen, Conventional changelog and Husky (for the git hooks)
npm t: Run test suite
npm start: Run
npm run buildin watch mode
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting and generate coverage
npm run build: Generate bundles and typings, create docs
npm run lint: Lints code
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)
On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.
Good news: the setup is here for you, you must only include the dependency name in
external property within
rollup.config.js. For example, if you want to exclude
lodash, just write there
Prerequisites: you need to create/login accounts and add your project to:
npm install --global --production windows-build-tools
Follow the console instructions to install semantic release and run it (answer NO to "Do you want a
.travis.yml file with semantic-release setup?").
Note: make sure you've setup
repository.url in your
npm install -g semantic-release-clisemantic-release-cli setup# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P
From now on, you'll need to use
npm run commit, which is a convenient way to create conventional commits.
Automatic releases are possible thanks to semantic release, which publishes your code automatically on github and npm, plus generates automatically a changelog. This setup is highly influenced by Kent C. Dodds course on egghead.io
There is already set a
precommit hook for formatting your code with Prettier 💅
By default, there are two disabled git hooks. They're set up when you run the
npm run semantic-release-prepare script. They make sure:
- You follow a conventional commit message
- Your build is not going to fail in Travis (or your CI server), since it's runned locally before
This makes more sense in combination with automatic releases
Map... is undefined?
TypeScript or Babel only provides down-emits on syntactical features (
async/await...), but not on functional features (
Promise...), . For that, you need Polyfills, such as
babel-polyfill (which extends
For a library,
core-js plays very nicely, since you can import just the polyfills you need:
What if I don't want git-hooks, automatic releases or semantic-release?
Then you may want to:
package.json. That will not use those git hooks to make sure you make a conventional commit
npm run semantic-releasefrom
What if I don't want to use coveralls or report my coverage?
npm run report-coverage from