Skip to content
BranchesTags

Repository files navigation

Files Spell Checker

A Node.js application to scan file names, directory paths, and file contents for spelling mistakes and generate comprehensive reports. Built to help developers maintain consistent and error-free naming conventions in their projects.

Built in February 2020. Updated in 2024. Thanks to cspell-dicts for the dictionaries.

Features

  • 📁 Dual Mode Scanning
    • NAME mode: Scan file and directory names for misspellings
    • CONTENT mode: Scan file contents for misspellings
  • 📚 Dictionary Support: Automatic download and integration of multiple dictionaries
  • 🎯 Flexible Configuration: Extensive settings for paths, file types, and ignore patterns
  • 📊 Real-time Progress: Console status updates with detailed statistics
  • 📝 Comprehensive Logging: Detailed TXT reports with suggestions for corrections
  • ⚡ Performance Controls: Configurable delays and limits for large projects
  • 🚫 Smart Filtering: Ignore specific words, paths, and file types
  • ✅ Interactive Confirmation: Review settings before starting scan

Core Capabilities

  • Dual-Mode Scanning: Supports both file/directory name scanning and file content scanning.
  • Automated Dictionary Management: Automatically downloads and initializes multi-language dictionaries.
  • Smart Filtering System: Exclude specific paths, file extensions, and common technical terms.
  • Interactive Validation: Pre-scan configuration review to ensure accuracy before processing.

Technical Excellence

  • Modular Architecture: Separated concerns between scripts, services, and utilities.
  • Robust Error Handling: Centralized error management for network and file system operations.
  • Performance Optimized: Implements configurable delays to prevent system resource exhaustion.
  • Clean Code Standards: Follows consistent naming conventions and functional programming principles.

Developer Experience

  • Extensible Configuration: Easily add new dictionaries or ignore patterns via dedicated config files.
  • Real-time Feedback: Detailed console progress bars and status indicators.
  • Comprehensive Reporting: Generates structured TXT reports with timestamped versioning.
  • Sandbox Environment: Dedicated testing scripts for safe feature verification.

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or pnpm
  • Internet connection (for initial dictionary download)

Installation

  1. Clone the repository:
git clone https://github.com/orassayag/files-spell-checker.git
cd files-spell-checker
  1. Install dependencies:
npm install

  1. Configure settings (see Configuration section)

  2. Run the application:

npm start

Configuration

Edit src/settings/settings.js to configure the application:

Essential Settings

{
  // Choose scanning method: NAME or CONTENT
  METHOD: MethodEnum.NAME,

  // Choose display mode: STANDARD or SILENT
  MODE: ModeEnum.STANDARD,

  // Set the path to scan
  SCAN_PATH: 'C:\\projects\\my-project',

  // Enable/disable result logging
  IS_LOG_RESULTS: true,

  // Maximum items to scan
  MAXIMUM_ITEMS_COUNT: 100000000
}

Additional Configuration Files

  • File Extensions: src/configurations/files/allowFileExtensions.configuration.js
  • Ignore Paths: src/configurations/files/ignorePaths.configuration.js
  • Ignore Words: src/configurations/files/ignoreWords.configuration.js
  • Ignore Files: src/configurations/files/ignoreFiles.configuration.js
  • Dictionaries: src/configurations/files/dictionariesURLs.configuration.js

See INSTRUCTIONS.md for detailed configuration guide.

Usage

Basic Usage

npm start

The application will:

  1. Display important settings
  2. Ask for confirmation
  3. Download dictionaries (first run only)
  4. Scan files/directories
  5. Generate report in dist directory

Console Output Example

===IMPORTANT SETTINGS===
METHOD: NAME
MODE: STANDARD
SCAN_PATH: C:\projects\my-project
========================
OK to run? (y = yes)

===[SETTINGS] Time: 00.00:00:04 | Method: NAME | Ignore Words: 0 | Ignore Paths: 13===
===[GENERAL] Current: 40/250 (16.00%) | Status: SCAN===
===[ITEMS] Total: ✅ 79 | Misspell: ❌ 0 | Skip: 0 | Error: 0===
===[WORDS] Total: 114 | Misspell: 0===

