Add API for future use with Github Actions

Author: kristoferbaxter

api.ts

@@ -0,0 +1,40 @@
+/**
+ * Copyright 2020 The AMP HTML Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import Project from './validation/Project';
+import Config from './validation/Config';
+import { Context, ItemConfig, CompressionMap } from './validation/Condition';
+import compress from './compress';
+
+export async function report(project: string): Promise<Map<ItemConfig['path'], CompressionMap>> {
+  const conditions = [Project, Config];
+  let context: Context = {
+    project,
+    package: '',
+    config: [],
+    silent: true,
+  };
+
+  for (const condition of conditions) {
+    const [success, message] = await condition(context)();
+    if (!success) {
+      throw message;
+    }
+  }
+
+  const { 1: report } = await compress(context);
+  return report;
+}

compress.ts

@@ -95,7 +95,7 @@ async function compressor(item: ItemConfig): Promise<boolean> {
  * Given a context, compress all Items within splitting work eagly per cpu core to achieve some concurrency.
  * @param context Finalized Valid Context from Configuration
  */
-export default async function compress(context: Context): Promise<boolean> {
+export default async function compress(context: Context): Promise<[boolean, Map<ItemConfig['path'], CompressionMap>]> {
   initReport(context.config);
 
   let success: boolean = true;
@@ -106,6 +106,6 @@ export default async function compress(context: Context): Promise<boolean> {
     }
   }
 
-  LogReport(reported);
-  return success;
+  LogReport(context, reported);
+  return [success, reported];
 }

index.ts

