Skip to content

Commit

Permalink
docs: 1.0.0 [skip ci]
Browse files Browse the repository at this point in the history
## 1.0.0 (2022-06-02)

### 🧭 API Documentation Changes

* **toBeMultiLineStringGeometry:** add the min point count error to the JSDoc API ([01f6c4b](01f6c4b))
* change JSDoc param types to avoid using GeoJSON unknown types ([06ac03a](06ac03a))
* **all:** cleanup JSDoc formatting and standardize API examples ([300a96d](300a96d))
* update JSDoc descriptions of coordinate core functions ([f5658f3](f5658f3))
* update JSDoc organization ([7ab7eca](7ab7eca))
* **isValidCoordinate:** update returns description ([70bd43e](70bd43e))
* **isValidCoordinate:** update the error and parameter descriptions ([7e3e8ed](7e3e8ed))

### 🐞 Bug Fixes

* add bounding box validity checking to geometry core functions and matchers ([ac6a9a1](ac6a9a1)), closes [/datatracker.ietf.org/doc/html/rfc7946#section-5](https://github.com/M-Scott-Lassiter//datatracker.ietf.org/doc/html/rfc7946/issues/section-5) [#9](#9) [#10](#10) [#11](#11) [#12](#12) [#13](#13) [#14](#14) [#16](#16) [#29](#29)
* **toBeLineStringGeometry:** prohibit single coordinate in "coordinates" member ([ee5de52](ee5de52)), closes [/datatracker.ietf.org/doc/html/rfc7946#section-3](https://github.com/M-Scott-Lassiter//datatracker.ietf.org/doc/html/rfc7946/issues/section-3) [#11](#11)

### 🎯 Test Changes

* add 'Feature' and 'FeatureCollection' to test list of disallowed geometry type values ([f139a09](f139a09))
* **toBeLineStringGeometry:** add a stress test with many points ([22df5c7](22df5c7))
* **toBeGeometryCollection:** add an unrecognizable geometry to the invalid tests ([5c041c6](5c041c6))
* **toBeGeometryCollection:** add robust snapshot tests, verify coordinates treated as foreign member ([472d12d](472d12d)), closes [#32](#32) [#33](#33)
* **isValid2DBoundingBox:** add robust snapshot tests ([4363710](4363710)), closes [#32](#32)
* **isValid2DCoordinate:** add robust snapshot tests ([ae92f67](ae92f67)), closes [#32](#32)
* **isValid3DBoundingBox:** add robust snapshot tests ([a37ec48](a37ec48)), closes [#32](#32)
* **isValid3DCoordinate:** add robust snapshot tests ([56fbf92](56fbf92)), closes [#32](#32)
* **isValidBoundingBox:** add robust snapshot tests ([063b94e](063b94e)), closes [#32](#32)
* **isValidCoordinate:** add robust snapshot tests ([7b4a804](7b4a804)), closes [#32](#32)
* **toBeAnyGeometry:** add robust snapshot tests ([8a6e611](8a6e611)), closes [#32](#32)
* **toBeLineStringGeometry:** add robust snapshot tests ([cfaed46](cfaed46)), closes [#32](#32)
* **toBeMultiLineStringGeometry:** add robust snapshot tests ([57dc767](57dc767)), closes [#32](#32)
* **toBeMultiPointGeometry:** add robust snapshot tests ([36013e1](36013e1)), closes [#32](#32)
* **toBeMultiPolygonGeometry:** add robust snapshot tests ([df1c23a](df1c23a)), closes [#32](#32)
* **toBePointGeometry:** add robust snapshot tests ([fd5c516](fd5c516)), closes [#32](#32)
* **toBePolygonGeometry:** add robust snapshot tests ([1c9df69](1c9df69)), closes [#32](#32)
* **toBeMultiLineStringGeometry:** fix coordinate out of range test that ([d6fe2ac](d6fe2ac))
* **toBeMultiPointGeometry:** fix typo in test and core function that was omitting coverage ([bc10f4e](bc10f4e))
* **isValid2DBoundingBox:** fix typo in test descriptions ([df94c27](df94c27))
* setup the project testing framework ([6a95c37](6a95c37))

### 🎁 Feature Changes

* **isValid2DBoundingBox:** add new matcher function ([7fe56f3](7fe56f3)), closes [#6](#6)
* **isValid2DCoordinate:** add new matcher function ([527bbc4](527bbc4)), closes [#1](#1)
* **isValid3DCoordinate:** add new matcher function ([0329231](0329231)), closes [#2](#2)
* **isValidCoordinate:** add new matcher function ([d7e5b70](d7e5b70)), closes [#4](#4)
* **isValid3DBoundingBox:** add new matcher ([6ee8cc6](6ee8cc6)), closes [#7](#7)
* **isValidBoundingBox:** add new matcher ([9a8b7ed](9a8b7ed)), closes [#8](#8)
* **toBeAnyGeometry:** add new matcher ([ed7c3eb](ed7c3eb)), closes [#15](#15)
* **toBeFeature:** add new matcher ([551aa7f](551aa7f)), closes [#32](#32) [#24](#24)
* **toBeFeatureCollection:** add new matcher ([21fe044](21fe044)), closes [#25](#25)
* **toBeGeometryCollection:** add new matcher ([63cc919](63cc919)), closes [#16](#16)
* **toBeLineStringGeometry:** add new matcher ([54416a5](54416a5)), closes [#11](#11)
* **toBeMultiLineStringGeometry:** add new matcher ([3d3a15e](3d3a15e)), closes [#12](#12)
* **toBeMultiPointGeometry:** add new matcher ([9a12752](9a12752)), closes [#10](#10)
* **toBeMultiPolygonGeometry:** add new matcher ([41fef3a](41fef3a)), closes [#14](#14)
* **toBePointGeometry:** add new matcher ([9973afa](9973afa)), closes [#9](#9)
* **toBePolygonGeometry:** add new matcher ([3b9d18d](3b9d18d)), closes [#13](#13)
* split package exports into matcher and core functionality ([a7340d9](a7340d9)), closes [#5](#5)

### 🏗️ Build Changes

* add conventional-changelog-conventionalcommits as dev dependency ([7361d79](7361d79)), closes [#3](#3)
* **package:** add entry points for all, boundingboxes, and coordinates ([8c1d312](8c1d312))
* move release configuration into a separate shareable file ([fa6e50d](fa6e50d))
* **package:** rename matcher loader entry script ([5221d6d](5221d6d))
* setup initial project environment ([b468a41](b468a41))
* **package:** update the commitizen config for customized scopes ([ac05626](ac05626))
* **devDependencies:** upgrade Jest to v28.1, specify peerDependency at >v24.0.0 ([22d1614](22d1614)), closes [#30](#30)
* **package:** upgrade min required Node version to 16 ([58a9824](58a9824))
* **package:** upgrade minimum required node version from 10 to 14 to match LTS schedule ([1e8a8bb](1e8a8bb))
  • Loading branch information
semantic-release-bot committed Jun 2, 2022
1 parent e0c5942 commit e990fa4
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 3 deletions.
78 changes: 78 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,81 @@
## 1.0.0 (2022-06-02)


### :compass: API Documentation Changes

* **toBeMultiLineStringGeometry:** add the min point count error to the JSDoc API ([01f6c4b](https://github.com/M-Scott-Lassiter/jest-geojson/commit/01f6c4b59f5a15a4edc8fddecc74bcdf845c367e))
* change JSDoc param types to avoid using GeoJSON unknown types ([06ac03a](https://github.com/M-Scott-Lassiter/jest-geojson/commit/06ac03a6d8c7c274a17e80c22ebf5d623bf48f06))
* **all:** cleanup JSDoc formatting and standardize API examples ([300a96d](https://github.com/M-Scott-Lassiter/jest-geojson/commit/300a96d7798e4cd3918dbd2248619da5b541f0a6))
* update JSDoc descriptions of coordinate core functions ([f5658f3](https://github.com/M-Scott-Lassiter/jest-geojson/commit/f5658f3a981aea534514d7457a6cf281c8fbe45c))
* update JSDoc organization ([7ab7eca](https://github.com/M-Scott-Lassiter/jest-geojson/commit/7ab7eca06bbc67acde85a7f7d06fac4388a1c953))
* **isValidCoordinate:** update returns description ([70bd43e](https://github.com/M-Scott-Lassiter/jest-geojson/commit/70bd43eba7bc1ebde699a36e351ae92307416ba0))
* **isValidCoordinate:** update the error and parameter descriptions ([7e3e8ed](https://github.com/M-Scott-Lassiter/jest-geojson/commit/7e3e8ed9e8603d8295ee77f4391dd3fe4077af91))


### :lady_beetle: Bug Fixes

* add bounding box validity checking to geometry core functions and matchers ([ac6a9a1](https://github.com/M-Scott-Lassiter/jest-geojson/commit/ac6a9a10615cf8e66aed01e63032d03ba5e4aa95)), closes [/datatracker.ietf.org/doc/html/rfc7946#section-5](https://github.com/M-Scott-Lassiter//datatracker.ietf.org/doc/html/rfc7946/issues/section-5) [#9](https://github.com/M-Scott-Lassiter/jest-geojson/issues/9) [#10](https://github.com/M-Scott-Lassiter/jest-geojson/issues/10) [#11](https://github.com/M-Scott-Lassiter/jest-geojson/issues/11) [#12](https://github.com/M-Scott-Lassiter/jest-geojson/issues/12) [#13](https://github.com/M-Scott-Lassiter/jest-geojson/issues/13) [#14](https://github.com/M-Scott-Lassiter/jest-geojson/issues/14) [#16](https://github.com/M-Scott-Lassiter/jest-geojson/issues/16) [#29](https://github.com/M-Scott-Lassiter/jest-geojson/issues/29)
* **toBeLineStringGeometry:** prohibit single coordinate in "coordinates" member ([ee5de52](https://github.com/M-Scott-Lassiter/jest-geojson/commit/ee5de52c9e3e6fecd6c5aa99b9fc8ded0604884b)), closes [/datatracker.ietf.org/doc/html/rfc7946#section-3](https://github.com/M-Scott-Lassiter//datatracker.ietf.org/doc/html/rfc7946/issues/section-3) [#11](https://github.com/M-Scott-Lassiter/jest-geojson/issues/11)


### :dart: Test Changes

* add 'Feature' and 'FeatureCollection' to test list of disallowed geometry type values ([f139a09](https://github.com/M-Scott-Lassiter/jest-geojson/commit/f139a09c47df09d0ccd5c71b67ad07fbb566ba6e))
* **toBeLineStringGeometry:** add a stress test with many points ([22df5c7](https://github.com/M-Scott-Lassiter/jest-geojson/commit/22df5c7fafe6f6a7db34c46dbbfdb56c505edbb7))
* **toBeGeometryCollection:** add an unrecognizable geometry to the invalid tests ([5c041c6](https://github.com/M-Scott-Lassiter/jest-geojson/commit/5c041c66c7b3c67858cc622533e466c707299166))
* **toBeGeometryCollection:** add robust snapshot tests, verify coordinates treated as foreign member ([472d12d](https://github.com/M-Scott-Lassiter/jest-geojson/commit/472d12d92db9f4e799d7ea8e66e603553f133831)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32) [#33](https://github.com/M-Scott-Lassiter/jest-geojson/issues/33)
* **isValid2DBoundingBox:** add robust snapshot tests ([4363710](https://github.com/M-Scott-Lassiter/jest-geojson/commit/4363710e8718ceb832882ac3f48ad6559ff85806)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **isValid2DCoordinate:** add robust snapshot tests ([ae92f67](https://github.com/M-Scott-Lassiter/jest-geojson/commit/ae92f67fcee3f5a81e8f829c549f59acbde7adab)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **isValid3DBoundingBox:** add robust snapshot tests ([a37ec48](https://github.com/M-Scott-Lassiter/jest-geojson/commit/a37ec485e8d2b32498c053c0252504011cb3adfc)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **isValid3DCoordinate:** add robust snapshot tests ([56fbf92](https://github.com/M-Scott-Lassiter/jest-geojson/commit/56fbf921bbabf6f4ee9c99f84c83ab85b7fff180)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **isValidBoundingBox:** add robust snapshot tests ([063b94e](https://github.com/M-Scott-Lassiter/jest-geojson/commit/063b94ec11198675684b52a7acfcf0303b2e5db3)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **isValidCoordinate:** add robust snapshot tests ([7b4a804](https://github.com/M-Scott-Lassiter/jest-geojson/commit/7b4a8040ba2c028d07451567929b07e99fd496c4)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBeAnyGeometry:** add robust snapshot tests ([8a6e611](https://github.com/M-Scott-Lassiter/jest-geojson/commit/8a6e61190e0c54752504590a56128c6d874f693b)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBeLineStringGeometry:** add robust snapshot tests ([cfaed46](https://github.com/M-Scott-Lassiter/jest-geojson/commit/cfaed46a9480ef542dc7cb2b9c66be0c31469d24)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBeMultiLineStringGeometry:** add robust snapshot tests ([57dc767](https://github.com/M-Scott-Lassiter/jest-geojson/commit/57dc7674baa69db9d83150dc85122b5b29b46753)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBeMultiPointGeometry:** add robust snapshot tests ([36013e1](https://github.com/M-Scott-Lassiter/jest-geojson/commit/36013e114b2929f43a38d44e448e5aa1092d4327)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBeMultiPolygonGeometry:** add robust snapshot tests ([df1c23a](https://github.com/M-Scott-Lassiter/jest-geojson/commit/df1c23af95ed197da9b4fb83180960d99326519f)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBePointGeometry:** add robust snapshot tests ([fd5c516](https://github.com/M-Scott-Lassiter/jest-geojson/commit/fd5c5169e6bd8201a0cc25abc1a22452962debee)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBePolygonGeometry:** add robust snapshot tests ([1c9df69](https://github.com/M-Scott-Lassiter/jest-geojson/commit/1c9df6962f49430aeb2d55983d5d833dfbdd8170)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32)
* **toBeMultiLineStringGeometry:** fix coordinate out of range test that ([d6fe2ac](https://github.com/M-Scott-Lassiter/jest-geojson/commit/d6fe2ac0bf70b1c2d2bf22b7cf227ecfabb85a34))
* **toBeMultiPointGeometry:** fix typo in test and core function that was omitting coverage ([bc10f4e](https://github.com/M-Scott-Lassiter/jest-geojson/commit/bc10f4e64fc6ac443dc9f0b7ac615843408a21ff))
* **isValid2DBoundingBox:** fix typo in test descriptions ([df94c27](https://github.com/M-Scott-Lassiter/jest-geojson/commit/df94c276b2932046d133a6e2e2cecce88f43f9b3))
* setup the project testing framework ([6a95c37](https://github.com/M-Scott-Lassiter/jest-geojson/commit/6a95c376de7c38cbee76679d88e997f8e64a245d))


### :gift: Feature Changes

* **isValid2DBoundingBox:** add new matcher function ([7fe56f3](https://github.com/M-Scott-Lassiter/jest-geojson/commit/7fe56f359d4f87bc1b6aa709498e5c316e58bce2)), closes [#6](https://github.com/M-Scott-Lassiter/jest-geojson/issues/6)
* **isValid2DCoordinate:** add new matcher function ([527bbc4](https://github.com/M-Scott-Lassiter/jest-geojson/commit/527bbc463c64e30546ff8def60776a07165adc64)), closes [#1](https://github.com/M-Scott-Lassiter/jest-geojson/issues/1)
* **isValid3DCoordinate:** add new matcher function ([0329231](https://github.com/M-Scott-Lassiter/jest-geojson/commit/0329231078764b5f031fb307a882b6d371cf9c9d)), closes [#2](https://github.com/M-Scott-Lassiter/jest-geojson/issues/2)
* **isValidCoordinate:** add new matcher function ([d7e5b70](https://github.com/M-Scott-Lassiter/jest-geojson/commit/d7e5b70ae19d2a2285af6a49414f4d552dc2c374)), closes [#4](https://github.com/M-Scott-Lassiter/jest-geojson/issues/4)
* **isValid3DBoundingBox:** add new matcher ([6ee8cc6](https://github.com/M-Scott-Lassiter/jest-geojson/commit/6ee8cc6b9ce57b72cb20eaa9a044279ee289d741)), closes [#7](https://github.com/M-Scott-Lassiter/jest-geojson/issues/7)
* **isValidBoundingBox:** add new matcher ([9a8b7ed](https://github.com/M-Scott-Lassiter/jest-geojson/commit/9a8b7ed39381e61a51c8d27878ff3b47a6a92c2a)), closes [#8](https://github.com/M-Scott-Lassiter/jest-geojson/issues/8)
* **toBeAnyGeometry:** add new matcher ([ed7c3eb](https://github.com/M-Scott-Lassiter/jest-geojson/commit/ed7c3ebf567f033998d88a4b963f16abaecfc1db)), closes [#15](https://github.com/M-Scott-Lassiter/jest-geojson/issues/15)
* **toBeFeature:** add new matcher ([551aa7f](https://github.com/M-Scott-Lassiter/jest-geojson/commit/551aa7f3b3875eb5fd9c0b184051ccc286bdfb0f)), closes [#32](https://github.com/M-Scott-Lassiter/jest-geojson/issues/32) [#24](https://github.com/M-Scott-Lassiter/jest-geojson/issues/24)
* **toBeFeatureCollection:** add new matcher ([21fe044](https://github.com/M-Scott-Lassiter/jest-geojson/commit/21fe044425d4d747ff22434c96898cd3173446fe)), closes [#25](https://github.com/M-Scott-Lassiter/jest-geojson/issues/25)
* **toBeGeometryCollection:** add new matcher ([63cc919](https://github.com/M-Scott-Lassiter/jest-geojson/commit/63cc919d4afaa257b1dd881af1b513c6bc6d66ee)), closes [#16](https://github.com/M-Scott-Lassiter/jest-geojson/issues/16)
* **toBeLineStringGeometry:** add new matcher ([54416a5](https://github.com/M-Scott-Lassiter/jest-geojson/commit/54416a5749b81120a618b8b472e1862e720f4108)), closes [#11](https://github.com/M-Scott-Lassiter/jest-geojson/issues/11)
* **toBeMultiLineStringGeometry:** add new matcher ([3d3a15e](https://github.com/M-Scott-Lassiter/jest-geojson/commit/3d3a15e30b776bbcb44b906b7a0bac900d9367a6)), closes [#12](https://github.com/M-Scott-Lassiter/jest-geojson/issues/12)
* **toBeMultiPointGeometry:** add new matcher ([9a12752](https://github.com/M-Scott-Lassiter/jest-geojson/commit/9a12752ad0d28451562f9499b991e42b388831f6)), closes [#10](https://github.com/M-Scott-Lassiter/jest-geojson/issues/10)
* **toBeMultiPolygonGeometry:** add new matcher ([41fef3a](https://github.com/M-Scott-Lassiter/jest-geojson/commit/41fef3a452c2045d976b6603bfe989fd65c346a0)), closes [#14](https://github.com/M-Scott-Lassiter/jest-geojson/issues/14)
* **toBePointGeometry:** add new matcher ([9973afa](https://github.com/M-Scott-Lassiter/jest-geojson/commit/9973afa52ec4ae81dde8976277bc9d0b95aef26b)), closes [#9](https://github.com/M-Scott-Lassiter/jest-geojson/issues/9)
* **toBePolygonGeometry:** add new matcher ([3b9d18d](https://github.com/M-Scott-Lassiter/jest-geojson/commit/3b9d18d33342bfc933c232cc28d83dbf4e541d32)), closes [#13](https://github.com/M-Scott-Lassiter/jest-geojson/issues/13)
* split package exports into matcher and core functionality ([a7340d9](https://github.com/M-Scott-Lassiter/jest-geojson/commit/a7340d9cd0f57a207322941a6abc8a8f1524c1b0)), closes [#5](https://github.com/M-Scott-Lassiter/jest-geojson/issues/5)


### :building_construction: Build Changes

* add conventional-changelog-conventionalcommits as dev dependency ([7361d79](https://github.com/M-Scott-Lassiter/jest-geojson/commit/7361d796a713e5c19aefe5b9fb4fab07189d1089)), closes [#3](https://github.com/M-Scott-Lassiter/jest-geojson/issues/3)
* **package:** add entry points for all, boundingboxes, and coordinates ([8c1d312](https://github.com/M-Scott-Lassiter/jest-geojson/commit/8c1d312d01d2c74e969a6598e11a44a3f5255113))
* move release configuration into a separate shareable file ([fa6e50d](https://github.com/M-Scott-Lassiter/jest-geojson/commit/fa6e50d8b3facad9902d749fb69adcc45ba734fe))
* **package:** rename matcher loader entry script ([5221d6d](https://github.com/M-Scott-Lassiter/jest-geojson/commit/5221d6dc37d1aab39d950436f399d64ba7d1f436))
* setup initial project environment ([b468a41](https://github.com/M-Scott-Lassiter/jest-geojson/commit/b468a418918737be357a957e920f3a9140c7c872))
* **package:** update the commitizen config for customized scopes ([ac05626](https://github.com/M-Scott-Lassiter/jest-geojson/commit/ac05626a146717f0b7b64a7f34d5e269f593b652))
* **devDependencies:** upgrade Jest to v28.1, specify peerDependency at >v24.0.0 ([22d1614](https://github.com/M-Scott-Lassiter/jest-geojson/commit/22d1614710be25eb3d3e1a50a4b3f91bf1c08c45)), closes [#30](https://github.com/M-Scott-Lassiter/jest-geojson/issues/30)
* **package:** upgrade min required Node version to 16 ([58a9824](https://github.com/M-Scott-Lassiter/jest-geojson/commit/58a982495173d771ad309f342a45a7037fd8ad2d))
* **package:** upgrade minimum required node version from 10 to 14 to match LTS schedule ([1e8a8bb](https://github.com/M-Scott-Lassiter/jest-geojson/commit/1e8a8bb3e2c5e91b6b171d0316264c06622f4464))

## [1.0.0-beta.16](https://github.com/M-Scott-Lassiter/jest-geojson/compare/v1.0.0-beta.15...v1.0.0-beta.16) (2022-06-02)


Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jest-geojson",
"version": "1.0.0-beta.16",
"version": "1.0.0",
"description": "Additional Jest matchers for GeoJSON",
"keywords": [
"jest",
Expand Down

0 comments on commit e990fa4

Please sign in to comment.