feat(scripts): implement init script (#143)

* feat(scripts): use init on postinstall
* feat(scripts): add vscode settings prompt
* ci: use latest yarn
* ci: don't run postinstall on CI
* chore: bump deps
* refactor: use ambient fiels for local types
* feat(templates): add templates and their setup
* feat(config): add replace-in-file types
* fix(scripts): fix init files modifications
* fix(scripts): fix templates setup
* feat(scripts): add additional prompt questions
* fix(scripts): properly handle vscode setup
* fix(scripts): initialize hooks properly
* ci: fix yarn install
* fix(scripts): resolve ts errors
* feat(vscode): add more settings
* fix(scripts): use githubName in readme template
* docs: add setup video
* feat: add index barrel tsd like header
* refactor(scripts): reorder modifyFiles array

BREAKING CHANGE:
Now TS >= 3 is used which may break some packages that desperately need to support lower versions

Closes #142 #145 #130

Author: Hotell

Diff for: .github/CONTRIBUTING.md

@@ -26,10 +26,10 @@ If you've never submitted a Pull request before please visit http://makeapullreq
 1.  Fork the repo.
 1.  `git clone` your fork.
 1.  Make a `git checkout -b branch-name` branch for your change.
-1.  Run `yarn install` (make sure you have node and npm installed first)
+1.  Run `yarn install --ignore-scripts` (make sure you have node and yarn installed first)
     Updates
 
-1.  make sure to add unit tests
+1.  Make sure to add unit tests
 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.
 

Diff for: .github/ISSUE_TEMPLATE.md

@@ -4,7 +4,7 @@
 
 ## Bug report
 
-- {library-name} version: _x.x.x_ (<!-- (run `npm list {library-name}` from a terminal/cmd prompt): -->)
+- {package-name} version: _x.x.x_ (<!-- (run `npm list {package-name}` from a terminal/cmd prompt): -->)
 - Affected browsers (and versions): _IE 10_
 
 ### Current behaviour

Diff for: .travis.yml

@@ -3,7 +3,10 @@ node_js: '8'
 cache: yarn
 notifications:
   email: false
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.12.3
+  - export PATH="$HOME/.yarn/bin:$PATH"
 install:
-  - yarn
+  - yarn --ignore-scripts
 script:
   - yarn build

Diff for: .vscode/settings.json

@@ -5,9 +5,12 @@
   "editor.formatOnSave": true,
   "typescript.format.enable": false,
   "javascript.format.enable": false,
+  "typescript.implementationsCodeLens.enabled": true,
   "typescript.referencesCodeLens.enabled": true,
   "javascript.referencesCodeLens.enabled": true,
   "editor.rulers": [
     80,100
   ],
+  // This needs to be here as prettier plugin has problems with consumning prettier config outside of root
+  "prettier.arrowParens": "always"
 }

Diff for: README.md

@@ -26,39 +26,15 @@ 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 4 steps !
+## Start coding in 2 steps !
 
 1.  `git clone https://github.com/Hotell/typescript-lib-starter <your-libary-folder-name> && cd $_`
 
-2.  `rm -rf .git && git init`
-
-3.  in `package.json` reset following fields:
-
-```diff
-{
-- "name": "@next-gen/typescript-lib-starter",
-+ "name": "{yourLibraryPackageName}",
-- "version": "1.7.0",
-+ "version": "1.0.0",
-- "description": "TypeScript library setup for multiple compilation targets using tsc and webpack",
-+ "description": "What is your library all about...",
-- "keywords": [ "typescript", "library-starter", "rollup", "jest" ]
-+ "keywords": [ "typescript", "your library keyowrds" ]
-- "author": "Martin Hochel",
-+ "author": "{yourName}",
-- "license": "MIT",
-+ "license": "{yourLicense}",
-  "repository": {
-    "type": "git",
--   "url": "https://www.github.com/Hotell/typescript-lib-starter"
-+   "url": "https://www.github.com/{yourAccountName}/{yourLibraryPackageName}"
-  }
-}
-```
+1.  `yarn`
 
-4.  Install all dependencies `yarn install`
+![setting-up-your-library](https://user-images.githubusercontent.com/1223799/49905150-fd09c880-fe6c-11e8-9ad8-425c3a38b1b4.gif)
 
-Happy coding ! 🖖
+Yes that's it. Happy coding ! 🖖
 
 ## Consumption of published library:
 

Diff for: config/global.d.ts

@@ -73,3 +73,25 @@ declare module 'sort-object-keys' {
   ) => T
   export = sortPackageJson
 }
