refactor: format using eslint

Author: JakobVogelsang

.eslintignore

@@ -0,0 +1,8 @@
+node_modules
+coverage
+dist
+doc
+
+**/*.spec.ts
+
+**/*.html

describe.spec.ts

@@ -88,7 +88,7 @@ const testScl = new DOMParser().parseFromString(
       </EnumType>
       </DataTypeTemplates>
     </SCL>`,
-  "application/xml"
+  "application/xml",
 );
 
 const sclElement = testScl.querySelector("SCL")!;
@@ -111,21 +111,21 @@ describe("Describe SCL elements function", () => {
 
   it("return equal description with semantically equal SCL element", () =>
     expect(JSON.stringify(describeSclElement(baseEnumType))).to.equal(
-      JSON.stringify(describeSclElement(equalEnumType))
+      JSON.stringify(describeSclElement(equalEnumType)),
     ));
 
   it("return different description with semantically unequal SCL element", () =>
     expect(JSON.stringify(describeSclElement(diffEnumType))).to.not.equal(
-      JSON.stringify(describeSclElement(equalEnumType))
+      JSON.stringify(describeSclElement(equalEnumType)),
     ));
 
   it("returns same description with semantically equal LN's", () =>
     expect(JSON.stringify(describeSclElement(baseLN))).to.equal(
-      JSON.stringify(describeSclElement(equalLN))
+      JSON.stringify(describeSclElement(equalLN)),
     ));
 
   it("returns different description with unequal LN elements", () =>
     expect(JSON.stringify(describeSclElement(baseLN))).to.not.equal(
-      JSON.stringify(describeSclElement(diffLN))
+      JSON.stringify(describeSclElement(diffLN)),
     ));
 });

describe.ts

@@ -8,7 +8,8 @@ import { LN, LNDescription } from "./describe/LN.js";
 
 export type Description =
   | PrivateDescription
-  | TextDescription
+  // eslint-disable-next-line @typescript-eslint/no-duplicate-type-constituents
+  | TextDescription // FIXME: duplication to PrivateDescription
   | EnumTypeDescription
   | DATypeDescription
   | DOTypeDescription

describe/AbstractDataAttribute.spec.ts

@@ -48,7 +48,7 @@ const scl = new DOMParser().parseFromString(
         </EnumType>
     </DataTypeTemplates>
     </SCL>`,
-  "application/xml"
+  "application/xml",
 );
 
 const baseBDA = scl.querySelector(`#baseDAType>BDA`)!;
@@ -57,14 +57,14 @@ const equalBDA = scl.querySelector(`#equalDAType>BDA`)!;
 const orphanBDA = new DOMParser()
   .parseFromString(
     `<BDA name="hstVal" desc="refArrayBDA" bType="FLOAT32" count="hstRangeC" />`,
-    "application/xml"
+    "application/xml",
   )
   .querySelector("BDA")!;
 
 const missingBType = scl.querySelector(`BDA[desc="missingBType"`)!;
 const refInvalidCount = scl.querySelector(`BDA[desc="invalidRefArrayBDA"`)!;
 const refInvalidSiblingCount = scl.querySelector(
-  `BDA[desc="invalidSiblingCount"`
+  `BDA[desc="invalidSiblingCount"`,
 )!;
 const refMissingCount = scl.querySelector(`BDA[desc="missingRefArrayBDA"`)!;
 const refValidCount = scl.querySelector(`BDA[desc="refArrayBDA"`)!;
