🐛 Use last version from changelog file instead of previous git tag (#82)

Author: kefranabg

misc/package.sample.json

@@ -0,0 +1,11 @@
+{
+  "name": "gitmoji-changelog",
+  "version": "0.0.1",
+  "description": "Some description",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "MIT"
+}

packages/gitmoji-changelog-cli/package.json

@@ -35,10 +35,14 @@
     "@gitmoji-changelog/markdown": "^1.1.0",
     "libnpm": "^1.0.0",
     "semver-compare": "^1.0.0",
+    "simple-git": "^1.113.0",
     "yargs": "^12.0.1"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "fs-extra": "^8.0.1"
   }
 }

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

@@ -0,0 +1,76 @@
+const os = require('os')
+const fs = require('fs')
+const { removeSync } = require('fs-extra')
+const path = require('path')
+const simpleGit = require('simple-git/promise')
+const util = require('util')
+const execFile = util.promisify(require('child_process').execFile)
+
+expect.extend({
+  includes(str, items) {
+    const pass = items.every(item => str.includes(item))
+    return {
+      pass,
+      message: () => pass ? '' : '',
+    }
+  },
+})
+
+describe('generate changelog', () => {
+  let testDir
+  let repo
+
+  beforeAll(async () => {
+    testDir = path.join(os.tmpdir(), 'gitmoji-changelog')
+    if (fs.existsSync(testDir)) removeSync(testDir)
+    fs.mkdirSync(testDir)
+    repo = simpleGit(testDir)
+    await repo.init()
+    fs.copyFileSync(
+      path.join(__dirname, '..', '..', '..', 'misc', 'package.sample.json'),
+      path.join(testDir, 'package.json'),
+    )
+  })
+
+  afterAll(() => {
+    removeSync(testDir)
+  })
+
+  it('should generate changelog even if user doesn\'t call cli at each tag', async () => {
+    await newVersion('1.0.0')
+    await gitmojiChangelog()
+
+    expect(getChangelog()).toMatch(/1.0.0/)
+
+    await newVersion('1.0.1')
+    await newVersion('1.0.2')
+    await gitmojiChangelog()
+
+    expect(getChangelog()).includes(['1.0.0', '1.0.1', '1.0.2'])
+  })
+
+  async function newVersion(version) {
+    fs.writeFileSync(path.join(testDir, version))
+    bumpVersion(version)
+    await repo.add('.')
+    await repo.commit(`Commit ${version}`)
+    await repo.addTag(`v${version}`)
+  }
+
+  function gitmojiChangelog() {
+    return execFile('node', [path.join(__dirname, 'index.js')], { cwd: testDir })
+  }
+
+  function getChangelog() {
+    return fs.readFileSync(path.join(testDir, 'CHANGELOG.md')).toString('utf8')
+  }
+
+  function bumpVersion(to) {
+    const pkg = path.join(testDir, 'package.json')
+    // eslint-disable-next-line global-require
+    const { version } = require(pkg)
+    const content = fs.readFileSync(pkg).toString('utf8')
+    const updatedContent = content.replace(version, to)
+    fs.writeFileSync(pkg, updatedContent)
+  }
+})

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

@@ -1,13 +1,14 @@
 const fs = require('fs')
-
+const { set } = require('immutadot')
 const libnpm = require('libnpm')
 const semverCompare = require('semver-compare')
 const { generateChangelog, logger } = require('@gitmoji-changelog/core')
-const { buildMarkdownFile } = require('@gitmoji-changelog/markdown')
+const { buildMarkdownFile, getLatestVersion } = require('@gitmoji-changelog/markdown')
+
 
 const pkg = require('../package.json')
 
