Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accept and encourage "minus-prefix" for unset gitattributes as per gitattributes documentation #4780

Merged
merged 5 commits into from
Jan 23, 2020
Merged

Accept and encourage "minus-prefix" for unset gitattributes as per gitattributes documentation #4780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dfd0cd6
Add the ability to handle minus gitattributes for negation
lildude Jan 23, 2020
1102f3e
Unless else is eeew
lildude Jan 23, 2020
f10e307
Add tests for -linguist-whatever gitattributes
lildude Jan 23, 2020
cdc74a4
Recommend using set/unset gitattributes (vs. true/false strings)
cespare Aug 25, 2019
50837ab
Update comment
lildude Jan 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Use the `linguist-vendored` attribute to vendor or un-vendor paths:

```gitattributes
special-vendored-path/* linguist-vendored
jquery.js linguist-vendored=false
jquery.js -linguist-vendored
```

#### Documentation
Expand All @@ -205,7 +205,7 @@ Use the `linguist-documentation` attribute to mark or unmark paths as documentat

```gitattributes
project-docs/* linguist-documentation
docs/formatter.rb linguist-documentation=false
docs/formatter.rb -linguist-documentation
```

#### Generated code
Expand All @@ -218,7 +218,7 @@ As an added bonus, unlike vendored and documentation files, these files are supp
Use the `linguist-generated` attribute to mark or unmark paths as generated.

```gitattributes
Api.elm linguist-generated=true
Api.elm linguist-generated
```

#### Detectable
Expand All @@ -229,9 +229,9 @@ Languages of a different type (as defined in [`languages.yml`](/lib/linguist/lan
Use the `linguist-detectable` attribute to mark or unmark paths as detectable:

```gitattributes
*.kicad_pcb linguist-detectable=true
*.sch linguist-detectable=true
tools/export_bom.py linguist-detectable=false
*.kicad_pcb linguist-detectable
*.sch linguist-detectable
tools/export_bom.py -linguist-detectable
```

### Using Emacs or Vim modelines
Expand Down
20 changes: 10 additions & 10 deletions lib/linguist/lazy_blob.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,24 @@ def git_attributes
end

def documentation?
if attr = git_attributes['linguist-documentation']
boolean_attribute(attr)
if not git_attributes['linguist-documentation'].nil?
boolean_attribute(git_attributes['linguist-documentation'])
else
super
end
end

def generated?
if attr = git_attributes['linguist-generated']
boolean_attribute(attr)
if not git_attributes['linguist-generated'].nil?
boolean_attribute(git_attributes['linguist-generated'])
else
super
end
end

def vendored?
if attr = git_attributes['linguist-vendored']
return boolean_attribute(attr)
if not git_attributes['linguist-vendored'].nil?
boolean_attribute(git_attributes['linguist-vendored'])
else
super
end
Expand All @@ -72,8 +72,8 @@ def language
end

def detectable?
if attr = git_attributes['linguist-detectable']
return boolean_attribute(attr)
if not git_attributes['linguist-detectable'].nil?
boolean_attribute(git_attributes['linguist-detectable'])
else
nil
end
Expand All @@ -100,9 +100,9 @@ def cleanup!

protected

# Returns true if the attribute is present and not the string "false".
# Returns true if the attribute is present and not the string "false" and not the false boolean.
def boolean_attribute(attribute)
attribute != "false"
attribute != "false" && attribute != false
end

def load_blob!
Expand Down
31 changes: 25 additions & 6 deletions test/test_repository.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ def test_repo_git_attributes
# test/*.rb linguist-language=Java
# Rakefile linguist-generated
# test/fixtures/* linguist-vendored=false
# README.md linguist-documentation=false
# samples/Arduino/* linguist-documentation
# samples/Markdown/*.md linguist-detectable=true
# samples/HTML/*.html linguist-detectable=false
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The four lines above have been added to the .gitattributes in the test branch but this side hasn't been update to reflect this, so I'm adding them as part of this PR.

# samples/CSS/bootstrap.css -linguist-vendored
# samples/CSS/bootstrap.min.css -linguist-generated
# LICENSE -linguist-documentation
# samples/CoffeeScript/browser.coffee -linguist-detectable

attr_commit = 'c20ebee0ebf33f73313d4694680521f80635d477'
repo = linguist_repo(attr_commit)
Expand Down Expand Up @@ -96,47 +104,58 @@ def test_linguist_override_vendored?
end

def test_linguist_override_unvendored?
attr_commit = 'c20ebee0ebf33f73313d4694680521f80635d477'
attr_commit = '933c687cb8c02035394979b2308e5120a9904fdf'
linguist_repo(attr_commit).read_index

# lib/linguist/vendor.yml defines this as vendored.
override_unvendored = Linguist::LazyBlob.new(rugged_repository, attr_commit, 'test/fixtures/foo.rb')
# test -linguist-vendored attribute method
override_unvendored_minus = Linguist::LazyBlob.new(rugged_repository, attr_commit, 'samples/CSS/bootstrap.css')

# overridden .gitattributes
assert !override_unvendored.vendored?
refute override_unvendored.vendored?
refute override_unvendored_minus.vendored?
end

def test_linguist_override_documentation?
attr_commit = "d4c8fb8a28e91f97a7e53428a365c0abbac36d3d"
attr_commit = "933c687cb8c02035394979b2308e5120a9904fdf"
linguist_repo(attr_commit).read_index

readme = Linguist::LazyBlob.new(rugged_repository, attr_commit, "README.md")
arduino = Linguist::LazyBlob.new(rugged_repository, attr_commit, "samples/Arduino/hello.ino")
# test -linguist-documentation attribute method
minus = Linguist::LazyBlob.new(rugged_repository, attr_commit, "LICENSE")

# overridden by .gitattributes
refute_predicate readme, :documentation?
assert_predicate arduino, :documentation?
refute_predicate minus, :documentation?
end

def test_linguist_override_generated?
attr_commit = "c20ebee0ebf33f73313d4694680521f80635d477"
attr_commit = "933c687cb8c02035394979b2308e5120a9904fdf"
linguist_repo(attr_commit).read_index

rakefile = Linguist::LazyBlob.new(rugged_repository, attr_commit, "Rakefile")

# test -linguist-generated attribute method
minus = Linguist::LazyBlob.new(rugged_repository, attr_commit, "samples/CSS/bootstrap.min.css")
# overridden .gitattributes
assert rakefile.generated?
refute minus.generated?
end

def test_linguist_override_detectable?
attr_commit = "8f86998866f6f2c8aa14e0dd430e61fd25cff720"
attr_commit = "933c687cb8c02035394979b2308e5120a9904fdf"
linguist_repo(attr_commit).read_index

# markdown is overridden by .gitattributes to be detectable, html to not be detectable
markdown = Linguist::LazyBlob.new(rugged_repository, attr_commit, "samples/Markdown/tender.md")
html = Linguist::LazyBlob.new(rugged_repository, attr_commit, "samples/HTML/pages.html")
# test -linguist-detectable attribute method
minus = Linguist::LazyBlob.new(rugged_repository, attr_commit, "samples/CoffeeScript/browser.coffee")

assert_predicate markdown, :detectable?
refute_predicate html, :detectable?
refute_predicate minus, :detectable?
end
end