qrlkit 0.12.0 → 0.13.0

package/README.md

@@ -193,63 +193,25 @@ State is stored in `$XDG_STATE_HOME/qrlkit/state.yaml` on Linux, falling back to
 
 ## Config syntax
 
-Each example replaces the previous one.
-
-References use their full path, like `{shared.repos}`.
-Strings supply fixed values. Lists offer choices when no value is supplied.
-CLI values follow first-reference order, including lookup inputs.
-Use `args` to declare argument order. Repeated references reuse the same selection.
-
 ### URLs
 
 Open URLs in your default browser.
 
 ```toml
 [repos]
-open = "https://github.com/qrlkit/qrlkit-rs"
-```
-
-Choose the repository with an argument.
-
-```toml
-[repos]
-open = "https://github.com/qrlkit/{repo}"
-```
-
-Reuse an organization.
-
-```toml
-[shared]
-hidden = true
-org = "qrlkit"
-
-[repos]
-open = "https://github.com/{shared.org}/{repo}"
-```
-
-Add hints and override the browser.
-
-```toml
-[shared]
-hidden = true
-org = "qrlkit"
-
-[repos]
-browser = "firefox"
-# hint: Browse the source code
-open = "https://github.com/{shared.org}/{repo}"
+rs = "https://github.com/qrlkit/qrlkit-rs"
 ```
 
-Offer repository choices.
+Or go advanced with reuseable constants and hints.
 
 ```toml
-[shared]
+[const]
 hidden = true
 org = "qrlkit"
 repos = ["qrlkit-rs", "qrlkit-web"]
 
 [repos.open]
-url = "https://github.com/{shared.org}/{shared.repos}"
+url = "https://github.com/{const.org}/{const.repos}"
 hint = "Browse the source code"
 browser = "firefox"
 ```
@@ -273,46 +235,16 @@ Print file paths without configured hooks.
 readme = "~/dev/qrlkit-rs/README.md"
 ```
 
-Choose the project with an argument.
-
-```toml
-[files]
-readme = "~/dev/{repo}/README.md"
-```
-
-Reuse your development directory across paths.
+Or beef it up with reuseable constants, hints and a custom filehook: 
 
 ```toml
-[shared]
-hidden = true
-root = "~/dev"
-
-[files]
-readme = "{shared.root}/{repo}/README.md"
-```
-
-Add hints and open your editor.
-
-```toml
-[shared]
-hidden = true
-root = "~/dev"
-
-[files]
-filehook = "nvim $file"
-readme = "{shared.root}/{repo}/README.md" # hint: Edit the project README
-```
-
-Offer project choices before opening files.
-
-```toml
-[shared]
+[const]
 hidden = true
 root = "~/dev"
 repos = ["qrlkit-rs", "qrlkit-web"]
 
 [files.readme]
-url = "{shared.root}/{shared.repos}/README.md"
+url = "{const.root}/{const.repos}/README.md"
 hint = "Edit the project README"
 filehook = "nvim $file"
 ```
@@ -322,52 +254,19 @@ qrlkit files readme qrlkit-rs  # Open directly
 qrlkit files readme            # Choose interactively
 ```
 
-Set global defaults with `qrlkit set-filehook`.
-
 ### Dirs
 
-Change directories through the shell integration.
+By default you can `cd` into a dir: 
 
 ```toml
 [dirs]
 project = "~/dev/qrlkit-rs"
 ```
 
-Choose the project with an argument.
-
-```toml
-[dirs]
-project = "~/dev/{repo}"
-```
-
-Reuse your development directory across projects.
+Or mod it similarly to files and urls with consts, dirhooks and hints:  
 
 ```toml
-[shared]
-hidden = true
-root = "~/dev"
-
-[dirs]
-project = "{shared.root}/{repo}"
-```
-
-Add hints and list directory contents.
-
-```toml
-[shared]
-hidden = true
-root = "~/dev"
-
-[dirs]
-dirhook = "cd $dir && tree -L 1"
-# hint: Enter and inspect the project
-project = "{shared.root}/{repo}"
-```
-
-Offer project choices before changing directories.
-
-```toml
-[shared]
+[const]
 hidden = true
 root = "~/dev"
 repos = ["qrlkit-rs", "qrlkit-web"]
@@ -383,8 +282,6 @@ qrlkit dirs project qrlkit-rs  # Open directly
 qrlkit dirs project            # Choose interactively
 ```
 
-Set global defaults with `qrlkit set-dirhook`.
-
 ### Scripts
 
 Run Bash from the config's directory.
@@ -463,23 +360,6 @@ qrlkit greet Hey
 
 Supported shells: `bash`, `sh`, and `zsh`.
 