-async function getLatestVersion() {
+async function getGitmojiChangelogLatestVersion() {
   const watchdog = new Promise(resolve => setTimeout(resolve, 500, { version: pkg.version }))
   const request = libnpm.manifest('gitmoji-changelog@latest')
 
@@ -21,7 +22,7 @@ async function main(options = {}) {
   logger.info(`${options.mode} ${options.output}`)
 
   try {
-    const latestVersion = await getLatestVersion()
+    const latestVersion = await getGitmojiChangelogLatestVersion()
     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:')
@@ -36,22 +37,25 @@ async function main(options = {}) {
   }
 
   try {
-    const changelog = await generateChangelog(options)
+    switch (options.format) {
+      case 'json': {
+        const changelog = await generateChangelog(options)
 
-    if (changelog.meta.package) {
-      const { name, version } = changelog.meta.package
-      logger.info(`${name} v${version}`)
-    }
-    if (changelog.meta.repository) {
-      logger.info(changelog.meta.repository.url)
-    }
+        logMetaData(changelog)
 
-    switch (options.format) {
-      case 'json':
         fs.writeFileSync(options.output, JSON.stringify(changelog))
         break
-      default:
-        await buildMarkdownFile(changelog, options)
+      }
+      default: {
+        const lastVersion = getLatestVersion(options.output)
+        const newOptions = set(options, 'meta.lastVersion', lastVersion)
+
+        const changelog = await generateChangelog(newOptions)
+
+        logMetaData(changelog)
+
+        await buildMarkdownFile(changelog, newOptions)
+      }
     }
     logger.success(`changelog updated into ${options.output}`)
   } catch (e) {
@@ -62,4 +66,14 @@ async function main(options = {}) {
   process.exit(0)
 }
 
+function logMetaData(changelog) {
+  if (changelog.meta.package) {
+    const { name, version } = changelog.meta.package
+    logger.info(`${name} v${version}`)
+  }
+  if (changelog.meta.repository) {
+    logger.info(changelog.meta.repository.url)
+  }
+}
+
 module.exports = { main }

packages/gitmoji-changelog-core/src/index.js

@@ -4,7 +4,7 @@ const gitSemverTags = require('git-semver-tags')
 const semverCompare = require('semver-compare')
 const through = require('through2')
 const concat = require('concat-stream')
-const { head, isEmpty } = require('lodash')
+const { head, isEmpty, get } = require('lodash')
 const { promisify } = require('util')
 
 const { parseCommit } = require('./parser')
@@ -82,11 +82,12 @@ async function generateVersion(options) {
   }
 }
 
-async function generateVersions({ tags, groupSimilarCommits }) {
+async function generateVersions({ tags, groupSimilarCommits, meta }) {
   let nextTag = ''
 
+  const initialFrom = meta && meta.lastVersion ? meta.lastVersion : ''
   return Promise.all(
-    [...tags, '']
+    [...tags, initialFrom]
       .map(tag => {
         const params = {
           groupSimilarCommits,
@@ -107,7 +108,12 @@ async function generateVersions({ tags, groupSimilarCommits }) {
 }
 
 async function generateChangelog(options = {}) {
-  const { mode, release, groupSimilarCommits } = options
+  const {
+    mode,
+    release,
+    groupSimilarCommits,
+    meta,
+  } = options
 
   const packageInfo = await getPackageInfo()
 
@@ -123,11 +129,11 @@ async function generateChangelog(options = {}) {
   let changes = []
 
   const tags = await gitSemverTagsAsync()
-  const lastTag = head(tags)
+  const lastTag = get(options, 'meta.lastVersion', head(tags))
 
   if (mode === 'init') {
     changes = await generateVersions({ tags, groupSimilarCommits })
-  } else {
+  } else if (lastTag === head(tags)) {
     const lastChanges = await generateVersion({
       groupSimilarCommits,
       from: lastTag,
@@ -139,6 +145,15 @@ async function generateChangelog(options = {}) {
     }
 
     changes.push(lastChanges)
+  } else {
+    const lastTagIndex = tags.findIndex(tag => tag === lastTag)
+    const missingTags = tags.splice(0, lastTagIndex)
+
+    const lastChanges = await generateVersions({ tags: missingTags, groupSimilarCommits, meta })
+    changes = [
+      ...changes,
+      ...lastChanges,
+    ]
   }
 
   const repository = await getRepoInfo(packageInfo)

packages/gitmoji-changelog-markdown/src/index.js

@@ -103,6 +103,22 @@ function matchVersionBreakpoint(tested, version = '.*') {
   return regex.test(tested)
 }
 
+function getLatestVersion(markdownFile) {
+  let markdownContent
+
+  try {
+    markdownContent = fs.readFileSync(markdownFile, 'utf-8')
+  } catch (err) {
+    return null
+  }
+
+  const result = markdownContent.match(/<a name="([\w.]+?)"><\/a>/)
+
+  if (!result) return null
+
+  return `v${result[1]}`
+}
+
 function getShortHash(hash, repository) {
   if (!hash) return null
 
@@ -131,4 +147,5 @@ module.exports = {
   matchVersionBreakpoint,
   getShortHash,
   autolink,
+  getLatestVersion,
 }

yarn.lock

@@ -1182,6 +1182,13 @@ debug@^2.1.2, debug@^2.2.0, debug@^2.3.3, debug@^2.6.8, debug@^2.6.9:
   dependencies:
     ms "2.0.0"
 
+debug@^4.0.1:
+  version "4.1.1"
+  resolved "https://registry.yarnpkg.com/debug/-/debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791"
+  integrity sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==
+  dependencies:
+    ms "^2.1.1"
+
 decamelize-keys@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/decamelize-keys/-/decamelize-keys-1.1.0.tgz#d171a87933252807eb3cb61dc1c1445d078df2d9"
@@ -1905,6 +1912,15 @@ fs-extra@^4.0.1:
     jsonfile "^4.0.0"
     universalify "^0.1.0"
 
+fs-extra@^8.0.1:
+  version "8.0.1"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-8.0.1.tgz#90294081f978b1f182f347a440a209154344285b"
+  integrity sha512-W+XLrggcDzlle47X/XnS7FXrXu9sDo+Ze9zpndeBxdgv88FHLm1HtmkhEwavruS6koanBjp098rUpHs65EmG7A==
+  dependencies:
+    graceful-fs "^4.1.2"
+    jsonfile "^4.0.0"
+    universalify "^0.1.0"
+
 fs-minipass@^1.2.5:
   version "1.2.5"
   resolved "https://registry.yarnpkg.com/fs-minipass/-/fs-minipass-1.2.5.tgz#06c277218454ec288df77ada54a03b8702aacb9d"
@@ -3882,7 +3898,7 @@ ms@2.0.0:
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
   integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=
 
-ms@^2.0.0:
+ms@^2.0.0, ms@^2.1.1:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.1.tgz#30a5864eb3ebb0a66f2ebe6d727af06a09d86e0a"
   integrity sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==
@@ -5122,6 +5138,13 @@ signale@^1.3.0:
     figures "^2.0.0"
     pkg-conf "^2.1.0"
 
+simple-git@^1.113.0:
+  version "1.113.0"
+  resolved "https://registry.yarnpkg.com/simple-git/-/simple-git-1.113.0.tgz#668989728a1e9cf4ec6c72b69ea2eecc93489bea"
+  integrity sha512-i9WVsrK2u0G/cASI9nh7voxOk9mhanWY9eGtWBDSYql6m49Yk5/Fan6uZsDr/xmzv8n+eQ8ahKCoEr8cvU3h+g==
+  dependencies:
+    debug "^4.0.1"
+
 sisteransi@^0.1.1:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-0.1.1.tgz#5431447d5f7d1675aac667ccd0b865a4994cb3ce"