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.

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

136 add regex filter #140

Merged
merged 11 commits into from
Nov 26, 2020
Merged

136 add regex filter #140

merged 11 commits into from
Nov 26, 2020

Conversation

epi052
Copy link
Owner

@epi052 epi052 commented Nov 25, 2020

closes #136

Branching checklist

Static analysis checks

  • All rust files are formatted using cargo fmt
  • All clippy checks pass when running cargo clippy --all-targets --all-features -- -D warnings -A clippy::deref_addrof
  • All existing tests pass

Documentation

  • New code is documented using doc comments
  • Documentation about your PR is included in the README, as needed

Additional Tests

  • New code is unit tested
  • New code is integration tested, as needed
  • New tests pass

@epi052
Copy link
Owner Author

epi052 commented Nov 25, 2020

  • config.rs
    • add new value to Configuration struct
    • update Configuration::default with new value
    • update Configuration docstring with the new value/default (if appropriate)
    • update Configuration::new so that the new value is stored in config
    • update Configuration::merge_config with new value
    • update Configuration::tests::setup_config_test with new value
    • add unit test to check config parsing
  • ferox-config.toml.example
    • add new value to example config
  • banner.rs
    • add new check for the value in banner::initialize
    • create new entry to be written in the banner for the new value
      • add new emoji to the entry (should be somewhat related to the value name)
    • add new integration test (tests/test_banner) or update existing so that it's displayed under test
  • Cargo.toml
    • bump version: add 1 to minor release and set patch release to 0
  • README.md
    • update default config section (if needed)
    • update example config file section
    • update help output section
    • add an example with a heading that conforms to others (new in v1.4.0...)
      • add an entry for the example in the table of contents
  • parser.rs
    • add the option to the parser
  • wherever.rs
    • implement the new feature

@codecov
Copy link

codecov bot commented Nov 26, 2020

Codecov Report

Merging #140 (31891b5) into master (4c39944) will increase coverage by 0.31%.
The diff coverage is 94.89%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #140      +/-   ##
==========================================
+ Coverage   93.71%   94.02%   +0.31%     
==========================================
  Files          13       13              
  Lines        2179     2260      +81     
==========================================
+ Hits         2042     2125      +83     
+ Misses        137      135       -2     
Impacted Files Coverage Δ
src/scanner.rs 91.91% <92.59%> (-0.15%) ⬇️
src/filters.rs 98.19% <94.44%> (+3.54%) ⬆️
src/banner.rs 100.00% <100.00%> (+0.29%) ⬆️
src/config.rs 96.48% <100.00%> (+0.07%) ⬆️
src/main.rs 90.25% <100.00%> (-0.43%) ⬇️
src/parser.rs 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4c39944...605661e. Read the comment docs.

@epi052 epi052 merged commit 2128b9e into master Nov 26, 2020
@epi052 epi052 deleted the 136-add-regex-filter branch November 26, 2020 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant