feat: describe idea of pwa and web cli tools
This commit is contained in:
commit
064376cccd
5 changed files with 237 additions and 0 deletions
2
.mise.toml
Normal file
2
.mise.toml
Normal file
|
@ -0,0 +1,2 @@
|
|||
[tools]
|
||||
zig = "0.11.0"
|
70
build.zig
Normal file
70
build.zig
Normal file
|
@ -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);
|
||||
}
|
26
example/.well-known/pwact.json
Normal file
26
example/.well-known/pwact.json
Normal file
|
@ -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"}]
|
||||
}
|
||||
}
|
||||
|
115
readme.md
Normal file
115
readme.md
Normal file
|
@ -0,0 +1,115 @@
|
|||
# Командная строка из браузера
|
||||
|
||||
Идея состоит в том, чтобы создать браузер, который сможет превращать api интерфес
|
||||
в интерфейс командной строки.
|
||||
|
||||
Схема
|
||||
|
||||
```sh
|
||||
pwact <tool.dns> <api_header> <api_methods>
|
||||
```
|
||||
|
||||
А так же установить локально
|
||||
|
||||
```sh
|
||||
pwact <tool.dns> install
|
||||
```
|
||||
|
||||
Чтобы это заработало, необходимо использовать `.well-know` URL
|
||||
|
||||
```json
|
||||
{
|
||||
"api": "https://codeberg.org/api/v1",
|
||||
"bin": {
|
||||
"<platform>": [{
|
||||
"<architecture>": "<path_for_file"
|
||||
}]
|
||||
}
|
||||
"settings": {
|
||||
"aliases": [{
|
||||
"alias": "i",
|
||||
"type": "path",
|
||||
"path": "<path>"
|
||||
}]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Например:
|
||||
|
||||
```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/`
|
24
src/main.zig
Normal file
24
src/main.zig
Normal file
|
@ -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());
|
||||
}
|
Loading…
Reference in a new issue