https://github.com/tabuckner/lazy-vin-lib
https://github.com/tabuckner/lazy-vin-lib
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tabuckner/lazy-vin-lib
- Owner: tabuckner
- License: mit
- Created: 2019-03-08T01:37:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T16:18:41.000Z (over 3 years ago)
- Last Synced: 2025-02-25T01:47:29.344Z (over 1 year ago)
- Language: TypeScript
- Size: 442 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Lazy VIN Library
[](https://github.com/prettier/prettier)
A very quick and very dirty library for getting random VINs.
[StackBlitz Demo](https://stackblitz.com/edit/lazy-vin-lib-demo)
[App Using the Library](https://tabuckner.github.io/barcode-tool)
## Usage
### Importing library
Install via yarn/npm
```bash
yarn add lazy-vin-lib
```
You can import the generated bundle to use the whole library generated by this starter:
```typescript
import LazyVin from 'lazy-vin-lib'
class MyClass {
private lazyVin;
constructor() {
this.lazyVin = new LazyVin();
}
someSlightlyBetterMethod(): string {
return this.lazyVin.getRandomValidVin();
}
someMethod(): string {
return this.lazyVin.getRandomCleanVin();
}
someRiskierMethod(): string {
return this.lazyVin.getRandomDirtyVin();
}
}
```
### Methods
This library exposes the following methods:
#### getRandomValidVin()
Returns a quick and dirty 'random' VIN, complete with a North American [valid Check Digit](https://en.wikibooks.org/wiki/Vehicle_Identification_Numbers_(VIN_codes)/Check_digit).
#### getRandomDirtyVin()
A simple, quick and dirty 'random' VIN. It is not guaranteed to be valid. ...did I mention it's quick and dirty?
#### getRandomCleanVin()
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 install` things will setup for you :wink:
- **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/)
- Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)**
- **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency
- **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)**
- Automatic types `(*.d.ts)` file generation
- **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report
- (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks)
### NPM scripts
- `npm t`: Run test suite
- `npm start`: Run `npm run build` in watch mode
- `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
- `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](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)
### Excluding peerDependencies
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](https://rollupjs.org/#peer-dependencies) 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 `external: ['lodash']`.
### Automatic releases
_**Prerequisites**: you need to create/login accounts and add your project to:_
- [npm](https://www.npmjs.com/)
- [Travis CI](https://travis-ci.org)
- [Coveralls](https://coveralls.io)
_**Prerequisite for Windows**: Semantic-release uses
**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to
install
[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools)
using this command:_
```bash
npm install --global --production windows-build-tools
```
#### Setup steps
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 `package.json` file_
```bash
npm install -g semantic-release-cli
semantic-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](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library)
### Git Hooks
There is already set a `precommit` hook for formatting your code with Prettier :nail_care:
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](https://github.com/conventional-changelog/conventional-changelog)
- Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push`
This makes more sense in combination with [automatic releases](#automatic-releases)
### FAQ
#### `Array.prototype.from`, `Promise`, `Map`... is undefined?
TypeScript or Babel only provides down-emits on syntactical features (`class`, `let`, `async/await`...), but not on functional features (`Array.prototype.find`, `Set`, `Promise`...), . For that, you need Polyfills, such as [`core-js`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`).
For a library, `core-js` plays very nicely, since you can import just the polyfills you need:
```javascript
import "core-js/fn/array/find"
import "core-js/fn/string/includes"
import "core-js/fn/promise"
...
```
#### What if I don't want git-hooks, automatic releases or semantic-release?
Then you may want to:
- Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit
- Remove `npm run semantic-release` from `.travis.yml`
#### What if I don't want to use coveralls or report my coverage?
Remove `npm run report-coverage` from `.travis.yml`
## Acknowledgements
### Typescript-Libarary-Starter
[Check It Out](https://github.com/alexjoverm/typescript-library-starter)
Made with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):