feat(scripts): implement build script

- this handles dts header creation

Author: Hotell

package.json

@@ -29,7 +29,7 @@
     "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",
-    "postbuild": "node scripts/copy && npm run size",
+    "postbuild": "node scripts/copy && node scripts/build && npm run size",
     "docs": "typedoc -p . --theme minimal --target 'es6' --excludeNotExported --excludePrivate --ignoreCompilerErrors --exclude \"**/src/**/__tests__/*.*\" --out docs src/",
     "test": "jest -c ./config/jest.config.js",
     "test:watch": "npm t -- --watch",
@@ -46,7 +46,7 @@
     "lint:fix": "npm run lint -- --fix",
     "prerelease": "npm run build",
     "release": "standard-version",
-    "postrelease": "node scripts/copy && npm run release:github && npm run release:npm",
+    "postrelease": "node scripts/copy && node scripts/build && npm run release:github && npm run release:npm",
     "release:github": "git push --no-verify --follow-tags origin master",
     "release:npm": "npm publish dist",
     "release:preflight": "npm pack ./dist --dry-run",

scripts/build.js

@@ -0,0 +1,66 @@
+/**
+ * This file only purpose is to execute any build related tasks
+ */
+
+const { resolve, normalize } = require('path')
+const { readFileSync, writeFileSync } = require('fs')
+const pkg = require('../package.json')
+
+const ROOT = resolve(__dirname, '..')
+const DIST = resolve(ROOT, 'dist')
+const TYPES_ROOT_FILE = resolve(DIST, normalize(pkg.typings))
+
+main()
+
+function main() {
+  writeDtsHeader()
+}
+
+function writeDtsHeader() {
+  const dtsHeader = getDtsHeader(
+    pkg.name,
+    pkg.version,
+    pkg.author,
+    pkg.repository.url,
+    pkg.devDependencies.typescript
+  )
+
+  prependFileSync(TYPES_ROOT_FILE, dtsHeader)
+}
+
+/**
+ *
+ * @param {string} pkgName
+ * @param {string} version
+ * @param {string} author
+ * @param {string} repoUrl
+ * @param {string} tsVersion
+ */
+function getDtsHeader(pkgName, version, author, repoUrl, tsVersion) {
+  const extractUserName = repoUrl.match(/\.com\/([\w-]+)\/\w+/i)
+  const githubUserUrl = extractUserName ? extractUserName[1] : 'Unknown'
+
+  return `
+// Type definitions for ${pkgName} ${version}
+// Project: ${repoUrl}
+// Definitions by: ${author} <https://github.com/${githubUserUrl}>
+// Definitions: ${repoUrl}
+// TypeScript Version: ${tsVersion}
+`.replace(/^\s+/gm, '')
+}
+
+/**
+ *
+ * @param {string} path
+ * @param {string | Blob} data
+ */
+function prependFileSync(path, data) {
+  const existingFileContent = readFileSync(path, {
+    encoding: 'utf8',
+  })
+  const newFileContent = [data, existingFileContent].join('\n')
+  writeFileSync(path, newFileContent, {
+    flag: 'w+',
+    encoding: 'utf8',
+  })
+}

scripts/migrate/migrate-4-5.js

@@ -252,7 +252,7 @@ function updateScriptsDir() {
   const starterPathDir = resolve(ROOT, 'scripts')
   const libPackagePathDir = resolve(PACKAGE_ROOT, 'scripts')
 
-  const cpFiles = ['copy.js', 'file-size.js', 'tsconfig.json']
+  const cpFiles = ['copy.js', 'file-size.js', 'build.js', 'tsconfig.json']
   /** @type {string[]} */
   const rmFiles = []
   const rmDirs = ['migrate']

src/index.ts

@@ -1,9 +1 @@
-/**
- * Type definitions for {package-name} 0.0.0
- * Project: https://github.com/{github-name}/{library-name}
- * Definitions by: {username} <https://github.com/{github-name}>
- * Definitions: https://github.com/{github-name}/{library-name}
- * TypeScript Version: 3.2
- */
-
 export { Greeter } from './greeter'