Skip to content

Commit 45b4e9c

Browse files
tyler-dunkeltyler-dunkel
authored
Merge pull request #34 from cloudgraphdev/feature/CG-539-github
feat: Update CG to use Oclif core and space for the `topicSeparator`
2 parents f520796 + 8b1e7e8 commit 45b4e9c

File tree

26 files changed

+11036
-11356
lines changed

26 files changed

+11036
-11356
lines changed

‎README.md

Lines changed: 54 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1373,41 +1373,41 @@ There are some common errors you may see when running CloudGraph that are usuall
13731373
* [`cg launch [PROVIDER]`](#cg-launch-provider)
13741374
* [`cg load [PROVIDER]`](#cg-load-provider)
13751375
* [`cg policy [PROVIDER]`](#cg-policy-provider)
1376-
* [`cg policy:add [PROVIDER]`](#cg-policyadd-provider)
1377-
* [`cg policy:install [PROVIDER]`](#cg-policyinstall-provider)
1378-
* [`cg policy:list [PROVIDER]`](#cg-policylist-provider)
1379-
* [`cg policy:remove [PROVIDER]`](#cg-policyremove-provider)
1380-
* [`cg policy:update [PROVIDER]`](#cg-policyupdate-provider)
1376+
* [`cg policy add [PROVIDER]`](#cg-policy-add-provider)
1377+
* [`cg policy install [PROVIDER]`](#cg-policy-install-provider)
1378+
* [`cg policy list [PROVIDER]`](#cg-policy-list-provider)
1379+
* [`cg policy remove [PROVIDER]`](#cg-policy-remove-provider)
1380+
* [`cg policy update [PROVIDER]`](#cg-policy-update-provider)
13811381
* [`cg provider [PROVIDER]`](#cg-provider-provider)
1382-
* [`cg provider:add [PROVIDER]`](#cg-provideradd-provider)
1383-
* [`cg provider:install [PROVIDER]`](#cg-providerinstall-provider)
1384-
* [`cg provider:list [PROVIDER]`](#cg-providerlist-provider)
1385-
* [`cg provider:remove [PROVIDER]`](#cg-providerremove-provider)
1386-
* [`cg provider:update [PROVIDER]`](#cg-providerupdate-provider)
1382+
* [`cg provider add [PROVIDER]`](#cg-provider-add-provider)
1383+
* [`cg provider install [PROVIDER]`](#cg-provider-install-provider)
1384+
* [`cg provider list [PROVIDER]`](#cg-provider-list-provider)
1385+
* [`cg provider remove [PROVIDER]`](#cg-provider-remove-provider)
1386+
* [`cg provider update [PROVIDER]`](#cg-provider-update-provider)
13871387
* [`cg scan [PROVIDER]`](#cg-scan-provider)
13881388
* [`cg serve [PROVIDER]`](#cg-serve-provider)
13891389
* [`cg teardown [PROVIDER]`](#cg-teardown-provider)
13901390
* [`cg update [PROVIDER]`](#cg-update-provider)
13911391

13921392
## `cg help [COMMAND]`
13931393

1394-
display help for cg
1394+
Display help for cg.
13951395

13961396
```
13971397
USAGE
1398-
$ cg help [COMMAND] [--all]
1398+
$ cg help [COMMAND] [-n]
13991399
14001400
ARGUMENTS
1401-
COMMAND command to show help for
1401+
COMMAND Command to show help for.
14021402
14031403
FLAGS
1404-
--all see all commands in CLI
1404+
-n, --nested-commands Include all nested commands in the output.
14051405
14061406
DESCRIPTION
1407-
display help for cg
1407+
Display help for cg.
14081408
```
14091409

1410-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.17/src/commands/help.ts)_
1410+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
14111411

14121412
## `cg init [PROVIDER]`
14131413

@@ -1541,13 +1541,13 @@ DESCRIPTION
15411541

15421542
_See code: [src/commands/policy/index.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/policy/index.ts)_
15431543

1544-
## `cg policy:add [PROVIDER]`
1544+
## `cg policy add [PROVIDER]`
15451545

15461546
Add new policy packs
15471547

15481548
```
15491549
USAGE
1550-
$ cg policy:add [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1550+
$ cg policy add [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
15511551
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
15521552
15531553
FLAGS
@@ -1569,23 +1569,21 @@ DESCRIPTION
15691569
Add new policy packs
15701570
15711571
ALIASES
1572-
$ cg add:policy
1572+
$ cg add policy
15731573
15741574
EXAMPLES
15751575
$ cg policy add aws-cis-1.2.0
15761576
15771577
$ cg policy add aws-cis-1.2.0@0.12.0
15781578
```
15791579

1580-
_See code: [src/commands/policy/add.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/policy/add.ts)_
1581-
1582-
## `cg policy:install [PROVIDER]`
1580+
## `cg policy install [PROVIDER]`
15831581

15841582
Install policy packs based on the lock file
15851583

15861584
```
15871585
USAGE
1588-
$ cg policy:install [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1586+
$ cg policy install [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
15891587
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
15901588
15911589
FLAGS
@@ -1607,21 +1605,19 @@ DESCRIPTION
16071605
Install policy packs based on the lock file
16081606
16091607
ALIASES
1610-
$ cg install:policy
1608+
$ cg install policy
16111609
16121610
EXAMPLES
16131611
$ cg policy install
16141612
```
16151613

1616-
_See code: [src/commands/policy/install.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/policy/install.ts)_
1617-
1618-
## `cg policy:list [PROVIDER]`
1614+
## `cg policy list [PROVIDER]`
16191615

16201616
List currently installed policy packs and versions
16211617

16221618
```
16231619
USAGE
1624-
$ cg policy:list [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1620+
$ cg policy list [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
16251621
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
16261622
16271623
FLAGS
@@ -1643,25 +1639,22 @@ DESCRIPTION
16431639
List currently installed policy packs and versions
16441640
16451641
ALIASES
1646-
$ cg ls:policy
1647-
$ cg list:policy
1648-
$ cg ls:policy
1642+
$ cg ls policy
1643+
$ cg list policy
16491644
16501645
EXAMPLES
16511646
$ cg policy list
16521647
16531648
$ cg policy list aws
16541649
```
16551650

1656-
_See code: [src/commands/policy/list.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/policy/list.ts)_
1657-
1658-
## `cg policy:remove [PROVIDER]`
1651+
## `cg policy remove [PROVIDER]`
16591652

16601653
Remove currently installed policy pack
16611654

16621655
```
16631656
USAGE
1664-
$ cg policy:remove [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1657+
$ cg policy remove [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
16651658
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
16661659
16671660
FLAGS
@@ -1683,12 +1676,11 @@ DESCRIPTION
16831676
Remove currently installed policy pack
16841677
16851678
ALIASES
1686-
$ cg remove:policy
1687-
$ cg policy:remove
1688-
$ cg policy:rm
1689-
$ cg del:policy
1690-
$ cg rm:policy
1691-
$ cg del:policy
1679+
$ cg remove policy
1680+
$ cg policy remove
1681+
$ cg policy rm
1682+
$ cg del policy
1683+
$ cg rm policy
16921684
16931685
EXAMPLES
16941686
$ cg policy delete
@@ -1698,15 +1690,13 @@ EXAMPLES
16981690
$ cg policy delete aws-cis-1.2.0 --no-save
16991691
```
17001692

1701-
_See code: [src/commands/policy/remove.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/policy/remove.ts)_
1702-
1703-
## `cg policy:update [PROVIDER]`
1693+
## `cg policy update [PROVIDER]`
17041694

17051695
Update currently installed policy packs
17061696

17071697
```
17081698
USAGE
1709-
$ cg policy:update [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1699+
$ cg policy update [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
17101700
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
17111701
17121702
FLAGS
@@ -1735,8 +1725,6 @@ EXAMPLES
17351725
$ cg policy update aws-cis-1.2.0@0.12.0
17361726
```
17371727

1738-
_See code: [src/commands/policy/update.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/policy/update.ts)_
1739-
17401728
## `cg provider [PROVIDER]`
17411729

17421730
Commands to manage provider modules, run $ cg provider for more info.
@@ -1766,13 +1754,13 @@ DESCRIPTION
17661754

17671755
_See code: [src/commands/provider/index.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/provider/index.ts)_
17681756

1769-
## `cg provider:add [PROVIDER]`
1757+
## `cg provider add [PROVIDER]`
17701758

17711759
Add new providers
17721760

17731761
```
17741762
USAGE
1775-
$ cg provider:add [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1763+
$ cg provider add [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
17761764
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
17771765
17781766
FLAGS
@@ -1794,23 +1782,21 @@ DESCRIPTION
17941782
Add new providers
17951783
17961784
ALIASES
1797-
$ cg add:provider
1785+
$ cg add provider
17981786
17991787
EXAMPLES
18001788
$ cg provider add aws
18011789
18021790
$ cg provider add aws@0.12.0
18031791
```
18041792

1805-
_See code: [src/commands/provider/add.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/provider/add.ts)_
1806-
1807-
## `cg provider:install [PROVIDER]`
1793+
## `cg provider install [PROVIDER]`
18081794

18091795
Install providers based on the lock file
18101796

18111797
```
18121798
USAGE
1813-
$ cg provider:install [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1799+
$ cg provider install [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
18141800
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
18151801
18161802
FLAGS
@@ -1832,21 +1818,19 @@ DESCRIPTION
18321818
Install providers based on the lock file
18331819
18341820
ALIASES
1835-
$ cg install:provider
1821+
$ cg install provider
18361822
18371823
EXAMPLES
18381824
$ cg provider install
18391825
```
18401826

1841-
_See code: [src/commands/provider/install.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/provider/install.ts)_
1842-
1843-
## `cg provider:list [PROVIDER]`
1827+
## `cg provider list [PROVIDER]`
18441828

18451829
List currently installed providers and versions
18461830

18471831
```
18481832
USAGE
1849-
$ cg provider:list [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1833+
$ cg provider list [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
18501834
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
18511835
18521836
FLAGS
@@ -1868,25 +1852,22 @@ DESCRIPTION
18681852
List currently installed providers and versions
18691853
18701854
ALIASES
1871-
$ cg ls:provider
1872-
$ cg list:provider
1873-
$ cg ls:provider
1855+
$ cg ls provider
1856+
$ cg list provider
18741857
18751858
EXAMPLES
18761859
$ cg provider list
18771860
18781861
$ cg provider list aws
18791862
```
18801863

1881-
_See code: [src/commands/provider/list.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/provider/list.ts)_
1882-
1883-
## `cg provider:remove [PROVIDER]`
1864+
## `cg provider remove [PROVIDER]`
18841865

18851866
Remove currently installed provider
18861867

18871868
```
18881869
USAGE
1889-
$ cg provider:remove [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1870+
$ cg provider remove [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
18901871
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
18911872
18921873
FLAGS
@@ -1908,12 +1889,11 @@ DESCRIPTION
19081889
Remove currently installed provider
19091890
19101891
ALIASES
1911-
$ cg remove:provider
1912-
$ cg provider:remove
1913-
$ cg provider:rm
1914-
$ cg del:provider
1915-
$ cg rm:provider
1916-
$ cg del:provider
1892+
$ cg remove provider
1893+
$ cg provider remove
1894+
$ cg provider rm
1895+
$ cg del provider
1896+
$ cg rm provider
19171897
19181898
EXAMPLES
19191899
$ cg provider delete
@@ -1923,15 +1903,13 @@ EXAMPLES
19231903
$ cg provider delete aws --no-save
19241904
```
19251905

1926-
_See code: [src/commands/provider/remove.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/provider/remove.ts)_
1927-
1928-
## `cg provider:update [PROVIDER]`
1906+
## `cg provider update [PROVIDER]`
19291907

19301908
Update currently installed providers
19311909

19321910
```
19331911
USAGE
1934-
$ cg provider:update [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
1912+
$ cg provider update [PROVIDER] [--no-save] [--dev] [-d <value>] [-s dgraph] [--directory <value>] [--no-serve] [-p
19351913
<value>] [-q playground|altair] [-l <value>] [--use-roles] [-P <value>]
19361914
19371915
FLAGS
@@ -1960,8 +1938,6 @@ EXAMPLES
19601938
$ cg provider update aws@0.12.0
19611939
```
19621940

1963-
_See code: [src/commands/provider/update.ts](https://github.com/cloudgraphdev/cli/blob/v0.21.0-alpha.4/src/commands/provider/update.ts)_
1964-
19651941
## `cg scan [PROVIDER]`
19661942

19671943
Scan one or multiple providers data to be queried through Dgraph

‎bin/dev

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#!/usr/bin/env node
2+
3+
// eslint-disable-next-line @typescript-eslint/no-var-requires
4+
const oclif = require('@oclif/core')
5+
6+
// eslint-disable-next-line @typescript-eslint/no-var-requires
7+
const path = require('path')
8+
9+
const project = path.join(__dirname, '..', 'tsconfig.json')
10+
11+
// In dev mode -> use ts-node and dev plugins
12+
process.env.NODE_ENV = 'development'
13+
14+
// eslint-disable-next-line @typescript-eslint/no-var-requires
15+
require('ts-node').register({project})
16+
17+
// In dev mode, always show stack traces
18+
oclif.settings.debug = true;
19+
20+
// Start the CLI
21+
oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

‎bin/dev.cmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@echo off
2+
3+
node "%~dp0\dev" %*

‎bin/run

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env node
22

3-
require('@oclif/command').run()
4-
.then(require('@oclif/command/flush'))
5-
.catch(require('@oclif/errors/handle'))
3+
// eslint-disable-next-line @typescript-eslint/no-var-requires
4+
require('@oclif/core').run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))
5+

0 commit comments

Comments
 (0)