-Use a script's output in another resource.
-
-```toml
-[system]
-hidden = true
-
-[system.hostname]
-run = "hostname"
-
-[logs]
-url = "https://logs.example.com/search?host={system.hostname}"
-```
-
-Referenced scripts run only when needed. Their stdout is reused within the command,
-with trailing newlines removed. A failed script stops the command.
-Script bodies stay literal; use `args` and `env` to pass values.
-
 ### Shared values
 
 Put shared values in any config and register it with `qrlkit add`.
@@ -510,71 +390,58 @@ run = 'printf "Hello, %s!\n" "$NAME"'
 NAME = "{shared.name}"
 ```
 
-`constants.toml` is no longer loaded automatically. Register shared values explicitly
-and replace `{global.name}` with their full path. `constants` is now an ordinary group.
-
 ### Composition
 
-Reference another resource's target without opening it.
+`qrlkit` offers a few ways to compose one QRL from multiple others. First principle is that everything is callable and referenceable if its not `hidden = true`.
 
-```toml
-[shared]
-hidden = true
-repos = ["qrlkit-rs", "qrlkit-web"]
-
-[repos.open]
-url = "https://github.com/qrlkit/{shared.repos}"
-
-[repos.prs]
-url = "{repos.open}/pulls"
-```
-
-```sh
-repos prs qrlkit-web  # Opens the repository's pull requests
-repos prs            # Choose the repository
+** One QRL calls another**
 ```
+[qrl-1]
+url = "https:/..."
 
-Missing references and circular dependencies are errors.
+[qrl-1.qrl-2]
+run = 'echo "sub/path"'
 
-### Lookups
+[qrl-3]
+url = "{qrl-1}/{qrl-1.qrl-2}"
+```
+Not here its possible to chain keys with a dot like `objs.fruits.apples`. 
 
-Choose a URL part from a mapping. Use one selector for a flat mapping,
-or multiple selectors to walk nested mappings.
+** Group static fields and ref them**
 
 ```toml
-[projects]
-hidden = true
-repos = ["qrlkit-rs", "qrlkit-web"]
-
-[shared]
-hidden = true
-environments = ["sim", "live"]
+[args]
+floors = ["1", "2", "3"]
+apartment = ["a", "b", "c"]
 
-[logs]
-url = "https://{logs.subdomains[projects.repos, shared.environments]}.logs.example.com"
+[ding]
+url = "https://ding-a.door/{floor}/{apartment}"
+args = [
+  { name = "floor", enum = { ref = "args.floors" } },
+  { name = "apartment", enum = { ref = "args.apartment" } },
+]
+```
 
-[logs.subdomains]
-hidden = true
+**Dynamically look up keys**
 
-[logs.subdomains.qrlkit-rs]
-sim = "rust-sandbox"
-live = "rust-production"
+```toml
+[args]
+project = ["docs", "status"]
+environment = ["staging", "prod"]
 
-[logs.subdomains.qrlkit-web]
-sim = "web-sandbox"
-live = "web-production"
-```
+[domains.docs]
+staging = "docs-staging.example.com"
+prod = "docs.example.com"
 
-Put `url` directly on a group to call it without a subcommand.
+[domains.status]
+staging = "status-staging.example.com"
+prod = "status.example.com"
 
-```sh
-logs qrlkit-rs live  # Opens https://rust-production.logs.example.com
-logs qrlkit-rs       # Choose the environment
-logs                 # Choose the repository and environment
+[site]
+url = "https://{domains[args.project, args.environment]}"
 ```
 
-Missing lookup keys are errors. Child commands take precedence over arguments;
-use `--` before a value that matches a child command's name.
+Here `domains[args.project, args.environment]` resolves by first prompting for project (`docs` or `status`) and then use that to select either `[domains.docs]` or `[domains.status]`  and prompt for a environment (`staging` or `prod`). 
 
 ### Hints and hidden groups
 

package/package.json

@@ -9,10 +9,10 @@
     "README.md"
   ],
   "optionalDependencies": {
-    "qrlkit-darwin-arm64": "0.12.0",
-    "qrlkit-darwin-x64": "0.12.0",
-    "qrlkit-linux-arm64": "0.12.0",
-    "qrlkit-linux-x64": "0.12.0"
+    "qrlkit-darwin-arm64": "0.13.0",
+    "qrlkit-darwin-x64": "0.13.0",
+    "qrlkit-linux-arm64": "0.13.0",
+    "qrlkit-linux-x64": "0.13.0"
   },
   "os": [
     "linux",
@@ -34,5 +34,5 @@
   "bugs": {
     "url": "https://github.com/qrlkit/qrlkit-rs/issues"
   },
-  "version": "0.12.0"
+  "version": "0.13.0"
 }