Upgrade AvalynxRef to version 1.0.2.

jschwind · jschwind · commit 206eb8ee50af · 2026-02-25T11:11:30.000+01:00
Updated version references in package.json, README files, and examples. Added a German README translation, improved Jest configuration for coverage collection with thresholds, and excluded coverage directory in .gitignore. Minor code adjustments include enhanced `module.exports` implementation and coverage annotation. Upgraded devDependencies for consistent builds.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
 /.idea/
-/node_modules/
-/package-lock.json
 /ai.txt
+/coverage/
+/node_modules/
diff --git a/README.de.md b/README.de.md
@@ -0,0 +1,140 @@
+# AvalynxRef
+
+[![npm version](https://img.shields.io/npm/v/avalynx-ref)](https://www.npmjs.com/package/avalynx-ref)
+[![npm downloads](https://img.shields.io/npm/dt/avalynx-ref)](https://www.npmjs.com/package/avalynx-ref)
+[![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/avalynx-ref)](https://www.jsdelivr.com/package/npm/avalynx-ref)
+[![License](https://img.shields.io/npm/l/avalynx-ref)](LICENSE)
+[![Tests](https://github.com/avalynx/avalynx-ref/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/avalynx/avalynx-ref/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/avalynx/avalynx-ref/branch/main/graph/badge.svg)](https://codecov.io/gh/avalynx/avalynx-ref)
+[![GitHub stars](https://img.shields.io/github/stars/avalynx/avalynx-ref?style=flat&logo=github)](https://github.com/avalynx/avalynx-ref)
+
+AvalynxRef ist eine Implementierung eines Referenzsystem (Ref), ähnlich wie Refs in React oder Vue, das zur Aktualisierung von DOM-Elementen mit einem bestimmten Wert entwickelt wurde. Dies ermöglicht eine reaktive Verknüpfung zwischen JavaScript-Daten und der Benutzeroberfläche.
+
+## Funktionen
+
+- **Leichtgewichtig**: AvalynxRef ist eine leichtgewichtige Bibliothek, die keine Abhängigkeiten erfordert.
+- **Ref-System**: Verwenden Sie Refs, um DOM-Elemente mit einem bestimmten Wert zu aktualisieren.
+
+## Beispiel
+
+Hier ist ein einfaches Beispiel für die Verwendung von AvalynxRef in Ihrem Projekt:
+
+* [Übersicht](https://avalynx-ref.jbs-newmedia.de/examples/index.html)
+* [Zufallswerte](https://avalynx-ref.jbs-newmedia.de/examples/random-values.html)
+
+## Installation
+
+Um AvalynxRef in Ihrem Projekt zu verwenden, können Sie es direkt in Ihre HTML-Datei einbinden.
+
+Binden Sie AvalynxRef ein:
+
+```html
+<script src="pfad/zu/avalynx-ref.js"></script>
+```
+
+Ersetzen Sie `pfad/zu/avalynx-ref.js` durch den tatsächlichen Pfad zur Datei in Ihrem Projekt.
+
+## Installation über jsDelivr ([Link](https://cdn.jsdelivr.net/npm/avalynx-ref/))
+
+AvalynxRef ist auch über [jsDelivr](https://www.jsdelivr.com/) verfügbar. Sie können es wie folgt in Ihr Projekt einbinden:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/avalynx-ref@1.0.2/dist/js/avalynx-ref.min.js"></script>
+```
+
+## Installation über NPM ([Link](https://www.npmjs.com/package/avalynx-ref))
+
+AvalynxRef ist auch als npm-Paket verfügbar. Sie können es mit dem folgenden Befehl zu Ihrem Projekt hinzufügen:
+
+```bash
+npm install avalynx-ref
+```
+
+Nach der Installation können Sie AvalynxRef wie folgt in Ihre JavaScript-Datei importieren:
+
+```javascript
+import { AvalynxRef } from 'avalynx-ref';
+```
+
+## Installation über Symfony AssetMapper
+
+```bash
+php bin/console importmap:require avalynx-ref
+```
+
+Nach der Installation können Sie AvalynxRef wie folgt in Ihre JavaScript-Datei importieren:
+
+```javascript
+import { AvalynxRef } from 'avalynx-ref';
+```
+
+## Installation über Symfony AssetComposer
+
+Weitere Informationen zum Symfony AssetComposer Bundle finden Sie [hier](https://github.com/jbsnewmedia/asset-composer-bundle).
+
+```twig
+{% do addAssetComposer('avalynx/avalynx-ref/dist/js/avalynx-ref.js') %}
+```
+
+Stellen Sie sicher, dass Sie auch das JS/CSS von Bootstrap in Ihr Projekt einbinden, damit AvalynxRef korrekt angezeigt wird.
+
+## Installation über Composer ([Link](https://packagist.org/packages/avalynx/avalynx-ref))
+
+AvalynxRef ist auch als Composer-Paket verfügbar. Sie können es mit dem folgenden Befehl zu Ihrem Projekt hinzufügen:
+
+```bash
+composer require avalynx/avalynx-loader
+```
+
+Nach der Installation können Sie AvalynxLoader wie folgt in Ihre HTML-Datei einbinden:
+
+```html
+<script src="vendor/avalynx/avalynx-loader/dist/js/avalynx-loader.js"></script>
+``` 
+
+## Verwendung
+
+Um AvalynxRef in Ihrem Projekt zu verwenden, binden Sie die JavaScript-Datei AvalynxRef in Ihr Projekt ein und initialisieren Sie die Klasse mit dem entsprechenden Selektor.
+
+```javascript
+const myRef = new AvalynxRef("#myElement");
+myRef.value = "Aktualisierter Inhalt";
+```
+
+oder verwenden Sie die Option `isHtml`, um den Wert als HTML zu behandeln:
+
+```javascript
+const myRef = new AvalynxRef("#myElement", { isHtml: true });
+myRef.value = "<p>Aktualisierter Inhalt</p>";
+```
+
+## Optionen
+
+AvalynxRef ermöglicht die folgenden Optionen zur Anpassung:
+
+- `selector`: (string) Der Selektor, der für die Zielbestimmung von Tabellen im DOM verwendet werden soll (Standard: `'.avalynx-ref'`).
+- `options`: Ein Objekt, das die folgenden Schlüssel enthält:
+  - `isHtml`: (boolean) Behandelt den Wert als HTML (Standard: `false`).
+
+## Geplante Funktionen
+- Callback-Funktion für Wertänderungen
+ 
+## Beitragen
+
+Beiträge sind willkommen! Wenn Sie etwas beitragen möchten, forken Sie bitte das Repository und senden Sie einen Pull-Request mit Ihren Änderungen oder Verbesserungen. Wir suchen nach Beiträgen in den folgenden Bereichen:
+
+- Fehlerbehebungen
+- Funktionserweiterungen
+- Dokumentationsverbesserungen
+
+Bevor Sie Ihren Pull-Request einreichen, stellen Sie bitte sicher, dass Ihre Änderungen gut dokumentiert sind und dem bestehenden Codierungsstil des Projekts entsprechen.
+
+## Lizenz
+
+AvalynxRef ist quelloffene Software, die unter der [MIT-Lizenz](LICENSE) lizenziert ist.
+
+## Kontakt
+
+Wenn Sie Fragen, Funktionswünsche oder Probleme haben, eröffnen Sie bitte ein Issue in unserem [GitHub-Repository](https://github.com/avalynx/avalynx-ref/issues) oder reichen Sie einen Pull-Request ein.
+
+Vielen Dank, dass Sie AvalynxRef für Ihr Projekt in Betracht ziehen!
diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
 # AvalynxRef
 
+[![npm version](https://img.shields.io/npm/v/avalynx-ref)](https://www.npmjs.com/package/avalynx-ref)
+[![npm downloads](https://img.shields.io/npm/dt/avalynx-ref)](https://www.npmjs.com/package/avalynx-ref)
+[![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/avalynx-ref)](https://www.jsdelivr.com/package/npm/avalynx-ref)
+[![License](https://img.shields.io/npm/l/avalynx-ref)](LICENSE)
+[![Tests](https://github.com/avalynx/avalynx-ref/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/avalynx/avalynx-ref/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/avalynx/avalynx-ref/branch/main/graph/badge.svg)](https://codecov.io/gh/avalynx/avalynx-ref)
+[![GitHub stars](https://img.shields.io/github/stars/avalynx/avalynx-ref?style=flat&logo=github)](https://github.com/avalynx/avalynx-ref)
+
 AvalynxRef is an implementation of a reference (Ref) system, similar to Refs in React or Vue, designed for updating DOM elements with a specified value. This facilitates a reactive linkage between JavaScript data and the user interface.
 
 ## Features
@@ -31,7 +39,7 @@ Replace `path/to/avalynx-ref.js` with the actual path to the file in your projec
 AvalynxRef is also available via [jsDelivr](https://www.jsdelivr.com/). You can include it in your project like this:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/avalynx-ref@1.0.1/dist/js/avalynx-ref.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/avalynx-ref@1.0.2/dist/js/avalynx-ref.min.js"></script>
 ```
 
 ## Installation via NPM ([Link](https://www.npmjs.com/package/avalynx-ref))
diff --git a/dist/js/avalynx-ref.esm.js b/dist/js/avalynx-ref.esm.js
@@ -3,7 +3,7 @@
  *
  * AvalynxRef is an implementation of a reference (Ref) system, similar to Refs in React or Vue, designed for updating DOM elements with a specified value. This facilitates a reactive linkage between JavaScript data and the user interface.
  *
- * @version 1.0.1
+ * @version 1.0.2
  * @license MIT
  * @author https://github.com/avalynx/avalynx-ref/graphs/contributors
  * @website https://github.com/avalynx/
@@ -74,6 +74,7 @@ export class AvalynxRef {
     }
 }
 
+/* istanbul ignore next */
 if (typeof module !== 'undefined' && module.exports) {
     module.exports = AvalynxRef
 }
diff --git a/dist/js/avalynx-ref.js b/dist/js/avalynx-ref.js
@@ -3,7 +3,7 @@
  *
  * AvalynxRef is an implementation of a reference (Ref) system, similar to Refs in React or Vue, designed for updating DOM elements with a specified value. This facilitates a reactive linkage between JavaScript data and the user interface.
  *
- * @version 1.0.1
+ * @version 1.0.2
  * @license MIT
  * @author https://github.com/avalynx/avalynx-ref/graphs/contributors
  * @website https://github.com/avalynx/
@@ -72,6 +72,7 @@ class AvalynxRef {
     }
 }
 
+/* istanbul ignore next */
 if (typeof module !== 'undefined' && module.exports) {
     module.exports = AvalynxRef
 }
diff --git a/examples/random-values.html b/examples/random-values.html
@@ -16,8 +16,8 @@
 	<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9/build/styles/stackoverflow-light.min.css" id="hljsTheme">
 	<script>hljs.highlightAll();</script>
 
-	<!-- AvalynxRef 1.0.1 -->
-	<script src="https://cdn.jsdelivr.net/npm/avalynx-ref@1.0.1/dist/js/avalynx-ref.min.js"></script>
+	<!-- AvalynxRef -->
+	<script src="../src/js/avalynx-ref.js"></script>
 
 	<!-- Example helper -->
 	<link href="./css/helper.css" rel="stylesheet">
diff --git a/jest.config.js b/jest.config.js
@@ -8,4 +8,15 @@ module.exports = {
     transform: {
         "^.+\\.js$": "babel-jest"
     },
+    collectCoverage: true,
+    collectCoverageFrom: ["src/**/*.js"],
+    coverageReporters: ["text", "lcov", "html"],
+    coverageThreshold: {
+        global: {
+            branches: 100,
+            functions: 100,
+            lines: 100,
+            statements: 100
+        }
+    }
 };
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "avalynx-ref",
   "title": "AvalynxRef",
   "description": "AvalynxRef is a Ref implementation for updating elements with a value like React's Ref or Vue's Ref.",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
   "main": "dist/js/avalynx-ref.js",
   "module": "dist/js/avalynx-ref.esm.js",
@@ -36,12 +36,12 @@
     "build": "shx rm -rf dist; shx mkdir -p dist/js/; shx cp src/js/avalynx-ref.js dist/js/avalynx-ref.js; shx cp src/js/avalynx-ref.js dist/js/avalynx-ref.esm.js; node build.js dist/js/avalynx-ref.esm.js;"
   },
   "devDependencies": {
-    "@babel/core": "^7",
-    "@babel/preset-env": "^7",
-    "babel-jest": "^29",
-    "jest": "^29",
-    "jest-environment-jsdom": "^29",
-    "shelljs": "^0",
-    "shx": "^0"
+    "@babel/core": "^7.29.0",
+    "@babel/preset-env": "^7.29.0",
+    "babel-jest": "^30.2.0",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "shelljs": "^0.10.0",
+    "shx": "^0.4.0"
   }
 }
diff --git a/src/js/avalynx-ref.js b/src/js/avalynx-ref.js
@@ -3,7 +3,7 @@
  *
  * AvalynxRef is an implementation of a reference (Ref) system, similar to Refs in React or Vue, designed for updating DOM elements with a specified value. This facilitates a reactive linkage between JavaScript data and the user interface.
  *
- * @version 1.0.1
+ * @version 1.0.2
  * @license MIT
  * @author https://github.com/avalynx/avalynx-ref/graphs/contributors
  * @website https://github.com/avalynx/
@@ -72,6 +72,7 @@ class AvalynxRef {
     }
 }
 
+/* istanbul ignore next */
 if (typeof module !== 'undefined' && module.exports) {
     module.exports = AvalynxRef
 }

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`*`
`4`	`4`	`* AvalynxRef is an implementation of a reference (Ref) system, similar to Refs in React or Vue, designed for updating DOM elements with a specified value. This facilitates a reactive linkage between JavaScript data and the user interface.`
`5`	`5`	`*`
`6`		`- * @version 1.0.1`
	`6`	`+ * @version 1.0.2`
`7`	`7`	`* @license MIT`
`8`	`8`	`* @author https://github.com/avalynx/avalynx-ref/graphs/contributors`
`9`	`9`	`* @website https://github.com/avalynx/`
`@@ -74,6 +74,7 @@ export class AvalynxRef {`
`74`	`74`	`}`
`75`	`75`	`}`
`76`	`76`
	`77`	`+/* istanbul ignore next */`
`77`	`78`	`if (typeof module !== 'undefined' && module.exports) {`
`78`	`79`	`module.exports = AvalynxRef`
`79`	`80`	`}`