fix: fix reading last notes from changelog

dangreen · dangreen · commit 151b5df50365 · 2022-01-19T00:00:56.000+07:00
diff --git a/README.md b/README.md
@@ -86,7 +86,7 @@ pnpm release
 
 | Options | Description | Default |
 |---------|-------------|---------|
-| titleRegExp | Regular expression to find release title in changelog. Must contain capture group, which will be used to detect release version. As fallback, version will read from package.json. | `/^#+ \[([^\]]*\d+\.\d+\.\d+[^\]]*)\]/` |
+| titleRegExp | Regular expression to find release title in changelog. Must contain capture group, which will be used to detect release version. As fallback, version will read from package.json. | not required |
 | includeTitle | Include release title into release notes. | `false` |
 | remoteUrl | GitHub repository remote url. | From local environment. |
 | host | Custom API host. | `'github.com'` |
diff --git a/src/changelog.spec.ts b/src/changelog.spec.ts
@@ -5,18 +5,14 @@ import { readLastChangesFromStream } from './changelog'
 describe('changelog', () => {
   describe('readLastChangesFromStream', () => {
     it('should read last changes from file', async () => {
-      const stream = fs.createReadStream(path.join('test', 'mocks', 'CHANGELOG.md'))
+      const stream = fs.createReadStream(path.join('test', 'mocks', 'CHANGELOG_0.md'))
 
       expect(await readLastChangesFromStream(stream)).toMatchInlineSnapshot(`
 Array [
   "8.0.0-alpha.2",
   "### Bug Fixes
 
 * **deps:** update dependency dotenv to v11 ([#16](https://github.com/TrigenSoftware/scripts/issues/16)) ([27e4ce7](https://github.com/TrigenSoftware/scripts/commit/27e4ce7414f6d50fec9fe363238d771cf49b4cd7))
-* **deps:** update dependency eslint to v8 ([#17](https://github.com/TrigenSoftware/scripts/issues/17)) ([9dac68c](https://github.com/TrigenSoftware/scripts/commit/9dac68c423a53a53f6ccbd5c19905cdb851b6ea5))
-* **deps:** update dependency eslint-plugin-jest-dom to v4 ([#15](https://github.com/TrigenSoftware/scripts/issues/15)) ([8133db1](https://github.com/TrigenSoftware/scripts/commit/8133db151811134b8fc2a22df5efd63bb8d51387))
-* **deps:** update typescript-eslint monorepo to v5 ([#18](https://github.com/TrigenSoftware/scripts/issues/18)) ([87f8d42](https://github.com/TrigenSoftware/scripts/commit/87f8d42f749665b8df0daa1c1631b9ac9ca57048))
-
 
 ### Features
 
@@ -27,7 +23,7 @@ Array [
     })
 
     it('should read last changes from file with header', async () => {
-      const stream = fs.createReadStream(path.join('test', 'mocks', 'CHANGELOG.md'))
+      const stream = fs.createReadStream(path.join('test', 'mocks', 'CHANGELOG_0.md'))
       const options = {
         includeTitle: true
       }
@@ -37,20 +33,52 @@ Array [
   "8.0.0-alpha.2",
   "# [8.0.0-alpha.2](https://github.com/TrigenSoftware/scripts/compare/v8.0.0-alpha.1...v8.0.0-alpha.2) (2022-01-14)
 
-
 ### Bug Fixes
 
 * **deps:** update dependency dotenv to v11 ([#16](https://github.com/TrigenSoftware/scripts/issues/16)) ([27e4ce7](https://github.com/TrigenSoftware/scripts/commit/27e4ce7414f6d50fec9fe363238d771cf49b4cd7))
-* **deps:** update dependency eslint to v8 ([#17](https://github.com/TrigenSoftware/scripts/issues/17)) ([9dac68c](https://github.com/TrigenSoftware/scripts/commit/9dac68c423a53a53f6ccbd5c19905cdb851b6ea5))
-* **deps:** update dependency eslint-plugin-jest-dom to v4 ([#15](https://github.com/TrigenSoftware/scripts/issues/15)) ([8133db1](https://github.com/TrigenSoftware/scripts/commit/8133db151811134b8fc2a22df5efd63bb8d51387))
-* **deps:** update typescript-eslint monorepo to v5 ([#18](https://github.com/TrigenSoftware/scripts/issues/18)) ([87f8d42](https://github.com/TrigenSoftware/scripts/commit/87f8d42f749665b8df0daa1c1631b9ac9ca57048))
-
 
 ### Features
 
 * **browserslist-config:** update queries, add esm queries ([3031c6b](https://github.com/TrigenSoftware/scripts/commit/3031c6b322330be57654bdebc1012bddc20e7972))
 ",
 ]
+`)
+    })
+
+    it('should split titile without link', async () => {
+      const stream = fs.createReadStream(path.join('test', 'mocks', 'CHANGELOG_1.md'))
+
+      expect(await readLastChangesFromStream(stream)).toMatchInlineSnapshot(`
+Array [
+  "0.0.1-1",
+  "### Bug Fixes
+
+* **cli:** fix config file loading ([8603c2f](https://github.com/TrigenSoftware/simple-github-release/commit/8603c2fde4aeb53619fae8bb9feba53093f51c65))
+",
+]
+`)
+    })
+
+    it('should read keep a changelog', async () => {
+      const stream = fs.createReadStream(path.join('test', 'mocks', 'CHANGELOG_2.md'))
+
+      expect(await readLastChangesFromStream(stream)).toMatchInlineSnapshot(`
+Array [
+  "1.0.0",
+  "### Added
+- Version navigation.
+- Links to latest released version in previous versions.
+- \\"Why keep a changelog?\\" section.
+
+### Changed
+- Start using \\"changelog\\" over \\"change log\\" since it's the common usage.
+- Start versioning based on the current English version at 0.3.0 to help
+translation authors keep things up-to-date.
+
+### Removed
+- Section about \\"changelog\\" vs \\"CHANGELOG\\".
+",
+]
 `)
     })
   })
diff --git a/src/changelog.ts b/src/changelog.ts
@@ -10,7 +10,7 @@ import { Options } from './types'
  */
 export async function readLastChangesFromStream(stream: Readable, options: Pick<Options, 'titleRegExp' | 'includeTitle'> = {}) {
   const {
-    titleRegExp = /^#+ \[([^\]]*\d+\.\d+\.\d+[^\]]*)\]/,
+    titleRegExp = /^#+ \[?([^[\]()\s]*\d+\.\d+\.\d+[^[\]()\s]*)\]?/,
     includeTitle = false
   } = options
   let inLastChanges = false
diff --git a/src/types.ts b/src/types.ts
@@ -3,7 +3,6 @@ export interface Options {
    * Regular expression to find release title in changelog.
    * Must contain capture group, which will be used to detect release version.
    * As fallback, version will read from package.json.
-   * @default /^#+ \[([^\]]*\d+\.\d+\.\d+[^\]]*)\]/
    */
   titleRegExp?: RegExp
   /**
diff --git a/test/mocks/CHANGELOG.md b/test/mocks/CHANGELOG.md
diff --git a/test/mocks/CHANGELOG_0.md b/test/mocks/CHANGELOG_0.md
@@ -0,0 +1,18 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [8.0.0-alpha.2](https://github.com/TrigenSoftware/scripts/compare/v8.0.0-alpha.1...v8.0.0-alpha.2) (2022-01-14)
+
+### Bug Fixes
+
+* **deps:** update dependency dotenv to v11 ([#16](https://github.com/TrigenSoftware/scripts/issues/16)) ([27e4ce7](https://github.com/TrigenSoftware/scripts/commit/27e4ce7414f6d50fec9fe363238d771cf49b4cd7))
+
+### Features
+
+* **browserslist-config:** update queries, add esm queries ([3031c6b](https://github.com/TrigenSoftware/scripts/commit/3031c6b322330be57654bdebc1012bddc20e7972))
+
+# [8.0.0-alpha.1](https://github.com/TrigenSoftware/scripts/compare/v8.0.0-alpha.0...v8.0.0-alpha.1) (2022-01-12)
+
+**Note:** Version bump only for package scripts
diff --git a/test/mocks/CHANGELOG_1.md b/test/mocks/CHANGELOG_1.md
@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.0.1-1](https://github.com/TrigenSoftware/simple-github-release/compare/v0.0.1-0...v0.0.1-1) (2022-01-18)
+
+### Bug Fixes
+
+* **cli:** fix config file loading ([8603c2f](https://github.com/TrigenSoftware/simple-github-release/commit/8603c2fde4aeb53619fae8bb9feba53093f51c65))
+
+### 0.0.1-0 (2022-01-18)
diff --git a/test/mocks/CHANGELOG_2.md b/test/mocks/CHANGELOG_2.md
@@ -0,0 +1,37 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2017-06-20
+### Added
+- Version navigation.
+- Links to latest released version in previous versions.
+- "Why keep a changelog?" section.
+
+### Changed
+- Start using "changelog" over "change log" since it's the common usage.
+- Start versioning based on the current English version at 0.3.0 to help
+translation authors keep things up-to-date.
+
+### Removed
+- Section about "changelog" vs "CHANGELOG".
+
+## [0.3.0] - 2015-12-03
+### Added
+- RU translation from [@aishek](https://github.com/aishek).
+- pt-BR translation from [@tallesl](https://github.com/tallesl).
+- es-ES translation from [@ZeliosAriex](https://github.com/ZeliosAriex).
+
+## [0.2.0] - 2015-10-06
+### Changed
+- Remove exclusionary mentions of "open source" since this project can
+benefit both "open" and "closed" source projects equally.
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
+[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
