refactor to better support CLI

paulirish · paulirish · commit 1b53fb4855a8 · 2020-02-24T16:28:33.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,5 @@ other
 
 package-lock.json
 
-.now
+.now
+.env
diff --git a/now.json b/now.json
@@ -10,6 +10,6 @@
     ".gitattributes"
   ],
   "env": {
-    "GHTOKEN":"@ghtoken"
+    "ghtoken":"@ghtoken"
   }
 }
diff --git a/src/cli.js b/src/cli.js
@@ -0,0 +1,76 @@
+const commitlintbot = require('./');
+
+/*
+  Running
+
+  env (cat .env) node src/cli.js "feat: awesome feature"
+  gls src/* | entr env (cat .env) node src/cli.js "feat: awesome feature"
+
+  options:
+    --report reports to github status check
+*/
+
+(async function() {
+  const commitmsg = process.argv[2];
+
+  const {clintConfig, czConfig} = getLHConfigPlaceholders();
+
+  const cliRunData = {
+    title: commitmsg,
+    clintConfig,
+    czConfig,
+  };
+  const prData = {
+    repo: 'GoogleChrome/lighthouse',
+    srcRepo: 'GoogleChrome/lighthouse',
+    sha: 'dba63a60d774d9f6fa1ef0974495bec96af2235c',
+    pr: '10361',
+  };
+  const opts = {
+    reportStatus: process.argv.includes('--report'),
+  };
+
+  await commitlintbot(prData, cliRunData, opts);
+})();
+
+function getLHConfigPlaceholders() {
+  const clintConfig = {
+    extends: ['cz'],
+    rules: {
+      'body-leading-blank': [1, 'always'],
+      'body-tense': [1, 'always', ['present-imperative']],
+      'footer-leading-blank': [1, 'always'],
+      'footer-tense': [1, 'always', ['present-imperative']],
+      'header-max-length': [2, 'always', 80],
+      // 'lang': [0, 'always', 'eng'],
+      'scope-case': [2, 'always', 'lowerCase'],
+      'scope-empty': [0, 'never'],
+      'subject-case': [1, 'always', 'lowerCase'],
+      'subject-empty': [0, 'never'],
+      'subject-full-stop': [2, 'never', '.'],
+      // 'subject-tense': [1, 'always', ['present-imperative']],
+      'type-case': [2, 'always', 'lowerCase'],
+      'type-empty': [2, 'never'],
+      // The scope-enum :  defined in the cz-config
+      // The 'type-enum':  defined in the cz-config
+    },
+  };
+  const czConfig = {
+    allowBreakingChanges: ['core'],
+    allowCustomScopes: true,
+    scopes: [],
+    types: [
+      {value: 'new_audit', name: 'new_audit: A new audit'},
+      {value: 'core', name: 'core:      Driver, gather, (non-new) audits, LHR JSON, etc'},
+      {value: 'tests', name: 'tests:     Tests, smokehouse, etc'},
+      {value: 'i18n', name: 'i18n:      Internationalization'},
+      {value: 'docs', name: 'docs:      Documentation'},
+      {value: 'deps', name: 'deps:      Dependency bumps only'},
+      {value: 'report', name: 'report:    Report, UI, renderers'},
+      {value: 'cli', name: 'cli:       CLI stuff'},
+      {value: 'clients', name: 'clients:   Extension, DevTools, or LR stuff'},
+      {value: 'misc', name: 'misc:      Something else entirely'},
+    ],
+  };
+  return {clintConfig, czConfig};
+}
diff --git a/src/index.js b/src/index.js
@@ -17,47 +17,55 @@ const czConfigFilename = `.cz-config.js`;
 const clintConfigFilename = 'commitlint.config.js';
 
 const baseGithubData = {
-  token: process.env.GHTOKEN, // (github oauth token: https://developer.github.com/v3/oauth)
+  token: process.env.ghtoken, // (github oauth token: https://developer.github.com/v3/oauth)
   label: 'pr title lint'
 };
 
-async function init(prData) {
-  let status;
+async function gatherGithubData(githubData) {
+  const apiFetches = [
+    getPRTitle(githubData),
+    getFileContents(githubData, clintConfigFilename),
+    getFileContents(githubData, czConfigFilename)
+  ];
+  let [title, clintConfigContent, czConfigContent] = await Promise.all(apiFetches);
+
+  // requireFromString: js file string => object
+  const clintConfig = clintConfigContent && requireFromString(clintConfigContent);
+  const czConfig = requireFromString(czConfigContent);
+
+  return {title, clintConfig, czConfig}
+}
+
+async function main(prData, cliRunData = false, {reportStatus = true}) {
   try {
+    let status;
     const githubData = Object.assign({}, baseGithubData, prData);
-    status = new CommitStatus(githubData);
-    await status.start('Linting the pull request title...').catch(handleCommitStatusFailure);
 
-    const lintOpts = {};
+    status = reportStatus ? new CommitStatus(githubData) : new MockCommitStatus();
+    await status.start('Linting the pull request title...').catch(handleCommitStatusFailure);
 
-    const apiFetches = [
-      getPRTitle(githubData),
-      getFileContents(githubData, clintConfigFilename),
-      getFileContents(githubData, czConfigFilename)
-    ];
-    let [title, clintConfigContent, czConfigContent] = await Promise.all(apiFetches);
+    // Allow CLI use for local testing :p
+    const {title, clintConfig, czConfig} = await (!cliRunData ?
+      gatherGithubData(githubData) :
+      Promise.resolve(cliRunData));
 
-    if (clintConfigContent) {
-      lintOpts.clintConfig = requireFromString(clintConfigContent);
-    }
-    if (czConfigContent) {
-      czConfigContent = requireFromString(czConfigContent)
-    }
+    const {report, reportObj} = await lint(title, clintConfig, czConfig);
 
-    const {report, reportObj} = await lint(title, lintOpts, czConfigContent);
 
-    const flatReport = report.join('. ');
+    reportStatus && console.log('🌏 Reporting real status to GitHub: ', `https://api.github.com/repos/${prData.repo}/statuses/${prData.sha}`);
 
     // Set status to passing
     if (reportObj.valid === true) {
-      console.log(`> 🖋✅ Setting status: _passing_ (https://github.com/${githubData.repo}/pull/${githubData.pr})`);
+      console.log(`> 🖋✅ _Passing_ (https://github.com/${githubData.repo}/pull/${githubData.pr})`);
       return status
         .pass('PR title is good to go, boss', generateURL(title, report))
         .catch(handleCommitStatusFailure);
     }
 
     // Set status to failing
-    console.log(`> 🖋❌ Setting status: _failing_ (https://github.com/${githubData.repo}/pull/${githubData.pr})`);
+    console.log(`> 🖋❌ _Failing_ (https://github.com/${githubData.repo}/pull/${githubData.pr})`);
+
+    const flatReport = report.join('.\n');
     console.log(flatReport);
     const failureMsg = flatReport.slice(0, MAXIMUM_STATUS_LENGTH);
     return status.fail(failureMsg, generateURL(title, report)).catch(handleCommitStatusFailure);
@@ -74,7 +82,7 @@ async function init(prData) {
   }
 }
 
-module.exports = init;
+module.exports = main;
 
 function generateURL(prTitle, reportArr) {
   const outputStr = `
@@ -93,3 +101,9 @@ Expected PR title format is: \`{type}({optional-scope}): {subject}\`
   return `https://commitlintbot.now.sh/details/?msg=${encodeURIComponent(outputStr)}`;
 }
 
+class MockCommitStatus {
+  start (_) { return Promise.resolve(); }
+  pass  (_) { return Promise.resolve(); }
+  fail  (_) { return Promise.resolve(); }
+  error (_) { return Promise.resolve(); }
+}
diff --git a/src/jest.config.js b/src/jest.config.js
@@ -2,6 +2,6 @@
 
 module.exports = {
   globals: {
-    GHTOKEN: process.env.GHTOKEN,
+    ghtoken: process.env.ghtoken,
   },
 };
diff --git a/src/lint.js b/src/lint.js
@@ -4,11 +4,11 @@ const commitlint = require('@commitlint/core');
 const mergeCZWithBaseConfig = require('commitlint-config-cz/lib/config').get;
 const defaultClintConfig = require('./default-commitlint.config');
 
-async function lint(prTitle, lintOpts = {}, czConfig) {
+async function lint(prTitle, clintConfig = {}, czConfig) {
   console.log(`> Linting: ${prTitle}`);
 
   // Use provided commitlint.config or fallback to our local preset
-  const baseConfig = lintOpts.clintConfig || defaultClintConfig;
+  const baseConfig = clintConfig || defaultClintConfig;
   baseConfig.extends = baseConfig.extends || [];
 
   let mergedConfig;
@@ -30,73 +30,28 @@ async function lint(prTitle, lintOpts = {}, czConfig) {
     mergedConfig = baseConfig;
   }
 
-  const opts = await commitlint.load(mergedConfig);
-  const reportObj = await commitlint.lint(prTitle, opts.rules);
-  let report = await commitlint.format.formatResult(reportObj, {color: false});
-  // drop weird helpURL https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-api.md#usage
-  report = report.slice(0, report.length - 2);
-  return {reportObj, report};
-}
-
-module.exports = lint;
+  // HACK remove deprecated rules. Can be removed after existing PRs
+  for (const deprecatedRule of ['body-tense', 'footer-tense', 'lang', 'subject-tense']) {
+    delete mergedConfig.rules[deprecatedRule];
+  }
 
-// Run via
-//         node lint.js "feat: awesome feature"
-//         node lint.js "feat: awesome feature" --lh  # --lh has to be argv[3]..
-//
-if (process.argv.length > 2 && process.argv[1].includes('lint.js')) {
-  (async function() {
-    if (process.argv[3] == '--lh') {
-      const {lintOpts, czConfig} =  getLHConfigPlaceholders();
-      const {report} = await lint(process.argv[2], lintOpts, czConfig);
-      process.stdout.write(report.join('\n') + '\n');
-    } else {
-      const {report} = await lint(process.argv[2],);
-      process.stdout.write(report.join('\n') + '\n');
+  const opts = await commitlint.load(mergedConfig);
+  try {
+    const reportObj = await commitlint.lint(prTitle, opts.rules);
+    let report = await commitlint.format.formatResult(reportObj, {color: false});
+    // drop weird helpURL https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-api.md#usage
+    report = report.slice(0, report.length - 2);
+    return {reportObj, report};
+  } catch (e) {
+    return {
+      reportObj: {
+        valid: false,
+        errors: [e.message],
+        warnings: [],
+      },
+      report: [e.message]
     }
-  })();
+  }
 }
 
-function getLHConfigPlaceholders() {
-  const lintOpts = {
-    clintConfig: {
-      extends: ['cz'],
-      rules: {
-        'body-leading-blank': [1, 'always'],
-        // 'body-tense': [1, 'always', ['present-imperative']],
-        'footer-leading-blank': [1, 'always'],
-        // 'footer-tense': [1, 'always', ['present-imperative']],
-        'header-max-length': [2, 'always', 80],
-        // 'lang': [0, 'always', 'eng'],
-        'scope-case': [2, 'always', 'lowerCase'],
-        'scope-empty': [0, 'never'],
-        'subject-case': [1, 'always', 'lowerCase'],
-        'subject-empty': [0, 'never'],
-        'subject-full-stop': [2, 'never', '.'],
-        // 'subject-tense': [1, 'always', ['present-imperative']],
-        'type-case': [2, 'always', 'lowerCase'],
-        'type-empty': [2, 'never'],
-        // The scope-enum :  defined in the cz-config
-        // The 'type-enum':  defined in the cz-config
-      },
-    }
-  };
-  const czConfig = {
-    allowBreakingChanges: ['core'],
-    allowCustomScopes: true,
-    scopes: [],
-    types: [
-      {value: 'new_audit',  name: 'new_audit: A new audit'},
-      {value: 'core',       name: 'core:      Driver, gather, (non-new) audits, LHR JSON, etc'},
-      {value: 'tests',      name: 'tests:     Tests, smokehouse, etc'},
-      {value: 'i18n',       name: 'i18n:      Internationalization'},
-      {value: 'docs',       name: 'docs:      Documentation'},
-      {value: 'deps',       name: 'deps:      Dependency bumps only'},
-      {value: 'report',     name: 'report:    Report, UI, renderers'},
-      {value: 'cli',        name: 'cli:       CLI stuff'},
-      {value: 'clients',    name: 'clients:   Extension, DevTools, or LR stuff'},
-      {value: 'misc',       name: 'misc:      Something else entirely'}
-    ]
-  };
-  return {lintOpts, czConfig};
-}
+module.exports = lint;
diff --git a/src/server.js b/src/server.js
@@ -21,7 +21,7 @@ const indexGET = (request, response) => {
 };
 
 const indexPOST = (request, response) => {
-  let result;
+  let prData;
   try {
     const {headers, body} = request;
 
@@ -45,7 +45,7 @@ const indexPOST = (request, response) => {
     }
 
     // pull out required info
-    result = {
+    prData = {
       repo: body.repository.full_name,
       srcRepo: body.pull_request.head.repo.full_name,
       sha: body.pull_request.head.sha,
@@ -60,7 +60,7 @@ const indexPOST = (request, response) => {
   queue.add(async _ => {
     log.info(`> Calling commitlint bot with received webhook data`);
     try {
-      const {status, data} = await commitlintbot(result);
+      const {status, data} = await commitlintbot(prData);
       // Some status API call failure
       if (data.error) {
         if (status === 404)

-Original file line number
+Diff line change
 package-lock.json
 -.now
 +.now
 +.env
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,6 @@`
`10`	`10`	`".gitattributes"`
`11`	`11`	`],`
`12`	`12`	`"env": {`
`13`		`- "GHTOKEN":"@ghtoken"`
	`13`	`+ "ghtoken":"@ghtoken"`
`14`	`14`	`}`
`15`	`15`	`}`