File Length Lint

A lightweight VS Code extension that checks the number of lines in your files and reports problems when files exceed a configured maximum line count.

Features

• Configurable maximum line count for files
• Language-specific line count limits (different limits for different file types)
• Ability to disable linting for specific languages
• Reports problems in the VS Code Problems panel
• Status bar indicator showing current file's line count
• On-demand workspace scanning command
• Quick fix suggestions for splitting large files
• Customizable exclude patterns with sensible defaults for binary files and build outputs
• Real-time scanning of files using multi-threading for better performance
• Respects .gitignore files (can be disabled) with real-time updates when files change
• Immediately applies changes to exclusion settings and .gitignore files without requiring a reload
• Minimal performance impact with optimized file processing

How It Works

The extension works in several ways:

1. Active file checking: When you open or save a file, the extension immediately counts the number of lines in the file. If the line count exceeds the configured maximum, a problem is reported in the VS Code Problems panel.

2. Real-time scanning: The extension scans files in your workspace in real-time using multi-threading to find files that exceed the maximum line count. This happens without requiring you to open the files, ensuring all problematic files are identified efficiently.

3. Status bar indicator: The extension shows the current file's line count in the status bar, along with the maximum allowed for that file type. The indicator turns red when the file exceeds the limit.

4. Quick fix suggestions: When a file exceeds the maximum line count, you can use the quick fix feature to get suggestions on how to split the file into smaller, more manageable pieces.

5. Customizable exclude patterns: You can configure which files and directories should be excluded from linting. By default, common binary files, build outputs, and version control directories are excluded.

6. Respects .gitignore files: The extension can respect your .gitignore files, ensuring that files and directories you've excluded from version control are also excluded from linting.

7. Minimal performance impact: The extension is designed to have minimal impact on your VS Code performance. It uses multi-threading to scan files efficiently and only processes files that haven't been scanned recently.

8. Token-based linting: In addition to line count linting, you can also configure the extension to use token counting as an alternative. This is useful for estimating the number of tokens that would be used by an LLM (Large Language Model) when processing your files.

Extension Settings

This extension contributes the following settings:

• fileLengthLint.maxLines: Maximum number of lines allowed in a file before showing a lint error (default: 300)
• fileLengthLint.languageSpecificMaxLines: Language-specific maximum line counts that override the global setting (default: { "javascript": 500, "typescript": 500, "markdown": 1000, "json": 5000, "html": 800 })
• fileLengthLint.disabledLanguages: List of language IDs for which linting should be disabled (default: []). For example: ["markdown", "json", "yaml"]
• fileLengthLint.enabled: Enable or disable file length linting (default: true)
• fileLengthLint.exclude: Glob patterns to exclude from file length linting. Supports patterns like **/*.dll (all .dll files in any directory) or *.dll (any .dll file). By default, excludes common binary files, build outputs, and version control directories.
• fileLengthLint.respectGitignore: Respect .gitignore files when scanning for files to lint (default: true)
• fileLengthLint.realtimeScanningEnabled: Enable real-time scanning of files in the workspace (default: true)
• fileLengthLint.customQuickFixMessage: Custom message to append to the diagnostic and quick fix suggestion (default: ""). For example: "Please consider refactoring this file according to our team guidelines." This message will appear in the Problems panel, in the quick fix suggestion, and in the information message when using the quick fix.
• fileLengthLint.measurementType: Measurement type to use for file length linting. 'lines' counts the number of lines in a file, 'tokens' estimates the number of tokens that would be used by an LLM (using the approximation of 4 characters ≈ 1 token).
• fileLengthLint.maxTokens: Maximum number of tokens allowed in a file before showing a lint error (only used when measurementType is set to 'tokens'). For LLMs, approximately 4 characters ≈ 1 token.
• fileLengthLint.languageSpecificMaxTokens: Language-specific maximum token counts. Overrides the global maxTokens setting for specified languages (only used when measurementType is set to 'tokens'). For LLMs, approximately 4 characters ≈ 1 token.

Why Use This Extension?

Excessively long files can be difficult to navigate, understand, and maintain. By setting a maximum line count for your files, you can encourage better code organization and modularization. This extension helps enforce these best practices by providing immediate feedback when files grow too large.

Contributing

Contributions are welcome! Feel free to submit issues or pull requests on the GitHub repository.

Enjoy!