ci: integrate public export checks

Author: vladjerca

.build/check-public-exports/index.ts

@@ -11,17 +11,24 @@ import {
 } from 'path';
 import * as ts from 'typescript';
 
+import {
+  getPullRequestHead,
+  statusReporterFactory,
+} from '../common/github';
+
+const reportStatus = statusReporterFactory('public-api-check');
+
 const {
     red,
     cyan,
     green,
+    grey,
 } = chalk.default;
 
 const ROOT = resolve(__dirname, '../..');
 const BARREL = 'index.ts';
 
 const resolveParentDir = (path) => dirname(resolve(ROOT, path));
-
 interface IExportPair {
     exportLocation: string;
     exported: string;
@@ -39,6 +46,12 @@ interface IDecoratedError extends IDecoratedClass {
 
 let isErrorFlagged = false;
 
+const _handleUnexpectedError = (err?: string) => {
+    if (err) { console.error(err); }
+
+    process.exit(1);
+};
+
 const buildError = ({ className, decoratorName, exportLocation, rootPath }: IDecoratedError, message: string) => {
     return [
         red(`ERROR:`),
@@ -144,7 +157,7 @@ const resolveFileLocation = (exportLocation: string, path: string) => {
     return resolve(parentDir, fileName);
 };
 
-const checkForUnamedDecoratedExports = (rootPath: string, path: string, exportList: IExportPair[]) =>
+const checkForUnnamedDecoratedExports = (rootPath: string, path: string, exportList: IExportPair[]) =>
     exportList
         .filter(e => !e.exported)
         .forEach(({ exportLocation }) => {
@@ -171,7 +184,7 @@ const checkForUnamedDecoratedExports = (rootPath: string, path: string, exportLi
                             }),
                     );
             } else {
-                checkForUnamedDecoratedExports(rootPath, fileLocation, exportDeclarations);
+                checkForUnnamedDecoratedExports(rootPath, fileLocation, exportDeclarations);
             }
         });
 
@@ -229,22 +242,53 @@ const checkFile = (path: string) => {
     const sourceFile = readFileNode(path);
     const rootExports = getExportDeclarations(sourceFile);
 
-    checkForUnamedDecoratedExports(path, path, rootExports);
+    console.log(`${grey('Checking')} ${cyan(sourceFile.fileName)} ${grey('for unnamed decorated exports...')}`);
+    checkForUnnamedDecoratedExports(path, path, rootExports);
+
+    console.log(`${grey('Checking')} ${cyan(sourceFile.fileName)} ${grey('decorated exports hidden behind barrels...')}`);
     checkForBarreledDecoratedExports(path, path, rootExports);
 };
 
-glob(
-    './projects/**/public_api.ts',
-    { root: ROOT },
-    (err, files) => {
-        if (err) { throw err; }
+const forEachApiFile = (callback: (string) => void) => {
+    return new Promise((res, rej) => {
+        const walker = new glob.Glob('./projects/**/public_api.ts', {
+            root: ROOT,
+        }, (err, files) => {
+            if (err) {
+                console.error(err);
+                rej(err);
+            }
 
-        files.forEach(file => {
-            checkFile(file);
+            files.forEach(callback);
         });
 
-        if (isErrorFlagged) {
-            process.exit(1);
-        }
-    },
-);
+        walker.on('end', res);
+    });
+};
+
+const run = async () => {
+    const head = await getPullRequestHead();
+
+    await reportStatus('pending', head.sha, 'Checking Public API...')
+        .catch(_handleUnexpectedError);
+
+    await forEachApiFile(checkFile);
+
+    if (isErrorFlagged) {
+        console.error(red(`⛔   Something doesn't check out`));
+
+        await reportStatus('error', head.sha, 'npm run check:exports for more info...')
+            .catch(_handleUnexpectedError);
+    } else {
+        console.log(green(`💯   Good to go!`));
+
+        await reportStatus('success', head.sha, '✔ Good to go!')
+            .catch(_handleUnexpectedError);
+    }
+};
+
+(async () => {
+    await run()
+        .catch(_handleUnexpectedError);
+})();
+

.build/commitlint/index.js

@@ -1,60 +1,23 @@
 /**
  * Adapted from: https://github.com/fathyb/commitlint-circle
  */
-const Octokit = require('@octokit/rest')
 const { lint, load } = require('@commitlint/core')
 const path = require('path')
+const { red, yellow, blue, green } = require('chalk');
 
-const { variables } = require('../common')
-const { owner, repo, pull, token } = variables;
-
-const github = new Octokit({
-    auth: token,
-})
+const { getPullRequestHead, getCommits, statusReporterFactory } = require('../common/github');
 
 const _handleUnexpectedError = (err) => {
     console.error(err)
     process.exit(1)
 }
 
-const getCommits = async () => {
-    console.log('📡   Looking up commits for PR #%s...', pull)
-    const response = await github.pulls.listCommits({
-        owner,
-        repo,
-        pull_number: pull,
-        per_page: 100
-    })
-
-    return response.data
-}
-
-const reportStatus = async (state, sha, description, target_url) => {
-    await github.repos.createStatus({
-        owner,
-        repo,
-        sha,
-        state,
-        description,
-        context: 'commitlint',
-        target_url,
-    })
-}
-
-const getPullRequestHead = async () => {
-    const pr = await github.pullRequests.get({
-        owner,
-        repo,
-        pull_number: pull,
-    })
-
-    return pr.data.head
-}
+const reportStatus = statusReporterFactory('commitlint')
 
 const run = async () => {
     const head = await getPullRequestHead()
 
-    console.log('👮‍   Calling Git Police...')
+    console.log(blue('👮‍   Calling Git Police...'))
 
     await reportStatus('pending', head.sha, 'Checking commits...')
 
@@ -69,13 +32,11 @@ const run = async () => {
     const isConventionalCommitGuidelineRespected = lintResultList.every(result => result.valid)
     const isAnyFixupCommit = commits.some(({ commit }) => commit.message.startsWith('fixup!'))
 
-    console.log(isConventionalCommitGuidelineRespected)
-
     if (
         isConventionalCommitGuidelineRespected &&
         !isAnyFixupCommit
     ) {
-        console.log(`💯   Good to go!`)
+        console.log(green(`💯   Good to go!`))
 
         await reportStatus('success', head.sha, '✔ Good to go!')
             .catch(_handleUnexpectedError)
@@ -84,15 +45,15 @@ const run = async () => {
     }
 
     if (isAnyFixupCommit) {
-        console.log(`😬   There are still some fixup commits.`)
+        console.warn(yellow(`😬   There are still some fixup commits.`))
 
         await reportStatus('error', head.sha, 'Please rebase and apply the fixup commits!')
             .catch(_handleUnexpectedError)
 
         return;
     }
 
-    console.log(`⛔   Something doesn't check out`)
+    console.error(red(`⛔   Something doesn't check out`))
 
     await reportStatus('error', head.sha, 'We use conventional commits (╯°□°）╯︵ ┻━┻', 'https://www.conventionalcommits.org/en/v1.0.0-beta.4/')
         .catch(_handleUnexpectedError)