search

mitchspano / sfdx-scan-pull-request

Runs sfdx-scanner on a pull request and generates in-line comments with the findings.
Apache License 2.0
71 stars 24 forks source link

Doc Suggestion #42

Open codefriar opened 1 year ago

codefriar commented 1 year ago

A couple of suggestions for the documentation / readme. In the engine section:

I'd file a PR, but I don't know the actual values for which engines are supported / how to run multiple.

mitchspano commented 1 year ago

The supported engines are enumerated in this file within the scanner's source code.

Here are the current values which can be accepted as engine value for input:

I am a little hesitant to add this to the documentation just in case the owners of the Sfdx Scanner plugin add more values in the future.

codefriar commented 1 year ago

That’s a fair point. How about linking to the scanners file as a way of pointing out where the valid values can be found? On May 29, 2023 at 21:18 -0800, Mitchell spano @.***>, wrote:

The supported engines are enumerated in this file within the scanner's source code. Here are the current values which can be accepted as engine value for input:

• pmd • eslint • eslint-lwc • eslint-typescript • retire-js • cpd • sfge

I am a little hesitant to add this to the documentation just in case the owners of the Sfdx Scanner plugin add more values in the future. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.Message ID: @.***>

marcopinder commented 1 year ago

@mitchspano Can I suggest that you add some additional information to the Readme file that informs the user that the pmdconfig and custom-pmd-rules inputs typically don't get used together as per point 1 in @jfeingold35 's comment here. I feel this is not even clear on the Salesforce Code Analyzer site and I only appreciated the difference after I read the comment.