🔖 Release v1.6.0

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.6.0] - 2024-04-27
+
 ### Added
 
 - field abbreviations to paragraph blocks that maps abbreviations to their HTML definitions
@@ -152,6 +154,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial release
 
 [Unreleased]: https://github.com/ortfo/db/compare/v1.5.0...HEAD
+[1.6.0]: https://github.com/ortfo/db/-/releases/tag/v1.6.0
 [1.5.0]: https://github.com/ortfo/db/compare/v1.4.1...v1.5.0
 [1.4.1]: https://github.com/ortfo/db/compare/v1.4.0...v1.4.1
 [1.4.0]: https://github.com/ortfo/db/compare/v1.3.0...v1.4.0
@@ -165,3 +168,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.2.0]: https://github.com/ortfo/db/releases/tag/v0.2.0
 
 [//]: # (C3-2-DKAC:GGH:Rortfo/db:Tv{t})
+
+[unreleased]: https://github.com/ortfo/db/-/compare/v1.6.0...main

README.md

@@ -31,6 +31,7 @@ Available Commands:
   completion  Generate the autocompletion script for the specified shell
   exporters   Commands related to ortfo/db exporters
   help        Help about any command
+  lsp         Start a Language Server Protocol server for ortfo
   replicate   Replicate a database directory from a built database file.
   schemas     Output JSON schemas for ortfodb's various resources
 

docs/changelog.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - errors when encountering duplicate block IDs, empty blocks and other edge cases in descriptions
 - support for `null` values in layouts. this gets rendered as a special layout cell "ghost" (see `ortfodb.EmptyLayoutCell` for the value). This is useful to add empty spaces in a grid of images, for example
 - lsp subcommand for LSP support
+- Database.FindWork to facilitate alias resolution when finding works in a database
 
 ### Changed
 

docs/commands/exporters-doc.md

@@ -15,9 +15,7 @@ ortfodb exporters doc <name> [flags]
 ```ansi
 $ ortfodb exporters help localize
 
-localize    Export separately the database as a single database for each language. The
-`content` field of each work is localized, meaning it's not an object mapping
-languages to localized content, but the content directly, in the language.
+localize    Export separately the database as a single database for each language. The `content` field of each work is localized, meaning it's not an object mapping languages to localized content, but the content directly, in the language.
             Options:
             • filename_template
 

docs/commands/global-options.md

@@ -30,6 +30,7 @@ Manage your portfolio's database — See https://github.com/ortfo/db for more in
 * [ortfodb add](add.md)	 - Add a new project to your portfolio
 * [ortfodb build](build.md)	 - Build the database
 * [ortfodb exporters](exporters.md)	 - Commands related to ortfo/db exporters
+* [ortfodb lsp](lsp.md)	 - Start a Language Server Protocol server for ortfo
 * [ortfodb replicate](replicate.md)	 - Replicate a database directory from a built database file.
 * [ortfodb schemas](schemas.md)	 - Output JSON schemas for ortfodb's various resources
 

docs/commands/lsp.md

@@ -0,0 +1,30 @@
+---
+editLink: false
+---
+
+# ortfodb lsp
+
+Start a Language Server Protocol server for ortfo
+
+```
+ortfodb lsp [flags]
+```
+
+## Options
+
+| Shorthand | Flag | Argument | Description | Default value |
+| --- | --- | --- | --- | --- |
+| -h | ‐‐help | | help for lsp 
+| | ‐‐stdio | | Used for compatibility with VSCode. Ignored (the server is always started in stdio mode) 
+
+## Options inherited from parent commands
+
+| Shorthand | Flag | Argument | Description | Default value |
+| --- | --- | --- | --- | --- |
+| -c | ‐‐config | string | config file path | ortfodb.yaml
+| | ‐‐scattered | | Operate in scattered mode. In scattered mode, the description.md files are searched inside `.ortfo' folders in every folder of the database directory, instead of directly in the database directory's folders. See https://github.com/ortfo/ 
+
+## See also
+
+* [ortfodb](global-options.md)	 - Manage your portfolio's database
+

go.mod

@@ -44,7 +44,6 @@ require (
 	github.com/atotto/clipboard v0.1.4 // indirect
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
 	github.com/bahlo/generic-list-go v0.2.0 // indirect
-	github.com/bluele/gcache v0.0.2 // indirect
 	github.com/buger/jsonparser v1.1.1 // indirect
 	github.com/catppuccin/go v0.2.0 // indirect
 	github.com/charmbracelet/bubbles v0.18.0 // indirect
@@ -67,7 +66,6 @@ require (
 	github.com/imdario/mergo v0.3.16 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
-	github.com/lithdew/quickjs v0.0.0-20200714182134-aaa42285c9d2 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-localereader v0.0.1 // indirect
@@ -104,7 +102,6 @@ require (
 
 require (
 	github.com/FurqanSoftware/goldmark-d2 v0.0.0-20240222042550-23ef2a4e585c
-	github.com/FurqanSoftware/goldmark-katex v0.0.0-20230820031700-1c400212c1e1
 	github.com/MakeNowJust/heredoc v1.0.0
 	github.com/Masterminds/sprig/v3 v3.2.3
 	github.com/PuerkitoBio/goquery v1.9.1 // indirect

go.sum

@@ -9,8 +9,6 @@ github.com/EdlinOrg/prominentcolor v1.0.0 h1:sQNY8Dtsv3PK3J1LbmrDmtlZm9Y9U8Loi1i
 github.com/EdlinOrg/prominentcolor v1.0.0/go.mod h1:mYmDsxfcmBz6izH/SqtSzfsUiZdPNPpPgUPKCZq70KQ=
 github.com/FurqanSoftware/goldmark-d2 v0.0.0-20240222042550-23ef2a4e585c h1:lkvzSLfTKUAk/tc2RLD4Ibgk3xVMxUwp9VkOVyO/+vA=
 github.com/FurqanSoftware/goldmark-d2 v0.0.0-20240222042550-23ef2a4e585c/go.mod h1:oT5hllDAs21uHEC9PKpf80k5WDraw2omGwa4pNYXb2g=
-github.com/FurqanSoftware/goldmark-katex v0.0.0-20230820031700-1c400212c1e1 h1:zm4WOvvzOeEiA47eE74RTNTi/FC5Cpw6R4fk/4hxdpc=
-github.com/FurqanSoftware/goldmark-katex v0.0.0-20230820031700-1c400212c1e1/go.mod h1:Z4lsscLMP+DMuc7k7AU0TsFRA2xQWTGhOp9zELvG1lQ=
 github.com/JohannesKaufmann/html-to-markdown v1.5.0 h1:cEAcqpxk0hUJOXEVGrgILGW76d1GpyGY7PCnAaWQyAI=
 github.com/JohannesKaufmann/html-to-markdown v1.5.0/go.mod h1:QTO/aTyEDukulzu269jY0xiHeAGsNxmuUBo2Q0hPsK8=
 github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
@@ -48,8 +46,6 @@ github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiE
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
 github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk=
 github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg=
-github.com/bluele/gcache v0.0.2 h1:WcbfdXICg7G/DGBh1PFfcirkWOQV+v077yF1pSy3DGw=
-github.com/bluele/gcache v0.0.2/go.mod h1:m15KV+ECjptwSPxKhOhQoAFQVtUFjTVkc3H8o0t/fp0=
 github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
 github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
 github.com/campoy/embedmd v1.0.0 h1:V4kI2qTJJLf4J29RzI/MAt2c3Bl4dQSYPuflzwFH2hY=
@@ -189,8 +185,6 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/lafriks/go-svg v0.4.0 h1:XgciXbad7H0js3c0Uk47dmGFJ9pCRlG7vP+mlqDEq6w=
 github.com/lafriks/go-svg v0.4.0/go.mod h1:7Qj5mwY/s5NcPAZwbjyB/V8Hlet3ZYznx3ltPac2K+s=
-github.com/lithdew/quickjs v0.0.0-20200714182134-aaa42285c9d2 h1:9o8F2Jlv6jetf9FKdseYhgv036iyW87vi9DoFd2O76s=
-github.com/lithdew/quickjs v0.0.0-20200714182134-aaa42285c9d2/go.mod h1:zkXUczDT56GViklqUXAzmvSKkGTxV2jrG/NOWqHAbT8=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=

manpages/ortfodb-add.1

@@ -43,4 +43,4 @@ Create a new project in the appropriate folder. ID is the work's slug.
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-build.1

@@ -69,4 +69,4 @@ If include-works is provided, only works that match the pattern will be included
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-exporters-doc.1

@@ -36,9 +36,7 @@ Get help for a specific exporter
 .EX
 $ ortfodb exporters help localize
 
-localize    Export separately the database as a single database for each language. The
-            `content` field of each work is localized, meaning it's not an object mapping
-            languages to localized content, but the content directly, in the language.
+localize    Export separately the database as a single database for each language. The `content` field of each work is localized, meaning it's not an object mapping languages to localized content, but the content directly, in the language.
             Options:
             • filename_template 
 
@@ -62,4 +60,4 @@ Feel free to change these configuration values. Check out the exporter's documen
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-exporters-init.1

@@ -39,4 +39,4 @@ Create a new exporter
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-exporters-list.1

@@ -39,4 +39,4 @@ List all available exporters
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-exporters.1

@@ -39,4 +39,4 @@ Commands related to ortfo/db exporters
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-lsp.1

@@ -0,0 +1,46 @@
+.nh
+.TH "ORTFODB" "1" "Apr 2024" "https://ortfo.org/db" "ortfo/db Manual"
+
+.SH NAME
+.PP
+ortfodb-lsp - Start a Language Server Protocol server for ortfo
+
+
+.SH SYNOPSIS
+.PP
+\fBortfodb lsp [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Start a Language Server Protocol server for ortfo
+
+
+.SH OPTIONS
+.PP
+\fB-h\fP, \fB--help\fP[=false]
+	help for lsp
+
+.PP
+\fB--stdio\fP[=false]
+	Used for compatibility with VSCode. Ignored (the server is always started in stdio mode)
+
+
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
+.PP
+\fB-c\fP, \fB--config\fP="ortfodb.yaml"
+	config file path
+
+.PP
+\fB--scattered\fP[=false]
+	Operate in scattered mode. In scattered mode, the description.md files are searched inside `.ortfo' folders in every folder of the database directory, instead of directly in the database directory's folders. See https://github.com/ortfo/
+
+
+.SH SEE ALSO
+.PP
+\fBortfodb(1)\fP
+
+
+.SH HISTORY
+.PP
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-replicate.1

@@ -53,4 +53,4 @@ Example: ortfodb replicate ./database.json ./replicated-database/
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb-schemas.1

@@ -47,4 +47,4 @@ Output the JSON schema for:
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra

manpages/ortfodb.1

@@ -40,9 +40,9 @@ Manage your portfolio's database — See https://github.com/ortfo/db for more in
 
 .SH SEE ALSO
 .PP
-\fBortfodb-add(1)\fP, \fBortfodb-build(1)\fP, \fBortfodb-exporters(1)\fP, \fBortfodb-replicate(1)\fP, \fBortfodb-schemas(1)\fP
+\fBortfodb-add(1)\fP, \fBortfodb-build(1)\fP, \fBortfodb-exporters(1)\fP, \fBortfodb-lsp(1)\fP, \fBortfodb-replicate(1)\fP, \fBortfodb-schemas(1)\fP
 
 
 .SH HISTORY
 .PP
-22-Apr-2024 Auto generated by spf13/cobra
+27-Apr-2024 Auto generated by spf13/cobra