feat(build): add manifest.json validation

Author: adamdbradley

src/compiler/build/validate-files.ts

@@ -1,9 +1,15 @@
 import * as d from '../../declarations';
+import { validateManifestJson } from '../html/validate-manifest-json';
 import { validatePackageJson } from '../types/validate-package-json';
 
 
 export function validateFiles(config: d.Config, compilerCtx: d.CompilerCtx, buildCtx: d.BuildCtx) {
+  if (buildCtx.hasError) {
+    return null;
+  }
+
   return Promise.all([
+    validateManifestJson(config, compilerCtx, buildCtx),
     validatePackageJson(config, compilerCtx, buildCtx)
   ]);
 }

src/compiler/html/validate-manifest-json.ts

@@ -0,0 +1,58 @@
+import * as d from '../../declarations';
+import { buildError, buildJsonFileWarn } from '@utils';
+import { isOutputTargetWww } from '../output-targets/output-utils';
+
+
+export function validateManifestJson(config: d.Config, compilerCtx: d.CompilerCtx, buildCtx: d.BuildCtx) {
+  const outputTargets = config.outputTargets.filter(isOutputTargetWww);
+
+  return Promise.all(outputTargets.map(async outputsTarget => {
+    const manifestFilePath = config.sys.path.join(outputsTarget.dir, 'manifest.json');
+
+    try {
+      const manifestContent = await compilerCtx.fs.readFile(manifestFilePath);
+
+      try {
+        const manifestData = JSON.parse(manifestContent);
+        await validateManifestJsonData(config, compilerCtx, buildCtx, manifestFilePath, manifestData);
+
+      } catch (e) {
+        const err = buildError(buildCtx.diagnostics);
+        err.header = `Invalid manifest.json`;
+        err.absFilePath = manifestFilePath;
+      }
+
+    } catch (e) {}
+  }));
+}
+
+
+async function validateManifestJsonData(config: d.Config, compilerCtx: d.CompilerCtx, buildCtx: d.BuildCtx, manifestFilePath: string, manifestData: any) {
+  if (Array.isArray(manifestData.icons)) {
+    await Promise.all(manifestData.icons.map((manifestIcon: any) => {
+      return validateManifestJsonIcon(config, compilerCtx, buildCtx, manifestFilePath, manifestIcon);
+    }));
+  }
+}
+
+
+async function validateManifestJsonIcon(config: d.Config, compilerCtx: d.CompilerCtx, buildCtx: d.BuildCtx, manifestFilePath: string, manifestIcon: any) {
+  let iconSrc = manifestIcon.src;
+  if (typeof iconSrc !== 'string') {
+    const msg = `Manifest icon missing "src"`;
+    buildJsonFileWarn(compilerCtx, buildCtx.diagnostics, manifestFilePath, msg, `"icons"`);
+    return;
+  }
+
+  if (iconSrc.startsWith('/')) {
+    iconSrc = iconSrc.substr(1);
+  }
+
+  const manifestDir = config.sys.path.dirname(manifestFilePath);
+  const iconPath = config.sys.path.join(manifestDir, iconSrc);
+  const hasAccess = await compilerCtx.fs.access(iconPath);
+  if (!hasAccess) {
+    const msg = `Unable to find manifest icon "${manifestIcon.src}"`;
+    buildJsonFileWarn(compilerCtx, buildCtx.diagnostics, manifestFilePath, msg, `"${manifestIcon.src}"`);
+  }
+}

src/compiler/types/validate-package-json.ts

@@ -4,7 +4,7 @@ import { getComponentsDtsTypesFilePath, isOutputTargetDistCollection } from '../
 
 
 export function validatePackageJson(config: d.Config, compilerCtx: d.CompilerCtx, buildCtx: d.BuildCtx) {
-  if (buildCtx.packageJson == null || buildCtx.hasError) {
+  if (buildCtx.packageJson == null) {
     return null;
   }