b3nj5m1n/xdg-ninja
Xdg Ninja
xdg-ninja is a home directory sanitizer and XDG base directory auditor designed to identify files that violate XDG directory specifications. It functions as a Linux configuration migrator that scans home directories for misplaced application data and generates JSON-based relocation rules to organize dotfiles into standard locations.
The project utilizes a JSON-based configuration manager to define program-specific file rules. This system allows for the creation of custom file tracking and relocation rules, specifying exactly which files a program stores and the instructions required to move them to compliant directories.
The tool provides capabilities for XDG compliance scanning and automated file remediation. It offers migration guidance by generating step-by-step instructions to move non-compliant directories, supporting a broader workflow for Linux home directory cleanup and application configuration migration.
Features
- XDG Standard Management - Provides tools for creating and editing rules that define how files are handled to ensure XDG compliance.
- Data Directory Relocation - Relocates application data files from non-standard paths to compliant system directories.
- Application Data Tracking - Allows the definition of custom rules to track which files specific programs store in the home directory.
- File Discovery Rules - Scans the home directory using predefined rules to discover files that violate XDG specifications.
- Configuration Migration - Provides automation for transforming and relocating configuration files to standard XDG locations.
- XDG Specification Compliance - Finds and moves configuration files that violate the XDG Base Directory Specification.
- Filesystem Migrations - Implements a declarative system to map the current filesystem state to a desired XDG-compliant state.
- Application Configuration Relocations - Provides a system for specifying exact instructions to relocate application data to new, standard locations.
- Home Directory Sanitization - Identifies misplaced application data in the user home directory to organize it into standard locations.
- Home Directory Sanitizers - Acts as a scanner that detects misplaced application data and generates relocation rules.
- JSON Relocation Rules - Uses structured JSON files to define the mapping of program-specific data to standard XDG locations.
- XDG Compliance Scanning - Implements a scanning capability that identifies files and folders in the home directory violating XDG standard directory specifications.
- XDG Directory Auditors - Scans home directories specifically to identify files that violate XDG Base Directory specifications.
- Automated File Organizers - Automatically moves non-compliant files and folders to correct standard locations based on generated instructions.
- Configuration File Generators - Provides a command-line interface to generate necessary JSON setup files for various software programs.
- Dotfile Managers - Scans for hidden configuration files and provides a workflow to organize dotfiles into standard structures.
- File Pattern Matching - Employs file pattern matching to identify misplaced configuration files across the home directory.
- Automated Config Generation - Provides a tool to automatically generate JSON configuration files required for filesystem scanning and migration.
- JSON Configuration Mapping - Uses JSON mappings to associate program-specific file patterns with their intended target directories.
- Stateless Architectures - Implements a stateless scanning engine that analyzes the filesystem without making changes until explicitly commanded.
- Configuration Migration Guidance - Provides specific, step-by-step instructions for moving non-compliant configuration directories to their correct standard locations.
- Dotfile Managers - Checks for unwanted files in the home directory.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
