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

Restrict Vim modeline parsing to a single line #4138

Merged
merged 3 commits into from
May 27, 2018
Merged

Restrict Vim modeline parsing to a single line #4138

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d4eaf5
Restrict Vim modeline parsing to a single line
jatoben May 24, 2018
eda3e02
Use [ \t] instead of [[:blank:]]
jatoben May 25, 2018
5fed5cd
Fix comment indents
jatoben May 25, 2018
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
18 changes: 9 additions & 9 deletions lib/linguist/strategy/modeline.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class Modeline

# Start modeline. Could be `vim:`, `vi:` or `ex:`
(?:
(?:\s|^)
(?:[[:blank:]]|^)
vi
(?:m[<=>]?\d+|m)? # Version-specific modeline
|
Expand All @@ -49,20 +49,20 @@ class Modeline
# serves as a terminator for an option sequence, delimited by whitespace.
(?=
# So we have to ensure the modeline ends with a colon
: (?=\s* set? \s [^\n:]+ :) |
: (?=[[:blank:]]* set? [[:blank:]] [^\n:]+ :) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd recommend the use of [ \t] instead, as it's arguably clearer than a POSIX character class.


# Otherwise, it isn't valid syntax and should be ignored
: (?!\s* set? \s)
: (?![[:blank:]]* set? [[:blank:]])
)

# Possible (unrelated) `option=value` pairs to skip past
(?:
# Option separator. Vim uses whitespace or colons to separate options (except if
# the alternate "vim: set " form is used, where only whitespace is used)
(?:
\s
[[:blank:]]
|
\s* : \s* # Note that whitespace around colons is accepted too:
[[:blank:]]* : [[:blank:]]* # Note that whitespace around colons is accepted too:
) # vim: noai : ft=ruby:noexpandtab
Copy link
Collaborator

Choose a reason for hiding this comment

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

You should indent this line so the comment matches the line above it.


# Option's name. All recognised Vim options have an alphanumeric form.
Expand All @@ -71,25 +71,25 @@ class Modeline
# Possible value. Not every option takes an argument.
(?:
# Whitespace between name and value is allowed: `vim: ft =ruby`
\s*=
[[:blank:]]*=

# Option's value. Might be blank; `vim: ft= ` says "use no filetype".
(?:
[^\\\s] # Beware of escaped characters: titlestring=\ ft=ruby
[^\\[[:blank:]]] # Beware of escaped characters: titlestring=\ ft=ruby
| # will be read by Vim as { titlestring: " ft=ruby" }.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Indent needed here too.

\\.
)*
)?
)*

# The actual filetype declaration
[\s:] (?:filetype|ft|syntax) \s*=
[[[:blank:]]:] (?:filetype|ft|syntax) [[:blank:]]*=

# Language's name
(\w+)

# Ensure it's followed by a legal separator
(?=\s|:|$)
(?=[[:blank:]]|:|$)
/xi

MODELINES = [EMACS_MODELINE, VIM_MODELINE]
Expand Down