Doc Suggestion

Question

Doc Suggestion

codefriar opened this issue a year ago · comments

Kevin Poorman commented a year ago

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

please enumerate the engines that are currently supported
please show how to run multiple engines.

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

Mitch Spano · Answer 1 · Tue May 30 2023 13:18:13 GMT+0800 (China Standard Time)

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.

Kevin Poorman · Answer 2 · Tue May 30 2023 13:19:33 GMT+0800 (China Standard Time)

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: ***@***.***>

Marco Pinder · Answer 3 · Fri Oct 06 2023 16:36:00 GMT+0800 (China Standard Time)

@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.