Skip to content

v2.0.0

Choose a tag to compare

View all tags
@robinglen robinglen released this 14 Sep 15:53
· 1 commit to 7a27c809e4b7fb0a5a4ac855f7fc0eab7a3ce36b since this release
v2.0.0
ec115dc

2.0.0 new functionality and breaking changes

Bookworms now has support for interpolation of bookmarks YAML.

What does that mean?
Now whenever loading of bookmarks if parses them as a template.This adds the ability to load and deep nest other bookmarks within your main bookmarks YAML. See interpolating bookmarks for a full breakdown but basically you can now nest YAML files within your main bookmarks file.

label: Interpolated bookmarks
description: This is an example of interpolating YAML files
folders:
  -
    {{ get './my-bookmarks.yaml' '    '}}
  -
    {{ get 'https://raw.githubusercontent.com/thearegee/bookworms/main/demo/config/bookmarks-for-merging.yaml' '    '}}

Why would you want to do this?
For myself personally I work with multiple companies and teams as well as having my own personal bookmarks YAML files. The merge command was ok but I wanted to be able to deep nest different files within different folders which that could not support.

Why is this a major version?
The function fetchBookmarkConfig(path, asYAML) previously always returned JSON but for the new interpolation I wanted it to be able to return YAML. While this change is backwards compatible some of the functions within loadBookmarks had to change to support this. As this broke the contract of what is returned this made for a major change in the library.

Full Changelog: v1.3.3...v2.0.0

Assets 2
Loading