@metalsmith/collections
Version:
A Metalsmith plugin that adds collections of files to the global metadata.
71 lines (48 loc) • 5.89 kB
Markdown
### Changelog
All notable changes to this project will be documented in this file. Dates are displayed in UTC.
Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
#### [v2.0.0](https://github.com/metalsmith/collections/compare/v1.3.1...v2.0.0)
- Closes #98: adds 'first' & 'last' references when refer:true [`#98`](https://github.com/metalsmith/collections/issues/98)
- BREAKING: Closes #101: condenses sortBy, reverse into sort option. Renames filterBy option to filter. [`#101`](https://github.com/metalsmith/collections/issues/101)
- Updates README.md, fixes ESLint issues, versions build to allow npm installing from repo [`f9da8e4`](https://github.com/metalsmith/collections/commit/f9da8e4d3952c3452fbef52cdc5951bd4e48b9f6)
- BREAKING: references (previous, next,..) are set on file.collection[name][previous/next] as arrays [`8c7d9d6`](https://github.com/metalsmith/collections/commit/8c7d9d68fa5b48f314707a3d29075438a8cb43f2)
- BREAKING: collections are only available via metalsmith.metadata().collections [`e8e2760`](https://github.com/metalsmith/collections/commit/e8e2760e72b06211f8d5f9f11296a82efe8efc4f)
- Require metalsmith > 2.6.0 & use metalsmith.matter instead of removed dependency read-metadata [`c0748fa`](https://github.com/metalsmith/collections/commit/c0748fa69c55456c39214121998719b01a695064)
- BREAKING: collection metadata can only be added from in-source files [`df507d6`](https://github.com/metalsmith/collections/commit/df507d6b20d9a44215dc34e3c3ce25517032c66f)
- BREAKING: Make metadata accessible from Collection array instead of '.metadata' property [`42f45c8`](https://github.com/metalsmith/collections/commit/42f45c876946f66578e770c38c3b0ac7b1a247ac)
- BREAKING: Adds 'path' property to sorting context, and changes the default sorting to path:asc [`64b5f72`](https://github.com/metalsmith/collections/commit/64b5f7203ec0afa3c9c76e29af277b4e91b61738)
- Drops support for Node < 14.14.0, updates CI, drops Gitter notification [`36eb59d`](https://github.com/metalsmith/collections/commit/36eb59daf06e35f748b3c9872e77f1ee947e63e7)
- BREAKING: no longer sets 'file.path' property [`df26510`](https://github.com/metalsmith/collections/commit/df26510b210ae2731295ff4f733c4550e32e741c)
- Better documentation for sorting + typescript [`1d3f81e`](https://github.com/metalsmith/collections/commit/1d3f81e5997375673c49efcbb5f4e7a7408068b5)
#### [v1.3.1](https://github.com/metalsmith/collections/compare/v1.3.0...v1.3.1)
> 26 November 2024
- Fix: make all option properties optional [`b85b6cf`](https://github.com/metalsmith/collections/commit/b85b6cf75f949188191415147338ae28c5b9fbac)
- Renames default export to collections for better intellisense [`61ec7f9`](https://github.com/metalsmith/collections/commit/61ec7f93fe4fac2112909b4fee233507affe05a2)
- Includes sourcemap for better stack traces [`b5b8059`](https://github.com/metalsmith/collections/commit/b5b80597cf821b3c478b864ddf5739d60aadce0d)
- Fix: conditional exports types [`e8bb72a`](https://github.com/metalsmith/collections/commit/e8bb72ac22298324669b3e7b45d7177c88b13c2a)
#### [v1.3.0](https://github.com/metalsmith/collections/compare/v1.2.2...v1.3.0)
> 27 September 2022
- Provides dual ESM/CJS bundle [`61430d4`](https://github.com/metalsmith/collections/commit/61430d489ae87df1276f61de8aad2755c0491cc9)
- switched debugger to metalsmith.debug [`8df9e65`](https://github.com/metalsmith/collections/commit/8df9e65b6b03f4c3d96a81d477a21d69aeafadbf)
- Adds Typescript types support [`9f9b36c`](https://github.com/metalsmith/collections/commit/9f9b36ca569153ad84be89facdc6a2630e86a6af)
#### [v1.2.2](https://github.com/metalsmith/collections/compare/v1.2.1...v1.2.2)
> 28 July 2022
- Resolves #102: remove multimatch, use metalsmith.match [`#102`](https://github.com/metalsmith/collections/issues/102)
- Drops support for Node < 12 [`6a7271c`](https://github.com/metalsmith/collections/commit/6a7271c9a170e88ae91e1d05e2f7162606566f3f)
#### [v1.2.1](https://github.com/metalsmith/collections/compare/v1.2.0...v1.2.1)
> 3 February 2022
- Closes #27 by adding a test for repeat builds [`#27`](https://github.com/metalsmith/collections/issues/27)
- Fixes incorrect next and previous references [`665de09`](https://github.com/metalsmith/collections/commit/665de091b3bbb7b74741d15e17e471ae225ba2ec)
- Fixes collection property on files and adds test: no dupes, no nested arrays (#99) [`727769d`](https://github.com/metalsmith/collections/commit/727769d95464e61739523538006cb863220cfae6)
#### [v1.2.0](https://github.com/metalsmith/collections/compare/v1.1.0...v1.2.0)
> 29 January 2022
- feat: refactor, clean code, remove redundant dependencies, add tests [`d481b92`](https://github.com/metalsmith/collections/commit/d481b927b6137df81e8fc71de99c1277f6a131c2)
- docs: update README, prepare changelog for v1.2 [`c004ed0`](https://github.com/metalsmith/collections/commit/c004ed00216145f3cfa82042ab9243e42c23edb3)
- [skip travis] dev: fix readme badges [`87e4d37`](https://github.com/metalsmith/collections/commit/87e4d370530065a790c0b077d820fcc47bd6594c)
#### [v1.1.0](https://github.com/metalsmith/collections/compare/v1.0.0...v1.1.0)
> 15 December 2021
- Added standardised code formatting and QA [`#86`](https://github.com/metalsmith/collections/pull/86)
- Updated History with v1 PRs [`#85`](https://github.com/metalsmith/collections/pull/85)
- Aligned dotfiles & repo files with core plugins. Added LICENSE, updated devDependencies [`0f2480b`](https://github.com/metalsmith/collections/commit/0f2480b4c2baa22268229ad3d686fb9e21773602)
- Updated multimatch to 4.0.0, debug to 4.3.3 [`71d6f65`](https://github.com/metalsmith/collections/commit/71d6f65b9ec5572196e17dfebf5cff2361853f9d)
- Added better JSDoc types, return named plugin function [`3aa3443`](https://github.com/metalsmith/collections/commit/3aa3443802c2f814c90cf39c7b43de8fc3d3ff13)