Add example and first schema test

Author: justinfagnani

.github/workflows/tests.yaml

@@ -1,4 +1,5 @@
 name: Test
+
 on:
   push:
     branches: [ main ]
@@ -17,3 +18,5 @@ jobs:
       - run: npm run build
       - name: Check schema.json is up-to-date
         run: git diff --exit-code
+      - name: Run tests
+        run: npm test

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 node_modules/
+/test/

examples/simple-element.json

@@ -0,0 +1,63 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "README.md",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "my-project/my-element.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "This is the description of the class",
+          "name": "MyElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "disabled"
+            },
+            {
+              "kind": "method",
+              "name": "fire"
+            }
+          ],
+          "events": [
+            {
+              "name": "disabled-changed",
+              "type": {
+                "text": "Event"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "disabled"
+            }
+          ],
+          "superclass": {
+            "name": "HTMLElement"
+          },
+          "tagName": "my-element",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "MyElement",
+          "declaration": {
+            "name": "MyElement",
+            "module": "my-project/my-element.js"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "my-element",
+          "declaration": {
+            "name": "MyElement",
+            "module": "my-project/my-element.js"
+          }
+        }
+      ]
+    }
+  ]
+}

package-lock.json

@@ -2,10 +2,14 @@
   "name": "custom-elements-manifest",
   "version": "1.0.0",
   "description": "A file format for describing custom elements",
+  "type": "module",
   "main": "schema.json",
   "scripts": {
-    "format": "prettier schema.d.ts --write",
-    "build": "typescript-json-schema --required --ignoreErrors schema.d.ts -o schema.json Package",
+    "format": "prettier schema.d.ts src/**/*.ts --write",
+    "build": "npm run build:ts && npm run build:schema",
+    "build:ts": "tsc",
+    "build:schema": "typescript-json-schema --required --ignoreErrors schema.d.ts -o schema.json Package",
+    "test": "node ./test/schema_test.js",
     "prepublishOnly": "npm run build"
   },
   "files": [
@@ -24,8 +28,10 @@
   },
   "homepage": "https://github.com/webcomponents/custom-elements-manifest#readme",
   "devDependencies": {
+    "jsonschema": "^1.4.0",
     "prettier": "^2.2.1",
     "typescript": "~4.5.5",
-    "typescript-json-schema": "^0.53.0"
+    "typescript-json-schema": "^0.53.0",
+    "uvu": "^0.5.3"
   }
 }

package.json

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright (c) 2022 The Polymer Project Authors. All rights reserved.
+ * This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
+ * The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
+ * The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
+ * Code distributed by Google as part of the polymer project is also
+ * subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
+ */
+
+import {test} from 'uvu';
+import * as assert from 'uvu/assert';
+import {Validator} from 'jsonschema';
+import * as fs from 'fs/promises';
+
+const schema = JSON.parse(await fs.readFile('./schema.json', 'utf-8'));
+
+test('Schema tests', async () => {
+  // TODO: read multiple test files
+  const example = JSON.parse(
+    await fs.readFile('./examples/simple-element.json', 'utf-8')
+  );
+  const validator = new Validator();
+  const result = validator.validate(example, schema);
+  assert.is(result.errors.length, 0);
+});
+
+test.run();

src/test/schema_test.ts

@@ -6,6 +6,7 @@
     "declaration": true,
     "declarationMap": true,
     "sourceMap": true,
+    "rootDir": "./src/",
     "outDir": "./",
     "strict": true,
     "noUnusedLocals": true,
@@ -14,6 +15,6 @@
     "noFallthroughCasesInSwitch": true,
     "moduleResolution": "node",
   },
-  "include": ["*.ts"],
+  "include": ["schema.d.ts", "src/**/*.ts"],
   "exclude": []
 }