Merge pull request #14 from xymopen/master

Add JSON Schema

Author: KTachibanaM

CONTRIBUTING.md

@@ -16,10 +16,28 @@ Let's get started
 2. Create a JSON file for your repository metadata. End its filename with `.meta.json`, for example, `foo.meta.json`
 3. If you decide to host your repository on this GitHub repo
     1. Metadata JSON file should follow [this interface](https://github.com/cloud-emoticon/store-repos/blob/master/linter/src/api/RepositoryMetadata.ts). Don't worry about TypeScript, the interface alone should be easy to follow. If you are still not sure, look at [this example](https://github.com/cloud-emoticon/store-repos/blob/master/kt-favorites.meta.json)
+        1. Bonus: If your editor supports JSON schema, add the following line to aid you:
+
+        ```
+        "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
+        ```
+
     2. Create a JSON file for your actual repository in JSON format (sorry no XML). Name the file to have the same name as the repository metadata JSON file, e.g. if your metadata JSON file is named `foo.meta.json`, this file should be named `foo.json`
-    3. Repository JSON file should follow [this interface](https://github.com/cloud-emoticon/store-repos/blob/master/linter/src/api/JsonRepository.ts). Again, no worries on TypeScript. Here is [an example](https://github.com/cloud-emoticon/store-repos/blob/master/kt-favorites.json).
+    3. Repository JSON file should follow [this interface](https://github.com/cloud-emoticon/store-repos/blob/master/linter/src/api/JsonRepository.ts). Again, no worries on TypeScript. Here is [an example](https://github.com/cloud-emoticon/store-repos/blob/master/kt-favorites.json).should be easy to follow. If you are still not sure, look at [this example](https://github.com/cloud-emoticon/store-repos/blob/master/kt-favorites.json)
+        1. Bonus: If your editor supports JSON schema, add the following line to aid you:
+
+        ```
+        "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/JsonRepository.json",
+        ```
+
 4. If you decide to host your repository on your own server
     1. Metadata JSON file should still follow [this interface](https://github.com/cloud-emoticon/store-repos/blob/master/linter/src/api/RepositoryMetadata.ts). Don't worry about TypeScript, the interface alone should be easy to follow. If you are still not sure, look at [this example](https://github.com/cloud-emoticon/store-repos/blob/master/remote-demo.meta.json)
+        1. Bonus: If your editor supports JSON schema, add the following line to aid you:
+
+        ```
+        "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
+        ```
+
 5. You can optinoally add an avatar for author of your repo to the branch. See exmaple in `a-land.meta.json`.
 6. Push the branch, create a merge request to this repo's master. There is a CI bot to check the integrity of the JSON files. Please assign the reviewer to `KTachibanaM`(me).
 7. Wait for review, merge, wait for about 5 minutes for your repository to appear in the store, and profit :P

a-land.meta.json

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "A岛颜文字汇集",
     "location": {
         "type": "localXml"

japaneseemoticons.meta.json

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "japaneseemoticons.net",
     "location": {
         "type": "localXml"

kaomojiya.meta.json

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "颜文字屋",
     "location": {
         "type": "localXml"

kt-cia.json

@@ -1,4 +1,5 @@
 {
+   "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/JsonRepository.json",
    "information":[
       "Thanks to CIA",
       "http://ktachibana.party/cloudemoticon/cia.json",

kt-cia.meta.json

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "CIA",
     "location": {
         "type": "localJson"

kt-favorites.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/JsonRepository.json",
   "categories": [
     {
       "name": "G+都亡了",

kt-favorites.meta.json

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "KT's favorites",
     "location": {
         "type": "localJson"

linter/README.md

@@ -12,7 +12,7 @@ Linter for store repos
 yarn
 ```
 
-## Build
+## Build (Optional)
 
 ```bash
 yarn built-ts
@@ -22,4 +22,12 @@ yarn built-ts
 
 ```bash
 yarn run-linter
-```
+```
+
+## Generate schemas
+
+If you make any changes to [src/api/](src/api/), run this script to generate new JSON schemas for emoticon authors.
+
+```bash
+yarn gen-schema
+```

linter/package.json

@@ -7,7 +7,10 @@
   "private": false,
   "scripts": {
     "build-ts": "tsc",
-    "run-linter": "node dist/index.js"
+    "prerun-linter": "yarn run build-ts",
+    "run-linter": "node dist/index.js",
+    "pregen-schema": "yarn run build-ts",
+    "gen-schema": "node dist/bin/genSchema.js"
   },
   "devDependencies": {
     "tslint": "^5.18.0",

linter/src/api/JsonRepositorySchema.ts

@@ -2,8 +2,10 @@
 export interface RepositoryMetadata {
     name: string,
     location: {
-        type: "localJson" | "localXml" | "remoteJson",
-        remoteUrl?: string
+        type: "localJson" | "localXml"
+    } | {
+        type: "remoteJson",
+        remoteUrl: string
     },
     description: string,
     author: {

linter/src/api/RepositoryMetadata.ts

@@ -0,0 +1,9 @@
+import * as fs from 'fs'
+import toJsonSchema from "../lib/toJsonSchema"
+
+const JsonRepositorySchema = toJsonSchema("./src/api/JsonRepository.ts", "JsonRepository")
+const RepositoryMetadataSchema = toJsonSchema("./src/api/RepositoryMetadata.ts", "RepositoryMetadata")
+
+fs.mkdirSync("../schema", { recursive: true })
+fs.writeFileSync("../schema/JsonRepository.json", JSON.stringify(JsonRepositorySchema, null, '    '))
+fs.writeFileSync("../schema/RepositoryMetadata.json", JSON.stringify(RepositoryMetadataSchema, null, '    '))

linter/src/api/RepositoryMetadataSchema.ts

@@ -1,8 +1,10 @@
 import * as fs from 'fs'
 import * as process from "process"
 import Ajv from "ajv"
-import JsonRepositorySchema from "./api/JsonRepositorySchema"
-import RepositoryMetadataSchema from "./api/RepositoryMetadataSchema"
+import toJsonSchema from "./lib/toJsonSchema"
+
+const JsonRepositorySchema = toJsonSchema("./src/api/JsonRepository.ts", "JsonRepository")
+const RepositoryMetadataSchema = toJsonSchema("./src/api/RepositoryMetadata.ts", "RepositoryMetadata")
 
 const ajv = new Ajv()
 const validateJsonRepository = ajv.compile(JsonRepositorySchema)

linter/src/bin/genSchema.ts

@@ -0,0 +1,14 @@
+import { resolve } from "path";
+import * as TJS from "typescript-json-schema";
+import { compilerOptions, settings } from "./tjsSettings"
+
+const toJsonSchema = (pathname: string, fullTypeName: string) => {
+	const program = TJS.getProgramFromFiles(
+		[resolve(pathname)],
+		compilerOptions
+	);
+
+	return TJS.generateSchema(program, fullTypeName, settings);
+};
+
+export default toJsonSchema;

linter/src/index.ts

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "Midori",
     "location": {
         "type": "localXml"

linter/src/api/tjsSettings.ts linter/src/lib/tjsSettings.ts

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "Oliver Wang",
     "location": {
         "type": "localXml"

linter/src/lib/toJsonSchema.ts

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "Remote repo demo",
     "location": {
         "type": "remoteJson",

midori.meta.json

@@ -0,0 +1 @@
+Files in this folder are generated by `yarn run gen-schema`; DO NOT EDIT.

oliver-wang.meta.json

@@ -0,0 +1,49 @@
+{
+    "type": "object",
+    "properties": {
+        "information": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "categories": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string"
+                    },
+                    "entries": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "emoticon": {
+                                    "type": "string"
+                                },
+                                "description": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "description",
+                                "emoticon"
+                            ]
+                        }
+                    }
+                },
+                "required": [
+                    "entries",
+                    "name"
+                ]
+            }
+        }
+    },
+    "required": [
+        "categories",
+        "information"
+    ],
+    "$schema": "http://json-schema.org/draft-07/schema#"
+}

remote-demo.meta.json

@@ -0,0 +1,72 @@
+{
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string"
+        },
+        "location": {
+            "anyOf": [
+                {
+                    "type": "object",
+                    "properties": {
+                        "type": {
+                            "enum": [
+                                "localJson",
+                                "localXml"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "type"
+                    ]
+                },
+                {
+                    "type": "object",
+                    "properties": {
+                        "type": {
+                            "type": "string",
+                            "enum": [
+                                "remoteJson"
+                            ]
+                        },
+                        "remoteUrl": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "remoteUrl",
+                        "type"
+                    ]
+                }
+            ]
+        },
+        "description": {
+            "type": "string"
+        },
+        "author": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "url": {
+                    "type": "string"
+                },
+                "avatarUrl": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "name"
+            ]
+        }
+    },
+    "required": [
+        "author",
+        "description",
+        "location",
+        "name"
+    ],
+    "$schema": "http://json-schema.org/draft-07/schema#"
+}

schema/DO_NOT_EDIT.txt

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://github.com/cloud-emoticon/store-repos/raw/master/schema/RepositoryMetadata.json",
     "name": "Yashi-poi",
     "location": {
         "type": "localXml"