Support .gitignore

Open
#2,443 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
git
Domain
build-system

Research direction

Start by tracing Spotless's file-selection and configuration entry points, then check how an optional .gitignore setting could apply to untracked files. Done means the configuration can be enabled through the proposed interface and Spotless honors the repository's .gitignore rules without changing default behavior.

Written by the indexing model from the issue text.

Description

enhancement

I'd like to be able to optionally enable .gitignore support where spotless honors the rules set there and automatically ignores files I don't track.

There are workarounds for this but I'd like to have a simple interface like

<enableGitignore />
Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

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.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.