@movable/rollup-plugin-manifest-validator 3.2.0-app-validation

package/src/apps/validators/warningValidator.js

@@ -0,0 +1,4 @@
+import ajvCompiler from './ajvCompiler';
+import { warningSchemaApps } from '../../schemas';
+
+export default ajvCompiler.compile(warningSchemaApps);

package/src/index.js

@@ -0,0 +1,4 @@
+import { manifestValidatorPluginPackages } from './packages';
+import { manifestValidatorPluginApps } from './apps';
+
+export { manifestValidatorPluginPackages, manifestValidatorPluginApps };

package/src/packages/index.js

@@ -0,0 +1,3 @@
+import manifestValidatorPluginPackages from './plugins/package-manifest-validator';
+
+export { manifestValidatorPluginPackages };

package/src/packages/plugins/package-manifest-validator.js

@@ -0,0 +1,19 @@
+import YAML from 'yamljs';
+import { readFileSync } from 'fs';
+import packageManifestValidator from '../utils/package-manifest-validator';
+
+const formatJSON = (j) => JSON.stringify(j, null, 1);
+
+export default ({ manifestPath }) => ({
+  buildStart() {
+    this.addWatchFile(manifestPath);
+    const manifest = YAML.parse(readFileSync(manifestPath).toString('utf-8'));
+    const { warnings, errors } = packageManifestValidator(manifest);
+    if (errors.length) {
+      this.error({ message: `INVALID PACKAGE MANIFEST: ${formatJSON(errors)}` });
+    }
+    warnings.forEach((w) =>
+      this.warn({ message: `'PACKAGE MANIFEST VALIDATION WARNING': ${formatJSON(w)}` })
+    );
+  }
+});

package/src/packages/utils/package-manifest-validator.js

@@ -0,0 +1,31 @@
+import { warningValidator, erroringValidator } from '../validators';
+
+export const TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE =
+  'Manifest has a prohibited keyword at the top level.';
+const TOP_LEVEL_PATH = 'package-manifest.yml';
+
+const parseValidationItem = ({ message, dataPath, params, keyword }) => {
+  const validation = {
+    message,
+    dataPath,
+    params
+  };
+
+  if (!dataPath) {
+    validation.dataPath = TOP_LEVEL_PATH;
+    if (keyword === 'prohibited') validation.message = TOP_LEVEL_PROHIBITED_PROPERTY_MESSAGE;
+  }
+
+  return validation;
+};
+
+export default function validateManifest(manifest) {
+  warningValidator(manifest);
+  erroringValidator(manifest);
+  const warnings = warningValidator.errors ?? [];
+  const errors = erroringValidator.errors ?? [];
+  return {
+    warnings: warnings.map(parseValidationItem),
+    errors: errors.map(parseValidationItem)
+  };
+}

package/src/packages/validators/ajvCompiler.js

@@ -0,0 +1,28 @@
+import Ajv from 'ajv';
+import ajvKeywords from 'ajv-keywords';
+
+const compiler = new Ajv({ allErrors: true });
+ajvKeywords(compiler);
+
+compiler.addKeyword('name', {
+  schema: false,
+  validate: function validation(data) {
+    const { name: packageName } = data;
+    const propertyGroup = data.studio_options?.property_groups?.[0];
+    if (propertyGroup?.name) {
+      validation.errors = [
+        {
+          message: 'property_group name must match package name',
+          keyword: 'invalidPropertyGroupName',
+          params: { name: propertyGroup.name },
+          dataPath: '.studio_options.propertyGroups[0]'
+        }
+      ];
+      return propertyGroup.name === packageName;
+    }
+    return true;
+  },
+  errors: true
+});
+
+export default compiler;

package/src/packages/validators/erroringValidator.js

@@ -0,0 +1,4 @@
+import ajvCompiler from './ajvCompiler';
+import { erroringSchemaPackages } from '../../schemas';
+
+export default ajvCompiler.compile(erroringSchemaPackages);

package/src/packages/validators/index.js

@@ -0,0 +1,4 @@
+import warningValidator from './warningValidator';
+import erroringValidator from './erroringValidator';
+
+export { warningValidator, erroringValidator };

package/src/packages/validators/warningValidator.js

@@ -0,0 +1,4 @@
+import ajvCompiler from './ajvCompiler';
+import { warningSchemaPackages } from '../../schemas';
+
+export default ajvCompiler.compile(warningSchemaPackages);

package/src/schemas/enums.js

@@ -0,0 +1,130 @@
+const contextOptionTypes = ['select', 'text', 'hidden'];
+
+const propertyTypes = ['text', 'image', 'link', 'api', 'boolean'];
+
+const fieldTypes = [
+  'asset',
+  'checkbox',
+  'color',
+  'data-source',
+  'data-source-package',
+  'date',
+  'datetime',
+  'dynamic-text',
+  'font',
+  'image',
+  'map',
+  'number',
+  'oauth2',
+  'oAuthAccount',
+  'radio',
+  'select',
+  'text',
+  'token',
+  'upload',
+  'url'
+];
+
+const studioIcons = [
+  'align-bottom',
+  'align-center',
+  'align-left',
+  'align-middle',
+  'align-right',
+  'align-top',
+  'arrange-center',
+  'arrange-left',
+  'arrange-right',
+  'arrows-select',
+  'avatar',
+  'bar-chart',
+  'barcode',
+  'calendar',
+  'cart',
+  'chatter',
+  'clock',
+  'code',
+  'condensed-view',
+  'copy',
+  'countdown-timer',
+  'countdown',
+  'crop',
+  'cursor-grab',
+  'cursor-move',
+  'cursor',
+  'distribute-horizontal',
+  'distribute-vertical',
+  'dropdown-arrow',
+  'duplicate',
+  'expanded-view',
+  'external-link',
+  'globe',
+  'grab',
+  'image-layer',
+  'image',
+  'images',
+  'instagram',
+  'local-time',
+  'locked',
+  'map-helper',
+  'maps',
+  'media-library',
+  'minus',
+  'move',
+  'olapic',
+  'param',
+  'personal',
+  'picture',
+  'pie-chart',
+  'pin',
+  'pinterest',
+  'plus',
+  'polling',
+  'proximity-pin',
+  'QR',
+  'qr-code',
+  'redo',
+  'rotate',
+  'rss',
+  'settings',
+  'shape',
+  'sharing',
+  'square',
+  'text-center',
+  'text-justify',
+  'text-layer',
+  'text-left',
+  'text-right',
+  'text-tool',
+  'text-vector',
+  'text',
+  'tools',
+  'trash',
+  'twitter-favorite',
+  'twitter-retweet',
+  'twitter-username',
+  'twitter',
+  'undo',
+  'unlocked',
+  'vector-square',
+  'vector-tool',
+  'video',
+  'weather-average',
+  'weather-city',
+  'weather-day',
+  'weather-description',
+  'weather-high-temp',
+  'weather-icon',
+  'weather',
+  'workspace-barcode',
+  'workspace-favorites',
+  'workspace-instagram',
+  'workspace-olapic',
+  'workspace-picture',
+  'workspace-pinterest',
+  'workspace-qr-code',
+  'workspace-retweets',
+  'workspace-weather'
+];
+
+export { studioIcons, fieldTypes, propertyTypes, contextOptionTypes };