Page MenuHomePhabricator

Minus-X documentation does not state directories ignored by default
Closed, ResolvedPublic

Description

The Minus-X documentation helpfully states: If you need to whitelist a specific file or directory, create a .minus-x.json in the repository root., but neglects to mention that it always ignores the directories .git, vendor', and node_modules. As seen in the source code.

The documentation should be amended that these directories are automatically ignored.

Adding

The directories `.git`, `vendor`, and `node_modules` are always ignored.

after the example should be sufficient.

Event Timeline

Change 511685 had a related patch set uploaded (by Mainframe98; owner: Mainframe98):
[mediawiki/tools/minus-x@master] Mention always ignored directories in the readme

https://gerrit.wikimedia.org/r/511685

Mainframe98 triaged this task as Lowest priority.

Change 511685 merged by jenkins-bot:
[mediawiki/tools/minus-x@master] Mention always ignored directories in the readme

https://gerrit.wikimedia.org/r/511685

Mainframe98 closed this task as Resolved.May 21 2019, 6:17 PM

Note that there is a slight behavior difference. Default ignored directories can occur anywhere in the path (e.g. repo/foo/bar/.git/baz will be ignored) but configured ignored directories are relative to the repo root, so if "ignore" is ignored, then "repo/ignore/foo" will be ignored, but not "repo/foo/ignore/bar".