@@ -35,6 +35,7 @@ const args = mri(process.argv.slice(2), {
     project,
     package: '',
     config: [],
+    silent: false,
   };
 
   for (const condition of conditions) {
@@ -45,7 +46,7 @@ const args = mri(process.argv.slice(2), {
     }
   }
 
-  const compressionSuccess = await compress(context);
+  const [compressionSuccess] = await compress(context);
   if (!compressionSuccess) {
     process.exit(6);
   }

log.ts

@@ -15,8 +15,8 @@
  */
 
 const kleur = require('kleur');
-import bytes from 'bytes';
-import { ItemConfig, CompressionMap } from './validation/Condition';
+const bytes = require('bytes');
+import { ItemConfig, CompressionMap, Context } from './validation/Condition';
 
 // Disable output colors for test runs.
 kleur.enabled = !('AVA_PATH' in process.env);
@@ -63,11 +63,11 @@ function compressedExtension(compression: string): string {
  * Display report to the console.
  * @param report
  */
-export function LogReport(report: Map<ItemConfig['path'], CompressionMap>) {
+export function LogReport({ silent }: Context, report: Map<ItemConfig['path'], CompressionMap>) {
   let success: number = 0;
   let failure: number = 0;
 
-  if ([...report.keys()].length > 0) {
+  if (!silent && [...report.keys()].length > 0) {
     console.log(bold('\nFilesize Report'));
     for (const [originalPath, values] of report) {
       console.log(grey(`\npath: ${originalPath}`));
@@ -86,11 +86,12 @@ export function LogReport(report: Map<ItemConfig['path'], CompressionMap>) {
       }
     }
     if (success > 0 || failure > 0) {
-      console.log('\n  ' + green(success + ` ${success === 1 ? 'check' : 'checks'} passed`));
-      console.log('  ' + red(failure + ` ${failure === 1 ? 'check' : 'checks'} failed`) + (failure === 0 ? ' 🎉' : ''));
+      console.log('\n  ' + green(success + ` ${success === 1 ? 'check' : 'checks'} passed`) + (failure === 0 ? ' 🎉' : ''));
+      const failureColor = failure < 1 ? grey : red;
+      console.log('  ' + failureColor(failure + ` ${failure === 1 ? 'check' : 'checks'} failed`));
     }
     console.log();
-  } else {
+  } else if (!silent) {
     MakeError('No report available.');
   }
 }

package.json

@@ -5,6 +5,7 @@
   "author": "Kristofer Baxter",
   "license": "Apache-2.0",
   "main": "dist/filesize",
+  "module": "dist/api.mjs",
   "files": [
     "dist"
   ],
@@ -73,7 +74,7 @@
     {
       "path": "./dist/index.js",
       "compression": "brotli",
-      "maxSize": "4 kB"
+      "maxSize": "10 kB"
     }
   ],
   "ava": {

rollup.config.js

@@ -37,8 +37,8 @@ const external = ['os', 'zlib', 'path', 'fs'];
 const plugins = executable => [
   resolve({ preferBuiltins: true }),
   commonjs({ include: 'node_modules/**' }),
-  typescript({ include: '**/*.ts' }),
-  compiler(),
+  typescript({ include: '**/*.ts', exclude: 'dist/**/*.ts' }),
+  executable ? compiler() : null,
   executable ? makeExecutable() : null,
 ];
 
@@ -63,4 +63,14 @@ export default [
     external,
     plugins: plugins(false),
   },
+  {
+    input: 'api.ts',
+    output: {
+      file: 'dist/api.mjs',
+      format: 'esm',
+      sourcemap: true,
+    },
+    external,
+    plugins: plugins(false),
+  }
 ];

test/config-validation/config-validation.test.ts

@@ -22,6 +22,7 @@ test('missing package.json should fail', async t => {
     package: 'test/config-validation/fixtures/missing-package-json/package.json',
     config: [],
     project: 'test/config-validation/fixtures/missing-package-json',
+    silent: false,
   };
   const [success, message] = await Config(context)();
 
@@ -34,6 +35,7 @@ test('unparseable package.json should fail', async t => {
     package: 'test/config-validation/fixtures/unparseable-package-json/package.json',
     config: [],
     project: 'test/config-validation/fixtures/unparseable-package-json',
+    silent: false,
   };
   const [success, message] = await Config(context)();
 
@@ -46,6 +48,7 @@ test("missing 'filesize' key from package.json should fail", async t => {
     package: 'test/config-validation/fixtures/missing-configuration/package.json',
     config: [],
     project: 'test/config-validation/fixtures/missing-configuration',
+    silent: false,
   };
   const [success, message] = await Config(context)();
 
@@ -58,6 +61,7 @@ test("missing path from item in 'filesize' should fail", async t => {
     package: 'test/config-validation/fixtures/item-path-missing/package.json',
     config: [],
     project: 'test/config-validation/fixtures/item-path-missing',
+    silent: false,
   };
   const [success, message] = await Config(context)();
 
@@ -70,6 +74,7 @@ test("missing maxSize from item in 'filesize' should fail", async t => {
     package: 'test/config-validation/fixtures/max-size-missing/package.json',
     config: [],
     project: 'test/config-validation/fixtures/max-size-missing',
+    silent: false,
   };
   const [success, message] = await Config(context)();
 
@@ -82,6 +87,7 @@ test("missing compression from item in 'filesize' should fail", async t => {
     package: 'test/config-validation/fixtures/compression-missing/package.json',
     config: [],
     project: 'test/config-validation/fixtures/compression-missing',
+    silent: false,
   };
   const [success, message] = await Config(context)();
 

test/end-to-end/fixtures/successful/index.js

@@ -0,0 +1,19 @@
+{
+  "filesize": [
+    {
+      "path": "test/end-to-end/fixtures/successful/index.js",
+      "maxSize": "10 KB",
+      "compression": "none"
+    },
+    {
+      "path": "test/end-to-end/fixtures/successful/index.js",
+      "maxSize": "4 KB",
+      "compression": "gzip"
+    },
+    {
+      "path": "test/end-to-end/fixtures/successful/index.js",
+      "maxSize": "3.5 KB",
+      "compression": "brotli"
+    }
+  ]
+}

test/end-to-end/fixtures/successful/package.json

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2020 The AMP HTML Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import test from 'ava';
+import { exec } from 'child_process';
+import { report } from '../../api';
+import { CompressionMap } from '../../validation/Condition';
+
+test.cb('item under requested filesize limit passes', t => {
+  const executeFailure = exec('./dist/filesize -p=test/end-to-end/fixtures/successful');
+
+  executeFailure.on('exit', code => {
+    t.is(code, 0);
+    t.end();
+  });
+});
+
+test('item under requested filesize limit passes from API', async t => {
+  const toReport = 'test/end-to-end/fixtures/successful';
+
+  const sizes: CompressionMap = new Map([
+    ['brotli', [3410, 3584]],
+    ['gzip', [3737, 4096]],
+    ['none', [9327, 10240]],
+  ]);
+  const expected: Map<string, CompressionMap> = new Map([['test/end-to-end/fixtures/successful/index.js', sizes]]);
+  const results = await report(toReport);
+  t.deepEqual(results, expected);
+});