docs: add issues create help

Author: fsargent

help/cli-commands/README.md

@@ -44,6 +44,10 @@ These commands find and report security issues in Infrastructure as Code files;
 
 The `snyk code test` command finds security issues using Static Code Analysis.
 
+### [`snyk issues`](issues.md)
+
+These commands manage Snyk issues for a workspace.
+
 ### [`snyk sbom`](sbom.md)
 
 Generate or test an SBOM document in ecosystems supported by Snyk.

help/cli-commands/issues-create.md

@@ -0,0 +1,21 @@
+# Issues create
+
+## Usage
+
+`snyk issues create [<OPTIONS>]`
+
+## Description
+
+The `snyk issues create` command creates Snyk issues from a workspace.
+
+Run this command in a workspace context to create issues for findings that are available to the CLI.
+
+## Examples
+
+Create issues from the current workspace:
+
+`$ snyk issues create`
+
+Create issues from the current workspace for a specific Organization:
+
+`$ snyk issues create --org=00000000-0000-0000-0000-000000000000`

help/cli-commands/issues.md

@@ -0,0 +1,17 @@
+# Issues
+
+## Usage
+
+`snyk issues <COMMAND> [<OPTIONS>]`
+
+## Description
+
+The `snyk issues` commands manage Snyk issues for a workspace.
+
+Use these commands to create issues from the workspace context available to the CLI.
+
+## `snyk issues` commands and the help docs
+
+The `snyk issues` commands are listed here with the help options:
+
+- [`snyk issues create`](issues-create.md); `snyk issues create --help`: creates Snyk issues from a workspace

src/cli/modes.ts

@@ -38,6 +38,10 @@ const modes: Record<string, ModeData> = {
       return args;
     },
   },
+  issues: {
+    allowedCommands: ['create'],
+    config: (args): [] => args,
+  },
 };
 
 export function parseMode(mode: string, args): string {

test/jest/acceptance/help.spec.ts

@@ -57,6 +57,23 @@ describe('help', () => {
       expect(stderr).toBe('');
     });
 
+    it('prints specific help info for issues', async () => {
+      const { stdout, code, stderr } = await runSnykCLI('issues --help');
+
+      expect(stdout).toContain('snyk issues create');
+      expect(code).toBe(0);
+      expect(stderr).toBe('');
+    });
+
+    it('prints specific help info for issues create', async () => {
+      const { stdout, code, stderr } = await runSnykCLI('issues create --help');
+
+      expect(stdout).toContain('Issues create');
+      expect(stdout).toContain('snyk issues create [<OPTIONS>]');
+      expect(code).toBe(0);
+      expect(stderr).toBe('');
+    });
+
     it('prints specific help info when called with flag and equals sign', async () => {
       const { stdout, code, stderr } = await runSnykCLI('--help=iac');
 

test/tap/args.test.ts

@@ -482,6 +482,23 @@ test('test command line "iac test --help" should display help for mode', (t) =>
   t.end();
 });
 
+test('test command line "issues --help" should display help for mode', (t) => {
+  const cliArgs = [
+    '/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
+    '/Users/dror/work/snyk/snyk-internal/cli',
+    'issues',
+    '--help',
+  ];
+  const result = args(cliArgs);
+  t.equal(result.command, 'help', 'command should be replaced by help');
+  t.equal(
+    result.options.help,
+    'issues',
+    'help option should be assigned to issues',
+  );
+  t.end();
+});
+
 test('test command line "snyk iac --experimental" should be true on options', (t) => {
   const cliArgsWithFlag = [
     '/Users/dror/.nvm/versions/node/v6.9.2/bin/node',