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

Jump to bottom

[INFRA] adds a helper script to check for missing includes #2376

Merged
merged 1 commit into from
Mar 11, 2021
Merged

[INFRA] adds a helper script to check for missing includes #2376

merged 1 commit into from
Mar 11, 2021

Conversation

SGSSGene
Copy link
Contributor

@SGSSGene SGSSGene commented Feb 14, 2021 •
edited
Loading

PR #2351 has done some renaming of includes. This messed up the include-order. To find
most includes that have to be adjusted, I wrote a little script.
I thought this might be a great addition for the CI.

Usage example:

$ # finds include blocks that are not correct in seqan3
$ ./test/scripts/checkIncludeOrder.pl $(find include -type f)
$
$ # finds include blocks that have been broken since the origin/master
$ ./test/scripts/checkIncludeOrder.pl $(git diff --name-only HEAD origin/mater)

@codecov
Copy link

codecov bot commented Feb 14, 2021 •
edited
Loading

Codecov Report

Merging #2376 (2ed387b) into master (920cdcc) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2376   +/-   ##
=======================================
  Coverage   98.24%   98.24%           
=======================================
  Files         266      266           
  Lines       10926    10928    +2     
=======================================
+ Hits        10734    10736    +2     
  Misses        192      192
Impacted Files Coverage Δ
include/seqan3/alphabet/cigar/cigar.hpp 91.30% <0.00%> (ø)
...n3/search/dream_index/interleaved_bloom_filter.hpp 100.00% <0.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 920cdcc...2ed387b. Read the comment docs.

@eseiler eseiler removed their request for review February 16, 2021 07:46
@vercel
Copy link

vercel bot commented Mar 9, 2021 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/seqan/seqan3/6X8my2G9LVp1mTpVaXEbiXFiDTxA
✅ Preview: https://seqan3-git-fork-sgssgene-misc-includeorderscript-seqan.vercel.app

@SGSSGene
Copy link
Contributor Author

SGSSGene commented Mar 9, 2021

This will now output something like this, files in the wrong location a marked with a *

include/seqan3/alphabet/composite/alphabet_tuple_base.hpp  
*       seqan3/alphabet/concept.hpp                        
        seqan3/alphabet/composite/detail.hpp  
*       seqan3/alphabet/alphabet_base.hpp                  
        seqan3/alphabet/detail/alphabet_proxy.hpp          
        seqan3/core/concept/core_language.hpp              
        seqan3/utility/detail/integer_traits.hpp
        seqan3/utility/tuple/concept.hpp                   
        seqan3/utility/type_list/traits.hpp                
        seqan3/utility/type_pack/traits.hpp                
        seqan3/utility/type_traits/detail/transformation_trait_or.hpp

@marehr
Copy link
Member

marehr commented Mar 9, 2021

Can you rebase? and lower case checkIncludeOrder?

@SGSSGene
Copy link
Contributor Author

SGSSGene commented Mar 9, 2021

Can you rebase? and lower case checkIncludeOrder?

Done :-)

@SGSSGene
Copy link
Contributor Author

SGSSGene commented Mar 9, 2021

Can you rebase? and lower case checkIncludeOrder?

Done :-)

Oh no, I was to quick, let me fix the names in the docs :ups:

@SGSSGene SGSSGene requested review from marehr and eseiler March 11, 2021 11:59
@SGSSGene
[INFRA] adds a helper script to check for missing includes
2ed387b 
Usage example:
$ # will find include blocks that are not correct in seqan3
$ ./test/scripts/check_include_order.pl $(find include -type f)
$
$ # will find include blocks that have been broken since the origin/master
$ ./test/scripts/check_include_order.pl $(git diff --name-only HEAD origin/mater)
@eseiler eseiler merged commit bc5df0c into seqan:master Mar 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marehr marehr marehr approved these changes

@eseiler eseiler eseiler approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@SGSSGene @marehr @eseiler