VSLint 1.1.0
This package was created before dotnet tools existed and is no longer maintained, use dotnet-vslint instead.
dotnet add package VSLint --version 1.1.0
NuGet\Install-Package VSLint -Version 1.1.0
<PackageReference Include="VSLint" Version="1.1.0" />
paket add VSLint --version 1.1.0
#r "nuget: VSLint, 1.1.0"
// Install VSLint as a Cake Addin
#addin nuget:?package=VSLint&version=1.1.0
// Install VSLint as a Cake Tool
#tool nuget:?package=VSLint&version=1.1.0
VSLint
VSLint is a command line tool used for detecting issues in Visual Studio project files.
Features
VSLint scans for the following issues.
| Classic project format | Modern project format | |
|---|---|---|
| Duplicate file references | Yes | Yes |
| Missing files | Yes | Yes |
| Files on disk not included in project | Yes | No |
It will also try to locate .gitignore and .hgignore files and use them to try to avoid false positives.
Limitations
Due to the complexity VSLint will not parse conditional includes or targets files.
Complex .gitignore GLOBs may not be parsed properly, internally GLOBs are converted to regular expressions with a pretty naive implementation that works in most cases. For example, negated patterns are not honored.
Command line usage
> vslint --help
vslint, a tool for detecting inconsistencies in Visual Studio project files
Usage: vslint [options..] path [path2 path3 ..]
Options:
-h, --help Prints this help message
-m, --machine-readable Print results in an alternate machine readable format
-v, --verbose Lists scanned projects even if no issues are found
-q, --quiet Quiet unless issues are found
> vslint -v
Project .\vslint\vslint.fsproj
no issues
Project .\vslint.Tests\vslint.Tests.fsproj
no issues
Found 0 issues
Use as commit hook
VSLint can be used as a pre commit hook in either git or Mercurial to prevent commits with errors in project files that may, for instance, arise in auto merges.
For use with git, add vslint.exe to your path and create a .git/hooks/pre-commit file with the following contents.
#!/bin/bash
vslint
For use with Mercurial, add vslint.exe to your path and add the following to your .hg/hgrc file.
[hooks]
precommit =
precommit.vslint = vslint
Ignored files and folders
Even if you don't have a .gitignore or .hgignore some files and folders are ignored by default.
Folders
- .git
- .hg
- .svn
- bin
- obj
- packages
Files
- .gitignore
- .hgignore
- .sln
- .csproj
- .fsproj
- .vbproj
- .targets
- .suo
- .user
- .orig
.vslintignore
If you have additional files that should be ignored you may add a file named .vslintignore with one regular expression per line.
Lines starting with # are comments, empty lines are ignored.
Sample
# Ignore powershell files
\.ps(m|1)$
# Ignore ReSharper files
_ReSharper\.*/
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.