@kintone/plugin-manifest-validator

!Node.js version
!License

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

How to install

``console
$ npm install @kintone/plugin-manifest-validator
`

Usage

`js
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
console.log(result.warnings); // string array
`

ajv error objects is like:

`js
{
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.

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

manifest-schema.d.ts

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

`typescript
import { KintonePluginManifestJson } from "@kintone/plugin-manifest-validator/manifest-schema";

let manifest: KintonePluginManifestJson;
`

Setting the $schema property

When you are configuring your project, you would better set the $schema property. This property should point to a schema file that validates your manifest.
We recommend setting the $schema property to the following URI in your manifest.json:

`
https://raw.githubusercontent.com/kintone/js-sdk/%40kintone/plugin-manifest-validator%4011.1.0/packages/plugin-manifest-validator/manifest-schema.json
``

Note: Add or update the $schema property at the top of the manifest.json.

License

MIT License