Initial commit

Author: ogerly

.github/workflows/node.js.yml

@@ -0,0 +1,42 @@
+# .github/workflows/node.js.yml
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test --if-present
+
+  publish:
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CONTRIBUTING-GUIDE.md

@@ -0,0 +1,66 @@
+# Beitragsrichtlinien
+
+Vielen Dank für dein Interesse, zu diesem Projekt beizutragen! Hier sind einige Richtlinien, die dir helfen werden.
+
+## Code of Conduct
+
+Dieses Projekt und alle Mitwirkenden verpflichten sich zu einem respektvollen und inklusiven Umgang miteinander. Bitte sei freundlich und respektiere andere Perspektiven und Erfahrungen.
+
+## Wie kann ich beitragen?
+
+### Fehler melden
+
+- Prüfe zuerst, ob der Fehler bereits gemeldet wurde
+- Verwende die Issue-Vorlage für Fehlerberichte
+- Beschreibe den Fehler klar und präzise
+- Füge Reproduktionsschritte hinzu
+- Gib Informationen über deine Umgebung (Node.js-Version, Betriebssystem, etc.)
+
+### Feature-Anfragen
+
+- Prüfe zuerst, ob das Feature bereits angefragt wurde
+- Verwende die Issue-Vorlage für Feature-Anfragen
+- Beschreibe das gewünschte Feature klar und präzise
+- Erkläre, warum das Feature nützlich wäre
+
+### Pull Requests
+
+1. Forke das Repository
+2. Erstelle einen Feature-Branch (`git checkout -b feature/amazing-feature`)
+3. Committe deine Änderungen (`git commit -m 'Add some amazing feature'`)
+4. Pushe den Branch (`git push origin feature/amazing-feature`)
+5. Öffne einen Pull Request
+
+## Entwicklungsrichtlinien
+
+### Codequalität
+
+- Halte dich an den bestehenden Codestil
+- Kommentiere komplexen Code
+- Schreibe Tests für neue Funktionen
+
+### Commit-Nachrichten
+
+Bitte folge diesen Richtlinien für Commit-Nachrichten:
+
+- Verwende den Imperativ ("Add feature" statt "Added feature")
+- Erste Zeile als kurze Zusammenfassung (max. 72 Zeichen)
+- Füge bei Bedarf detaillierte Beschreibungen nach einer Leerzeile hinzu
+
+Beispiel:
+```
+Add support for TypeScript config files
+
+- Parse tsconfig.json for aliases
+- Add tests for TypeScript configuration
+- Update documentation
+```
+
+### Tests
+
+- Füge Tests für neue Funktionen hinzu
+- Stelle sicher, dass alle Tests bestehen
+
+## Lizenz
+
+Mit deinen Beiträgen stimmst du zu, dass sie unter der gleichen Lizenz wie das Projekt (MIT) veröffentlicht werden.

README.md

@@ -1,5 +1,9 @@
 # find-unused.mjs: Analyse und Erkennung ungenutzter Dateien in Vue.js-Projekten
 
