Setup automated tests for pull requests (#29)

Resolves #28
karelklima · Oct 3, 2022 · 8a3b5a7 · 8a3b5a7
1 parent f6d3830
commit 8a3b5a7
Show file tree

Hide file tree

Showing 12 changed files with 97 additions and 69 deletions.
diff --git a/.github/workflows/deno-test.yml b/.github/workflows/deno-test.yml
@@ -0,0 +1,22 @@
+# This workflow will run tests using Deno
+
+name: Test using Deno
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  fmt-lint-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+      - run: deno task fmt:check
+      - run: deno task lint
+      - run: deno task test
diff --git a/deno.json b/deno.json
@@ -1,6 +1,9 @@
 {
   "importMap": ".vscode/import_map.json",
   "tasks": {
+    "fmt:fix": "deno fmt library/ specs/ www/ docs/",
+    "fmt:check": "deno fmt --check library/ specs/ www/ docs/",
+    "lint": "deno lint library/ specs/ www/ docs/",
     "test": "deno test --allow-env --allow-net ./specs",
     "dnt": "deno run -A --importmap ./scripts/dnt_import_map.json ./scripts/dnt.ts"
   },

diff --git a/library/encoder.ts b/library/encoder.ts
@@ -89,7 +89,7 @@ class Encoder {
     });
   }
 
