✨ Check CLI version (#52)

Author: fabienjuif

packages/gitmoji-changelog-cli/package.json

@@ -33,6 +33,8 @@
   "dependencies": {
     "@gitmoji-changelog/core": "^1.0.1",
     "@gitmoji-changelog/markdown": "^1.0.0",
+    "libnpm": "^1.0.0",
+    "semver-compare": "^1.0.0",
     "yargs": "^12.0.1"
   },
   "publishConfig": {

packages/gitmoji-changelog-cli/src/cli.js

@@ -1,14 +1,34 @@
 const fs = require('fs')
 
+const libnpm = require('libnpm')
+const semverCompare = require('semver-compare')
 const { generateChangelog, logger } = require('@gitmoji-changelog/core')
 const { buildMarkdownFile } = require('@gitmoji-changelog/markdown')
 
 const pkg = require('../package.json')
 
+async function getLatestVersion() {
+  const watchdog = new Promise(resolve => setTimeout(resolve, 500, { version: pkg.version }))
+  const request = libnpm.manifest('gitmoji-changelog@latest')
+
+  const { version } = await Promise.race([watchdog, request])
+
+  return version
+}
+
 async function main(options = {}) {
   logger.start(`gitmoji-changelog v${pkg.version}`)
   logger.info(`${options.mode} ${options.output}`)
 
+  try {
+    const latestVersion = await getLatestVersion()
+    if (semverCompare(latestVersion, pkg.version) > 0) {
+      logger.warn(`You got an outdated version of gitmoji-changelog, please update! (yours: ${pkg.version}, latest: ${latestVersion})`)
+      logger.warn('Just do the following npm command to update it:')
+      logger.warn('\t> npm install -g gitmoji-changelog@latest')
+    }
+  } catch (e) { /* ignore error */ }
+
   try {
     const changelog = await generateChangelog(options)
 
@@ -31,6 +51,9 @@ async function main(options = {}) {
   } catch (e) {
     logger.error(e)
   }
+
+  // force quit (if the latest version request is pending, we don't wait for it)
+  process.exit(0)
 }
 
 module.exports = { main }

packages/gitmoji-changelog-cli/src/cli.spec.js

@@ -1,14 +1,68 @@
 const { generateChangelog, logger } = require('@gitmoji-changelog/core')
+const { manifest } = require('libnpm')
 const { main } = require('./cli')
 
 describe('cli', () => {
+  const realExitFunction = process.exit
+  beforeEach(() => {
+    process.exit = jest.fn(() => {})
+    jest.clearAllMocks()
+  })
+  afterEach(() => {
+    process.exit = realExitFunction
+  })
+
   it('should throw an error if changelog generation fails', async () => {
     generateChangelog.mockRejectedValue(new Error())
 
     await main()
 
     expect(logger.error).toHaveBeenCalled()
   })
+
+  it('should call process.exit explicitly so promises are not waited for', async () => {
+    await main()
+
+    expect(process.exit).toHaveBeenCalledTimes(1)
+  })
+
+  describe('version control', () => {
+    const findOutdatedMessage = () => logger.warn.mock.calls.find(([message]) => message.includes('outdated'))
+
+    it('should print a warning about a new version', async () => {
+      manifest.mockReturnValueOnce(Promise.resolve({ version: '2.0.0' }))
+      await main()
+
+      expect(findOutdatedMessage()).toBeTruthy()
+    })
+
+    it('should NOT print a warning about a new version', async () => {
+      // older version in npm registry
+      manifest.mockReturnValueOnce(Promise.resolve({ version: '0.5.0' }))
+      await main()
+
+      // same version in npm registry
+      manifest.mockReturnValueOnce(Promise.resolve({ version: '1.0.0' }))
+      await main()
+
+      expect(manifest).toHaveBeenCalledTimes(2)
+      expect(findOutdatedMessage()).toBeFalsy()
+    })
+
+    it('should NOT print a warning about a new version when request took to much time', async () => {
+      manifest.mockImplementationOnce(() => new Promise((resolve) => { setTimeout(resolve, 1000, { version: '2.0.0' }) }))
+      await main()
+
+      expect(findOutdatedMessage()).toBeFalsy()
+    })
+
+    it('should NOT print a warning about a new version when request is on error', async () => {
+      manifest.mockReturnValueOnce(Promise.reject(new Error('faked error (manifest)')))
+      await main()
+
+      expect(findOutdatedMessage()).toBeFalsy()
+    })
+  })
 })
 
 jest.mock('@gitmoji-changelog/core', () => ({
@@ -18,5 +72,14 @@ jest.mock('@gitmoji-changelog/core', () => ({
     error: jest.fn(),
     success: jest.fn(),
     info: jest.fn(),
+    warn: jest.fn(),
   },
 }))
+
+jest.mock('../package.json', () => ({
+  version: '1.0.0',
+}))
+
+jest.mock('libnpm', () => ({
+  manifest: jest.fn(),
+}))