chore: add commit guards

Author: stee-re

.gitignore

@@ -3,6 +3,7 @@ node_modules
 *.map
 *.d.ts
 *.tsbuildinfo
+!commitlint.config.js
 
 ## editors
 /.idea

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

README.md

@@ -1,4 +1,4 @@
-[![Release](https://github.com/OMICRONEnergyOSS/oscd-api/actions/workflows/release-please.yml/badge.svg)](https://github.com/OMICRONEnergyOSS/oscd-api/actions/workflows/release-please.yml)
+[![Tests](https://github.com/OMICRONEnergyOSS/oscd-api/actions/workflows/test.yml/badge.svg)](https://github.com/OMICRONEnergyOSS/oscd-api/actions/workflows/test.yml) ![NPM Version](https://img.shields.io/npm/v/@omicronenergy/oscd-api)
 
 # OpenSCD API
 

commitlint.config.js

@@ -0,0 +1 @@
+export default { extends: ['@commitlint/config-conventional'] };

edit-event.ts

@@ -1,4 +1,4 @@
-import { EditV2 } from "./editv2.js";
+import { EditV2 } from './editv2.js';
 
 export type EditDetailV2<E extends EditV2 = EditV2> = {
   edit: E;
@@ -19,7 +19,7 @@ export function newEditEventV2<E extends EditV2>(
   edit: E,
   options?: EditEventOptions,
 ): EditEventV2<E> {
-  return new CustomEvent<EditDetailV2<E>>("oscd-edit-v2", {
+  return new CustomEvent<EditDetailV2<E>>('oscd-edit-v2', {
     composed: true,
     bubbles: true,
     detail: { ...options, edit },
@@ -28,6 +28,6 @@ export function newEditEventV2<E extends EditV2>(
 
 declare global {
   interface ElementEventMap {
-    ["oscd-edit-v2"]: EditEventV2;
+    ['oscd-edit-v2']: EditEventV2;
   }
 }

editv1.spec.ts

@@ -1,11 +1,11 @@
-import { expect } from "@open-wc/testing";
+import { expect } from '@open-wc/testing';
 
-import { isEdit, Update } from "./editv1.js";
-import { Insert, Remove, SetAttributes, SetTextContent } from "./editv2.js";
+import { isEdit, Update } from './editv1.js';
+import { Insert, Remove, SetAttributes, SetTextContent } from './editv2.js';
 
 const element = new DOMParser().parseFromString(
-  "<SCL />",
-  "application/xml",
+  '<SCL />',
+  'application/xml',
 )!.documentElement;
 
 const update: Update = { element, attributes: {} };
@@ -16,31 +16,31 @@ const setAttributes: SetAttributes = {
   attributes: {},
   attributesNS: {},
 };
-const setTextContent: SetTextContent = { element, textContent: "" };
+const setTextContent: SetTextContent = { element, textContent: '' };
 
-describe("type guard functions for editv1", () => {
-  it("returns false on invalid Edit type", () =>
-    expect("invalid edit").to.not.satisfy(isEdit));
+describe('type guard functions for editv1', () => {
+  it('returns false on invalid Edit type', () =>
+    expect('invalid edit').to.not.satisfy(isEdit));
 
-  it("returns false on Update", () => expect(update).to.satisfy(isEdit));
+  it('returns false on Update', () => expect(update).to.satisfy(isEdit));
 
-  it("returns true for Insert", () => expect(insert).to.satisfy(isEdit));
+  it('returns true for Insert', () => expect(insert).to.satisfy(isEdit));
 
-  it("returns true for Remove", () => expect(remove).to.satisfy(isEdit));
+  it('returns true for Remove', () => expect(remove).to.satisfy(isEdit));
 
-  it("returns false for SetAttributes", () =>
+  it('returns false for SetAttributes', () =>
     expect(setAttributes).to.not.satisfy(isEdit));
 
-  it("returns true for SetTextContent", () =>
+  it('returns true for SetTextContent', () =>
     expect(setTextContent).to.not.satisfy(isEdit));
 
-  it("returns false on mixed edit and editV2 array", () =>
+  it('returns false on mixed edit and editV2 array', () =>
     expect([update, setAttributes]).to.not.satisfy(isEdit));
 
-  it("returns true on edit array", () =>
+  it('returns true on edit array', () =>
     expect([update, remove, insert]).to.satisfy(isEdit));
 
-  it("returns false on editV2 array", () =>
+  it('returns false on editV2 array', () =>
     expect([setAttributes, remove, insert, setTextContent]).to.not.satisfy(
       isEdit,
     ));

editv1.ts

@@ -1,4 +1,4 @@
-import { isSetAttributes } from "./editv2";
+import { isSetAttributes } from './editv2';
 
 /** Intent to `parent.insertBefore(node, reference)` */
 export type Insert = {
@@ -37,7 +37,7 @@ export function isInsert(edit: Edit): edit is Insert {
 export function isNamespaced(
   value: AttributeValue,
 ): value is NamespacedAttributeValue {
-  return value !== null && typeof value !== "string";
+  return value !== null && typeof value !== 'string';
 }
 
 export function isUpdate(edit: Edit): edit is Update {
@@ -57,7 +57,7 @@ export type EditEvent<E extends Edit = Edit> = CustomEvent<E>;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isEdit(edit: any): edit is Edit {
-  if (isComplex(edit)) return !edit.some((e) => !isEdit(e));
+  if (isComplex(edit)) return !edit.some(e => !isEdit(e));
 
   return (
     !isSetAttributes(edit) &&

editv2.spec.ts

@@ -1,17 +1,17 @@
-import { expect } from "@open-wc/testing";
+import { expect } from '@open-wc/testing';
 
-import { Update } from "./editv1.js";
+import { Update } from './editv1.js';
 import {
   Insert,
   isEditV2,
   Remove,
   SetAttributes,
   SetTextContent,
-} from "./editv2.js";
+} from './editv2.js';
 
 const element = new DOMParser().parseFromString(
-  "<SCL />",
-  "application/xml",
+  '<SCL />',
+  'application/xml',
 )!.documentElement;
 
 const update: Update = { element, attributes: {} };
@@ -22,31 +22,31 @@ const setAttributes: SetAttributes = {
   attributes: {},
   attributesNS: {},
 };
-const setTextContent: SetTextContent = { element, textContent: "" };
+const setTextContent: SetTextContent = { element, textContent: '' };
 
-describe("type guard functions for editv2", () => {
-  it("returns false on invalid Edit type", () =>
-    expect("invalid edit").to.not.satisfy(isEditV2));
+describe('type guard functions for editv2', () => {
+  it('returns false on invalid Edit type', () =>
+    expect('invalid edit').to.not.satisfy(isEditV2));
 
-  it("returns false on Update", () => expect(update).to.not.satisfy(isEditV2));
+  it('returns false on Update', () => expect(update).to.not.satisfy(isEditV2));
 
-  it("returns true for Insert", () => expect(insert).to.satisfy(isEditV2));
+  it('returns true for Insert', () => expect(insert).to.satisfy(isEditV2));
 
-  it("returns true for Remove", () => expect(remove).to.satisfy(isEditV2));
+  it('returns true for Remove', () => expect(remove).to.satisfy(isEditV2));
 
-  it("returns true for SetAttributes", () =>
+  it('returns true for SetAttributes', () =>
     expect(setAttributes).to.satisfy(isEditV2));
 
-  it("returns true for SetTextContent", () =>
+  it('returns true for SetTextContent', () =>
     expect(setTextContent).to.satisfy(isEditV2));
 
-  it("returns false on mixed edit and editV2 array", () =>
+  it('returns false on mixed edit and editV2 array', () =>
     expect([update, setAttributes]).to.not.satisfy(isEditV2));
 
-  it("returns false on edit array", () =>
+  it('returns false on edit array', () =>
     expect([update, update]).to.not.satisfy(isEditV2));
 
-  it("returns true on editV2 array", () =>
+  it('returns true on editV2 array', () =>
     expect([setAttributes, remove, insert, setTextContent]).to.satisfy(
       isEditV2,
     ));

editv2.ts

@@ -66,7 +66,7 @@ export function isInsert(edit: EditV2): edit is Insert {
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isEditV2(edit: any): edit is EditV2 {
-  if (isComplex(edit)) return !edit.some((e) => !isEditV2(e));
+  if (isComplex(edit)) return !edit.some(e => !isEditV2(e));
 
   return (
     isSetAttributes(edit) ||