@kintone/plugin-manifest-validator

@kintone/plugin-manifest-validator

Validate manifest.json of kintone plugin. Used in @kintone/plugin-packer.

How to install

$ npm install @kintone/plugin-manifest-validator

Usage

const validator = require('@kintone/plugin-manifest-validator');

const manifestJson = require('./path/to/your/manifest.json');
const result = validator(manifestJson);
console.log(result.valid); // true or false
console.log(result.errors); // array of ajv error objects

ajv error objects is like:

{
  dataPath: '/version',
  keyword: 'type',
  message: 'should be integer',
  params: {
    type: 'integer',
  },
  schemaPath: '#/properties/version/type',
}

manifest-schema.json

JSON schema for manifest.json is available.

const manifestJsonSchema = require('@kintone/plugin-manifest-validator/manifest-schema.json');

manifest-schema.d.ts

TypeScript type definition (d.ts) for manifest.json is available.

import {KintonePluginManifestJson} from '@kintone/plugin-manifest-validator/manifest-schema';

let manifest: KintonePluginManifestJson;

License

MIT License