Skip to content

Commit

Permalink
feat: add help for new --project-name-prefix flag
Browse files Browse the repository at this point in the history
  • Loading branch information
ekbsnyk committed Jan 28, 2021
1 parent f65ad26 commit 2593496
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 1 deletion.
3 changes: 3 additions & 0 deletions help/commands-docs/_SNYK_COMMAND_OPTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ Below are flags that are influencing CLI behavior for specific projects, languag
- `--packages-folder`:
Custom path to packages folder

- `--project-name-prefix`=<PREFIX_STRING>:
When monitoring a .NET project, use this flag to add a custom prefix to the name of files inside a project along with any desired separators, e.g. `snyk monitor --file=my-project.sln --project-name-prefix=my-group/`. This is useful when you have multiple projects with the same name in other sln files.

### npm options

- `--strict-out-of-sync`=true|false:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
"snyk-module": "3.1.0",
"snyk-mvn-plugin": "2.25.1",
"snyk-nodejs-lockfile-parser": "1.30.1",
"snyk-nuget-plugin": "1.19.4",
"snyk-nuget-plugin": "1.20.0",
"snyk-php-plugin": "1.9.2",
"snyk-policy": "1.14.1",
"snyk-python-plugin": "1.19.2",
Expand Down
57 changes: 57 additions & 0 deletions test/args.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -303,3 +303,60 @@ test('test command line "container test --help" should display help for mode', (
);
t.end();
});

test('test command line "snyk monitor --project-name-prefix" should add a property on options', (t) => {
const cliArgs = [
'/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
'/Users/dror/work/snyk/snyk-internal/cli',
'monitor',
'--project-name-prefix=my-prefix/',
];
const result = args(cliArgs);
t.equal(
result.options['project-name-prefix'],
'my-prefix/',
'expected options[project-name-prefix] to equal expected value',
);
t.end();
});

test('test command line "snyk monitor --packages-folder" should add a property on options', (t) => {
const cliArgs = [
'/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
'/Users/dror/work/snyk/snyk-internal/cli',
'monitor',
'--packages-folder=/path/to/folder',
];
const result = args(cliArgs);
t.equal(
result.options['packagesFolder'], // this option is camel-cased in src/cli/args.ts
'/path/to/folder',
'expected options[packagesFolder] to equal expected value',
);
t.end();
});

test('test command line "snyk monitor --assets-project-name" should add a property on options', (t) => {
const cliArgsWithFlag = [
'/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
'/Users/dror/work/snyk/snyk-internal/cli',
'monitor',
'--assets-project-name',
];
const resultWithFlag = args(cliArgsWithFlag);
t.ok(
resultWithFlag.options['assets-project-name'],
'expected options[assets-project-name] to be true',
);
const cliArgsWithoutFlag = [
'/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
'/Users/dror/work/snyk/snyk-internal/cli',
'monitor',
];
const resultWithoutFlag = args(cliArgsWithoutFlag);
t.notOk(
resultWithoutFlag.options['assets-project-name'],
'expected options[assets-project-name] to be false',
);
t.end();
});

0 comments on commit 2593496

Please sign in to comment.