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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Static analysis #3

Closed
larshp opened this issue May 3, 2019 · 8 comments
Closed

Static analysis #3

larshp opened this issue May 3, 2019 · 8 comments

Comments

@larshp
Copy link
Contributor

larshp commented May 3, 2019

Hi,
First of all, thanks, very nice guide and thanks for sharing 馃憤

Any thoughts on including links/recommendations regarding static analysis tools supporting the guidelines?

Eg.
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#omit-the-optional-keyword-exporting
is implemented by
https://docs.abapopenchecks.org/checks/30/

and some of
https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#omit-the-parameter-name-in-single-parameter-calls
is found by
https://docs.abapopenchecks.org/checks/43/

HrFlorianHoffmann added a commit that referenced this issue May 3, 2019
@HrFlorianHoffmann
Copy link
Contributor

Put some links together in #9 but not sure this is the best format. It sure links the issues to the checks on a precise level, but it feels like there is some more general section missing that details what static code check tools we actually recommend. Some stuff is also covered in rarer Code Inspector checks, plus there are other projects that announced that they want to add static checks for clean code as well.

@larshp
Copy link
Contributor Author

larshp commented May 3, 2019

yeah, agree, need to consider the format, hmm

one approach is to add additional information in an collapsible section, example https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab, but the markdown format for this is not very nice IMHO

@larshp larshp mentioned this issue May 3, 2019
@HrFlorianHoffmann HrFlorianHoffmann added enhancement New feature or request and removed enhancement New feature or request labels May 8, 2019
@HrFlorianHoffmann
Copy link
Contributor

Tried around some more and found it a bit tedious to add detailed links to all sections. Suggest to add a general section "How to Check Automatically" instead, with #32.

@larshp
Copy link
Contributor Author

larshp commented May 8, 2019

yea, cool, looks good to me

@larshp
Copy link
Contributor Author

larshp commented May 8, 2019

perhaps also mention "ATC"? IMHO ATC is basically code inspector, but it depends on who you ask. Plus I guess the general SAP recommendation is to use ATC

@HrFlorianHoffmann
Copy link
Contributor

Added and merged.

@larshp
Copy link
Contributor Author

larshp commented May 8, 2019

#32 merged, closing

@larshp
Copy link
Contributor Author

larshp commented May 16, 2019

links from abapOpenChecks documentation to this styleguide added in larshp/abapOpenChecks@5e5262e

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants