...
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? |
---|---|---|---|---|---|
npm.ignoreDirectoryPatterns | A string parameter that defines the list of directory patterns which will be ignored when searching for the package.json dependency file during the npm resolution. The list of directories is a comma/semi-colon delimited list. | N/A | N/A | example,examples,test,.ws_bower | No |
npm.resolveDependencies | Whether to resolve npm dependencies. NOTE: 'package.json' dependency files defined within directories defined by the npm.ignoreDirectoryPatterns are not scanned, and therefore dependencies declared in these files are ignored. For example, the default set of directories to ignore will not include the following dependency files: */examples/*package.json */example/*package.json */.ws_bower/*package.json */test/*package.json | Resolves npm dependencies. | Will not resolve npm dependencies. | True | -npm.resolveDependencies |
npm.ignoreSourceFiles | When using the npm resolver, ignore or include the js files outside the node_modules folder. NOTE: Only relevant when fileSystemScan is true. | Ignores the js files outside the node_modules folder. | Includes the js files outside the node_modules folder. | True | No |
npm.includeDevDependencies | Whether to include dev dependencies. | Adds devDependencies to the scan | Only the prod dependencies will be scanned. | False | -npm.includeDevDependencies |
npm.runPreStep | Whether to run "npm “npm install " on found package.json file. | Runs "npm install" on found package.json file.
| Will not run "npm install" on found package.json file. | False | No |
npm.ignoreNpmLsErrors | Whether to ignore errors of the 'npm list' command. | The scan will end with SUCCESS status + hierarchy tree. | The scan will end with SUCCESS status + flat list. | False | No |
npm.ignoreScripts | Whether to ignore the scripts in your project's package.json file. NOTES:
| The Unified Agent executes npm install --ignore-scripts, and the scripts in your project's package.json file will not be run. | The npm install command will run and the scripts in your project's package.json file will be run. | False | No |
npm.yarnProject | Whether this is a yarn project (or not). | Resolves yarn projects | Will not resolve yarn projects | False | No |
npm.accessToken | The access token value provided by the relevant environment (Microsoft Visual Studio or Artifactory) to fetch required data from the NPM registry. | N/A | N/A | Empty | No |
npm.identifyByNameAndVersion | Defines whether to fetch package data from npm registry (either private or public). | The Unified Agent will use only the name and the version of the package. | Fetches package data from npm registry (either private or public). | False | No |
npm.yarn.frozenLockfile | Enables running the pre-step with the ‘--frozen.lockfile’ yarn parameter. | Runs the pre-step with the ‘--frozen.lockfile’ yarn parameter. | Will not run the pre-step with the ‘--frozen.lockfile’ yarn parameter. | False | No |
npm.resolveMainPackageJsonOnly | In npm projects, more than one package.json file can exist. Therefore, you can decide to resolve only the main package.json file (the one in the root directory) or all package.json files. | The Unified Agent checks if there is a package.json file in the folder passed as the -d parameter. If no such file exists, the scan will fail; otherwise, the Unified Agent will scan only this package.json. | The Unified Agent resolves all package.json files | False | No |
npm.removeDuplicateDependencies | Whether to remove duplicate dependencies during npm dependency resolution. | Removes duplicate dependencies during npm dependency resolution. | Includes duplicate dependencies during npm dependency resolution. | True | No |
npm.resolveAdditionalDependencies | Whether to resolve global dependencies and require modules. NOTE: Require is the equivalent to import in other languages. | Resolves global dependencies and require modules. | Resolves only the dependencies that are declared in the package.json. | False | No |
npm.resolveLockFile | Whether the Unified Agent will rely on the manifest (package.json) and lock file (package-lock.json) for the resolution and not rely on NPM commands. If the lock file is missing, the detection will be based on the node_modules folder. | The Unified Agent uses the package.json and package-lock.json to get the hierarchy tree. If the package-lock.json is missing, the detection is based on the node_modules folder. | The Unified Agent runs npm commands to get the hierarchy tree. | True | No |
npm.projectNameFromDependencyFile | Whether the project name will be taken from the dependency file. This is a standalone parameter for the NPM resolver only, taking effect only when the npm resolver is the only active resolver. If the Unified Agent identifies any additional resolvers besides npm that are set to True, an error is generated. NOTE: If a productVersion was specified, it will override the project version and be part of the project's name. | The project name will be taken from the package.json file. | The project name will be taken from the CLI/configuration file. | False | No |
npm.failOnNpmLsErrors | Whether to fail and exit the scan in case of 'npm ls' errors. | In case an error occurs while running 'npm ls', the following log will be printed and the scan will stop: "Errors found in 'npm ls' command, while flag npm.failOnNpmLsErrors is true program will exit". | In case of an error in 'npm ls' the Unified Agent will continue to run and get as much dependencies information as possible. | NULL (meaning False - the scan will not fail on npm ls errors) | No |
npm.resolveGlobalPackages | When scanning Docker images, and npm is not available, in order to extract global dependencies, this parameter eliminates the need to rely on NPM being installed and available;, as the Unified Agent identifies all the global npm packages installed on the Docker image. When true - the Unified Agent will scan every package.json file inside 'node_modules' directory. This parameter is mostly relevant when scanning Docker images. | Resolves all package.json files under the node_modules folder. | Will not scan package.json files under the node_modules folder. | False | No |
...
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? |
---|---|---|---|---|---|
bower.resolveDependencies | Whether to resolve Bower project folders. | Resolves Bower project folders | Will not resolve Bower project folders | True | No |
bower.ignoreSourceFiles | When using the dependency resolver, whether to include package dependencies or package dependencies + source files. NOTE: Only relevant when fileSystemScan is true. | Includes only package dependencies | Include package dependencies and source files | False | No |
bower.nuget.runPreStep | Whether to install your Bower project. | Installs your Bower project | Does not install your Bower project | False | No |
...
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
nuget.resolveDependencies | Whether to resolve NuGet packages.config and .csproj files. | Resolves NuGet packages.config and .csproj files. | Will not resolve NuGet packages.config and .csproj files. | True | No | ||||||
nuget.resolvePackagesConfigFiles | Whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No | ||||||
nuget.resolveCsProjFiles | Whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No | ||||||
nuget.restoreDependencies | Whether to run dotnet restore on found '.csproj' files in order to download the project's dependencies. | Runs dotnet restore on found '.csproj' files | Will not run dotnet restore on found '.csproj' files | False | No | nuget.preferredEnvironment | Defines the preferred NuGet restore command. Available values are nuget and dotnet. NOTE: This parameter will be used only if the nuget.restoreDepencies parameter is set to True. | N/A | N/A | No default | No |
nuget.packagesDirectory | Provides a path to the directory where WhiteSource temporary files will be created (and removed at the end of a scan). NOTE: Provide a short directory, in order to avoid errors related to the path size during the restore command. | N/A | N/A | No default | No | ||||||
nuget.ignoreSourceFiles | When using the dependency resolver, whether to include package dependencies or package dependencies + source files. NOTE: Only relevant when fileSystemScan is true. | Includes only package dependencies | Includes package dependencies and source files | True | No | ||||||
nuget.runPreStep | Whether to run nuget restore on found 'found | Runs dotnet restore on csproj files and nuget restore on found ' packages.config ' files in order to download all dependencies to a temporary folder, scans this folder and deletes it after fetching the dependencies. | Will not run dotnet restore and nuget restore on found ' packages.config ' and csproj files. | False | No | ||||||
nuget.resolveNuspecFiles | Indicates whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No | ||||||
nuget.resolveAssetsFiles | Resolves obj/project.assets.json file for new .NET dependency management structure. | N/A | N/A | True | No |
...