Available Scripts

  • npm start - Run the spell checker
  • npm run backup - Create a backup of the project
  • npm run sand - Run sandbox tests

Development

  • Workflow: The application uses a script-based execution model where scan.script.js orchestrates services.
  • Environment: Built with standard Node.js APIs to ensure cross-platform compatibility.
  • Testing: Includes a sandbox test suite for verifying spell-checking logic in isolation.

Project Structure

graph TD
    A[scan.script.js] --> B[ScanLogic]
    B --> C[Confirm Settings]
    B --> D[Validate Settings]
    B --> E[Initiate Services]
    B --> F[Start Scanning]

    E --> G[nSpellService]
    E --> H[ScanService]
    E --> I[LogService]
    E --> J[PathService]

    F --> K[ItemService]
    F --> L[SpellCheckService]

    G --> M[Download Dictionaries]
    G --> N[Load nspell]

    H --> O[Scan Files/Dirs]
    O --> K
    K --> L
    L --> I

    style A fill:#e1f5ff
    style B fill:#fff3e0
    style G fill:#f3e5f5
    style H fill:#e8f5e9
    style I fill:#fff9c4
Loading

Directory Structure

src/
├── configurations/     # Dictionary URLs and ignore patterns
├── core/               # Enums and core data models
├── scripts/            # Main execution logic (scan, backup, initiate)
├── services/           # Business logic (spell-checking, logging, scanning)
├── settings/           # Global application settings
├── tests/              # Sandbox and integration tests
└── utils/              # Helper functions for file, path, and text operations

Architecture

graph LR
    A[Settings] --> B[Scripts]
    B --> C[Logics]
    C --> D[Services]
    D --> E[Utils]
    D --> F[Models]
    D --> G[Enums]

    H[Configurations] --> D

    style A fill:#e3f2fd
    style B fill:#f3e5f5
    style C fill:#fff3e0
    style D fill:#e8f5e9
    style E fill:#fce4ec
    style F fill:#fff9c4
    style G fill:#f1f8e9
    style H fill:#fce4ec
Loading

Architecture Principles

  1. Separation of Concerns: Business logic is isolated in services, while orchestration lives in scripts.
  2. Configuration-Driven: Application behavior is controlled by centralized settings and configuration files.
  3. Stateless Utilities: Utility functions are pure and independent of application state.
  4. Single Responsibility: Each service handles a specific domain (e.g., nspell, logging, file system).

Design Patterns

  • Service Pattern: Encapsulates logic for specific features like spell checking or log management.
  • Singleton-like Services: Services are initialized once per execution run.
  • Utility Pattern: Shared helper functions for cross-cutting concerns.
  • Enum Pattern: Centralized constants for method and mode selections.

Output Files

Results are saved to timestamped directories:

dist/
  └── 1_20240305_143022/
      └── scan_results.txt

Log files include:

  • Files/directories with misspellings
  • Suggested corrections
  • Full path information
  • Summary statistics

Best Practices

  • Path Handling: Always use absolute paths or properly escaped relative paths in settings.
  • Dictionary Updates: Periodically check dictionary URLs for availability.
  • Ignore Lists: Keep ignore lists focused to avoid skipping valid misspellings.
  • Memory Management: Use the delay settings when scanning large-scale projects.

Built With

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Author

License

This application has an MIT license - see the LICENSE file for details.

Acknowledgments

  • Built for educational and research purposes
  • Respects robots.txt and implements rate limiting
  • Uses user-agent rotation to avoid detection
  • Implements polite crawling practices

About

A Node.js application that scans file names, directory paths, and file contents for spelling mistakes and generates detailed reports. Built in February 2020 and updated in 2024, it helps maintain consistent naming conventions and code quality, leveraging cspell dictionaries to improve accuracy and support reliable validation across projects.

linkedin.com/in/orassayag

Topics

code-qualitydictionarydirectory-scannerfile-scannerfile-validationlintermisspellingnaming-conventionsnspellproject-scannerspell-checkspell-checkerspell-checkingspellcheckspelling

Resources

Readme
MIT license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Packages

Used by

Contributors

Languages