feat(cli): json output

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

.eslintrc.base.cjs

@@ -884,6 +884,12 @@ const config = {
         '@typescript-eslint/no-redundant-type-constituents': 0
       }
     },
+    {
+      files: '**/*.abstract.ts',
+      rules: {
+        '@typescript-eslint/no-useless-constructor': 0
+      }
+    },
     {
       files: ['**/decorators/*.constraint.ts', '**/*.decorator.ts'],
       rules: {

.github/ISSUE_TEMPLATE/bug.yml

@@ -54,7 +54,7 @@ body:
     type: textarea
     attributes:
       label: Environment info
-      description: Output of `grease info -p <package-manager>`
+      description: Output of `grease info -jp <package-manager>`
       render: jsonc
     validations:
       required: true

package.json

@@ -93,6 +93,7 @@
   "dependencies": {
     "@flex-development/aggregate-error-ponyfill": "3.1.1",
     "@flex-development/commitlint-config": "1.0.1",
+    "@flex-development/errnode": "2.0.0",
     "@flex-development/mkbuild": "1.0.0-alpha.23",
     "@flex-development/mlly": "1.0.0-alpha.18",
     "@flex-development/pathe": "2.0.0",
@@ -184,8 +185,7 @@
     "chai": "5.0.0-alpha.1"
   },
   "engines": {
-    "node": ">=16.20.0 <20.6.0 || >20.6.0",
-    "yarn": "4.0.0-rc.50"
+    "node": ">=16.20.0 <20.6.0 || >20.6.0"
   },
   "packageManager": "[email protected]",
   "readme": "README.md",

src/__snapshots__/grease.service.snap

@@ -1,18 +1,26 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`unit:GreaseService > #bump > should return package manifest 1`] = `
+exports[`unit:GreaseService > #bump > should return bump version 1`] = `
 {
-  "name": "premajor",
+  "build": [],
+  "major": 3,
+  "minor": 0,
+  "patch": 0,
+  "prerelease": [
+    "rc",
+    1,
+  ],
   "version": "3.0.0-rc.1",
 }
 `;
 
 exports[`unit:GreaseService > #recommend > should return recommended version bump 1`] = `
-RecommendedBump {
+{
   "breaks": 1,
-  "bump": "major",
+  "bump": "premajor",
   "commits": 72,
   "features": 16,
+  "unstable": true,
 }
 `;
 

src/__tests__/grease.service.spec.ts

@@ -19,7 +19,7 @@ import { ConfigModule } from '#src/config'
 import { ReleaseType } from '#src/enums'
 import { GitModule, GitService, TagOperation } from '#src/git'
 import { LogModule } from '#src/log'
-import { PackageManifest } from '#src/models'
+import { Version } from '#src/models'
 import { set } from '@flex-development/tutils'
 import { CqrsModule } from '@nestjs/cqrs'
 import { Test } from '@nestjs/testing'
@@ -58,13 +58,13 @@ describe('unit:GreaseService', () => {
       }
     })
 
-    it('should return package manifest', async () => {
+    it('should return bump version', async () => {
       // Act
       const result = await subject.bump(operation)
 
       // Expect
-      expect(result).to.be.instanceof(PackageManifest)
-      expect(result.pkg).toMatchSnapshot()
+      expect(result).to.be.instanceof(Version)
+      expect(result).toMatchSnapshot()
     })
   })
 
@@ -101,7 +101,8 @@ describe('unit:GreaseService', () => {
       // Act
       const result = await subject.recommend({
         tagprefix: gc.tagprefix,
-        to: sha
+        to: sha,
+        unstable: true
       })
 
       // Expect

src/cli/commands/__tests__/bump.command.functional.spec.ts

@@ -3,41 +3,104 @@
  * @module grease/cli/commands/tests/functional/BumpCommand
  */
 
+import { RecommendedBump } from '#src/bump'
 import { ReleaseType } from '#src/enums'
 import GreaseService from '#src/grease.service'
+import { LogObject, LoggerService } from '#src/log'
+import { Version } from '#src/models'
 import type { ReleaseVersion } from '#src/types'
 import type { Mock } from '#tests/interfaces'
 import { CliUtilityService } from '@flex-development/nest-commander'
 import { CommandTestFactory } from '@flex-development/nest-commander/testing'
 import type { TestingModule } from '@nestjs/testing'
 import TestSubject from '../bump.command'
+import GreaseCommand from '../grease.command'
 
 describe('functional:cli/commands/BumpCommand', () => {
   let args: ['bump', ReleaseVersion]
   let bump: Mock<GreaseService['bump']>
   let command: TestingModule
+  let debug: Mock<LoggerService['debug']>
+  let log: Mock<LoggerService['log']>
   let recommend: Mock<GreaseService['recommend']>
+  let success: Mock<LoggerService['success']>
 
   beforeAll(() => {
     args = ['bump', ReleaseType.PREMAJOR]
   })
 
   beforeEach(async () => {
     command = await CommandTestFactory.createTestingCommand({
+      positional: false,
       providers: [
         CliUtilityService,
+        GreaseCommand,
+        LoggerService,
         TestSubject,
         {
           provide: GreaseService,
           useValue: {
-            bump: bump = vi.fn().mockName('GreaseService#bump'),
-            recommend: recommend = vi.fn().mockName('GreaseService#recommend')
+            bump: bump = vi
+              .fn()
+              .mockReturnValue(new Version(faker.system.semver()))
+              .mockName('GreaseService#bump'),
+            config: vi
+              .fn()
+              .mockReturnValue({})
+              .mockName('GreaseService#config'),
+            recommend: recommend = vi
+              .fn()
+              .mockReturnValue(new RecommendedBump({
+                breaks: 1,
+                commits: 72,
+                features: 16,
+                unstable: true
+              }))
+              .mockName('GreaseService#recommend')
+          }
+        },
+        {
+          provide: LoggerService,
+          useValue: {
+            debug: debug = vi.fn().mockName('LoggerService#debug'),
+            log: log = vi.fn().mockName('LoggerService#log'),
+            success: success = vi.fn().mockName('LoggerService#success'),
+            withTag: vi.fn().mockReturnValue({
+              debug,
+              log,
+              success,
+              sync: vi.fn().mockName('LoggerService#sync')
+            })
           }
         }
       ]
     })
   })
 
+  describe('--json, -j', () => {
+    it('should parse flag', async () => {
+      // Act
+      await CommandTestFactory.run(command, [...args, '--json'])
+
+      // Expect
+      expect(log).toHaveBeenCalledOnce()
+      expect(log).toHaveBeenCalledWith(expect.any(LogObject))
+      expect(debug).not.toHaveBeenCalled()
+      expect(success).not.toHaveBeenCalled()
+    })
+
+    it('should parse short flag', async () => {
+      // Act
+      await CommandTestFactory.run(command, [...args, '-j'])
+
+      // Expect
+      expect(log).toHaveBeenCalledOnce()
+      expect(log).toHaveBeenCalledWith(expect.any(LogObject))
+      expect(debug).not.toHaveBeenCalled()
+      expect(success).not.toHaveBeenCalled()
+    })
+  })
+
   describe('--preid <id>', () => {
     let preid: string
 
@@ -52,6 +115,9 @@ describe('functional:cli/commands/BumpCommand', () => {
       // Expect
       expect(bump).toHaveBeenCalledOnce()
       expect(bump.mock.lastCall?.[0]).to.have.property('preid', preid)
+      expect(success).toHaveBeenCalledOnce()
+      expect(debug).not.toHaveBeenCalled()
+      expect(log).not.toHaveBeenCalled()
     })
   })
 
@@ -69,6 +135,9 @@ describe('functional:cli/commands/BumpCommand', () => {
       // Expect
       expect(bump).toHaveBeenCalledOnce()
       expect(bump.mock.lastCall?.[0]).to.have.property('prestart', prestart)
+      expect(success).toHaveBeenCalledOnce()
+      expect(debug).not.toHaveBeenCalled()
+      expect(log).not.toHaveBeenCalled()
     })
   })
 
@@ -80,6 +149,9 @@ describe('functional:cli/commands/BumpCommand', () => {
       // Expect
       expect(recommend).toHaveBeenCalledOnce()
       expect(recommend).toHaveBeenCalledWith(expect.any(Object))
+      expect(log).toHaveBeenCalledOnce()
+      expect(debug).toHaveBeenCalledTimes(3)
+      expect(success).not.toHaveBeenCalled()
     })
 
     it('should parse short flag', async () => {
@@ -89,26 +161,61 @@ describe('functional:cli/commands/BumpCommand', () => {
       // Expect
       expect(recommend).toHaveBeenCalledOnce()
       expect(recommend).toHaveBeenCalledWith(expect.any(Object))
+      expect(log).toHaveBeenCalledOnce()
+      expect(debug).toHaveBeenCalledTimes(3)
+      expect(success).not.toHaveBeenCalled()
+    })
+  })
+
+  describe('--unstable, -u', () => {
+    it('should parse flag', async () => {
+      // Act
+      await CommandTestFactory.run(command, [args[0], '-r', '--unstable'])
+
+      // Expect
+      expect(recommend).toHaveBeenCalledOnce()
+      expect(recommend.mock.lastCall?.[0]).to.have.property('unstable').be.true
+      expect(log).toHaveBeenCalledOnce()
+      expect(debug).toHaveBeenCalledTimes(3)
+      expect(success).not.toHaveBeenCalled()
+    })
+
+    it('should parse short flag', async () => {
+      // Act
+      await CommandTestFactory.run(command, [args[0], '-r', '-u'])
+
+      // Expect
+      expect(recommend).toHaveBeenCalledOnce()
+      expect(recommend.mock.lastCall?.[0]).to.have.property('unstable').be.true
+      expect(log).toHaveBeenCalledOnce()
+      expect(debug).toHaveBeenCalledTimes(3)
+      expect(success).not.toHaveBeenCalled()
     })
   })
 
-  describe('--write, -w [choice]', () => {
+  describe('--write, -w', () => {
     it('should parse flag', async () => {
       // Act
       await CommandTestFactory.run(command, [...args, '--write'])
 
       // Expect
       expect(bump).toHaveBeenCalledOnce()
-      expect(bump.mock.lastCall?.[0]).to.have.property('write', true)
+      expect(bump.mock.lastCall?.[0]).to.have.property('write').be.true
+      expect(success).toHaveBeenCalledOnce()
+      expect(debug).not.toHaveBeenCalled()
+      expect(log).not.toHaveBeenCalled()
     })
 
     it('should parse short flag', async () => {
       // Act
-      await CommandTestFactory.run(command, [...args, '-w', 'n'])
+      await CommandTestFactory.run(command, [...args, '-w'])
 
       // Expect
       expect(bump).toHaveBeenCalledOnce()
-      expect(bump.mock.lastCall?.[0]).to.have.property('write', false)
+      expect(bump.mock.lastCall?.[0]).to.have.property('write').be.true
+      expect(success).toHaveBeenCalledOnce()
+      expect(debug).not.toHaveBeenCalled()
+      expect(log).not.toHaveBeenCalled()
     })
   })
 })

src/cli/commands/__tests__/changelog.command.functional.spec.ts

@@ -8,8 +8,10 @@ import GreaseService from '#src/grease.service'
 import type { Mock } from '#tests/interfaces'
 import { CliUtilityService } from '@flex-development/nest-commander'
 import { CommandTestFactory } from '@flex-development/nest-commander/testing'
+import { constant } from '@flex-development/tutils'
 import type { TestingModule } from '@nestjs/testing'
 import TestSubject from '../changelog.command'
+import GreaseCommand from '../grease.command'
 
 describe('functional:cli/commands/ChangelogCommand', () => {
   let args: ['changelog']
@@ -22,13 +24,16 @@ describe('functional:cli/commands/ChangelogCommand', () => {
 
   beforeEach(async () => {
     command = await CommandTestFactory.createTestingCommand({
+      positional: false,
       providers: [
         CliUtilityService,
+        GreaseCommand,
         TestSubject,
         {
           provide: GreaseService,
           useValue: {
-            changelog: changelog = vi.fn().mockName('GreaseService#changelog')
+            changelog: changelog = vi.fn().mockName('GreaseService#changelog'),
+            config: vi.fn(constant({})).mockName('GreaseService#config')
           }
         }
       ]
@@ -159,6 +164,26 @@ describe('functional:cli/commands/ChangelogCommand', () => {
     })
   })
 
+  describe('--unstable, -u [choice]', () => {
+    it('should parse flag', async () => {
+      // Act
+      await CommandTestFactory.run(command, [...args, '--unstable'])
+
+      // Expect
+      expect(changelog).toHaveBeenCalledOnce()
+      expect(changelog.mock.lastCall?.[0]).to.have.property('unstable').be.true
+    })
+
+    it('should parse short flag', async () => {
+      // Act
+      await CommandTestFactory.run(command, [...args, '-u', '0'])
+
+      // Expect
+      expect(changelog).toHaveBeenCalledOnce()
+      expect(changelog.mock.lastCall?.[0]).to.have.property('unstable').be.false
+    })
+  })
+
   describe('--write, -w', () => {
     let write: boolean
 

src/cli/commands/__tests__/grease.command.functional.spec.ts

@@ -135,22 +135,4 @@ describe('functional:cli/commands/GreaseCommand', () => {
       expect(exitOverride).not.toHaveBeenCalled()
     })
   })
-
-  describe('--unstable, -u [choice]', () => {
-    it('should parse flag', async () => {
-      // Act
-      await CommandTestFactory.run(command, ['--unstable=false'])
-
-      // Expect
-      expect(exitOverride).not.toHaveBeenCalled()
-    })
-
-    it('should parse short flag', async () => {
-      // Act
-      await CommandTestFactory.run(command, ['-u', '0'])
-
-      // Expect
-      expect(exitOverride).not.toHaveBeenCalled()
-    })
-  })
 })