+[![npm version](https://img.shields.io/npm/v/vue-find-unused.svg)](https://www.npmjs.com/package/vue-find-unused)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js CI](https://github.com/DEVmatrose/vue-find-unused/actions/workflows/node.js.yml/badge.svg)](https://github.com/DEVmatrose/vue-find-unused/actions/workflows/node.js.yml)
+
 ## Übersicht
 
 Das Skript `find-unused.mjs` ist ein spezialisiertes Analyse-Tool zur statischen Codeanalyse, das ungenutzte Dateien in Vue.js-Projekten identifiziert. Es führt eine umfassende Untersuchung der Importabhängigkeiten und Komponentenreferenzen durch, um nicht verwendete Code-Artefakte zu erkennen.
@@ -147,10 +151,49 @@ const GLOBAL_COMPONENTS = ['Button', 'Card'];
 - Vue.js-Projekt mit standardisierter Verzeichnisstruktur
 - Ausführung aus dem Projektstamm (neben dem `src/`-Verzeichnis)
 
+### Installation
+
+#### Lokale Installation im Projekt
+
+```bash
+npm install --save-dev vue-find-unused
+```
+
+Dann kannst du das Tool in deinen npm-Scripts verwenden:
+
+```json
+"scripts": {
+  "find-unused": "vue-find-unused"
+}
+```
+
+#### Globale Installation
+
+```bash
+npm install -g vue-find-unused
+```
+
+Nach der globalen Installation kannst du das Tool direkt von der Kommandozeile aufrufen:
+
+```bash
+vue-find-unused
+```
+
 ### Ausführung
 
+Wenn lokal installiert:
 ```bash
-node find-unused.mjs
+npx vue-find-unused
+```
+
+Oder direkt mit Node.js:
+```bash
+node node_modules/vue-find-unused/find-unused.mjs
+```
+
+Bei globaler Installation einfach:
+```bash
+vue-find-unused
 ```
 
 ### Ausgabebeispiel
@@ -173,6 +216,9 @@ Ungenutzte Dateien: 22
 Einstiegspunkte: 3
 ```
 
+![Beispiel-Ausgabe](https://raw.githubusercontent.com/DEVmatrose/vue-find-unused/main/docs/images/screenshot.png)
+*Beispielhafte Darstellung der Konsolenausgabe*
+
 ## Wissenschaftliche Genauigkeit und Einschränkungen
 
 ### Precision und Recall
@@ -202,10 +248,60 @@ Das Skript wurde optimiert, um eine hohe Precision zu erreichen, kann jedoch dur
 - **Continuous Integration**: Automatische Überprüfung als Teil des CI/CD-Prozesses
 - **Erweiterte Heuristiken**: Verbesserte Komponenten-Erkennung und Pfadauflösung
 
+## CLI-Verwendung
+
+Das Tool ist als Befehlszeilen-Interface (CLI) verfügbar und kann mit verschiedenen Optionen verwendet werden.
+
+```bash
+Usage: vue-find-unused [options]
+
+Options:
+  -d, --dir <directory>    Das Quellverzeichnis (Standard: src/)
+  -e, --ext <extensions>   Dateiendungen (Komma-getrennt, Standard: vue,js,ts,mjs)
+  -v, --verbose            Ausführliche Ausgabe aktivieren
+  -o, --output <file>      Ausgabe in eine Datei schreiben
+  -h, --help               Zeigt diese Hilfe an
+```
+
+### Beispiele
+
+```bash
+# Standard-Analyse im aktuellen Verzeichnis
+vue-find-unused
+
+# Analyse eines spezifischen Verzeichnisses
+vue-find-unused --dir lib/components
+
+# Nur bestimmte Dateiendungen analysieren
+vue-find-unused --ext vue,ts
+
+# Ausführliche Ausgabe in eine Datei schreiben
+vue-find-unused --verbose --output unused-report.txt
+```
+
+Diese CLI-Optionen sind noch nicht implementiert, zeigen aber die geplante Erweiterung des Tools.
+
 ## Schlussbemerkung
 
 `find-unused.mjs` bietet einen wissenschaftlich fundierten Ansatz zur Optimierung von Vue.js-Projekten durch statische Codeanalyse. Es ermöglicht Entwicklungsteams, die Codebasis effizient zu bereinigen und technische Schulden abzubauen.
 
+
+## Automatisierte Tests
+
+Dieses Repository verwendet GitHub Actions für kontinuierliche Integration:
+
+- Lint-Prüfung des Codes
+- Automatische Tests bei jedem Push und Pull Request
+- Automatisierte Veröffentlichung zu npm bei neuen Releases
+
+Die Workflow-Konfiguration findest du in `.github/workflows/node.js.yml`.
+
+## Danksagungen
+
+- Dank an alle Mitwirkenden L;L)M's, die dieses Projekt verbessert haben 
+- Besonderer Dank an die Vue.js-Community für ihr Feedback
+- Inspiration durch ähnliche Tools wie [unused-webpack-plugin](https://github.com/MatthieuLemoine/unused-webpack-plugin)
+
 ## Lizenz
 
 MIT

package.json

@@ -1,3 +1,4 @@
+
 {
   "name": "vue-find-unused",
   "version": "1.0.0",
@@ -8,25 +9,28 @@
     "vue-find-unused": "./find-unused.mjs"
   },
   "scripts": {
-    "start": "node find-unused.mjs"
+    "start": "node find-unused.mjs",
+    "test": "echo \"No tests specified yet\" && exit 0"
   },
   "keywords": [
     "vue",
     "static-analysis",
     "dead-code",
-    "code-quality"
+    "code-quality",
+    "unused-files",
+    "vue-components"
   ],
-  "author": "Dein Name",
+  "author": "DEVmatrose",
   "license": "MIT",
   "engines": {
     "node": ">=14.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dein-username/vue-find-unused.git"
+    "url": "git+https://github.com/DEVmatrose/vue-find-unused.git"
   },
   "bugs": {
-    "url": "https://github.com/dein-username/vue-find-unused/issues"
+    "url": "https://github.com/DEVmatrose/vue-find-unused/issues"
   },
-  "homepage": "https://github.com/dein-username/vue-find-unused#readme"
+  "homepage": "https://github.com/DEVmatrose/vue-find-unused#readme"
 }