Skip to content
This repository has been archived by the owner on Jun 5, 2020. It is now read-only.

Commit

Permalink
feat: add manifest-schema.d.ts (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
teppeis committed May 6, 2017
1 parent 907af28 commit 7adb084
Show file tree
Hide file tree
Showing 8 changed files with 278 additions and 17 deletions.
12 changes: 10 additions & 2 deletions README.md
Expand Up @@ -10,13 +10,13 @@ Validate `manifest.json` of kintone plugin. Used in [kintone-plugin-packer](http
[![dependency status][deps-image]][deps-url]
![License][license]

# How to install
## How to install

```console
$ npm install @teppeis/kintone-plugin-packer
```

# Usage
## Usage

```js
const validator = require('@teppeis/kintone-plugin-manifest-validator');
Expand All @@ -41,6 +41,14 @@ console.log(result.errors); // array of ajv error objects
}
```

## `manifest-json.d.ts`

```js
/// <reference types="@teppeis/kintone-plugin-manifest-validator/manifest-json" />

let manifest: KintonePluginManifestJson;
```

## License

MIT License: Teppei Sato &lt;teppeis@gmail.com&gt;
Expand Down
34 changes: 34 additions & 0 deletions manifest-schema.d.ts
@@ -0,0 +1,34 @@
declare interface KintonePluginManifestJson {
manifest_version: number;
version: number;
type: "APP";
name: {
ja?: string;
en: string;
zh?: string;
};
description?: {
ja?: string;
en: string;
zh?: string;
};
icon: string;
homepage_url?: {
ja?: string;
en?: string;
zh?: string;
};
desktop?: {
js?: string[];
css?: string[];
};
mobile?: {
js?: string[];
};
config?: {
html?: string;
js?: string[];
css?: string[];
required_params?: string[];
};
}
10 changes: 5 additions & 5 deletions manifest-schema.json
Expand Up @@ -92,18 +92,18 @@
"type": "object",
"properties": {
"js": {
"$ref": "#resources"
"$ref": "#/definitions/resources"
},
"css": {
"$ref": "#resources"
"$ref": "#/definitions/resources"
}
}
},
"mobile": {
"type": "object",
"properties": {
"js": {
"$ref": "#resources"
"$ref": "#/definitions/resources"
}
}
},
Expand All @@ -118,10 +118,10 @@
"minLength": 1
},
"js": {
"$ref": "#resources"
"$ref": "#/definitions/resources"
},
"css": {
"$ref": "#resources"
"$ref": "#/definitions/resources"
},
"required_params": {
"type": "array",
Expand Down
11 changes: 8 additions & 3 deletions package.json
Expand Up @@ -4,14 +4,17 @@
"author": "Teppei Sato <teppeis@gmail.com>",
"main": "index.js",
"files": [
"manifest-schema.json",
"index.js",
"manifest-schema.d.ts",
"manifest-schema.json",
"src"
],
"scripts": {
"gen-dts": "node script/generate-dts.js",
"lint": "eslint index.js src test",
"mocha": "mocha test --require intelli-espower-loader",
"test": "run-s lint mocha"
"test": "run-s lint mocha test:dts",
"test:dts": "tsc --noEmit --strict test/manifest-schema.ts"
},
"dependencies": {
"ajv": "^5.0.0",
Expand All @@ -21,9 +24,11 @@
"eslint": "^3.19.0",
"eslint-config-teppeis": "^5.3.0",
"intelli-espower-loader": "^1.0.1",
"json-schema-to-typescript": "^4.2.0",
"mocha": "^3.2.0",
"npm-run-all": "^4.0.2",
"power-assert": "^1.4.2"
"power-assert": "^1.4.2",
"typescript": "^2.3.2"
},
"homepage": "https://github.com/teppeis/kintone-plugin-manifest-validator#readme",
"repository": {
Expand Down
8 changes: 8 additions & 0 deletions script/generate-dts.js
@@ -0,0 +1,8 @@
'use strict';

const fs = require('fs');
const json2ts = require('json-schema-to-typescript');
const compileFromFile = json2ts.compileFromFile;

compileFromFile('./manifest-schema.json')
.then(ts => fs.writeFileSync('manifest-schema.d.ts', ts));
11 changes: 11 additions & 0 deletions test/manifest-schema.ts
@@ -0,0 +1,11 @@
/// <reference path="../manifest-schema.d.ts" />

let manifest: KintonePluginManifestJson = {
manifest_version: 1,
version: 1,
type: 'APP',
name: {
en: 'foo'
},
icon: 'path/to/icon.png'
};
53 changes: 53 additions & 0 deletions tsconfig.json
@@ -0,0 +1,53 @@
{
"compilerOptions": {
/* Basic Options */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd' or 'es2015'. */
// "lib": [], /* Specify library files to be included in the compilation: */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "removeComments": true, /* Do not emit comments to output. */
"noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */

/* Source Map Options */
// "sourceRoot": "./", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "./", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
}
}

0 comments on commit 7adb084

Please sign in to comment.