-  encodeNodeProperty(value: any, property: Property, nodeId: NodeId) {
+  encodeNodeProperty(value: unknown, property: Property, nodeId: NodeId) {
     if (value === undefined) {
       return;
     }
@@ -107,10 +107,11 @@ class Encoder {
     }
 
     if (property["@multilang"]) {
-      Object.keys(value).forEach((language) => {
-        const languageValue: string[] = Array.isArray(value[language])
-          ? value[language]
-          : [value[language]];
+      const multiValue = value as unknown as Record<string, unknown>;
+      Object.keys(multiValue).forEach((language) => {
+        const languageValue: string[] = Array.isArray(multiValue[language])
+          ? multiValue[language] as string[]
+          : [multiValue[language]] as string[];
         languageValue.forEach((singleValue) => {
           this.push(
             nodeId,

diff --git a/library/namespaces/namespace.ts b/library/namespaces/namespace.ts
@@ -28,7 +28,7 @@ export const createNamespace = <
       //acc[term] = `${namespaceSpec.prefix}${term}`
       acc[term] = `${namespaceSpec.iri}${term}`;
       return acc;
-    }, {} as any),
+    }, {} as Record<string, string>),
     {
       $prefix: namespaceSpec["prefix"],
       $iri: namespaceSpec["iri"],

diff --git a/library/resource/query_helper.ts b/library/resource/query_helper.ts
@@ -71,7 +71,7 @@ export class QueryHelper {
       const value = entity[key];
 
       if (key === "$id") {
-        output.$id = value;
+        output.$id = value as string;
         return output;
       }
       if (key === "$type") {
@@ -90,10 +90,10 @@ export class QueryHelper {
       }
 
       if (property["@array"]) {
-        if (value.length === 0) {
+        if ((value as Entity[]).length === 0) {
           output[key] = null;
         } else {
-          output[key] = value.map((subEntity: Entity) =>
+          output[key] = (value as Entity[]).map((subEntity) =>
             this.replaceVariables(subEntity, property["@context"]!)
           );
         }

diff --git a/library/resource/types.ts b/library/resource/types.ts
@@ -1,9 +1,11 @@
 import type { SchemaInterfaceIdentity } from "../schema/mod.ts";
 
-export type Entity<T extends any = Record<string, any>> =
+export type Entity<
+  T extends unknown = Record<string, unknown>,
+> =
   & DeepPartial<T>
   & SchemaInterfaceIdentity;
 
-export type DeepPartial<T> = T extends Function ? T
-  : T extends object ? { [P in keyof T]?: DeepPartial<T[P]> }
+export type DeepPartial<T> = T extends Record<string, unknown>
+  ? { [P in keyof T]?: DeepPartial<T[P]> }
   : T;
diff --git a/library/schema/interface.ts b/library/schema/interface.ts
@@ -1,44 +1,39 @@
 import type { SupportedDataTypes } from "./data_types.ts";
-import type { SchemaPrototype, PropertyPrototype } from "./schema.ts";
+import type { PropertyPrototype, SchemaPrototype } from "./schema.ts";
 
 type IsOptional<Property extends PropertyPrototype> = Property extends {
   "@optional": true;
-}
-  ? true
+} ? true
   : false;
 
 type IsArray<Property extends PropertyPrototype> = Property extends {
   "@array": true;
-}
-  ? true
+} ? true
   : false;
 
 type IsMultilang<Property extends PropertyPrototype> = Property extends {
   "@multilang": true;
-}
-  ? true
+} ? true
   : false;
 
 type ValidPropertyDefinition = PropertyPrototype | string;
 
 type ConvertPropertyType<T extends PropertyPrototype> = T extends {
   "@context": SchemaPrototype;
 }
-  ? // embedded schema
-    SchemaInterface<T["@context"]>
-  : // type specified
-  T extends { "@type": any }
-  ? T["@type"] extends keyof SupportedDataTypes
-    ? // type is built-int
-      SupportedDataTypes[T["@type"]]
-    : // type is invalid
-      never
-  : // no type -> defaults to string
-    string;
+  // embedded schema
+  ? SchemaInterface<T["@context"]>
+  // type specified
+  : T extends { "@type": unknown } ? T["@type"] extends keyof SupportedDataTypes
+      // type is built-int
+      ? SupportedDataTypes[T["@type"]]
+      // type is invalid
+    : never
+  // no type -> defaults to string
+  : string;
 
 type ConvertPropertyOptional<T extends PropertyPrototype> =
-  IsOptional<T> extends true
-    ? ConvertPropertyType<T> | undefined
+  IsOptional<T> extends true ? ConvertPropertyType<T> | undefined
     : ConvertPropertyType<T>;
 
 type ConvertPropertyArray<T extends PropertyPrototype> = IsArray<T> extends true
@@ -47,16 +42,15 @@ type ConvertPropertyArray<T extends PropertyPrototype> = IsArray<T> extends true
 
 type ConvertPropertyMultilang<T extends PropertyPrototype> =
   IsMultilang<T> extends true
-    ? IsArray<T> extends true
-      ? Record<string, ConvertPropertyType<T>[]>
-      : Record<string, ConvertPropertyType<T>>
+    ? IsArray<T> extends true ? Record<string, ConvertPropertyType<T>[]>
+    : Record<string, ConvertPropertyType<T>>
     : ConvertPropertyArray<T>;
 
 type ConvertPropertyObject<T extends PropertyPrototype> =
   ConvertPropertyMultilang<T>;
 
-type ConvertProperty<T extends ValidPropertyDefinition> =
-  T extends PropertyPrototype ? ConvertPropertyObject<T> : string;
+type ConvertProperty<T extends ValidPropertyDefinition> = T extends
+  PropertyPrototype ? ConvertPropertyObject<T> : string;
 
 export type SchemaInterfaceIdentity = {
   $id: string;
@@ -66,9 +60,11 @@ export type SchemaInterfaceType = {
   $type: string[];
 };
 
-export type SchemaInterface<T extends SchemaPrototype> = {
-  [X in Exclude<keyof T, "@type">]: T[X] extends ValidPropertyDefinition
-    ? ConvertProperty<T[X]>
-    : never;
-} & SchemaInterfaceIdentity &
-  SchemaInterfaceType;
+export type SchemaInterface<T extends SchemaPrototype> =
+  & {
+    [X in Exclude<keyof T, "@type">]: T[X] extends ValidPropertyDefinition
+      ? ConvertProperty<T[X]>
+      : never;
+  }
+  & SchemaInterfaceIdentity
+  & SchemaInterfaceType;
diff --git a/library/schema/mod.ts b/library/schema/mod.ts
@@ -5,10 +5,10 @@ export type {
 } from "./interface.ts";
 
 export type {
-  Schema,
-  SchemaPrototype,
   Property,
   PropertyPrototype,
+  Schema,
+  SchemaPrototype,
 } from "./schema.ts";
 
 export { expandSchema, getSchemaProperties } from "./utils.ts";
diff --git a/library/schema/utils.ts b/library/schema/utils.ts
@@ -13,7 +13,7 @@ export const expandSchema = (schemaPrototype: SchemaPrototype) => {
   };
 
   const expandSchemaProperty = (
-    stringOrProperty: string | PropertyPrototype
+    stringOrProperty: string | PropertyPrototype,
   ) => {
     if (typeof stringOrProperty === "string") {
       return {
@@ -37,15 +37,15 @@ export const expandSchema = (schemaPrototype: SchemaPrototype) => {
       "@multilang",
     ] as const;
 
-    const baseProperty: Record<string, any> = {
+    const baseProperty: Record<string, unknown> = {
       "@id": "",
     };
 
     const expandedProperty = Object.keys(property).reduce((acc, key) => {
       if (key === "@context") {
         acc[key] = expandSchema(property[key]!);
       } else if (validKeys.includes(key as keyof PropertyPrototype)) {
-        acc[key] = property[key as keyof PropertyPrototype] as any;
+        acc[key] = property[key as keyof PropertyPrototype] as unknown;
       }
       return acc;
     }, baseProperty);
@@ -66,7 +66,7 @@ export const expandSchema = (schemaPrototype: SchemaPrototype) => {
       acc[key] = expandArray(schemaPrototype[key]);
     } else {
       acc[key] = expandSchemaProperty(
-        schemaPrototype[key] as string | PropertyPrototype
+        schemaPrototype[key] as string | PropertyPrototype,
       );
     }
     return acc;

diff --git a/www/components/Header.tsx b/www/components/Header.tsx
@@ -62,19 +62,20 @@ type MenuItemProps = {
 const baseLinkClass = "flex flex-row p-4 border-b-2 hover:border-black";
 
 function MenuItem({ title, url, activeLink }: MenuItemProps) {
-  const linkClass =
-    url === activeLink
-      ? `${baseLinkClass} border-black bg-gray-50`
-      : `${baseLinkClass} border-transparent`;
+  const linkClass = url === activeLink
+    ? `${baseLinkClass} border-black bg-gray-50`
+    : `${baseLinkClass} border-transparent`;
   return (
     <li class="inline-block">
       <a href={url} class={linkClass}>
         <span>{title}</span>
-        {url.startsWith("http") ? (
-          <span class="ml-1 mt-1 w-2 h-2 text-gray-400">
-            <IconExternalLink />
-          </span>
-        ) : null}
+        {url.startsWith("http")
+          ? (
+            <span class="ml-1 mt-1 w-2 h-2 text-gray-400">
+              <IconExternalLink />
+            </span>
+          )
+          : null}
       </a>
     </li>
   );

diff --git a/www/components/Icons.tsx b/www/components/Icons.tsx
@@ -55,7 +55,8 @@ export function IconGitHub() {
       stroke-linejoin="round"
       class="feather feather-github"
     >
-      <path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path>
+      <path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22">
+      </path>
     </svg>
   );
 }

diff --git a/www/components/Title.tsx b/www/components/Title.tsx
@@ -5,14 +5,16 @@ type TitleProps = {
 };
 
 export function Title({ children }: TitleProps) {
-  return children ? (
-    <title>
-      {children}
-      {" · LDkit"}
-    </title>
-  ) : (
-    <title>
-      {"LDkit · Linked Data query toolkit for TypeScript developers"}
-    </title>
-  );
+  return children
+    ? (
+      <title>
+        {children}
+        {" · LDkit"}
+      </title>
+    )
+    : (
+      <title>
+        {"LDkit · Linked Data query toolkit for TypeScript developers"}
+      </title>
+    );
 }