Some changes proposed by copilot

Author: iherman

deno.lock

@@ -14,7 +14,7 @@ export const EXTRA_DATATYPES: string[] = [
     "rdf:HTML",
     "rdf:XMLLiteral",
     "rdf:PlainLiteral",
-    "rdf:langString"
+    "rdf:langString",
 ]
 
 /**
@@ -23,7 +23,7 @@ export const EXTRA_DATATYPES: string[] = [
 export enum Status {
     stable     = "stable", 
     reserved   = "reserved", 
-    deprecated = "deprecated"
+    deprecated = "deprecated",
 }
 
 /**
@@ -32,9 +32,9 @@ export enum Status {
  * should be removed (because it is empty), or not.
  */
 export class StatusCounter {
-    private stableNum    = 0;
-    private reservedNum  = 0;
-    private deprecateNum = 0;
+    private stableNum     = 0;
+    private reservedNum   = 0;
+    private deprecatedNum = 0;
 
     /**
      * Increase the relevant counter.
@@ -52,7 +52,7 @@ export class StatusCounter {
                 return;
             }
             case Status.deprecated: {
-                this.deprecateNum++; 
+                this.deprecatedNum++; 
                 return;
             }
         }
@@ -66,7 +66,8 @@ export class StatusCounter {
         switch (status) {
             case Status.stable: return this.stableNum; 
             case Status.reserved: return this.reservedNum;
-            case Status.deprecated: return this.deprecateNum;
+            case Status.deprecated: return this.deprecatedNum;
+            default: throw new Error(`Unknown term status: ${status}`);
         }
     }
 }
@@ -86,20 +87,20 @@ export interface Contexts {
  */
 export interface GlobalData {
     /** Vocabulary prefix for the vocabulary being handled. */
-    vocab_prefix     : string,
+    vocab_prefix     : string;
 
     /** Vocabulary URL for the vocabulary being handled. */
-    vocab_url        : string,
+    vocab_url        : string;
 
     /** Default context URL for the vocabulary being handled. */
-    vocab_context   ?: string,
+    vocab_context   ?: string;
 
     /**
      * Counter for the terms with various status values.
      * Some serializers (e.g. HTML) may optimize/improve the final
      * output if one of the categories have no entries whatsoever.
      */
-    status_counter   : StatusCounter,
+    status_counter   : StatusCounter;
 
     /**
      * Inverted info for contexts: for each context the list of relevant terms are listed.
@@ -194,7 +195,7 @@ export interface ValidationResults {
      * If the content is valid, the error array is empty. Otherwise, the vocab field is null, and
      * the validation error(s) are returned.
      */
-    vocab : RawVocab | null,
+    vocab : RawVocab | null;
     error : ValidationError[];
 }
 
@@ -203,9 +204,9 @@ export interface ValidationResults {
  * the generic Ajv error message is way too complex for our use)
  */
 export interface ValidationError {
-    message ?: string,
-    params  ?: any,
-    data    ?: any,
+    message ?: string;
+    params  ?: any;
+    data    ?: any;
 }
 
 /* ************************************* Internal representation ***********************************/
@@ -302,11 +303,11 @@ export interface OntologyProperty {
  * possibly, datatypes and individuals…
  */
 export interface Vocab {
-    prefixes            : RDFPrefix[],
-    ontology_properties : OntologyProperty[]
-    classes             : RDFClass[],
-    properties          : RDFProperty[],
-    individuals         : RDFIndividual[],
-    datatypes           : RDFDatatype[],
+    prefixes            : RDFPrefix[];
+    ontology_properties : OntologyProperty[];
+    classes             : RDFClass[];
+    properties          : RDFProperty[];
+    individuals         : RDFIndividual[];
+    datatypes           : RDFDatatype[];
 }
 

lib/common.ts

@@ -24,17 +24,17 @@ const preamble: Context = {
  * Generate the minimal JSON-LD context for the vocabulary.
  *
  * @param vocab - The internal representation of the vocabulary
- * @returns
+ * @returns - the full context in string (ready to be written to a file)
  */
 export function toContext(vocab: Vocab): string {
     // Generation of a unit for properties
-    const propertyContext = (property: RDFProperty, for_class = true): Context|string => {
+    const propertyContext = (property: RDFProperty, forClass = true): Context|string => {
         // the real id of the property...
-        const url = `${global.vocab_url}${property.id}`
+        const url = `${global.vocab_url}${property.id}`;
         const output: Context = {
             "@id" : url
         }
-        if (for_class || property.type.includes("owl:ObjectProperty")) {
+        if (forClass || property.type.includes("owl:ObjectProperty")) {
             output["@type"] = "@id";
         }
         // Try to catch the datatype settings; these can be used
@@ -45,7 +45,7 @@ export function toContext(vocab: Vocab): string {
                     output["@type"] = range.replace('xsd:', 'http://www.w3.org/2001/XMLSchema#');
                     break;
                 } else if (range === "rdf:List") {
-                    output["@container"] = "@list"
+                    output["@container"] = "@list";
                 }
             } 
         }
@@ -107,7 +107,7 @@ export function toContext(vocab: Vocab): string {
 
     // Add the individuals
     for (const individual of vocab.individuals) {
-        top_level[individual.id] = `${global.vocab_url}${individual.id}`
+        top_level[individual.id] = `${global.vocab_url}${individual.id}`;
     }
 
     // Add the datatypes

lib/context.ts

@@ -33,7 +33,7 @@ class MiniDOM {
     private readonly _localDocument: Document;
 
     constructor(html_text: string) {
-        const doc = (new JSDOM(html_text)).window._document;
+        const doc = (new JSDOM(html_text)).window.document;
         if (doc) {
             this._localDocument = doc;
         } else {
@@ -58,7 +58,9 @@ class MiniDOM {
     addChild(parent: Element, element: string, content: string | undefined = undefined): Element {
         const new_element = this._localDocument.createElement(element);
         parent.appendChild(new_element);
-        if (content !== undefined) new_element.innerHTML = content;
+        if (content !== undefined) {
+            new_element.innerHTML = content;
+        }
         return new_element;
     }
 
@@ -211,17 +213,7 @@ export function toHTML(vocab: Vocab, template_text: string): string {
             // curie
             output = computeHash(curie) /* curie */;
 
-            // This is still a matter of discussion... I am not sure that this is the
-            // right approach. However, I am an RDF oriented person...
-            // h4 = document.addChild(section,'h4', `<code>${curie}</code>`);
             document.addChild(section,'h4', `<code>${item.id}</code>`);
-
-            // A single RDFa statement is added to the lot to ensure a proper relationship
-            // to the "real" URL of the external term
-            section.setAttribute('about', `${vocab_url}${curie}`);
-            section.setAttribute('rel', 'owl:sameAs');
-            section.setAttribute('resource', `${curie}`);
-
             const term = document.addChild(section, 'p', `<em>${item.label}</code>`);
 
             if (item.status !== Status.stable) {
@@ -368,7 +360,8 @@ export function toHTML(vocab: Vocab, template_text: string): string {
                 return { id_prefix : 'reserved_', intro_prefix: '<em><strong>reserved</strong></em>' };
             case Status.stable :
                 return { id_prefix : '', intro_prefix : '' };
-
+            default :
+                throw new Error(`Unknown status: ${status}`);
         }
     }
 
@@ -810,7 +803,11 @@ export function toHTML(vocab: Vocab, template_text: string): string {
     }
 
     // That is it... generate the output
-    // I wish it was possible to generate a properly formatted HTML source, but I am not sure how to do that
+    // To generate a properly formatted HTML source, consider using a library like 'pretty' or 'js-beautify'.
+    // Example: 
+    // import { format } from 'pretty';
+    // return format(`<!DOCTYPE html>\n<html lang="en">${document.innerHTML()}</html>`, { ocd: true });
+
     return `<!DOCTYPE html>\n<html lang="en">${document.innerHTML()}</html>`;
 }
 

lib/html.ts

@@ -11,8 +11,7 @@ import { Vocab, global, RDFTerm, Link, Status } from './common';
  * Nothing complex, just a straightforward conversion of the information into the turtle syntax.
  * 
  * @param vocab - The internal representation of the vocabulary
- * @returns 
- * @async
+ * @returns - the full Turtle representation of the vocabulary
  */
 export function toTurtle(vocab: Vocab): string {