From 064376cccd0df1b091d4e41ddcfd37fc01b718c8 Mon Sep 17 00:00:00 2001 From: kogeletey Date: Tue, 20 Aug 2024 14:28:51 +0300 Subject: [PATCH] feat: describe idea of pwa and web cli tools --- .mise.toml | 2 + build.zig | 70 ++++++++++++++++++++ example/.well-known/pwact.json | 26 ++++++++ readme.md | 115 +++++++++++++++++++++++++++++++++ src/main.zig | 24 +++++++ 5 files changed, 237 insertions(+) create mode 100644 .mise.toml create mode 100644 build.zig create mode 100644 example/.well-known/pwact.json create mode 100644 readme.md create mode 100644 src/main.zig diff --git a/.mise.toml b/.mise.toml new file mode 100644 index 0000000..15cc23c --- /dev/null +++ b/.mise.toml @@ -0,0 +1,2 @@ +[tools] +zig = "0.11.0" diff --git a/build.zig b/build.zig new file mode 100644 index 0000000..a3847cc --- /dev/null +++ b/build.zig @@ -0,0 +1,70 @@ +const std = @import("std"); + +// Although this function looks imperative, note that its job is to +// declaratively construct a build graph that will be executed by an external +// runner. +pub fn build(b: *std.Build) void { + // Standard target options allows the person running `zig build` to choose + // what target to build for. Here we do not override the defaults, which + // means any target is allowed, and the default is native. Other options + // for restricting supported target set are available. + const target = b.standardTargetOptions(.{}); + + // Standard optimization options allow the person running `zig build` to select + // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not + // set a preferred release mode, allowing the user to decide how to optimize. + const optimize = b.standardOptimizeOption(.{}); + + const exe = b.addExecutable(.{ + .name = "wacli", + // In this case the main source file is merely a path, however, in more + // complicated build scripts, this could be a generated file. + .root_source_file = .{ .path = "src/main.zig" }, + .target = target, + .optimize = optimize, + }); + + // This declares intent for the executable to be installed into the + // standard location when the user invokes the "install" step (the default + // step when running `zig build`). + b.installArtifact(exe); + + // This *creates* a Run step in the build graph, to be executed when another + // step is evaluated that depends on it. The next line below will establish + // such a dependency. + const run_cmd = b.addRunArtifact(exe); + + // By making the run step depend on the install step, it will be run from the + // installation directory rather than directly from within the cache directory. + // This is not necessary, however, if the application depends on other installed + // files, this ensures they will be present and in the expected location. + run_cmd.step.dependOn(b.getInstallStep()); + + // This allows the user to pass arguments to the application in the build + // command itself, like this: `zig build run -- arg1 arg2 etc` + if (b.args) |args| { + run_cmd.addArgs(args); + } + + // This creates a build step. It will be visible in the `zig build --help` menu, + // and can be selected like this: `zig build run` + // This will evaluate the `run` step rather than the default, which is "install". + const run_step = b.step("run", "Run the app"); + run_step.dependOn(&run_cmd.step); + + // Creates a step for unit testing. This only builds the test executable + // but does not run it. + const unit_tests = b.addTest(.{ + .root_source_file = .{ .path = "src/main.zig" }, + .target = target, + .optimize = optimize, + }); + + const run_unit_tests = b.addRunArtifact(unit_tests); + + // Similar to creating the run step earlier, this exposes a `test` step to + // the `zig build --help` menu, providing a way for the user to request + // running the unit tests. + const test_step = b.step("test", "Run unit tests"); + test_step.dependOn(&run_unit_tests.step); +} diff --git a/example/.well-known/pwact.json b/example/.well-known/pwact.json new file mode 100644 index 0000000..a860f76 --- /dev/null +++ b/example/.well-known/pwact.json @@ -0,0 +1,26 @@ +{ + "api": "https://codeberg.org/api/v1", + "settings": { + "aliases": [ + { + "alias": "i", + "type": "path", + "path": "/repos/{owner}/{repo}/issues" + }, + { + "alias": "create", + "type": "method", + "method": "POST" + }, + { + "alias": "tea", + "type": "bin", + "bin": "tea" + } + ] + }, + "bin": { + "linux": [{"x86": "https://dl.gitea.com/tea/main/tea-main-linux-amd64.xz"}] + } +} + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..484e7b2 --- /dev/null +++ b/readme.md @@ -0,0 +1,115 @@ +# Командная строка из браузера + +Идея состоит в том, чтобы создать браузер, который сможет превращать api интерфес +в интерфейс командной строки. + +Схема + +```sh +pwact +``` + +А так же установить локально + +```sh +pwact install +``` + +Чтобы это заработало, необходимо использовать `.well-know` URL + +```json +{ + "api": "https://codeberg.org/api/v1", + "bin": { + "": [{ + "": "" + }] + } +} +``` + + +Например: + +```json +{ + "api": "https://codeberg.org/api/v1", + "settings": { + "aliases": [ + { + "alias": "i", + "type": "path", + "path": "/repos/{owner}/{repo}/issues" + }, + { + "alias": "create", + "type": "method", + "method": "POST" + }, + { + "alias": "tea", + "type": "bin", + "bin": "tea" + } + ] + }, + "bin": { + "linux": [{"x86": "https://dl.gitea.com/tea/main/tea-main-linux-amd64.xz"}] + } +} +``` + + + +Метод REST API - `https://codeberg.org/api/v1/repos/{owner}/{repo}/issues` превратиться в следующий код + +По умолчанию get запрос + +```sh +pwact api codeberg.org repos issues [owner] [repo] +``` + +Если нужно отправить post запрос, то + +```sh +pwact api codeberg.org post --auth repos issues [owner] [repo] +``` + +токены хранятся в отдельной базе данных, независимо от репозитория. + +Методы перед pwact можно переопределить + +```sh +pwact api codeberg.org create --auth repos issues [owner] [repo] +``` + +Установить и запустить инструмент в изолированном контексте можно + +```sh +pwact api codeberg.org install +``` + +Все те же методы работают с бинарниками. + +```sh +pwact bin codeberg.org install +``` + +В настройка самого инструмента может быть настройка, которая определить по умолчанию запускать бинарники или api. Так же можно не писать `api` или `bin` если в манифесте указан только один параметр + +По умолчанию все запросы в clearnet иду по `https`, tor и i2p - `http`. +Но можно указать и конкретный протокол + +```sh +pwact bin "http://codeberg.org" install +``` + +В случае выполнения команды по установки бинарников, даже если они не указаны в manifest на сайте, то могут быть скачаны с [репозиториия pkgx](https://github.com/pkgxdev/pantry) +Устанавливаются в случае пользователя в директорию `~/.local/bin`, в случае root `/usr/local/bin/` diff --git a/src/main.zig b/src/main.zig new file mode 100644 index 0000000..c8a3f67 --- /dev/null +++ b/src/main.zig @@ -0,0 +1,24 @@ +const std = @import("std"); + +pub fn main() !void { + // Prints to stderr (it's a shortcut based on `std.io.getStdErr()`) + std.debug.print("All your {s} are belong to us.\n", .{"codebase"}); + + // stdout is for the actual output of your application, for example if you + // are implementing gzip, then only the compressed bytes should be sent to + // stdout, not any debugging messages. + const stdout_file = std.io.getStdOut().writer(); + var bw = std.io.bufferedWriter(stdout_file); + const stdout = bw.writer(); + + try stdout.print("Run `zig build test` to run the tests.\n", .{}); + + try bw.flush(); // don't forget to flush! +} + +test "simple test" { + var list = std.ArrayList(i32).init(std.testing.allocator); + defer list.deinit(); // try commenting this out and see if zig detects the memory leak! + try list.append(42); + try std.testing.expectEqual(@as(i32, 42), list.pop()); +}