@@ -78,7 +78,7 @@ describe("Description for SCL schema type tAbstractDataAttribute", () => {
   it("returns property sAddr with existing sAddr attribute", () => {
     expect(describeDAorSDAorDAI(baseBDA)).to.have.property(
       "sAddr",
-      "someSAddr"
+      "someSAddr",
     );
     expect(describeDAorSDAorDAI(diffBDA1)).to.not.have.property("sAddr");
   });
@@ -97,7 +97,7 @@ describe("Description for SCL schema type tAbstractDataAttribute", () => {
     expect(describeDAorSDAorDAI(diffBDA1)).to.have.property("bType", "FLOAT32");
     expect(describeDAorSDAorDAI(missingBType)).to.have.property(
       "bType",
-      "undefined"
+      "undefined",
     );
   });
 
@@ -115,7 +115,7 @@ describe("Description for SCL schema type tAbstractDataAttribute", () => {
 
     expect(describeDAorSDAorDAI(refInvalidSiblingCount)).to.have.property(
       "count",
-      0
+      0,
     );
   });
 
@@ -125,7 +125,7 @@ describe("Description for SCL schema type tAbstractDataAttribute", () => {
     expect(describeDAorSDAorDAI(baseBDA).type).to.satisfy(isDATypeDescription);
 
     expect(describeDAorSDAorDAI(diffBDA2).type).to.satisfy(
-      isEnumTypeDescription
+      isEnumTypeDescription,
     );
   });
 
@@ -138,11 +138,11 @@ describe("Description for SCL schema type tAbstractDataAttribute", () => {
 
   it("returns same description with semantically equal BDA's", () =>
     expect(JSON.stringify(describeDAorSDAorDAI(baseBDA))).to.equal(
-      JSON.stringify(describeDAorSDAorDAI(equalBDA))
+      JSON.stringify(describeDAorSDAorDAI(equalBDA)),
     ));
 
   it("returns different description with unequal BDA elements", () =>
     expect(JSON.stringify(describeDAorSDAorDAI(baseBDA))).to.not.equal(
-      JSON.stringify(describeDAorSDAorDAI(diffBDA2))
+      JSON.stringify(describeDAorSDAorDAI(diffBDA2)),
     ));
 });

describe/AbstractDataAttribute.ts

@@ -4,7 +4,8 @@ import { NamingDescription, describeNaming } from "./Naming.js";
 import { ValDescription, describeVal, compareBySGroup } from "./Val.js";
 
 export function isAbstractDataAttributeDescription(
-  type: any
+  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+  type: any,
 ): type is AbstractDataAttributeDescription {
   return (
     "bType" in type &&
@@ -37,7 +38,7 @@ function siblingCount(element: Element, name: string): number {
   if (!parent) return NaN;
 
   const sibling = Array.from(parent.children).find(
-    (child) => child.getAttribute("name") === name
+    (child) => child.getAttribute("name") === name,
   );
   if (!sibling) return NaN;
 
@@ -50,11 +51,11 @@ function siblingCount(element: Element, name: string): number {
 }
 
 export function describeDAorSDAorDAI(
-  element: Element
+  element: Element,
 ): AbstractDataAttributeDescription {
   const abstractDataAttributeDesc: AbstractDataAttributeDescription = {
     ...describeNaming(element),
-    bType: element.getAttribute("bType") || "undefined",
+    bType: element.getAttribute("bType") ?? "undefined",
     valKind: "Set",
     valImport: false,
     count: 0,
@@ -94,10 +95,8 @@ export function describeDAorSDAorDAI(
     .sort(compareBySGroup);
 
   const referencedType = Array.from(
-    element.closest("DataTypeTemplates")?.children ?? []
-  ).find(
-    (sibling) => sibling.getAttribute("id") === element.getAttribute("type")
-  );
+    element.closest("DataTypeTemplates")?.children ?? [],
+  ).find((sibling) => sibling.getAttribute("id") === type);
   if (
     abstractDataAttributeDesc.bType === "Enum" &&
     referencedType &&

describe/BaseElement.spec.ts

@@ -55,7 +55,7 @@ const scl = new DOMParser().parseFromString(
         <EnumVal ord="13">SomeOtherContent</EnumVal>
       </EnumType>
     </SCL>`,
-  "application/xml"
+  "application/xml",
 );
 
 const baseElement = scl.querySelector("#someEqual")!;
@@ -83,43 +83,43 @@ describe("Description for SCL element typed tBaseElement", () => {
     const attributes = describeBaseElement(baseElement).eNSAttributes;
     expect(attributes).to.not.be.undefined;
     expect(attributes["http://somevalidURI"]["ens:some"]).to.equal(
-      "someOtherNamespace"
+      "someOtherNamespace",
     );
     expect(
-      attributes["http://www.iec.ch/61850/2003/SCLcoordinates"]["sxy:x"]
+      attributes["http://www.iec.ch/61850/2003/SCLcoordinates"]["sxy:x"],
     ).to.equal("1");
     expect(
-      attributes["http://www.iec.ch/61850/2003/SCLcoordinates"]["sxy:y"]
+      attributes["http://www.iec.ch/61850/2003/SCLcoordinates"]["sxy:y"],
     ).to.equal("3");
   });
 
   it("returns same description with semantically equal SCL element", () =>
     expect(JSON.stringify(describeBaseElement(baseElement))).to.equal(
-      JSON.stringify(describeBaseElement(equalElement))
+      JSON.stringify(describeBaseElement(equalElement)),
     ));
 
   it("returns different description with unequal extra namespace attributes", () =>
     expect(JSON.stringify(describeBaseElement(diffElement1))).to.not.equal(
-      JSON.stringify(describeBaseElement(equalElement))
+      JSON.stringify(describeBaseElement(equalElement)),
     ));
 
   it("returns different description with unequal Private child element", () =>
     expect(JSON.stringify(describeBaseElement(diffElement2))).to.not.equal(
-      JSON.stringify(describeBaseElement(equalElement))
+      JSON.stringify(describeBaseElement(equalElement)),
     ));
 
   it("returns different description with unequal Text child element", () =>
     expect(JSON.stringify(describeBaseElement(diffElement4))).to.not.equal(
-      JSON.stringify(describeBaseElement(equalElement))
+      JSON.stringify(describeBaseElement(equalElement)),
     ));
 
   it("returns different description with unequal Private child element order", () =>
     expect(JSON.stringify(describeBaseElement(diffElement3))).to.not.equal(
-      JSON.stringify(describeBaseElement(equalElement))
+      JSON.stringify(describeBaseElement(equalElement)),
     ));
 
   it("is insensitive to any attribute order", () =>
     expect(JSON.stringify(describeBaseElement(diffElement5))).to.equal(
-      JSON.stringify(describeBaseElement(equalElement))
+      JSON.stringify(describeBaseElement(equalElement)),
     ));
 });

describe/BaseElement.ts

@@ -13,7 +13,7 @@ export interface BaseElementDescription {
 }
 
 function sortENsAttributes(
-  eNsAttributes: ExtensionNSAttributes
+  eNsAttributes: ExtensionNSAttributes,
 ): ExtensionNSAttributes {
   return Object.keys(eNsAttributes)
     .sort()

describe/Control.spec.ts

@@ -42,7 +42,7 @@ const scl = new DOMParser().parseFromString(
         </AccessPoint>
       </IED>
     </SCL>`,
-  "application/xml"
+  "application/xml",
 );
 
 const baseDataSet = scl.querySelector(`*[datSet="baseDataSet"]`)!;
@@ -54,7 +54,7 @@ const invalidDataSet = scl.querySelector('*[datSet="invalidDataSet"]')!;
 const parentLessControl = new DOMParser()
   .parseFromString(
     `<ReportControl name="reportControl" datSet="parentLessDataSet" >`,
-    "application/xml"
+    "application/xml",
   )
   .querySelector("ReportControl")!;
 
@@ -70,11 +70,11 @@ describe("Description for SCL schema type tControl", () => {
 
   it("returns same description with semantically equal Control's", () =>
     expect(JSON.stringify(describeControl(baseDataSet))).to.equal(
-      JSON.stringify(describeControl(equalDataSet))
+      JSON.stringify(describeControl(equalDataSet)),
     ));
 
   it("returns different description with unequal Control elements", () =>
     expect(JSON.stringify(describeControl(baseDataSet))).to.not.equal(
-      JSON.stringify(describeControl(diffDataSet))
+      JSON.stringify(describeControl(diffDataSet)),
     ));
 });

describe/Control.ts

@@ -6,7 +6,7 @@ export interface ControlDescription extends NamingDescription {
 }
 
 export function describeControl(
-  element: Element
+  element: Element,
 ): ControlDescription | undefined {
   const datSet = element.getAttribute("datSet");
   if (!datSet) return { ...describeNaming(element) };
@@ -15,7 +15,7 @@ export function describeControl(
     (child) =>
       child.tagName === "DataSet" &&
       child.getAttribute("name") &&
-      child.getAttribute("name") === datSet
+      child.getAttribute("name") === datSet,
   );
   if (!dataSet) return;
 

describe/ControlWithTriggerOpt.spec.ts

@@ -44,7 +44,7 @@ const scl = new DOMParser().parseFromString(
         </AccessPoint>
       </IED>
     </SCL>`,
-  "application/xml"
+  "application/xml",
 );
 
 const baseDataSet = scl.querySelector(`*[datSet="baseDataSet"]`)!;
@@ -62,11 +62,11 @@ describe("Description for SCL schema type tControlWithTriggerOpt", () => {
 
   it("returns same description with semantically equal Control's", () =>
     expect(JSON.stringify(describeControlWithTriggerOpt(baseDataSet))).to.equal(
-      JSON.stringify(describeControlWithTriggerOpt(equalDataSet))
+      JSON.stringify(describeControlWithTriggerOpt(equalDataSet)),
     ));
 
   it("returns different description with unequal Control elements", () =>
     expect(
-      JSON.stringify(describeControlWithTriggerOpt(baseDataSet))
+      JSON.stringify(describeControlWithTriggerOpt(baseDataSet)),
     ).to.not.equal(JSON.stringify(describeControlWithTriggerOpt(diffDataSet))));
 });