chore: change the process for generatng readme

1. Remove post-commit hook for gernerating readme.
2. Add pre-push hook that checks readme is up to date.
3. Move other pre-commit hooks to pre-push hook.
4. Check readme is up to date in ci.

Author: chiawendt

.travis.yml

@@ -15,6 +15,7 @@ sudo: false
 script:
   - npm run test
   - 'if [ -n "${LINT-}" ]; then npm run lint; fi'
+  - 'if [ -n "${CHECK_README-}" ]; then npm run check-readme; fi'
   - npm run build
 env:
   matrix:
@@ -25,6 +26,8 @@ matrix:
   include:
     - node_js: 'lts/*'
       env: LINT=true
+    - node_js: 'lts/*'
+      env: CHECK_README=true
   exclude:
     - node_js: 6
       env: ESLINT=6

package.json

@@ -40,8 +40,7 @@
   },
   "husky": {
     "hooks": {
-      "post-commit": "npm run create-readme && git add README.md && git commit -m 'docs: generate docs' --no-verify",
-      "pre-commit": "npm run lint && npm run test && npm run build"
+      "pre-push": "npm run lint && npm run test && npm run build && npm run check-readme"
     }
   },
   "keywords": [
@@ -60,9 +59,9 @@
     "url": "https://github.com/gajus/eslint-plugin-jsdoc"
   },
   "scripts": {
-    "add-assertions": "babel-node ./src/bin/readme-assertions",
     "build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps",
-    "create-readme": "gitdown ./.README/README.md --output-file ./README.md && npm run add-assertions",
+    "check-readme": "babel-node ./src/bin/generateReadme.js --check",
+    "create-readme": "babel-node ./src/bin/generateReadme.js",
     "lint-fix": "eslint --fix ./src ./test",
     "lint": "eslint ./src ./test",
     "test-cov": "BABEL_ENV=test nyc mocha --recursive --require @babel/register --reporter progress --timeout 9000",

src/bin/readme-assertions.js renamed to src/bin/generateReadme.js

@@ -5,6 +5,7 @@ import path from 'path';
 import fs from 'fs';
 import _ from 'lodash';
 import glob from 'glob';
+import Gitdown from 'gitdown';
 
 const trimCode = (code) => {
   let lines = code.replace(/^\n/, '').trimEnd().split('\n');
@@ -66,10 +67,24 @@ const getAssertions = () => {
   return _.zipObject(assertionNames, assertionCodes);
 };
 
-const updateDocuments = (assertions) => {
-  const readmeDocumentPath = path.join(__dirname, '../../README.md');
+const getSomeBranch = () => {
+  const gitConfig = fs.readFileSync(path.join(__dirname, '../../.git/config')).toString();
+  const [, branch] = /\[branch "([^"]+)"\]/.exec(gitConfig) || [];
 
-  let documentBody = fs.readFileSync(readmeDocumentPath, 'utf8');
+  return branch;
+};
+
+const generateReadme = async () => {
+  const assertions = getAssertions();
+  const gitdown = Gitdown.readFile(path.join(__dirname, '../../.README/README.md'));
+
+  gitdown.setConfig({
+    gitinfo: {
+      defaultBranchName: getSomeBranch() || 'master',
+      gitPath: path.join(__dirname, '../../.git')
+    }
+  });
+  let documentBody = await gitdown.get();
 
   documentBody = documentBody.replace(/<!-- assertions ([a-z]+?) -->/ig, (assertionsBlock) => {
     const ruleName = assertionsBlock.match(/assertions ([a-z]+)/i)[1];
@@ -83,7 +98,45 @@ const updateDocuments = (assertions) => {
       '\n````\n\nThe following patterns are not considered problems:\n\n````js\n' + ruleAssertions.valid.join('\n\n') + '\n````\n';
   });
 
-  fs.writeFileSync(readmeDocumentPath, documentBody);
+  return documentBody;
+};
+
+const generateReadmeAndWriteToDisk = async () => {
+  const readme = await generateReadme();
+  const dist = path.join(__dirname, '..', '..', 'README.md');
+  fs.writeFileSync(dist, readme);
+};
+
+const assertReadmeIsUpToDate = async () => {
+  const readme = await generateReadme();
+  const readmePath = path.join(__dirname, '..', '..', 'README.md');
+
+  const isUpToDate = fs.readFileSync(readmePath).toString() === readme;
+
+  if (!isUpToDate) {
+    throw new Error('Readme is not up to date, please run `npm run create-readme` to update it.');
+  }
 };
 
-updateDocuments(getAssertions());
+const main = async () => {
+  try {
+    const hasCheckFlag = process.argv.some((arg) => {
+      return arg === '--check';
+    });
+
+    if (hasCheckFlag) {
+      await assertReadmeIsUpToDate();
+    } else {
+      await generateReadmeAndWriteToDisk();
+    }
+  } catch (error) {
+    /* eslint-disable-next-line no-console */
+    console.error(error);
+    /* eslint-disable-next-line no-process-exit */
+    process.exit(1);
+  }
+};
+
+main();
+
+export default generateReadme;