chore(*): setup generate-changelog npm script (#11)

Author: topheman

README.md

@@ -179,6 +179,14 @@ To have uniform commit messages, I follow the [AngularJS git commit guidelines](
 
 It also makes it easier to generate changelogs.
 
+To generate changelog:
+
+```shell
+npm run generate-changelog -- v1.1.0 v1.2.0
+```
+
+Ready to be pasted to the github releases part.
+
 ## Advanced
 
 ### Mock mode

bin/generate-changelog.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+
+/**
+ * Simple util based on npm package generate-changelog
+ *
+ * Usage: ./generate-changelog.js previousTag currentTag
+ */
+
+const program = require("commander");
+const packageJson = require("../package.json");
+const githubUrlFromGit = require("github-url-from-git");
+const generateChangelog = require("generate-changelog");
+const { exec } = require("child_process");
+
+const githubRepoUrl =
+  (packageJson.repository &&
+    packageJson.repository.url &&
+    githubUrlFromGit(packageJson.repository.url)) ||
+  undefined;
+
+/**
+ * generate-changelog always takes the latest tag as title / date
+ * this patches this little bug and retrieves the exact date of the targetted tag
+ */
+const retrieveGitTagDate = tag =>
+  new Promise((res, rej) => {
+    exec(`git show -s --format=%ci ${tag}^{commit}`, (error, stdout) => {
+      if (error) {
+        return rej(error);
+      }
+      return res(stdout);
+    });
+  });
+
+program
+  .usage("<previousTag> <currentTag>")
+  .command("* <previousTag> <currentTag>")
+  .action((previousTag, currentTag) => {
+    const githubDiffLink = `Diff: ${githubRepoUrl}/compare/${previousTag}...${currentTag}`;
+
+    Promise.all([
+      generateChangelog.generate({
+        tag: `${previousTag}...${currentTag}`,
+        repoUrl: githubRepoUrl
+      }),
+      retrieveGitTagDate(currentTag)
+    ]).then(([changelog, currentTagDate]) => {
+      console.log(
+        changelog.replace(
+          /^(.*)$/m,
+          `#### ${currentTag} (${currentTagDate.substr(0, 10)})`
+        ) + githubDiffLink
+      );
+    });
+  });
+
+program.parse(process.argv);

cypress/integration/search.spec.js

@@ -8,7 +8,7 @@ describe("Search", () => {
     cy
       .getByTestId("search-input")
       .type("react")
-      // can't test for search indicator (only shows up if search-input has focus) - it seams, we loose the focus by getting an other selector ...
+      // can't test for search indicator (only shows up if search-input has focus) - it seems, we loose the focus by getting an other selector ...
       // .getByTestId("search-loading-indicator")
       // .should("not.contain", "error")
       // wait for the results (and make sure it's correct)

package-lock.json

@@ -78,7 +78,8 @@
     "pretty": "npx prettier --write '**/*.{js,jsx,json,css,scss}'",
     "precommit": "lint-staged && npm run lint && npm run test:precommit",
     "proxy-apis-deprecated": "echo 'DEPRECATED' && node ./bin/cors-anywhere.js",
-    "record-http-mocks": "cross-env REACT_APP_NPM_REGISTRY_API_BASE_URL=https://registry.npmjs.org node ./bin/record-http-mocks.js"
+    "record-http-mocks": "cross-env REACT_APP_NPM_REGISTRY_API_BASE_URL=https://registry.npmjs.org node ./bin/record-http-mocks.js",
+    "generate-changelog": "./bin/generate-changelog.js"
   },
   "lint-staged": {
     "**/*.{js,jsx,json,css,scss}": [
@@ -88,6 +89,7 @@
   },
   "devDependencies": {
     "babel-polyfill": "^6.26.0",
+    "commander": "^2.15.1",
     "cors-anywhere": "^0.4.1",
     "cross-env": "^5.1.4",
     "cypress": "^2.1.0",
@@ -103,8 +105,10 @@
     "esm": "^3.0.14",
     "express": "^4.16.3",
     "fs-extra": "^5.0.0",
+    "generate-changelog": "^1.7.1",
     "gh-pages": "^1.1.0",
     "git-rev-sync": "^1.11.1",
+    "github-url-from-git": "^1.5.0",
     "http-proxy-middleware": "^0.18.0",
     "husky": "^0.14.3",
     "jest-dom": "^1.0.0",