https://github.com/steamcore/vslint

VSLint is a command line utility used for detecting inconsistencies in Visual Studio project files.
https://github.com/steamcore/vslint

csproj-tooling visual-studio

Last synced: 5 months ago
JSON representation

VSLint is a command line utility used for detecting inconsistencies in Visual Studio project files.

• Host: GitHub
• URL: https://github.com/steamcore/vslint
• Owner: steamcore
• License: mit
• Archived: true
• Created: 2014-03-31T12:28:55.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2022-10-22T14:17:04.000Z (over 3 years ago)
• Last Synced: 2025-10-20T21:51:45.244Z (8 months ago)
• Topics: csproj-tooling, visual-studio
• Language: F#
• Homepage:
• Size: 46.9 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# VSLint

[![NuGet](https://img.shields.io/nuget/v/dotnet-vslint.svg?maxAge=259200&label=dotnet-vslint)](https://www.nuget.org/packages/dotnet-vslint/)

![Build](https://github.com/steamcore/vslint/workflows/Build/badge.svg)

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.

```sh

#!/bin/bash

vslint

```

For use with Mercurial, add vslint.exe to your path and add the following to your `.hg/hgrc` file.

```ini

[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*

```sh

# Ignore powershell files

\.ps(m|1)$

# Ignore ReSharper files

_ReSharper\.*/

```