feat(scripts): implement file-size script (#162)

* build(scripts): implement file-size script

* fix(config): tweak missing types

* refactor(scripts): tweak file-size

* feat(scripts): add migrate v4 to v5 scripts

* chore(vscode): remove prettier config as plugin works now

* refactor: move prettier from config/ to root

* fix(prettier): ignore node_modules

* chore(npm-scripts): apply new prettier config

* feat(scripts): update  migrate v4 to v5 scripts

* ci: fix build

* fix(scripts): don't run init on CI and fix build

* refactor(npm-scripts): remove .js extension and use absolute path to commitizen adapter

* docs: rewrite/cleanup docs

* ci: fix build

* feat(config): extend processEnv types

Author: Hotell

.github/CONTRIBUTING.md

@@ -15,6 +15,47 @@ This library uses following libraries for development:
 - [yarn](https://yarnpkg.com/lang/en/) for package management
 - [npm scripts](https://docs.npmjs.com/misc/scripts) for executing tasks
 
+### 🧪 Tests
+
+Test are written and run via Jest 💪
+
+```sh
+# Run whole test suite once
+yarn test
+# Run test in watch mode
+yarn test:watch
+# Ged code coverage
+yarn test:coverage
+```
+
+### 💅 Style guides
+
+Style guides are enforced by robots _(I meant prettier and tslint of course 🤖 )_, so they'll let you know if you screwed something, but most of the time, they'll autofix things for you. Magic right ?
+
+Lint and format codebase via npm-script:
+
+```sh
+#Format and fix lint errors
+yarn ts:style:fix
+```
+
+#### Commit conventions (via commitizen)
+
+- this is preferred way how to create conventional-changelog valid commits
+- if you prefer your custom tool we provide a commit hook linter which will error out, it you provide invalid commit message
+- if you are in rush and just wanna skip commit message validation just prefix your message with `WIP: something done` ( if you do this please squash your work when you're done with proper commit message so standard-version can create Changelog and bump version of your library appropriately )
+
+```sh
+# invoke [commitizen CLI](https://github.com/commitizen/cz-cli)
+yarn commit
+```
+
+### 📖 Documentation
+
+```sh
+yarn docs
+```
+
 ## Getting started
 
 ### Creating a Pull Request
@@ -33,9 +74,63 @@ If you've never submitted a Pull request before please visit http://makeapullreq
 1.  If there is a `*.spec.ts` file, update it to include a test for your change, if needed. If this file doesn't exist, please create it.
 1.  Run `yarn test` or `yarn test:watch` to make sure all tests are working, regardless if a test was added.
 
-### Commit Message Format
+---
+
+## 🚀 Publishing
+
+> releases are handled by awesome [standard-version](https://github.com/conventional-changelog/standard-version)
+
+> #### NOTE:
+>
+> you have to create npm account and register token on your machine
+> 👉 `npm adduser`
+>
+> If you are using scope (you definitely should 👌) don't forget to [`--scope`](https://docs.npmjs.com/cli/adduser#scope)
+
+Execute `yarn release` which will handle following tasks:
+
+- bump package version and git tag
+- update/(create if it doesn't exist) CHANGELOG.md
+- push to github master branch + push tags
+- publish build packages to npm
+
+> releases are handled by awesome [standard-version](https://github.com/conventional-changelog/standard-version)
+
+### Initial Release (no package.json version bump):
+
+```sh
+yarn release --first-release
+```
+
+### Pre-release
+
+- To get from `1.1.2` to `1.1.2-0`:
+
+`yarn release --prerelease`
+
+- **Alpha**: To get from `1.1.2` to `1.1.2-alpha.0`:
+
+`yarn release --prerelease alpha`
+
+- **Beta**: To get from `1.1.2` to `1.1.2-beta.0`:
+
+`yarn release --prerelease beta`
+
+### Dry run
+
+#### version bump + changelog
+
+```sh
+# See what next release version would be with updated changelog
+yarn standard-version --dry-run
+```
+
+#### npm publish
 
-We use https://conventionalcommits.org/ message format. you can use `yarn commit` to invoke a CLI tool which will guide you through the process.
+```sh
+# check what files are gonna be published to npm
+yarn release:preflight
+```
 
 ## License
 

.prettierignore

@@ -1 +1,2 @@
+node_modules
 dist

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "arrowParens": "always",
+  "semi": false,
+  "bracketSpacing": true,
+  "trailingComma": "es5",
+  "printWidth": 80
+}

.travis.yml

@@ -3,10 +3,12 @@ node_js: '8'
 cache: yarn
 notifications:
   email: false
+env:
+  - CI=true
 before_install:
-  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.12.3
-  - export PATH="$HOME/.yarn/bin:$PATH"
+  - npm config set scripts-prepend-node-path true
+  - npm i -g yarn
 install:
-  - yarn --ignore-scripts
+  - yarn
 script:
   - yarn build

.vscode/settings.json

@@ -11,6 +11,4 @@
   "editor.rulers": [
     80,100
   ],
-  // This needs to be here as prettier plugin has problems with consumning prettier config outside of root
-  "prettier.arrowParens": "always"
 }

README.md

@@ -1,4 +1,8 @@
-# Typescript lib starter
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/1223799/50992071-73562500-1516-11e9-99fa-9f73b0f0eee2.png" width="597" alt="{library-name}">
+</p>
+
+# TypeScript lib starter
 
 [![Greenkeeper badge](https://badges.greenkeeper.io/Hotell/typescript-lib-starter.svg)](https://greenkeeper.io/)
 
@@ -9,7 +13,7 @@
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
 
-This npm library starter:
+## ✨ Features
 
 - creates package for both Node and Browser
 - build will creates 4 standard "package" formats:
@@ -26,7 +30,7 @@ This npm library starter:
   - > `types` field in package.json
 - `sideEffects` 👉 [support proper tree-shaking](https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free) for whole library ( Webpack >= 4). Turn this off or adjust as needed if your modules are not pure!
 
-## Start coding in 2 steps !
+## ✌️ start coding in 2 steps
 
 1.  `git clone https://github.com/Hotell/typescript-lib-starter <your-libary-folder-name> && cd $_`
 
@@ -36,7 +40,7 @@ This npm library starter:
 
 Yes that's it. Happy coding ! 🖖
 
-## Consumption of published library:
+## 💉 Consumption of published library:
 
 1.  install it 🤖
 
@@ -85,7 +89,7 @@ render(App, mountPoint)
 </html>
 ```
 
-### UMD/ES2015 module aware browsers ( no bundler )
+### UMD/ES2015 module aware browsers (no bundler)
 
 ```html
 <html>
@@ -133,91 +137,29 @@ render(App, mountPoint)
 </html>
 ```
 
-## Publish your library
-
-> #### NOTE:
->
-> you have to create npm account and register token on your machine
-> 👉 `npm adduser`
->
-> If you are using scope ( you definitely should 👌) don't forget to [`--scope`](https://docs.npmjs.com/cli/adduser#scope)
-
-Execute `yarn release` which will handle following tasks:
-
-- bump package version and git tag
-- update/(create if it doesn't exist) CHANGELOG.md
-- push to github master branch + push tags
-- publish build packages to npm
-
-> **NOTE:**
->
-> all package files are gonna be within `/dist` folder from where `npm publish` will be executed
-
-> releases are handled by awesome [standard-version](https://github.com/conventional-changelog/standard-version)
-
-### Initial Release (without bumping package.json version):
-
-`yarn release --first-release`
-
-### Pre-release
-
-- To get from `1.1.2` to `1.1.2-0`:
-
-`yarn release --prerelease`
-
-- **Alpha**: To get from `1.1.2` to `1.1.2-alpha.0`:
-
-`yarn release --prerelease alpha`
+## [👨‍🔧 Technical overview](./.github/CONTRIBUTING.md#technical-overview)
 
-- **Beta**: To get from `1.1.2` to `1.1.2-beta.0`:
+### [💅 Style guides](./.github/CONTRIBUTING.md#style-guides)
 
-`yarn release --prerelease beta`
+## [🚀 Publishing](./.github/CONTRIBUTING.md#publishing)
 
-### Dry run mode
-
-See what commands would be run, without committing to git or updating files
-
-`yarn release --dry-run`
-
-## Check what files are gonna be published to npm
-
-- `cd dist && yarn pack` OR `yarn release:preflight` which will create a tarball with everything that would get published to NPM
-
-## Check size of your published NPM bundle
-
-`yarn size`
-
-## Format and fix lint errors
-
-`yarn ts:style:fix`
-
-## Generate documentation
-
-`yarn docs`
-
-## Commit ( via commitizen )
-
-- this is preferred way how to create conventional-changelog valid commits
-- if you prefer your custom tool we provide a commit hook linter which will error out, it you provide invalid commit message
-- if you are in rush and just wanna skip commit message validation just prefix your message with `WIP: something done` ( if you do this please squash your work when you're done with proper commit message so standard-version can create Changelog and bump version of your library appropriately )
-
-`yarn commit` - will invoke [commitizen CLI](https://github.com/commitizen/cz-cli)
-
-### Troubleshooting
+## 🕵️‍♀️ Troubleshooting
 
 #### dynamic `import()`
 
-This starter uses latest **TypeScript >=2.9** which has support for lazy loading chunks/modules via `import()` and also definition acquisition via [`import('../path-to-module').TypeFoo`](http://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-9.html#import-types)
+This starter uses latest **TypeScript >=3.x** which has support for lazy loading chunks/modules via `import()` and also definition acquisition via [`import('../path-to-module').TypeFoo`](http://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-9.html#import-types)
 
 Before TS 2.9, it wasn't possible to properly generate ambient definitions if you used dynamic `import()`. This works now as expected without any hacks ❤️ !
 
----
-
-> ### Before TS 2.9
+> #### Before TS 2.9
 >
 > Please note that if you wanna use that feature, compiler will complain because declaration generation is turned on, and currently TS can't handle type generation with types that will be loaded in the future ( lazily )
 >
 > **How to solve this:**
 >
 > - turn of type checking and don't generate types for that lazy import: `import('./components/button') as any`
 > - or you can use this [temporary workaround](https://github.com/Microsoft/TypeScript/issues/16603#issuecomment-310208259)
+
+## 🥂 License
+
+[MIT](./LICENSE.md) as always

config/global.d.ts

@@ -1,6 +1,11 @@
 // ============================
 // extend existing types
 // ============================
+declare namespace NodeJS {
+  interface ProcessEnv {
+    CI: 'true' | 'false'
+  }
+}
 
 // ============================
 // Rollup plugins without types
@@ -97,3 +102,48 @@ declare module 'replace-in-file' {
   const api: API
   export = api
 }
+
+declare module 'gzip-size' {
+  type Options = import('zlib').ZlibOptions
+  type Input = string | Buffer
+
+  function gzipSize(input: Input, options?: Options): Promise<number>
+  namespace gzipSize {
+    function sync(input: Input, options?: Options): number
+    function stream(options?: Options): import('stream').PassThrough
+    function file(path: string, options?: Options): Promise<number>
+    function fileSync(path: string, options?: Options): number
+  }
+
+  export = gzipSize
+}
+
+declare module 'brotli-size' {
+  type Input = string | Buffer
+
+  namespace brotliSize {
+    function sync(input: Input): number
+    function stream(): import('stream').PassThrough
+  }
+
+  function brotliSize(input: Input): Promise<number>
+
+  export = brotliSize
+}
+
+declare module 'pretty-bytes' {
+  type Options = {
+    /**
+     * @default false
+     */
+    signed: boolean
+    /**
+     * @default false
+     */
+    locale: string | boolean
+  }
+
+  function prettyBytes(input: number, options?: Partial<Options>): string
+
+  export = prettyBytes
+}