vm-add
v7.7.0
Published
Take east, this module is just for test.
Downloads
2
Readme
vm-add
- test semantic-release 1412
- test semantic-release 1429
- test semantic-release 1445
- test semantic-release 1522
- test semantic-release 1655
- test semantic-release 1659
- test semantic-release 2208
- test semantic-release 2231
- test semantic-release 2240
- test semantic-release 2245
A starter project that makes creating a TypeScript library extremely easy.
Usage
yarn vm-add
# or
npm install vm-add
Start coding! package.json
and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same names.
Features
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 how to do that.
The good news is here is setup for you, you only must include the dependency name in external
property within rollup.config.js
. For example, if you wanna exclude lodash
, just write there external: ['lodash']
.
NPM scripts
npm t
: Run test suitenpm start
: Runsnpm run build
in watch modenpm run test:watch
: Run test suite in interactive watch modenpm run test:prod
: Run linting and generate coveragenpm run build
: Generage bundles and typings, create docsnpm run lint
: Lints codenpm run commit
: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)
Automatic releases
If you'd like to have automatic releases with Semantic Versioning, follow these simple steps.
Prerequisites: you need to create/login accounts and add your project to:
- npm
- Travis
- Coveralls
Run the following command to prepare hooks and stuff:
npm run semantic-release-prepare
Follow the console instructions to install semantic release run it (answer NO to "Generate travis.yml").
Note: make sure you've setup repository.url
in your package.json
file
npm install -g semantic-release-cli
semantic-release setup
# IMPORTANT!! Answer NO to "Generate travis.yml" question. 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
Git Hooks
There is already set a precommit
hook for formatting your code with Prettier :nail_care:
By default, there are 2 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 gonna fail in Travis (or your CI server), since it's runned locally before
git push
This makes more sense in combination with automatic releases
FAQ
Array.prototype.from
, Promise
, Map
... is undefined?
TypeScript or Babel only provides down-emits on syntactical features (class
, let
, async/away
...), but not on functional features (Array.prototype.find
, Set
, Promise
...), . For that, you need Polyfills, such as core-js
or babel-polyfill
(which extends core-js
).
For a library, core-js
plays very nicely, since you can import just the polyfills you need:
import "core-js/fn/array/find"
import "core-js/fn/string/includes"
import "core-js/fn/promise"
...
What is npm install
doing the first time runned?
It runs the script tools/init
which sets up everything for you. In short, it:
- Configures RollupJS for the build, which creates the bundles.
- Configures
package.json
(typings file, main file, etc) - Renames main src and test files
What if I don't want git-hooks, automatic releases or semantic-release?
Then you may want to:
- Remove
commitmsg
,postinstall
scripts frompackage.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
Credits
Made with :heart: by @alexjoverm and all these wonderful contributors (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!