Fix: Exclude not working with absolute path in some cases (#593) #618
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dqkqd
force-pushed
the
issue-593
branch
4 times, most recently
from
5a5a878 to
4293812
Compare
ccuser44
approved these changes
Oct 29, 2024
chriscerie
reviewed
Nov 16, 2024
There was a problem hiding this comment.
Thanks! Need changelogs for:
- the fix
- changing undocumented behavior that exclude paths are now relative to the config file instead of where selene is invoked
We should also properly document that in https://kampfkarren.github.io/selene/usage/configuration.html#excluding-files-from-being-linted
| Path::new(&config_file).parent().map(Path::to_path_buf), | ||
| ), | ||
| Ok(config) => { | ||
| // Get config directory to using absolute path. |
There was a problem hiding this comment.
Suggested change
| // Get config directory to using absolute path. |
Comment on lines
+528
to
+529
| // There is case where `config = Some("selene.toml")`, | ||
| // which returns `""`` when getting parent directory. |
| let config_directory = Path::new(&config_file) | ||
| .canonicalize() | ||
| .ok() | ||
| .and_then(|path| path.parent().map(|path| path.to_path_buf())); |
There was a problem hiding this comment.
Suggested change
| .and_then(|path| path.parent().map(|path| path.to_path_buf())); | |
| .and_then(|path| path.parent().map(Path::to_path_buf)); | |
| @@ -512,6 +512,7 @@ fn start(mut options: opts::Options) { | |||
|
|
|||
| let (config, config_directory): (CheckerConfig<toml::value::Value>, Option<PathBuf>) = | |||
| match options.config { | |||
| // User provides a config file. We must read it and report if it is misconfigured. | |||
There was a problem hiding this comment.
Suggested change
| // User provides a config file. We must read it and report if it is misconfigured. |
Comment on lines
+646
to
+647
| // Directory for matching files pattern. | ||
| // If user provides a config file, we use that as our working directory, otherwise fallback to the current directory. |
There was a problem hiding this comment.
Suggested change
| // Directory for matching files pattern. | |
| // If user provides a config file, we use that as our working directory, otherwise fallback to the current directory. |
| @@ -636,6 +643,26 @@ fn start(mut options: opts::Options) { | |||
|
|
|||
| let pool = ThreadPool::new(options.num_threads); | |||
|
|
|||
| // Directory for matching files pattern. | |||
| // If user provides a config file, we use that as our working directory, otherwise fallback to the current directory. | |||
| // The working directory needs to be an absolute path to match with paths in different directories. | |||
There was a problem hiding this comment.
This doesn't explain why relative path won't work. Can we either clarify that?
| return false; | ||
| } | ||
|
|
||
| // File pattern between the path we are checking and current working directory. |
There was a problem hiding this comment.
Suggested change
| // File pattern between the path we are checking and current working directory. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #593
Exclude files if they match exclude patterns using working directory (config directory if a config file is provided, otherwise it is the current directory) as a base.
I'm not sure whether I should add testcases for this, since this requires refactor into smaller functions.