FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...

fixinator-client

Build Status

Command Line Arguments

When running the fixinator command via the command line you can set the following arguments:

path

The folder or file to scan.

confidence

Default: high

Possible values are none, low, medium or high. This setting is used to filter out results that the scanner is not confident about. Setting it to a lower value will show more issues but may have some false positives.

severity

Default: low

Possible values are: low, medium or high. Filter by severity of the issues found.

autofix

Default: off

  • off - does not fix code
  • prompt - prompts at each issue that can be fixed, if you select a fix the file will be updated with the fix code
  • auto - does not prompt, it will fix each issue with the first choice

It is highly recommended that you use autofix only with code that is under version control so you can review the diff.

resultFile

Writes results to a file specified by the path in resultFile.

resultFormat

Specify either json (default), html or pdf.

Environment Variables

The following environment variables are used by fixinator:

FIXINATOR_API_KEY

The FIXINATOR_API_KEY environment variable holds an API key which will be passed to the Fixinator API service via the x-api-key HTTP request header. Please visit https://fixinator.app/ to obtain a key.

FIXINATOR_API_URL

The FIXINATOR_API_URL environment variable points to the URL of the Fixinator API service. If you are running fixinator locally you will want to point this to your local API instance. If you are using the public API then you do not need to set this variable.

.fixinator.json

A .fixinator.json configuration file can be placed in the root of a folder to be scanned. For Example:

{
	"ignorePaths":["some/folder-to-ignore", "some/file-to-ignore.cfm"],
	"ignoreExtensions":["ign","ore"],
	"ignoreScanners":[],
	"minSeverity": "low",
	"minConfidence": "low"
}

Note that .fixinator.json files placed in a subfolder of the base scan path are currently ignored.

ignorePaths

An array of path patterns to ignore. Certain paths are always ignored such as .git or .svn paths.

ignoreExtensions

An array of file extensions to ignore. Certain file extensions such as image files (png, gif, jpg, etc) are always ignored.

ignoreScanners

An array of scanner name slugs to ignore.

minSeverity

Default: low - The minimum severity level that will be flagged. Set this to high if you only care about severe issues.

minConfidence

Default: high - The minimum confidence level that will be flagged. Issues with low confidence will be more likely to be false positives.

failOnIssues

Default: true - When true returns an exit code of 1 when issues are found, this will cause your build to fail if you are running in CI. If you do not want the build to fail when issues are found, set this to false.

Here are all the versions for this package. Please note that you can leverage CommandBox package versioning to install any package you like. Please refer to our managing package version guide for more information.

Version Created Last Update Published By Stable Download
1.0.21 Apr 16 2019 03:54 PM Apr 16 2019 03:54 PM Pete Freitag (pfreitag)
1.0.20 Apr 04 2019 10:53 AM Apr 04 2019 10:53 AM Pete Freitag (pfreitag)
1.0.19 Apr 04 2019 10:43 AM Apr 04 2019 10:43 AM Pete Freitag (pfreitag)
1.0.18 Apr 04 2019 10:16 AM Apr 04 2019 10:16 AM Pete Freitag (pfreitag)
1.0.17 Mar 22 2019 02:05 PM Mar 22 2019 02:05 PM Pete Freitag (pfreitag)
1.0.16 Mar 22 2019 01:58 PM Mar 22 2019 01:58 PM Pete Freitag (pfreitag)
1.0.15 Mar 22 2019 11:51 AM Mar 22 2019 11:51 AM Pete Freitag (pfreitag)
1.0.14 Mar 21 2019 03:44 PM Mar 21 2019 03:44 PM Pete Freitag (pfreitag)
1.0.13 Mar 12 2019 09:09 AM Mar 12 2019 09:09 AM Pete Freitag (pfreitag)
1.0.12 Mar 11 2019 10:34 AM Mar 11 2019 10:34 AM Pete Freitag (pfreitag)
1.0.11 Feb 26 2019 03:39 PM Feb 26 2019 03:39 PM Pete Freitag (pfreitag)
1.0.10 Feb 25 2019 04:41 PM Feb 25 2019 04:41 PM Pete Freitag (pfreitag)
1.0.9 Feb 25 2019 11:48 AM Feb 25 2019 11:48 AM Pete Freitag (pfreitag)
1.0.8 Feb 21 2019 04:28 PM Feb 21 2019 04:28 PM Pete Freitag (pfreitag)
1.0.7 Feb 21 2019 03:11 PM Feb 21 2019 03:11 PM Pete Freitag (pfreitag)
1.0.6 Feb 21 2019 12:57 PM Feb 21 2019 12:57 PM Pete Freitag (pfreitag)
1.0.5 Feb 21 2019 09:31 AM Feb 21 2019 09:31 AM Pete Freitag (pfreitag)
1.0.4 Feb 20 2019 03:03 PM Feb 20 2019 03:03 PM Pete Freitag (pfreitag)
1.0.3 Feb 18 2019 02:02 PM Feb 18 2019 02:02 PM Pete Freitag (pfreitag)
1.0.2 Feb 14 2019 02:29 PM Feb 14 2019 02:29 PM Pete Freitag (pfreitag)
1.0.1 Feb 13 2019 01:59 PM Feb 13 2019 01:59 PM Pete Freitag (pfreitag)
1.0.0 Feb 13 2019 12:45 PM Feb 13 2019 12:45 PM Pete Freitag (pfreitag)

 

No collaborators yet.
     
  • Feb 13 2019 12:45 PM
  • Apr 16 2019 03:54 PM
  • 284
  • 0
  • 173