rust-lang / rust-lang/rust-clippy

Warn on use of Windows DOS devices in paths

Open
#8,511 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-lint
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

What it does

If the user uses a bare dos device name such as aux, windows will convert it to \\.\aux (the aux device). This may be surprising. Clippy could warn the user and suggest they explicitly use \\.\aux if that was intended. Using .\aux could also suppress this lint.

The DOS device names are (case insensitive):

  • AUX
  • CON
  • CONIN$
  • CONOUT$
  • COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, COM², COM³, COM¹
  • LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9, LPT², LPT³, LPT¹
  • NUL
  • PRN
Lint Name

bare_dos_device_name

Category

suspicious

Advantage

Avoids unexpected and surprising path transformations.

Drawbacks

This is platform specific behaviour.

Example
File::open("aux");

Could be written as:

File::open(r"\\.\aux");

Or

File::open("./aux");

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no implementation files or tests; start by locating existing Clippy lints that inspect path arguments and their Windows-specific tests. Completion means recognizing the listed case-insensitive DOS device names, offering the stated explicit-device or prefixed-path alternatives, and covering the Rust examples in tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.