feat: regenerate readme options on release

README.md

@@ -26,8 +26,7 @@ Here are a couple examples of using the FalTest CLI.
 
 ## Default Options
 
-(regen using `yarn start --help`)
-
+<!-- CODEGEN_CLI_HELP_START -->
 ```
   --help                          Show help                            [boolean]
   --version                       Show version number                  [boolean]
@@ -75,6 +74,7 @@ Here are a couple examples of using the FalTest CLI.
   --reporter                      Change the Mocha reporter             [string]
   --reporter-options              Supply Mocha reporter options         [string]
 ```
+<!-- CODEGEN_CLI_HELP_END -->
 
 ## Filtering
 

helpers/fs.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const fs = require('fs');
+const { promisify } = require('util');
+const readFile = promisify(fs.readFile);
+const writeFile = promisify(fs.writeFile);
+
+async function replaceFile(path, callback) {
+  let contents = await readFile(path, 'utf8');
+  contents = await callback(contents);
+  await writeFile(path, contents);
+}
+
+module.exports = {
+  replaceFile,
+};

package.json

@@ -8,7 +8,7 @@
     "lint:git": "commitlint",
     "lint:js": "eslint . --ext js,json",
     "lint:md": "remark -f doc CONTRIBUTING.md README.md packages/*/README.md examples/*/README.md packages/lint/doc",
-    "release": "next release --scripts.postbump \"node scripts/postbump\" --no-bump-in-range-dependencies",
+    "release": "next release --scripts.precommit \"node scripts/precommit && git add -A\" --scripts.postbump \"node scripts/postbump\" --no-bump-in-range-dependencies",
     "start": "./packages/cli/bin/index.js",
     "test": "./scripts/run.js packages test",
     "test:acceptance": "mocha --recursive"

scripts/precommit.js

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+'use strict';
+
+const execa = require('execa');
+const path = require('path');
+const { replaceFile } = require('../helpers/fs');
+
+const rootDirectory = path.resolve(__dirname, '..');
+
+async function replace({ replacementRegex, replacementText, filePath }) {
+  replacementText = `$1
+\`\`\`
+${replacementText}
+\`\`\`
+$2`;
+
+  await replaceFile(filePath, (contents) => {
+    if (!replacementRegex.test(contents)) {
+      throw new Error(`${filePath} is malformed`);
+    }
+
+    return contents.replace(replacementRegex, replacementText);
+  });
+}
+
+async function syncCliOptions() {
+  let helpText = (
+    await execa('yarn', ['--silent', 'start', '--help'], {
+      cwd: rootDirectory,
+      env: {
+        FALTEST_PRINT_VERSION: 'false',
+      },
+    })
+  ).stdout;
+
+  let replacementRegex = /(<!-- CODEGEN_CLI_HELP_START -->).+(<!-- CODEGEN_CLI_HELP_END -->)/s;
+
+  let readmePath = path.join(rootDirectory, 'README.md');
+
+  await replace({
+    replacementRegex,
+    replacementText: helpText,
+    filePath: readmePath,
+  });
+}
+
+(async () => {
+  await syncCliOptions();
+})();
+
+require('../packages/cli/src/utils/throw-up');