+
+declare module 'prompt'
+declare module 'replace-in-file' {
+  interface Options {
+    files: string | string[]
+    from: Array<string | RegExp>
+    to: string | string[]
+    ignore: string | string[]
+    dry: boolean
+    encoding: string
+    disableGlobs: boolean
+    allowEmptyPaths: boolean
+  }
+
+  interface API {
+    (options: Partial<Options>): string[]
+    sync(options: Partial<Options>): string[]
+  }
+
+  const api: API
+  export = api
+}

Diff for: config/types.d.ts

@@ -0,0 +1,14 @@
+// ===== JEST ====
+export type TsJestConfig = import('ts-jest/dist/types').TsJestConfig
+export type JestConfig = Partial<jest.ProjectConfig & jest.GlobalConfig>
+
+// ==== PRETTIER ====
+export type PrettierConfig = import('prettier').Options
+
+// ==== ROLLUP ====
+export type RollupConfig = import('rollup').InputOptions & {
+  output:
+    | import('rollup').OutputOptions
+    | Array<import('rollup').OutputOptions | null>
+}
+export type RollupPlugin = import('rollup').Plugin

Diff for: config/types.js

@@ -23,6 +23,7 @@
     "node": ">=8.5"
   },
   "scripts": {
+    "postinstall": "node scripts/init.js",
     "cleanup": "shx rm -rf dist",
     "prebuild": "npm run cleanup && npm run verify",
     "build": "tsc && tsc --target es2018 --outDir dist/esm2015 && rollup -c config/rollup.config.js && rollup -c config/rollup.config.js --environment NODE_ENV:production",
@@ -81,10 +82,11 @@
     "@commitlint/cli": "7.2.1",
     "@commitlint/config-conventional": "7.1.2",
     "@types/chokidar": "1.7.5",
-    "@types/jest": "23.3.9",
+    "@types/jest": "23.3.10",
     "@types/json5": "0.0.30",
-    "@types/node": "10.12.10",
-    "@types/prettier": "1.15.1",
+    "@types/node": "8.10.*",
+    "@types/prettier": "1.15.2",
+    "@types/prompts": "1.1.1",
     "@types/webpack-config-utils": "2.3.0",
     "commitizen": "3.0.5",
     "cross-var": "1.1.0",
@@ -94,29 +96,33 @@
     "jest": "23.6.0",
     "jest-watch-typeahead": "0.2.0",
     "json5": "2.1.0",
+    "kleur": "3.0.1",
     "lint-staged": "8.1.0",
-    "prettier": "1.15.2",
-    "rollup": "0.67.3",
+    "prettier": "1.15.3",
+    "prompts": "2.0.0",
+    "replace-in-file": "3.4.2",
+    "rollup": "0.67.4",
     "rollup-plugin-commonjs": "9.2.0",
     "rollup-plugin-json": "3.1.0",
-    "rollup-plugin-node-resolve": "3.4.0",
+    "rollup-plugin-node-resolve": "4.0.0",
     "rollup-plugin-replace": "2.1.0",
     "rollup-plugin-sourcemaps": "0.4.2",
     "rollup-plugin-terser": "3.0.0",
     "rollup-plugin-uglify": "6.0.0",
+    "shelljs": "0.8.3",
     "shx": "0.3.2",
     "sort-object-keys": "1.1.2",
     "standard-version": "4.4.0",
     "strip-json-comments-cli": "1.0.1",
     "ts-jest": "23.10.5",
     "tslib": "1.9.3",
     "tslint": "5.11.0",
-    "tslint-config-prettier": "1.16.0",
+    "tslint-config-prettier": "1.17.0",
     "tslint-config-standard": "8.0.1",
     "tslint-etc": "1.2.7",
     "tslint-react": "3.6.0",
     "typedoc": "0.13.0",
-    "typescript": "2.9.2",
+    "typescript": "3.2.2",
     "webpack-config-utils": "2.3.1"
   }
 }

Diff for: package.json

@@ -1,3 +1,9 @@
+/**
+ * This file only purpose is to copy files before npm publish and strip churn/security sensitive metadata from package.json
+ *
+ * **NOTE:**
+ * 👉 This file should not use any 3rd party dependency
+ */
 const { writeFileSync, copyFileSync } = require('fs')
 const { resolve } = require('path')
 const packageJson = require('../package.json')