fix: correctly document behavior of --strict-out-of-sync and avoid string typed booleans

[mrackwitz]

• Ready for review
• Follows CONTRIBUTING rules
• Reviewed by Snyk internal team

What does this PR do?

Changes the help text to document the default behavior of the --strict-out-of-sync flag and change the options type signature to eliminate the previously present string typed boolean option values "true" | "false".

How should this be manually tested?

The current default behavior was manually verified by @darscan and me, by running snyk test on a project with a lockfile (npm and yarn). Also I verified that the behavior is still the same.

Any background context you want to provide?

This will make it easier to get the CocoaPods plugin working. This failed because it had a stricter options definition, not including string typed booleans:

src/lib/plugins/index.ts:59:7 - error TS2322: Type 'typeof import("/Users/shaun/dev/work/snyk/repos/snyk/node_modules/@snyk/snyk-cocoapods-plugin/dist/index")' is not assignable to type 'Plugin'.
  Types of property 'inspect' are incompatible.
    Type '(root: string, targetFile?: string | undefined, options?: CocoaPodsInspectOptions | undefined) => Promise<SinglePackageResult>' is not assignable to type '(root: string, targetFile: string, options?: Options | undefined) => Promise<InspectResult>'.
      Types of parameters 'options' and 'options' are incompatible.
        Type 'Options | undefined' is not assignable to type 'CocoaPodsInspectOptions | undefined'.
          Type 'Options' is not assignable to type 'CocoaPodsInspectOptions'.
            Types of property 'strictOutOfSync' are incompatible.
              Type 'boolean | "true" | "false" | undefined' is not assignable to type 'boolean | undefined'.
                Type '"true"' is not assignable to type 'boolean | undefined'.

59       return cocoapodsPlugin;

[CLAassistant]

All committers have signed the CLA.

[snyksec]

🎉 This PR is included in version 1.228.6 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