diff --git a/.forgejo/workflows/release.yaml b/.forgejo/workflows/release.yaml index 9722d9e..1282205 100644 --- a/.forgejo/workflows/release.yaml +++ b/.forgejo/workflows/release.yaml @@ -69,8 +69,8 @@ jobs: cd _site netlify deploy --dir docs --prod - 'Release': - needs: Build + 'Release MacOS': +# needs: Build runs-on: macos steps: - name: Checkout @@ -90,7 +90,7 @@ jobs: go install github.com/goreleaser/goreleaser/v2@v2.12.7 - name: Release run: | - goreleaser release -f goreleaser.yml --skip=validate --clean + goreleaser release -f macos.goreleaser.yml --skip=validate --clean env: GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }} HOMEBREW_TAP_PRIVATE_KEY: ${{ secrets.HOMEBREW_TAP_PRIVATE_KEY }} @@ -99,3 +99,26 @@ jobs: MACOS_NOTARY_KEY: ${{ secrets.MACOS_NOTARY_KEY }} MACOS_NOTARY_KEY_ID: ${{ secrets.MACOS_NOTARY_KEY_ID }} MACOS_NOTARY_ISSUER_ID: ${{ secrets.MACOS_NOTARY_ISSUER_ID }} + +# release-linux: +# needs: build +# runs-on: ubuntu-latest +# steps: +# - name: Checkout +# uses: actions/checkout@v2 +# - name: Setup Go +# uses: actions/setup-go@v3 +# with: +# go-version: 1.22 +# - name: Configure +# run: | +# git config --global url."https://${{ secrets.GO_MODULES_TOKEN }}:x-oauth-basic@github.com/lmika".insteadOf "https://github.com/lmika" +# - name: Release +# uses: goreleaser/goreleaser-action@v1 +# if: startsWith(github.ref, 'refs/tags/') +# with: +# version: latest +# args: release -f linux.goreleaser.yml --skip=validate --clean +# env: +# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +# HOMEBREW_GITHUB_TOKEN: ${{ secrets.HOMEBREW_GITHUB_TOKEN }} \ No newline at end of file diff --git a/_site/.gitignore b/_site/.gitignore deleted file mode 100644 index 5a35c8d..0000000 --- a/_site/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -docs/ -node_modules/ -resources/ -themes/ \ No newline at end of file diff --git a/_site/.hugo_build.lock b/_site/.hugo_build.lock deleted file mode 100644 index e69de29..0000000 diff --git a/_site/content/_index.md b/_site/content/_index.md index ef82dc1..d68fcc7 100644 --- a/_site/content/_index.md +++ b/_site/content/_index.md @@ -1,6 +1,7 @@ ---- -weight: 10 ---- ++++ +title = "Dynamo-Browse" +bookToc = false ++++
@@ -16,31 +17,15 @@ With it, you can quickly connect to and browse the contents of a DynamoDB table in your AWS account or local machine. There are some basic facilities for editing as well. + + ## Getting Started +Instructions for installing Dynamo-Browse can be found on the [Downloads page](/download). + This video gives a brief introduction of how to use Dynamo-Browse to view the items of a DynamoDB table: {{< youtube cQnTIg1_tfg >}} More information about the tool can be found within the [Dynamo-Browse user manual](/docs). -## Download - -Binary packages for MacOS and Linux can be [found at Forgejo](https://lmika.dev/cmd/dynamo-browse/releases). - -### MacOS Using Homebrew - -If you have Homebrew, you can install Dynamo-Browse using the following command: - -``` -brew tap lmika/dynamo-browse https://lmika.dev/casks/dynamo-browse -brew install dynamo-browse -``` - -### Go - -If you have Go installed, you can install Dynamo-Browse using the following command: - -``` -go install lmika.dev/cmd/dynamo-browse/cmd/dynamo-browse@latest -``` diff --git a/_site/content/docs/_index.md b/_site/content/docs/_index.md new file mode 100644 index 0000000..ee4c39b --- /dev/null +++ b/_site/content/docs/_index.md @@ -0,0 +1,35 @@ +# User Guide + +## Table Of Contents + +- [Launching and Quitting](/docs/launching) + - [Selecting a Table](/docs/launching#selecting-a-table) + - [Selecting a Workspace](/docs/launching#selecting-a-workspace) + - [Quitting](/docs/launching#quitting) +- [Getting Around](/docs/getting-around) + - [The Back-stack](/docs/getting-around#the-back-stack) + - [Adjusting The Layout](/docs/getting-around#adjusting-the-layout) + - [Adjusting The Displayed Columns](/docs/getting-around#adjusting-the-displayed-columns) + - [Entering Commands](/docs/getting-around#entering-commands) +- [Filtering and Querying](/docs/filtering-querying) + - [Filtering](/docs/filtering-querying#filtering) + - [Querying](/docs/filtering-querying#querying) +- [Editing Items](/docs/editing-items) + - [Marking Items](/docs/editing-items#marking-items) + - [Modifying Attributes](/docs/editing-items#modifying-attributes) + - [Deleting Attributes](/docs/editing-items#deleting-attributes) + - [Adding Items](/docs/editing-items#adding-items) + - [Deleting Items](/docs/editing-items#deleting-items) + - [Committing Changes](/docs/editing-items#committing-changes) + - [Backing Out of Changes](/docs/editing-items#backing-out-of-changes) +- [Customising Dynamo-Browse](/docs/customising) + - [The RC File](/docs/customising#rc-file) + - [Rebinding Keys](/docs/customising#rebinding-keys) + +References + +- [Key Bindings](/docs/reference/key-bindings) +- [Commands](/docs/reference/commands) +- [Query Expressions](/docs/reference/query-expressions) +- [Launch Flags](/docs/reference/launch-flags) +- [Settings](/docs/reference/settings) diff --git a/_site/content/docs/user-guide/customising.md b/_site/content/docs/customising.md similarity index 53% rename from _site/content/docs/user-guide/customising.md rename to _site/content/docs/customising.md index 879ab82..34e4a3a 100644 --- a/_site/content/docs/user-guide/customising.md +++ b/_site/content/docs/customising.md @@ -1,24 +1,22 @@ ---- -title: Customising Dynamo-Browse -weight: 50 ---- # Customising Dynamo-Browse Some commands can be used to customise Dynamo-Browse, such as modify key bindings. The effect of these commands will only be applied for the duration of the session: they are currently not -tracked within the workspace file. To keep customisations across relaunches, these commands +tracked within the workspace file. So in order to keep customisations across relaunches, these commands can be added to an RC file. -## RC Files +## The RC File -RC files are text files containing commands that will be executed by Dynamo-Browse upon launch. -By default, RC files are located in `$HOME/.config/dynamo-browse/` and have the suffix `.ucl`. For example: +The RC file is a text file containing commands that will be executed by Dynamo-Browse upon launch. +By default, the RC file is located at the following path: ``` -$HOME/.config/dynamo-browse/init.ucl +$HOME/.config/audax/dynamo-browse/init.rc ``` -Any number of RC files can be present in this directory, and they are executed in lexicographical order. +This file is primarily intended for commands that customise Dynamo-Browse in a particular way, but any +command can be entered here. If this file is found, Dynamo-Browse will invoke each command before loading +or prompting the table. ## Rebinding Keys @@ -40,11 +38,4 @@ At the moment each binding name can only be mapped to a single key. It's also c to setup bindings for commands. These may be supported in the future. A list of available binding names can be found the the [reference](/docs/reference/key-bindings) -(check the "Show binding names" checkbox). Note that some bindings may not have default key bindings. - -## Extensions - -The RC files are primarily intended for commands that customise Dynamo-Browse in a particular way, but any -command can be entered here, including those for defining new commands or running predefined queries. These -are generally known as extensions, although act as any other RC file located within that directory. More -information on extensions can be found in the [reference](/docs/reference/script-api). \ No newline at end of file +(check the "Show binding names" checkbox). Note that some bindings may not have default key bindings. \ No newline at end of file diff --git a/_site/content/docs/user-guide/editing-items.md b/_site/content/docs/editing-items.md similarity index 98% rename from _site/content/docs/user-guide/editing-items.md rename to _site/content/docs/editing-items.md index d58d70e..e7d38b0 100644 --- a/_site/content/docs/user-guide/editing-items.md +++ b/_site/content/docs/editing-items.md @@ -1,7 +1,3 @@ ---- -title: Editing Items -weight: 40 ---- # Editing Items Dynamo-Browse offers some basic facilities for editing items — such as creating items, deleting items, diff --git a/_site/content/docs/user-guide/filtering-querying.md b/_site/content/docs/filtering-querying.md similarity index 59% rename from _site/content/docs/user-guide/filtering-querying.md rename to _site/content/docs/filtering-querying.md index 1cf0a09..87096cd 100644 --- a/_site/content/docs/user-guide/filtering-querying.md +++ b/_site/content/docs/filtering-querying.md @@ -1,8 +1,4 @@ ---- -title: Querying and Filtering Results -weight: 30 ---- -# Querying and Filtering Results +# Querying And Viewing Results ## Querying @@ -12,24 +8,7 @@ weight: 30 A query or scan over the table can be performed by entering a _Query Expression_. Query expressions are a built-in expression language which translates to either a DynamoDB query -or scan, depending on the expression. - -Query expressions are entered as expressions, with most being of the form `attribute operator value`. -For example, the expression for selecting records where `color` equals `red` is: - -``` -color = "red" -``` - -The `color` attribute can either be a partition key, sort key, or a regular attribute. Dynamo Browse -will do it's best to run the query as a DynamoDB query if possible. Usually query expressions of the -form `pk = ` or `pk = and sk ` where `pk` is a partition key, -`sk` is the sort key, and `` is one of the [equality](/docs/reference/query-expressions/#equality), -[numerical comparison](/docs/reference/query-expressions/#numerical-comparison), or -[prefix operator](/docs/reference/query-expressions/#prefix-operator), will be executed as queries. -Other expressions will be executed as scans. - -Details about the Query Expression language can be found in the +or scan, depending on the expression. Details about the Query Expression language can be found in the [Query Expressions references](/docs/reference/query-expressions/). To run a query, press ?, and enter the query expression. diff --git a/_site/content/docs/user-guide/getting-around.md b/_site/content/docs/getting-around.md similarity index 98% rename from _site/content/docs/user-guide/getting-around.md rename to _site/content/docs/getting-around.md index 6266ec7..c899947 100644 --- a/_site/content/docs/user-guide/getting-around.md +++ b/_site/content/docs/getting-around.md @@ -1,7 +1,3 @@ ---- -title: Getting Around -weight: 20 ---- # Getting Around After selecting a table, Dynamo-Browse will perform a scan and present the results in the default view mode. diff --git a/_site/content/docs/user-guide/launching.md b/_site/content/docs/launching.md similarity index 94% rename from _site/content/docs/user-guide/launching.md rename to _site/content/docs/launching.md index bc83d24..26f169e 100644 --- a/_site/content/docs/user-guide/launching.md +++ b/_site/content/docs/launching.md @@ -1,8 +1,4 @@ ---- -title: Launching and Quitting -weight: 10 ---- -# Launching and Quitting +# Launching And Quitting To launch Dynamo-Browse, run the following command at the terminal: diff --git a/_site/content/docs/reference/_index.md b/_site/content/docs/reference/_index.md deleted file mode 100644 index 782a9c6..0000000 --- a/_site/content/docs/reference/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -bookFlatSection: true -weight: 40 ---- \ No newline at end of file diff --git a/_site/content/docs/reference/commands.md b/_site/content/docs/reference/commands.md index 466ebca..2a9d407 100644 --- a/_site/content/docs/reference/commands.md +++ b/_site/content/docs/reference/commands.md @@ -1,12 +1,5 @@ ---- -title: Commands -weight: 20 ---- # Commands -These commands are meant for general, interactive use. For additional commands meant for defining -extensions, see [Extensions](/docs/reference/extensions/). - ## clone ``` @@ -47,7 +40,7 @@ Displays _message_ in the status bar. Mainly used for debugging. ## export ``` -:export [-all] +:export [-all] ``` Writes the currently loaded items as a CSV file to _filename_. @@ -112,7 +105,7 @@ Quits Dynamo-Browse. Rebinds the action with _bindingName_ to _key_. This will replace any existing binding for that action. See [Key Bindings](#key-bindings) with "Show binding names" checked to see available binding names. -## set-opt +## set ``` :set [value] @@ -123,7 +116,7 @@ Set the value of a setting. Flag setting types can be enabled without any value ## set-attr ``` -:set-attr [type] +:set-attr [type] ``` Alias: `sa` diff --git a/_site/content/docs/reference/extensions.md b/_site/content/docs/reference/extensions.md deleted file mode 100644 index 05e4bd6..0000000 --- a/_site/content/docs/reference/extensions.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Extensions" -type: script-api -weight: 60 -draft: true ---- -# Extensions \ No newline at end of file diff --git a/_site/content/docs/reference/key-bindings.md b/_site/content/docs/reference/key-bindings.md index f74a9e1..84d7230 100644 --- a/_site/content/docs/reference/key-bindings.md +++ b/_site/content/docs/reference/key-bindings.md @@ -1,7 +1,3 @@ ---- -title: Key Bindings -weight: 10 ---- # Key Bindings
diff --git a/_site/content/docs/reference/launch-flags.md b/_site/content/docs/reference/launch-flags.md index 4a71e34..145d8fd 100644 --- a/_site/content/docs/reference/launch-flags.md +++ b/_site/content/docs/reference/launch-flags.md @@ -1,7 +1,3 @@ ---- -title: Launch Flags -weight: 40 ---- # Launch Flags ## -debug diff --git a/_site/content/docs/reference/query-expressions.md b/_site/content/docs/reference/query-expressions.md index 9deff89..cf0b128 100644 --- a/_site/content/docs/reference/query-expressions.md +++ b/_site/content/docs/reference/query-expressions.md @@ -1,7 +1,3 @@ ---- -title: Query Expressions -weight: 30 ---- # Query Expression Query expressions are used to select rows of a table. When executed as a query (i.e. by pressing ?), diff --git a/_site/content/docs/reference/script-api.md b/_site/content/docs/reference/script-api.md new file mode 100644 index 0000000..90fbeb6 --- /dev/null +++ b/_site/content/docs/reference/script-api.md @@ -0,0 +1,5 @@ +--- +title: "Script API" +type: script-api +--- +# Script API \ No newline at end of file diff --git a/_site/content/docs/reference/settings.md b/_site/content/docs/reference/settings.md index 0fd0d05..5eea365 100644 --- a/_site/content/docs/reference/settings.md +++ b/_site/content/docs/reference/settings.md @@ -1,7 +1,3 @@ ---- -title: Settings -weight: 50 ---- # Settings ## default-limit diff --git a/_site/content/docs/scripting.md b/_site/content/docs/scripting.md new file mode 100644 index 0000000..5bd6ba5 --- /dev/null +++ b/_site/content/docs/scripting.md @@ -0,0 +1,103 @@ +--- +title: "Scripting" +--- +# Scripting + +Scripts can be used to automate certain tasks with Dynamo-Browse. They can also be used to define +new commands or key bindings. + +## Scripting Basics + +Dynamo-Browse scripts are written using the [Tamarin](https://cloudcmds.github.io/tamarin/) scripting language, +which looks a lot like [Go](https://go.dev). All features of the language are available in Dynamo-Browse. + +The typical "hello world" script for Dynamo-Browse is below: + +``` +ui.print("Hello, world") +``` + +This uses the [ui](/docs/reference/script-api/#module-ui) package, which is the package used to interact with +the Dynamo-Browse user interface. +A full list of supported packages can be found in the [Script API](/docs/reference/script-api/) reference, along +with the builtins and packages supported by Tamarin itself. + +{{}} + **Note:** the [ext](/docs/reference/script-api/#module-ext) package is only available to Extension Scripts. +{{}} + +To execute this script, use the `run-script` command: + +``` +run-script /path/to/script/hello.tm +``` + +You'll see that the message "Hello, world" will appear in the status bar of Dynamo-Browse. + + + +Any `print` or `printf` messages will be written to the debug log with the prefix `script `. The +debug log is turned off by default, but it can be enabled using the [-debug](/docs/reference/launch-flags/#-debug) flag on launch. + +Scripts loaded using the `run-script` command are for ad-hoc automation tasks that are not necessarily designed for +repeated use. These ad-hoc scripts are executed, then immediately unloaded, and are not generally allowed to extend +Dynamo-Browse. In order to do so, you will need to write an Extension Script. + +## Extension Scripts + +Extension scripts are scripts designed to extend Dynamo-Browse in some way, such as with new commands or key bindings. +They are traditionally loaded on startup and exist in the predefined "script" directory. They are usually designed for +repeated operations, including those that can be bound to command name or keys. + +The following is an example script which will define a "goto" command. When invoked, the script will prompt the +user for the value of the partition key. It will then perform a query over the currently viewed table for any rows with +that partition key. If no error occurred, the results of the query will be shown to the user. + +``` +// Define a new "goto" command, which can be invoked when the user presses ':' and types in 'goto' +ext.command("goto", func() { + // Use the information of the current table to get the name of the partition key. + pkName := session.current_table().keys["partition"] + + // Prompt the user for the value to go to. The user can press Esc, which will cancel + // the input and return 'nil'. + keyVal := ui.prompt(pkName + "? ") + if keyVal == nil { + return nil + } + + // Run a query over the DynamoDB table for any rows with the partition key. Notice + // the use of the 'args' option, and the presence of both the name prefix (':key') + // and value prefix ('$val'). + res := session.query(":key = $val", { + args: { + key: pkName, + val: keyVal, + }, + }) + + // The query method will return either an error or a result. If it's an error, print + // a notice and exist. + if res.is_err() { + ui.print("Can't goto: " + res.err_msg()) + return nil + } + + // If no error, unwrap the result object to get the result-set returned from the query. + // Then change the current result-set to this one. This will change the result-set the + // user is currently seeing. + session.set_result_set(res.unwrap()) +}) +``` + +To load an extension script, use the `load-script` command: + +``` +load-script script.tm +``` + +The script must exist in the "script" directory, which by default is: + +``` +$HOME/.config/audax/dynamo-browse/scripts +``` diff --git a/_site/content/docs/user-guide/_index.md b/_site/content/docs/user-guide/_index.md deleted file mode 100644 index bee53f3..0000000 --- a/_site/content/docs/user-guide/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -bookFlatSection: true -weight: 30 ---- \ No newline at end of file diff --git a/_site/content/download.md b/_site/content/download.md index dc1deca..3fc727d 100644 --- a/_site/content/download.md +++ b/_site/content/download.md @@ -1,8 +1,19 @@ ---- -weight: 20 ---- ++++ +layout = "single" ++++ +# Download +Binary packages can be [download from GitHub](https://github.com/lmika/audax/releases/latest). + +## MacOS Using Homebrew + +If you have Homebrew, you can install using the following command: + +``` +brew tap lmika/audax +brew install audax +``` ## Linux diff --git a/_site/content/menu/index.md b/_site/content/menu/index.md new file mode 100644 index 0000000..564161c --- /dev/null +++ b/_site/content/menu/index.md @@ -0,0 +1,25 @@ ++++ +headless = true ++++ +- [Download]({{< relref "/download" >}}) +- [Releases](https://github.com/lmika/audax/releases) +- [Github](https://github.com/lmika/audax) +
+ +[**User Guide**]({{< relref "/docs" >}}) +- [Launching]({{< relref "/docs/launching" >}}) +- [Getting Around]({{< relref "/docs/getting-around" >}}) +- [Filtering And Querying]({{< relref "/docs/filtering-querying" >}}) +- [Editing Items]({{< relref "/docs/editing-items" >}}) +- [Customising]({{< relref "/docs/customising" >}}) +- [Scripting]({{< relref "/docs/scripting" >}}) +
+ +**References** +- [Key Bindings]({{< relref "/docs/reference/key-bindings" >}}) +- [Commands]({{< relref "/docs/reference/commands" >}}) +- [Query Expressions]({{< relref "/docs/reference/query-expressions" >}}) +- [Launch Flags]({{< relref "/docs/reference/launch-flags" >}}) +- [Settings]({{< relref "/docs/reference/settings" >}}) +- [Script API]({{< relref "/docs/reference/script-api" >}}) +
\ No newline at end of file diff --git a/_site/data/scriptmods/async.yaml b/_site/data/scriptmods/async.yaml deleted file mode 100644 index d521ab6..0000000 --- a/_site/data/scriptmods/async.yaml +++ /dev/null @@ -1,40 +0,0 @@ -module: async -docs: | - Provides commands for executing blocks asynchronously. - - Asynchronous blocks are executed in the same thread as regular commands, so it's recommended - to avoid long running operations in these blocks. Exception to these are commands which require fetching - data from the database. -symbols: - - name: do - syntax: async:do BLOCK - docs: | - Schedules a block to be executed at the conclusion of all other running commands. - Blocks are place in a queue in the order the call to `async:do` is made, with a maximum - queue size of 100 blocks. If the queue is full, the command will return an error. - example: | - async:do { - echo "World" - } - echo "Hello" - - name: in - syntax: async:in SECONDS BLOCK - docs: | - Schedules a block to be executed in SECONDS seconds. Once the timout has ellapsed, the block will - be placed on the queue and will be executed once all other pending blocks have been consumed. - example: | - async:in 5 { - echo "5 seconds have ellapsed" - } - - name: query - syntax: async:query EXPRESSION [QUERY_ARGS] BLOCK [OPTIONS] - docs: | - Executes the query in the background and schedules BLOCK once the resultset is available. The available - options match that of rs:query. - - Note: the RC files are invoked before the table picker is shown, so any async:query calls invoked during - startup should have the `-table` option set. - example: | - async:query 'pk = $arg' [arg:"abc123"] { |rs| - echo $rs.First.pk - } diff --git a/_site/data/scriptmods/av.yaml b/_site/data/scriptmods/av.yaml deleted file mode 100644 index cf98916..0000000 --- a/_site/data/scriptmods/av.yaml +++ /dev/null @@ -1,22 +0,0 @@ -module: av -docs: | - Provides commands for translating between UCL and DynamoDB types. -symbols: - - name: 'true' - syntax: av:true - docs: | - Returns a true BOOL attribute value. - - name: 'false' - syntax: av:false - docs: | - Returns a false BOOL attribute value. - - name: 'null' - syntax: av:null - docs: | - Returns a NULL attribute value. - - name: string-set - syntax: av:string-set LIST - docs: | - Converts a list into a string set (SS) attribute value. - example: | - av:string-set [apple banana cherry] diff --git a/_site/data/scriptmods/ext.yaml b/_site/data/scriptmods/ext.yaml new file mode 100644 index 0000000..95c20a5 --- /dev/null +++ b/_site/data/scriptmods/ext.yaml @@ -0,0 +1,75 @@ +module: ext +docs: | + Provides access to the extension points scripts can used to extend the functionality of Dynamo-Browse. + + This module is only available for scripts loaded using the [load-script]() command. +symbols: + - name: command + syntax: ext.command(name, fn) + docs: | + Defines a new command, which can be invoked by entering _name_ within the main view mode. + The parameter _fn_ must be a function, which will be executed when the _name_ command is entered + while in view mode. + + The command can accept arguments, which will be passed in to the parameters of _fn_. The number + of command arguments must match the number of parameters, except for any function arguments with + a default value. + example: | + ext.command("add", func(x, y) { + sum := x + y + ui.print("x + y = ", sum) + }) + - name: related_items + syntax: ext.related_items(table, fn) + docs: | + Defines a "related item" for a table. These act as quick jumps between tables. + When the user presses Shift+O, all the related item functions that match the given + table will be evaluated. Each one is to return zero or more related queries, which are presented + to the user as a list. When the user selects one, the query will be evaluated and the result set will + be shown. + + The _table_ parameter is the name of the table of the related items managed by this function. + If the last character of the table is `*`, then _table_ will be treated as a name prefix. + + The _fn_ will produce a list of queries that are related to a given item. The function takes the currently + selected item as the argument, and is expected to produce a list of maps, with each map having the following + fields: + + - `label`: The label to use for the picker option + - `query`: The query expression that will run when the option is chosen + - `table`: The table to run the query over. If not set, the current table will be used + - `args`: A map of query placeholder values + - `on_select`: An optional function that will run in place of a predefined query. If set, the `query` field will + be ignored. + example: | + ext.related_items("user-account", func(item) { + return [ + { + "label": "Customer", + "table": "billing", + "query": "email=$email", + "args": {"email": item.attr("email")}, + }, + ] + }) + - name: key_binding + syntax: ext.key_binding(name, options, fn) + docs: | + Defines a new key binding, which can be invoked while viewing the table. + + The _name_ parameter defines the binding name. The binding names will be prefixed with + `ext.`. This name can be used with the [rebind]() command. + + The _option_ parameter defines a map of options. The only valid option is + `default`, which is the default key to use for this binding. If unset, the binding will + have no key binding and can only be bound using the [rebind]() command. + + The _fn_ parameter is the function that will be invoked when the key is pressed. + It must accept no parameters. + example: | + // Script name: sayhello.tm + // + // This binding can be rebound with the command "rebind ext.sayhello.hello " + ext.key_binding("hello", {"default": "H"}, func() { + ui.print("Hello") + }) \ No newline at end of file diff --git a/_site/data/scriptmods/opt.yaml b/_site/data/scriptmods/opt.yaml deleted file mode 100644 index 3744323..0000000 --- a/_site/data/scriptmods/opt.yaml +++ /dev/null @@ -1,9 +0,0 @@ -module: opt -docs: | - Provides commands for modifying options. -symbols: - - name: 'set' - syntax: opt:set NAME [VALUE] - docs: | - Returns the current value of the setting option NAME. If VALUE is present, modifies the setting option first before - returning the value. \ No newline at end of file diff --git a/_site/data/scriptmods/pb.yaml b/_site/data/scriptmods/pb.yaml deleted file mode 100644 index e9cbc29..0000000 --- a/_site/data/scriptmods/pb.yaml +++ /dev/null @@ -1,14 +0,0 @@ -module: pb -docs: | - Provides access to the pasteboard. -symbols: - - name: 'paste' - syntax: pb:paste - docs: | - Returns the current text value of the paste board. If the paste board contains no text value, - or is unavailable, returns the empty string. - - name: 'copy' - syntax: pb:copy VALUE - docs: | - Sets the current text value of the paste board to VALUE. If the paste board is unavailable, this - command nops. \ No newline at end of file diff --git a/_site/data/scriptmods/resultset.yaml b/_site/data/scriptmods/resultset.yaml index f002137..a839e58 100644 --- a/_site/data/scriptmods/resultset.yaml +++ b/_site/data/scriptmods/resultset.yaml @@ -3,25 +3,18 @@ type: type docs: | Holds a collection of items returned from a query, or presented to a user. - A specific item of a result-set can be retrived using the subscript option. For example, `$result.(21)` will - return the 21st item of the result-set from the first item. + A specific item of a result-set can be retrived using the subscript option. For example, `result[21]` will + return the 21st item of the result-set from the first item. A negative index can be used to retrieve an + item from the last item. There is no guarantee to the ordering of items within the result-set, although items are usually ordered based on the partition and sort key. symbols: - - name: Items - syntax: '$resultset.Items' + - name: length + syntax: resultset.length docs: | - Returns the items within the result set. - - name: HasNextPage - syntax: '$resultset.HasNextPage' - docs: | - Returns true if this result-set has another page. The next page can be retrieved by calling `rs:next-page $resultset`. - - name: First - syntax: '$resultset.First' - docs: | - Returns the first item of the result-set, or nil if the result set is empty. Shorthand for `$result.Items.(0)`. - - name: Table - syntax: '$resultset.Table' + Returns the number of items within the result set. + - name: table + syntax: resultset.table docs: | Returns information about the table this result set belongs to. \ No newline at end of file diff --git a/_site/data/scriptmods/rs.yaml b/_site/data/scriptmods/rs.yaml deleted file mode 100644 index 052865f..0000000 --- a/_site/data/scriptmods/rs.yaml +++ /dev/null @@ -1,37 +0,0 @@ -module: rs -docs: | - Provides operations over result-sets, or commands which return result-sets. -symbols: - - name: new - syntax: rs:new [-table TABLE] - docs: | - Creates a new, empty result-set. If -table is specific, will configure the result-set table to - that of TABLE. Otherwise, the result-set will inherit the current table. - - name: query - syntax: rs:query EXPRESSION [ARGUMENTS] [-table TABLE] - docs: | - Invokes a query expression and returns the result as a result-set. The query can be invoked with - ARGUMENTS, which must be a dictionary with key/value pairs that are made available to the query - as either attribute placeholders (`:attr`), or value placeholders (`$value`). - - If -table is specific, will run the query over TABLE. Otherwise, the query will be invoked - over the current table. - - Note that this command blocks the command thread until either the results are available, or if - an error occurs. To avoid this, use 'async:query', which will run the query in the background. - example: | - results = rs:query 'pk = $myID' [myID:"abc132"] -table users - - name: scan - syntax: rs:scan [-table TABLE] - docs: | - Runs a table scan, returning the first page of results as a result-set. If -table is specific, will - run the scan over TABLE. Otherwise, the scan will be over the current table. - - name: next-page - syntax: rs:next-page RESULTSET - docs: | - Runs the next page of results from the passed in result-set. This will depend on how RESULTSET was - created. For example, if RESULTSET was from a query, this will return the next page of results from that - query. Likewise, for scans. - - If the next page is available, the results will be returned as a new result-set, leaving the original result-set - unmodified. If no next page is available, then nil will be returned. \ No newline at end of file diff --git a/internal/common/ui/commandctrl/cmdpacks/modopt.go b/internal/common/ui/commandctrl/cmdpacks/modopt.go index 3899927..c106ef9 100644 --- a/internal/common/ui/commandctrl/cmdpacks/modopt.go +++ b/internal/common/ui/commandctrl/cmdpacks/modopt.go @@ -2,7 +2,6 @@ package cmdpacks import ( "context" - "lmika.dev/cmd/dynamo-browse/internal/common/ui/commandctrl" "lmika.dev/cmd/dynamo-browse/internal/dynamo-browse/controllers" "ucl.lmika.dev/ucl" @@ -12,7 +11,7 @@ type optModule struct { settingsController *controllers.SettingsController } -func (m optModule) optSet(ctx context.Context, args ucl.CallArgs) (any, error) { +func (m optModule) pbSet(ctx context.Context, args ucl.CallArgs) (any, error) { var ( name string newVale string @@ -42,7 +41,7 @@ func moduleOpt( return ucl.Module{ Name: "opt", Builtins: map[string]ucl.BuiltinHandler{ - "set": m.optSet, + "set": m.pbSet, }, } } diff --git a/internal/common/ui/commandctrl/cmdpacks/modrs.go b/internal/common/ui/commandctrl/cmdpacks/modrs.go index 0cfbb88..56c5548 100644 --- a/internal/common/ui/commandctrl/cmdpacks/modrs.go +++ b/internal/common/ui/commandctrl/cmdpacks/modrs.go @@ -187,7 +187,7 @@ func (rs *rsModule) rsScan(ctx context.Context, args ucl.CallArgs) (_ any, err e return newResultSetProxy(newResultSet), nil } -func (rs *rsModule) rsHide(ctx context.Context, args ucl.CallArgs) (any, error) { +func (rs *rsModule) rsFilter(ctx context.Context, args ucl.CallArgs) (any, error) { var ( rsProxy SimpleProxy[*models.ResultSet] filter string @@ -307,7 +307,7 @@ func moduleRS(tableService *tables.Service, state *controllers.State) ucl.Module "new": m.rsNew, "query": m.rsQuery, "scan": m.rsScan, - "hide": m.rsHide, + "filter": m.rsFilter, "next-page": m.rsNextPage, "union": m.rsUnion, "set": m.rsSet, diff --git a/internal/common/ui/commandctrl/cmdpacks/modrs_test.go b/internal/common/ui/commandctrl/cmdpacks/modrs_test.go index 9d2da35..13a2dd7 100644 --- a/internal/common/ui/commandctrl/cmdpacks/modrs_test.go +++ b/internal/common/ui/commandctrl/cmdpacks/modrs_test.go @@ -154,16 +154,16 @@ func TestModRS_Query(t *testing.T) { } } -func TestModRS_Hide(t *testing.T) { +func TestModRS_Filter(t *testing.T) { tests := []struct { descr string cmd string }{ { - descr: "returns hidden items 1", + descr: "returns filtered items 1", cmd: ` rs = rs:scan -table service-test-data - rs = rs:hide $rs 'pk="abc"' + rs = rs:filter $rs 'pk="abc"' assert (len $rs) "expected len == 2" assert (eq $rs.First.pk "abc") "expected First.pk == abc" `, diff --git a/internal/common/ui/commandctrl/commandctrl.go b/internal/common/ui/commandctrl/commandctrl.go index 0a55ab3..7dc6ba4 100644 --- a/internal/common/ui/commandctrl/commandctrl.go +++ b/internal/common/ui/commandctrl/commandctrl.go @@ -21,8 +21,8 @@ import ( const ( commandsCategory = "commands" - pendingTaskBuffer = 100 - pendingAuxTaskBuffer = 100 + pendingTaskBuffer = 50 + pendingAuxTaskBuffer = 50 auxWorkers = 4 ) diff --git a/linux.goreleaser.yml b/linux.goreleaser.yml new file mode 100644 index 0000000..5b0f9c4 --- /dev/null +++ b/linux.goreleaser.yml @@ -0,0 +1,37 @@ +builds: + - id: dynamo-browse + targets: + - windows_amd64 + - linux_amd64 + env: + - CGO_ENABLED=1 + main: ./cmd/dynamo-browse/. + binary: dynamo-browse +archives: + - id: zip + builds: + - dynamo-browse + wrap_in_directory: true + format_overrides: + - goos: windows + format: zip + - goos: linux + format: tar.gz +nfpms: + - id: package_nfpms + package_name: audax + builds: + - dynamo-browse + vendor: lmika + homepage: https://dynamo-browse.lmika.dev/ + maintainer: Leon Mika + description: TUI tools for working with DynamoDB + license: MIT + formats: + - deb + - rpm + bindir: /usr/local/bin +checksum: + name_template: 'checksums.txt' +snapshot: + name_template: "{{ .Tag }}-next" \ No newline at end of file diff --git a/goreleaser.yml b/macos.goreleaser.yml similarity index 55% rename from goreleaser.yml rename to macos.goreleaser.yml index fa63dcc..b442d4b 100644 --- a/goreleaser.yml +++ b/macos.goreleaser.yml @@ -1,7 +1,7 @@ version: 2 builds: - - id: dynamo-browse_macos + - id: dynamo-browse targets: - darwin_amd64 - darwin_arm64 @@ -9,23 +9,12 @@ builds: - CGO_ENABLED=1 main: ./cmd/dynamo-browse/. binary: dynamo-browse - - id: dynamo-browse_linux - targets: - - linux_amd64 - - linux_arm64 - env: - - CGO_ENABLED=1 - main: ./cmd/dynamo-browse/. - binary: dynamo-browse - - -# MacOS Release: notarise and publish via Homebrew Tap notarize: macos: - enabled: true ids: - - dynamo-browse_macos + - dynamo-browse sign: certificate: "{{.Env.MACOS_SIGN_P12}}" password: "{{.Env.MACOS_SIGN_PASSWORD}}" @@ -37,23 +26,20 @@ notarize: timeout: 20m archives: - - id: macos_tgz - ids: - - dynamo-browse_macos - wrap_in_directory: false - formats: - - tar.gz - - id: linux_tgz - ids: - - dynamo-browse_linux + - id: tgz wrap_in_directory: false formats: - tar.gz +release: + gitea: + owner: cmd + name: dynamo-browse + ids: + - tgz + homebrew_casks: - name: dynamo-browse - ids: - - macos_tgz repository: owner: casks name: dynamo-browse @@ -65,32 +51,8 @@ homebrew_casks: description: TUI tools for working with DynamoDB license: MIT -# Linux releases: publish as deb and rpm packages -nfpms: - - id: package_nfpms - package_name: audax - ids: - - dynamo-browse_linux - vendor: lmika - homepage: https://dynamo-browse.lmika.dev/ - maintainer: Leon Mika - description: TUI tools for working with DynamoDB - license: MIT - formats: - - deb - - rpm - bindir: /usr/local/bin - -release: - gitea: - owner: cmd - name: dynamo-browse - ids: - - macos_tgz - - linux_tgz - checksum: - name_template: 'checksums.txt' + name_template: 'checksums-macos.txt' snapshot: version_template: "{{ .Tag }}-next" @@ -99,4 +61,4 @@ gitea_urls: api: https://lmika.dev/api/v1 download: https://lmika.dev # set to true if you use a self-signed certificate - skip_tls_verify: false + skip_tls_verify: false \ No newline at end of file