adds a script to validate Changelog

CHANGELOG.md

@@ -1,43 +1,54 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+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.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-And, this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [2.0.0-alpha-1] (2024-06-xx)
 
-## [Unreleased]
+### Features
+
+- Refactor using typescript, microbundle for packaging
+
+### Documentation
+
+- Uses [typedoc](https://typedoc.org/)
+
+<!-- ## [unreleased] -->
+
+## [1.0.6] (2024-06-xx)
 
 ### Chore
 
 - Drop CircleCI
 - Uses pnpm as package manager
+- upgrade dependencies
+- GHActions codecov and meterian runs only on branch master
 
-## [1.0.5] - 2024-04-27
+## [1.0.5] (2024-04-27)
 
 ### Chore
 
 - Adds CI using GitHub actions
 - upgrade dependencies
 
-## [1.0.4] - 2024-02-03
+## [1.0.4] (2024-02-03)
 
 ### Chore
 
 - upgrade dependencies
 
-## [1.0.3] - 2023-11-10
+## [1.0.3] (2023-11-10)
 
 ### Changed
 
 - adds input parameter `address_only` into the typescript definition
 
-## [1.0.2] - 2023-07-16
+## [1.0.2] (2023-07-16)
 
 ### Chore
 
 - upgrade dependencies
 
-## [1.0.1] - 2023-02-08
+## [1.0.1] (2023-02-08)
 
 ### Chore
 
@@ -46,7 +57,7 @@ And, this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.
 - unit test using async/await
 - uses HoundCI
 
-## [1.0.0] - 2021-02-27
+## [1.0.0] (2021-02-27)
 
 ### Changed
 
@@ -56,7 +67,7 @@ And, this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.
 - Information and example on error handling
 - Adds a TypeScript Example
 
-## [0.10.0] - 2020-11-14
+## [0.10.0] (2020-11-14)
 
 ### Added
 
@@ -69,59 +80,87 @@ And, this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.
 - updated README
 - fix typos thanks to [0xflotus](https://github.com/0xflotus)
 
-## [0.9.0] - 2020-09-20
+## [0.9.0] (2020-09-20)
+
+### Changed
+
+- fetch uses `cross-fetch`
 
-fetch uses `cross-fetch`
+## [0.8.1] (2020-09-19)
 
-## [0.8.1] - 2020-09-19
+### Changed
 
-`TypeScript` support without enum
+- `TypeScript` support without enum
 
-## [0.8.0] - 2020-09-19
+## [0.8.0] (2020-09-19)
 
-`TypeScript` support
+### Changed
 
-## [0.7.1] - 2020-03-15
+- `TypeScript` support
 
-Updates documentation
+## [0.7.1] (2020-03-15)
 
-## [0.7.0] - 2020-03-15
+### Changed
 
-Same JSON Error structure as the official API
+- Updates documentation
 
-## [0.6.0] - 2020-03-14
+## [0.7.0] (2020-03-15)
 
-Upgrade dependencies
+### Changed
 
-## [0.5.1] - 2019-12-09
+- Same JSON Error structure as the official API
 
-Upgrade dependencies
+## [0.6.0] (2020-03-14)
 
-## [0.5.0] - 2019-03-10
+### Changed
 
-Upgrade dependencies
+- Upgrade dependencies
 
-## [0.4.0] - 2018-12-08
+## [0.5.1] (2019-12-09)
 
-upgrade dependencies and update test with proxy
+### Changed
 
-## [0.3.0] - 2018-08-28
+- Upgrade dependencies
 
-adding readme documentation and upgrade dependencies
+## [0.5.0] (2019-03-10)
 
-## [0.2.0] - 2018-07-17
+### Changed
 
-Allow a proxy URL to use instead of official API endpoint
+- Upgrade dependencies
+
+## [0.4.0] (2018-12-08)
+
+### Changed
+
+- upgrade dependencies and update test with proxy
+
+## [0.3.0] (2018-08-28)
+
+### Changed
+
+- adding readme documentation and upgrade dependencies
+
+## [0.2.0] (2018-07-17)
+
+### Changed
+
+- Allow a proxy URL to use instead of official API endpoint
+
+## [0.1.1] (2018-06-21)
+
+### Changed
 
-## [0.1.1] - 2018-06-21
+- Open Cage website URL has changed
 
-Open Cage website URL has changed
+## [0.1.0] (2018-03-04)
 
-## [0.1.0] - 2018-03-04
+### Feature
 
-First release
+- First release
 
-[unreleased]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.5...HEAD
+[unreleased]: https://github.com/tsamaya/opencage-api-client/compare/v2.0.0-alpha-1...HEAD
+[2.0.0-alpha-1]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.6...v2.0.0-alpha-1
+[1.0.6]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.5...v1.0.6
 [1.0.5]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.4...v1.0.5
 [1.0.4]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.3...v1.0.4
 [1.0.3]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.2...v1.0.3

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencage-api-client",
-  "version": "1.0.5",
+  "version": "2.0.0-alpha-1",
   "description": "An OpenCageData Geocoder API client library for node and browsers (UMD)",
   "keywords": [
     "geocoder",
@@ -34,9 +34,10 @@
     "build:browser": "microbundle -f umd -i src/browser.ts -o dist/opencage-api.umd.js --name opencage --no-pkg-main --generateTypes false",
     "dev": "microbundle watch",
     "docs": "typedoc",
+    "format": "pnpm run lint:fix && prettier --write .",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "format": "pnpm run lint:fix && prettier --write .",
+    "release:changelog": "tsx ./scripts/valid-changelog.ts",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",