49 Commits

Author SHA1 Message Date
2df54930bb making it allways run on pull requests for now 2025-11-09 22:03:57 +01:00
f7a1f84730 removed colored library, using nu-ansi-term now 2025-11-09 21:54:22 +01:00
bb82dad4cf added paths to triggers 2025-11-09 21:09:37 +01:00
303309fff9 renamed existing deploy workflows. added testing workflow 2025-11-09 21:07:59 +01:00
6d2f76eb72 removed workflows from pullrequest trigger 2025-11-09 19:33:04 +01:00
451015d2f2 Merge pull request #5 from quirinecker/develop
Docki is now using cdn for Revealjs
2025-11-09 19:31:38 +01:00
1a009bac61 incremented version to 1.2.3 2025-11-09 19:27:02 +01:00
cc65ce3e7c updated help texts 2025-11-09 19:26:05 +01:00
926944e8dd revealjs default now cdn. added flag for downloading for offline use 2025-11-09 19:20:58 +01:00
78e2acb325 using relative path for reveal again because of issues with github page s 2025-11-09 14:37:31 +01:00
958856dcc0 updated crates ignore list 2025-11-08 19:44:21 +01:00
deb30aacea updated test to new file structure 2025-11-08 19:36:49 +01:00
9075b34ca3 version increment 2025-11-08 19:32:44 +01:00
7325e3a0c9 added working dir for the github actions 2025-11-07 13:03:40 +01:00
34e8ad4eb4 fixed path issue on macos 2025-11-07 12:28:30 +01:00
8a6dacf1c8 Merge pull request #3 from bauepete/patch-1
Update Homebrew installation instructions in README
2025-11-07 10:37:15 +01:00
Peter Bauer
8a65a5e596 Update Homebrew installation instructions in README
Removed note about Homebrew installation not including asciidoctor_revealjs.
2025-11-07 10:36:01 +01:00
47996b81bc Update README.md 2025-10-26 21:54:05 +01:00
a2f9622aaa added the readme once again 2025-10-26 21:51:51 +01:00
5b3ef929c4 now only pushing when the version actually changes 2025-10-26 17:01:42 +01:00
d706ba9f56 added instructions for building it using git pull 2025-10-26 16:56:41 +01:00
bb4b2ad3f5 also tagging latest now 2025-10-26 16:53:09 +01:00
bd77f0daff fixed typo 2025-10-26 16:40:44 +01:00
cd439006bb pushing latest too now 2025-10-26 16:34:53 +01:00
77eda0841b added right push url 2025-10-26 16:26:42 +01:00
21b6434145 writing cargo version to github env now 2025-10-26 16:20:55 +01:00
ff4b237651 wrong command for getting cargo version 2025-10-26 16:04:23 +01:00
4b11b0ada2 changed push url added auth for ghcr 2025-10-26 15:57:30 +01:00
7e40620df6 changed url and added publish step 2025-10-26 15:48:58 +01:00
4025bf9c7f added nix action 2025-10-26 14:39:51 +01:00
d7a387cf45 added docker gh action 2025-10-26 14:08:55 +01:00
e56a9fc1b5 added instructions for docker and moved the screencast asset to antoher folder 2025-10-26 13:58:15 +01:00
948df90006 removed outdated gitlab ci file 2025-10-26 13:51:28 +01:00
161ce02042 removed docker related files 2025-10-26 13:50:59 +01:00
97ab59a424 test docs also have slides now, if slides need to be tested 2025-10-26 13:48:41 +01:00
c3761464ee added docker target to flake 2025-10-26 13:48:16 +01:00
fb32fcfdb1 updated reveal js version 2025-10-26 13:47:59 +01:00
89d921299e added whitelist of paths that need to be changed in order to trigger cargo publish 2025-10-24 18:15:40 +02:00
9591ead7ea updated notice in the readme
Some checks failed
Rust / build (push) Has been cancelled
2025-10-24 18:13:04 +02:00
7a47b73d08 updated cargo lock file
Some checks failed
Rust / build (push) Has been cancelled
2025-10-24 18:05:59 +02:00
a5005d777f incremented version 2025-10-24 18:00:46 +02:00
961fe4ce56 added the .gitlab readme assets to exclude array 2025-10-24 17:07:43 +02:00
fe8e3e3e63 removed binary file 2025-10-23 22:44:44 +02:00
9945b45aa9 incremented version 2025-10-23 22:38:12 +02:00
0713ec0c80 added actions for publishing to crates.io 2025-10-23 22:28:28 +02:00
96d200888a added another notice 2025-10-23 22:17:40 +02:00
13e56f057b updated readme, addded usage and development notices 2025-10-23 22:15:38 +02:00
bb098ce77e updated installation options 2025-10-23 21:14:47 +02:00
4a2f852f30 updated flake. nix package now includes completions 2025-10-23 20:14:05 +02:00
28 changed files with 516 additions and 250 deletions

View File

@@ -1 +0,0 @@
**

View File

Before

Width:  |  Height:  |  Size: 18 MiB

After

Width:  |  Height:  |  Size: 18 MiB

40
.github/workflows/docker_deploy.yml vendored Normal file
View File

@@ -0,0 +1,40 @@
name: Deploy Docker Image to Github Container Registry
on:
push:
branches: ["main"]
paths:
- "Cargo.toml"
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
attestations: write
id-token: write
steps:
- uses: actions/checkout@v4
- uses: hustcer/setup-nu@v3
- uses: cachix/install-nix-action@v31
with:
nix_path: nixpkgs=channel:nixos-unstable
- run: nix build .#docker
- run: |
export CARGO_VERSION=$(nu -c "cargo metadata --format-version=1 --no-deps | from json | get packages | first | get version")
echo "CARGO_VERSION=$CARGO_VERSION" >> $GITHUB_ENV
- run: docker load -i result
- name: Log in to registry
run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
- run: docker tag docki:latest "ghcr.io/quirinecker/docki:$CARGO_VERSION"
- run: docker tag docki:latest "ghcr.io/quirinecker/docki:latest"
- run: docker push ghcr.io/quirinecker/docki:$CARGO_VERSION
- run: docker push ghcr.io/quirinecker/docki:latest

26
.github/workflows/rust_deploy.yml vendored Normal file
View File

@@ -0,0 +1,26 @@
name: Deploy Rust to Crates.io
on:
push:
branches: ["main"]
paths:
- "Cargo.toml"
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build
run: cargo build --verbose
- name: Run tests
run: cargo test --verbose
- name: Publish to crates.io
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
run: |
cargo publish --verbose

24
.github/workflows/rust_test.yml vendored Normal file
View File

@@ -0,0 +1,24 @@
name: Test Rust
on:
push:
branches: ["main", "develop"]
paths:
- "./src/**"
- "./Cargo.toml"
pull_request:
branches: ["main", "develop"]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build
run: cargo build --verbose
- name: Run tests
run: cargo test --verbose

1
.gitignore vendored
View File

@@ -3,3 +3,4 @@ dist
/docs
res/test/docs/slides/revealjs
res/test/result
result

View File

@@ -1,20 +0,0 @@
workflow:
rules:
- if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "main"'
default:
image: 'quirinecker/rust-openssl'
build:
script:
- cargo build
test:
script:
- cargo test
# publish:
# script:
# - export CARGO_REGISTRY_TOKEN=$CARGO_TOKEN
# - cargo publish

41
Cargo.lock generated
View File

@@ -1,6 +1,6 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
version = 4
[[package]]
name = "adler"
@@ -630,17 +630,6 @@ dependencies = [
"unicode-width",
]
[[package]]
name = "colored"
version = "2.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b3616f750b84d8f0de8a58bda93e08e2a81ad3f523089b05f1dffecab48c6cbd"
dependencies = [
"atty",
"lazy_static",
"winapi 0.3.9",
]
[[package]]
name = "concurrent-queue"
version = "2.1.0"
@@ -859,16 +848,16 @@ checksum = "212d0f5754cb6769937f4501cc0e67f4f4483c8d2c3e1e922ee9edbe4ab4c7c0"
[[package]]
name = "docki"
version = "1.1.0"
version = "1.2.3"
dependencies = [
"bytes",
"clap 4.1.8",
"clap_complete",
"colored",
"futures",
"home",
"live-server",
"notify 5.1.0",
"nu-ansi-term",
"regex",
"reqwest",
"text_io",
@@ -1872,6 +1861,15 @@ dependencies = [
"windows-sys 0.42.0",
]
[[package]]
name = "nu-ansi-term"
version = "0.50.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7957b9740744892f114936ab4a57b3f487491bbeafaf8083688b16841a4240e5"
dependencies = [
"windows-sys 0.61.2",
]
[[package]]
name = "num-integer"
version = "0.1.45"
@@ -3206,6 +3204,12 @@ version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
[[package]]
name = "windows-link"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
[[package]]
name = "windows-sys"
version = "0.42.0"
@@ -3230,6 +3234,15 @@ dependencies = [
"windows-targets",
]
[[package]]
name = "windows-sys"
version = "0.61.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
dependencies = [
"windows-link",
]
[[package]]
name = "windows-targets"
version = "0.42.1"

View File

@@ -1,20 +1,17 @@
# Cargo.toml
build = "build.rs"
[package]
name = "docki"
version = "1.1.0"
version = "1.2.3"
edition = "2021"
description = "cli for building and publishing documentation using asciidoctor"
license-file = "LICENSE.txt"
authors = ["Quirin Ecker"]
exclude = [".gitlab", ".github"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
bytes = "1.4.0"
clap = { version = "4.1.8", features = ["derive"] }
colored = "2.0.0"
futures = "0.3.26"
home = "0.5.4"
live-server = "0.6.0"
@@ -24,8 +21,5 @@ reqwest = { version = "0.11.14", features = ["blocking"] }
text_io = "0.1.12"
tokio = { version = "1.26.0", features = ["full"] }
zip-extract = "0.1.1"
[build-dependencies]
clap = { version = "4.1.8", features = ["derive"] }
clap_complete = "4.1.4"
nu-ansi-term = "0.50.3"

View File

@@ -1,7 +0,0 @@
FROM rust:slim
WORKDIR /opt/rust
RUN apt update \
&& apt-get -y upgrade \
&& apt-get -y install libssl-dev pkg-config

126
README.md
View File

@@ -1,42 +1,138 @@
# Docki
> [!NOTE]
> This project is under renovations. While installing it right now might work, it is not guaranteed
> This project is under renovations. It can be used, but it might not be completely stable yet.
## Preview
![screencast](.gitlab/screencast.gif)
![screencast](.github/assets/screencast.gif)
Docki is cli for converting asciidoctor files into html files. You can build your documentation with `docki build` and write documenation using the live server with `docki serve`.
Docki is cli for converting asciidoctor files into html files.
## Usage
> [!NOTE]
> This works in a directory with a directory called `docs`, which contains the asciidoctor documentation.
### Building the documentation
```shell
docki build
```
### Serving the documentation on a live server
```shell
docki serve
```
## Installation
### Nix
This installation method is recommended, becuase it is the most maintained due to me using nix in development.
Note: This is the most basic installation. If you are already more experienced, you might want to add it to your shell or home manager configuration.
```nix
nix profile install github:quirinecker/docki
```
### Homebrew
```
brew tap quirinecker/docki-homebrew https://gitlab.com/quirinecker/docki-homebrew
```shell
brew tap quirinecker/homebrew-docki https://github.com/quirinecker/homebrew-docki
```
```
brew install docki
```
### Nix
If you just want to try it out real quick and the nix package manager is available on your system you can use the following command.
```shell
nix develop github:quirinecker/docki#preview
```
This will open a shell evnironment with docki installed. If you want to install it permanently with nix, i would recommend following the instructions in the [Nix (Advanced, Flake)](#nix-advanced-flake) section.
### Cargo
> [!NOTE]
> This is the most basic installation. It will not include asciidoctor_revealjs and asciidoctor itself. Installing asciidoctor has to be done manually, while installing asciidoctor_revealjs can be done with `docki install-reveal`
```shell
cargo install docki
```
### Docker
There is also a docker image available to use. It is primarily used for the gh actions.
```shell
docker pull ghcr.io/quirinecker/docki:latest
```
You can also build it yourself with nix.
```
nix build .#docker && docker load -i result
```
### Nix (Advanced, Flake)
> [!NOTE]
> There are multiple ways to install docki with nix. This is the way I installed it on my machine.
1. Add it to the flake inputs
```nix
docki = {
url = "github:quirinecker/docki";
inputs.nixpkgs.follows = "nixpkgs";
};
```
2. Add `@inputs` at the end of the outputs (if you haven't already)
```nix
outputs = {
nixpkgs
...
}@inputs:
...Rest of your flake...
```
3. Add the input to your system packages (system configuration) or home packages (home manager configuration)
```nix
environment.systemPackages = with pkgs; [
inputs.docki.packages.${system}.default
]
```
or
```nix
home.packages = with pkgs; [
inputs.docki.packages.${system}.default
]
```
## Development
### Running it
If you just want to run it, you can use the `nix run` command. This will install all the build dependencies, build the binary and run it.
```shell
nix run
```
### Development Shell
You can also use the development shell with the command below. In this shell all dependencies for building and running the project are installed.
```shell
nix develop
```
Afterwards it can be built and run with cargo
```shell
cargo run -- <args>
```

View File

@@ -1,23 +0,0 @@
use std::io::Error;
use clap::CommandFactory;
use clap_complete::{generate_to, shells::{Bash, Zsh, Fish}};
include!("src/app/args/structure.rs");
include!("src/app/fs_util/mod.rs");
fn main() -> Result<(), Error> {
generate_completions()
}
fn generate_completions() -> Result<(), Error> {
let mut command = Args::command();
let home_path = env::var("HOME").expect("could not get home path");
let out_dir = format!("{}/.docki/completions/", home_path);
create_dir_recursive(&out_dir);
generate_to(Bash, &mut command, "docki", &out_dir)?;
generate_to(Zsh, &mut command, "docki", &out_dir)?;
generate_to(Fish, &mut command, "docki", &out_dir)?;
Ok(())
}

BIN
docki

Binary file not shown.

77
flake.lock generated
View File

@@ -1,6 +1,63 @@
{
"nodes": {
"fenix": {
"inputs": {
"nixpkgs": [
"naersk",
"nixpkgs"
],
"rust-analyzer-src": "rust-analyzer-src"
},
"locked": {
"lastModified": 1752475459,
"narHash": "sha256-z6QEu4ZFuHiqdOPbYss4/Q8B0BFhacR8ts6jO/F/aOU=",
"owner": "nix-community",
"repo": "fenix",
"rev": "bf0d6f70f4c9a9cf8845f992105652173f4b617f",
"type": "github"
},
"original": {
"owner": "nix-community",
"repo": "fenix",
"type": "github"
}
},
"naersk": {
"inputs": {
"fenix": "fenix",
"nixpkgs": "nixpkgs"
},
"locked": {
"lastModified": 1752689277,
"narHash": "sha256-uldUBFkZe/E7qbvxa3mH1ItrWZyT6w1dBKJQF/3ZSsc=",
"owner": "nix-community",
"repo": "naersk",
"rev": "0e72363d0938b0208d6c646d10649164c43f4d64",
"type": "github"
},
"original": {
"owner": "nix-community",
"repo": "naersk",
"type": "github"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1752077645,
"narHash": "sha256-HM791ZQtXV93xtCY+ZxG1REzhQenSQO020cu6rHtAPk=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "be9e214982e20b8310878ac2baa063a961c1bdf6",
"type": "github"
},
"original": {
"owner": "NixOS",
"ref": "nixpkgs-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"nixpkgs_2": {
"locked": {
"lastModified": 1760934318,
"narHash": "sha256-/oUYsC0lUCBory65VK+UHqCCsCspbL1Vgfcf1KUYqVw=",
@@ -18,10 +75,28 @@
},
"root": {
"inputs": {
"nixpkgs": "nixpkgs",
"naersk": "naersk",
"nixpkgs": "nixpkgs_2",
"systems": "systems"
}
},
"rust-analyzer-src": {
"flake": false,
"locked": {
"lastModified": 1752428706,
"narHash": "sha256-EJcdxw3aXfP8Ex1Nm3s0awyH9egQvB2Gu+QEnJn2Sfg=",
"owner": "rust-lang",
"repo": "rust-analyzer",
"rev": "591e3b7624be97e4443ea7b5542c191311aa141d",
"type": "github"
},
"original": {
"owner": "rust-lang",
"ref": "nightly",
"repo": "rust-analyzer",
"type": "github"
}
},
"systems": {
"locked": {
"lastModified": 1681028828,

129
flake.nix
View File

@@ -12,29 +12,71 @@
nixpkgs,
systems,
naersk,
self,
...
}:
let
eachSystem = f: nixpkgs.lib.genAttrs (import systems) (system: f nixpkgs.legacyPackages.${system});
build_asciidoctor_revealjs = pkgs: pkgs.buildRubyGem {
gemName = "asciidoctor-revealjs";
version = "5.2.0";
source = {
type = "git";
url = "https://rubygems.org/downloads/asciidoctor-revealjs-5.2.0.gem";
sha256 = "sha256-NQSl5+ryyR3jf5YYkxT/sea/lNrZ1kbVyaJMZpG/auI=";
build_asciidoctor_revealjs =
pkgs:
pkgs.buildRubyGem {
gemName = "asciidoctor-revealjs";
version = "5.2.0";
source = {
type = "git";
url = "https://rubygems.org/downloads/asciidoctor-revealjs-5.2.0.gem";
sha256 = "sha256-NQSl5+ryyR3jf5YYkxT/sea/lNrZ1kbVyaJMZpG/auI=";
};
};
};
build_asciidoctor = pkgs: pkgs.buildRubyGem {
gemName = "asciidoctor";
version = "2.0.25";
source = {
type = "git";
url = "https://rubygems.org/downloads/asciidoctor-2.0.25.gem";
sha256 = "sha256-sG/oIrCRDU4l6g9WL+z8eUjpRuIi79lJSEnSfaQmfRk=";
build_asciidoctor =
pkgs:
pkgs.buildRubyGem {
gemName = "asciidoctor";
version = "2.0.25";
source = {
type = "git";
url = "https://rubygems.org/downloads/asciidoctor-2.0.25.gem";
sha256 = "sha256-sG/oIrCRDU4l6g9WL+z8eUjpRuIi79lJSEnSfaQmfRk=";
};
};
};
build_docki =
{ naerskLib, pkgs }:
let
runtimeDeps = with pkgs; [
(ruby.withPackages (
p: with p; [
(build_asciidoctor_revealjs pkgs)
(build_asciidoctor pkgs)
bundler
]
))
];
in
naerskLib.buildPackage {
src = ./.;
buildInputs = [
];
nativeBuildInputs = with pkgs; [
pkg-config
openssl.dev
libiconv
makeWrapper
];
postInstall = ''
mkdir -p $out/share/bash-completion/completions
mkdir -p $out/share/zsh/site-functions
mkdir -p $out/share/fish/vendor_completions.d
$out/bin/docki completions bash > $out/share/bash-completion/completions/docki
$out/bin/docki completions zsh > $out/share/zsh/site-functions/_docki
$out/bin/docki completions fish > $out/share/fish/vendor_completions.d/docki.fish
wrapProgram $out/bin/docki --prefix PATH : ${pkgs.lib.makeBinPath runtimeDeps}
'';
};
in
{
devShells = eachSystem (pkgs: {
@@ -56,36 +98,47 @@
))
];
};
preview = pkgs.mkShell {
name = "docki-preview";
buildInputs = [
pkgs.zsh
pkgs.fish
pkgs.bash
self.packages.${pkgs.system}.default
];
};
});
packages = eachSystem (
pkgs:
let
naerskLib = pkgs.callPackage naersk { };
runtimeDeps = with pkgs; [
(ruby.withPackages (
p: with p; [
(build_asciidoctor_revealjs pkgs)
(build_asciidoctor pkgs)
bundler
]
))
];
in
{
default = naerskLib.buildPackage {
src = ./.;
buildInputs =[
];
nativeBuildInputs = with pkgs; [
pkg-config
openssl.dev
libiconv
makeWrapper
];
postInstall = ''
wrapProgram $out/bin/docki --prefix PATH : ${pkgs.lib.makeBinPath runtimeDeps}
'';
default = build_docki {
naerskLib = naerskLib;
pkgs = pkgs;
};
docker = pkgs.dockerTools.buildImage {
name = "docki";
tag = "latest";
config = {
WorkingDir = "/app";
};
copyToRoot = pkgs.buildEnv {
name = "docki-docker";
paths = [
pkgs.coreutils
pkgs.bash
pkgs.cacert
(build_docki {
naerskLib = naerskLib;
pkgs = pkgs;
})
];
};
};
}
);

View File

@@ -0,0 +1,11 @@
= My cool presentation
:author: John Doe
:email: john@doe.com
== First slide
Content
== Second slide
Content

View File

@@ -3,23 +3,38 @@ use clap::{Parser, Subcommand};
#[derive(Parser)]
pub struct Args {
#[command(subcommand)]
pub command: CommandArg
pub command: CommandArg,
}
#[derive(Subcommand)]
pub enum ShellArg {
Bash,
Fish,
Zsh,
}
#[derive(Subcommand)]
pub enum CommandArg {
/// Builds the documentation into a dist folder
Build,
Build {
/// When set to true, docki will download revealjs before building the documentation.
/// Otherwise it will use the cdn for revealjs
#[arg(short, long)]
offline_reveal: bool,
},
/// Checks if everything required for docki is installed
Health,
/// Helper command for installing asciidoctor-reveal-js
/// Deprecated: Helper command for installing asciidoctor-reveal-js
InstallReveal,
/// Starts a Webserver with the live preview of the Documentation
Serve {
/// Port for the Live Server
/// Port for the Live Server
#[arg(short, long)]
port: Option<u16>
port: Option<u16>,
},
/// Generates completions for the desired shell
Completions {
#[command(subcommand)]
shell: ShellArg,
},
/// Information about the completions
Completions
}

View File

@@ -1,6 +1,5 @@
use std::process;
use regex::Regex;
use std::process;
fn exec_command(command: &mut process::Command) -> Result<(), String> {
let result = command.output();
@@ -29,10 +28,14 @@ fn asciidoctor_docs(in_path: &str, out_path: &str) -> process::Command {
return command;
}
fn asciidoctor_slides(in_path: &str, out_path: &str) -> process::Command {
fn asciidoctor_slides(in_path: &str, out_path: &str, offline_reveal: bool) -> process::Command {
let mut command = process::Command::new(format!("asciidoctor-revealjs"));
let out_dir = parent_path(out_path);
let revealjs_path = "/slides/revealjs";
let revealjs_path = if offline_reveal {
path_between(out_dir.to_string(), "./dist/slides/revealjs".to_string())
} else {
"https://cdn.jsdelivr.net/npm/reveal.js@5.2.1".to_string()
};
command
.arg(format!("{in_path}"))
@@ -102,8 +105,8 @@ pub fn build_doc(in_path: &str, out_path: &str) -> Result<(), String> {
return exec_command(&mut command);
}
pub fn build_slide(in_path: &str, out_path: &str) -> Result<(), String> {
let mut command = asciidoctor_slides(in_path, out_path);
pub fn build_slide(in_path: &str, out_path: &str, offline_reveal: bool) -> Result<(), String> {
let mut command = asciidoctor_slides(in_path, out_path, offline_reveal);
return exec_command(&mut command);
}

View File

@@ -6,16 +6,12 @@ use super::fs_util;
pub mod asciidoctor;
pub trait Builder {
fn build(&self, in_path: &str, out_path: &str) -> Result<(), String>;
}
pub fn docki_build(in_path: &str) -> DockiBuildResult {
pub fn docki_build(in_path: &str, offline_reveal: bool) -> DockiBuildResult {
let out_path = in_path.replace("/docs/", "/dist/");
let convert_out_path = out_path.replace(".adoc", ".html");
if in_path.starts_with("./docs/slides/") && in_path.ends_with(".adoc") {
if let Err(err) = build_slide(&in_path, &convert_out_path) {
if let Err(err) = build_slide(&in_path, &convert_out_path, offline_reveal) {
return DockiBuildResult::Err(err);
}
@@ -27,6 +23,10 @@ pub fn docki_build(in_path: &str) -> DockiBuildResult {
DockiBuildResult::Doc(convert_out_path)
} else {
if in_path.starts_with("./docs/slides/revealjs") && !offline_reveal {
return DockiBuildResult::Silent;
}
if let Err(err) = copy(&in_path, &out_path) {
return DockiBuildResult::Err(err);
}
@@ -35,11 +35,11 @@ pub fn docki_build(in_path: &str) -> DockiBuildResult {
}
}
fn copy(in_path: &str, out_path: &str) -> Result<(), String> {
fn copy(in_path: &str, out_path: &str) -> Result<(), String> {
fs_util::create_parent_dir_recursive(out_path);
if let Err(err) = fs::copy(in_path, out_path) {
return Err(err.to_string())
return Err(err.to_string());
}
Ok(())
@@ -50,4 +50,5 @@ pub enum DockiBuildResult {
Doc(String),
Copy(String),
Err(String),
Silent,
}

View File

@@ -1,6 +1,6 @@
use super::executions::build_execution::BuildExecution;
pub async fn build() -> () {
pub async fn build(offline_reveal: bool) -> () {
let mut build_execution = BuildExecution::new();
build_execution.execute().await.expect("build failed")
build_execution.execute(offline_reveal).await.expect("build failed")
}

View File

@@ -1,21 +1,16 @@
use colored::Colorize;
use std::io;
const INFO: &str = "
You can add completions for docki with the following methods. If you want the completions to be persistent add
them to a init file e.g. ~/.zshrc, ~/.bashrc, ~/.config/fish/config.fish.
use clap::CommandFactory;
use clap_complete::{generate, shells::{Bash, Fish, Zsh}};
Get Fish Completions
source ~/.docki/completions/docki.fish
use crate::app::args::structure::{Args, ShellArg};
Get Zsh Completions
source ~/.docki/completions/_docki
pub fn completions(shell: ShellArg) {
let mut command = Args::command();
Get Bash Completions
source ~/.docki/completions/docki.bash
";
pub fn completions() {
println!();
println!("{}", "Completions".blue().bold());
println!("{}", INFO.bright_black());
match shell {
ShellArg::Bash => generate(Bash, &mut command, "docki", &mut io::stdout()),
ShellArg::Fish => generate(Fish, &mut command, "docki", &mut io::stdout()),
ShellArg::Zsh => generate(Zsh, &mut command, "docki", &mut io::stdout()),
}
}

View File

@@ -21,7 +21,7 @@ impl BuildExecution {
};
}
pub async fn execute(&mut self) -> Result<(), String> {
pub async fn execute(&mut self, offline_reveal: bool) -> Result<(), String> {
let path = "./docs/".to_string();
if !fs_util::directory_exists(&path) {
@@ -30,20 +30,25 @@ impl BuildExecution {
);
}
if let Err(error) = Self::prepare().await {
if let Err(error) = Self::prepare(offline_reveal).await {
return Err(error);
}
return self.build_dir(&path);
return self.build_dir(&path, offline_reveal);
}
async fn prepare() -> Result<(), String> {
let reveal_version = "3.9.2";
async fn prepare(offline_reveal: bool) -> Result<(), String> {
if !offline_reveal {
return Ok(())
}
let reveal_version = "5.2.1";
let target = format!("https://github.com/hakimel/reveal.js/archive/{reveal_version}.zip");
create_dir_recursive("./docs/slides");
reqwest::get(target.clone()).await.unwrap();
let Ok(response) = reqwest::get(target).await else {
return Err("could not downlaod revealjs".to_string())
};
@@ -61,7 +66,7 @@ impl BuildExecution {
return Ok(());
}
fn build_dir(&mut self, path: &str) -> Result<(), String> {
fn build_dir(&mut self, path: &str, offline_reveal: bool) -> Result<(), String> {
let result = fs_util::fetch_paths_recursive(&path);
let Ok(paths) = result else {
@@ -71,7 +76,7 @@ impl BuildExecution {
for (index, in_path) in paths.iter().enumerate() {
self.progress = index + 1;
self.goal = paths.len();
let result = docki_build(&in_path);
let result = docki_build(&in_path, offline_reveal);
match result {
DockiBuildResult::Err(err) => {
@@ -80,7 +85,8 @@ impl BuildExecution {
},
DockiBuildResult::Copy(out_path) => self.display_building_status("Copy", &in_path, &out_path),
DockiBuildResult::Slide(out_path) => self.display_building_status("Slide", &in_path, &out_path),
DockiBuildResult::Doc(out_path) => self.display_building_status("Doc", &in_path, &out_path)
DockiBuildResult::Doc(out_path) => self.display_building_status("Doc", &in_path, &out_path),
DockiBuildResult::Silent => ()
}
}

View File

@@ -1,5 +1,5 @@
use std::{process::Command, io::ErrorKind};
use colored::Colorize;
use nu_ansi_term::Color::{LightGray, LightGreen, LightRed};
use std::{io::ErrorKind, process::Command};
const INFO_ASCIIDOC: &str = "
Install the binary with your package manager!
@@ -37,7 +37,7 @@ fn check_reveal() -> () {
}
fn reveal_is_installed() -> bool {
return check_command("asciidoctor-revealjs")
return check_command("asciidoctor-revealjs");
}
fn check_asciidoc() -> () {
@@ -49,23 +49,21 @@ fn check_asciidoc() -> () {
}
fn asciidoc_is_installed() -> bool {
return check_command("asciidoctor")
return check_command("asciidoctor");
}
fn check_command(command: &str) -> bool {
return match Command::new(command)
.output() {
return match Command::new(command).output() {
Ok(_) => true,
Err(e) => ErrorKind::NotFound != e.kind()
}
Err(e) => ErrorKind::NotFound != e.kind(),
};
}
fn print_health_ok(name: &str) {
println!("- ✔️ {}", name.bright_green());
println!("- ✔️ {}", LightGreen.paint(name));
}
fn print_health_not_ok(name: &str, info: &str) {
println!("- ❗{}", name.bright_red());
println!("{}", info.bright_black())
println!("- ❗{}", LightRed.paint(name));
println!("{}", LightGray.paint(info))
}

View File

@@ -1,4 +1,4 @@
use colored::Colorize;
use nu_ansi_term::Color::Green;
use futures::StreamExt;
use live_server::listen;
use notify::{
@@ -11,7 +11,7 @@ use crate::app::{ watcher::watcher, build::{docki_build, DockiBuildResult}, comm
pub async fn serve(port: Option<u16>) {
build().await;
build(false).await;
tokio::join!(watch_and_build(), start_server(port));
}
@@ -21,15 +21,18 @@ async fn watch_and_build() {
.expect("something went wrong")
}
async fn start_server(port: Option<u16>) {
let unwrapped_port = port.unwrap_or(8080);
let port = port.unwrap_or(8080);
let link = &format!("http://localhost:{}", port);
let hyperlink = Green.paint(link).hyperlink(link);
println!(
"\nServing at {}{} ",
"http://localhost:".bold(),
unwrapped_port.to_string().bold()
"\nServing at {}",
hyperlink
);
let Ok(()) = listen("localhost", port.unwrap_or(8080), "./dist").await else {
let Ok(()) = listen("localhost", port, "./dist").await else {
panic!("could not start server")
};
}
@@ -59,13 +62,13 @@ fn build_file(paths: Vec<std::path::PathBuf>) {
let in_path = paths
.first()
.expect(invalid_path_message)
.strip_prefix(&current_dir())
.expect(invalid_path_message)
.to_str()
.expect(invalid_path_message)
.replace(&current_dir(), "")
.replace("/./", "./");
.expect(invalid_path_message);
let result = docki_build(&in_path);
let in_path = format!("./{}", in_path);
let result = docki_build(&in_path, false);
match result {
DockiBuildResult::Slide(out_path) => display_rebuilding_status("Slide", &in_path, &out_path),
@@ -75,6 +78,7 @@ fn build_file(paths: Vec<std::path::PathBuf>) {
display_rebuilding_status("Error", &in_path, "");
println!("{}", err);
},
DockiBuildResult::Silent => ()
}
}

View File

@@ -1,20 +1,19 @@
use colored::Colorize;
use nu_ansi_term::Color::LightGreen;
use nu_ansi_term::Color::LightRed;
use nu_ansi_term::Style;
pub fn display_status(context1: &str, context2: &str, in_path: &str, out_path: &str) {
let colored_context = color_context(context2);
let colored_context = if context2 == "Error" {
LightRed.paint(context2)
} else {
LightGreen.paint(context2)
};
println!(
"({}) [{}] {} -> {}",
context1.bold(),
Style::new().paint(context1),
colored_context,
in_path,
out_path
);
}
fn color_context(context: &str) -> colored::ColoredString {
if context == "Error" {
return context.bright_red()
} else {
return context.bright_green()
}
}

View File

@@ -23,11 +23,11 @@ impl App {
Self::setup_environment_variables();
match args.command {
CommandArg::Build => build().await,
CommandArg::Build { offline_reveal } => build(offline_reveal).await,
CommandArg::Health => health(),
CommandArg::InstallReveal => install_reveal().await,
CommandArg::Serve { port } => serve(port).await,
CommandArg::Completions => completions()
CommandArg::Completions { shell } => completions(shell)
};
}

View File

@@ -1,37 +0,0 @@
use crate::app::build::asciidoctor;
#[test]
fn last_matching_index_0() {
let vec1 = vec!["dings", "dings", "dingens"].iter().map(|s| s.to_string()).collect();
let vec2 = vec!["dings", "dings", "dings"].iter().map(|s| s.to_string()).collect();
let last_maching = asciidoctor::matching_from_start(&vec1, &vec2);
assert_eq!(last_maching, 2);
}
#[test]
fn last_matching_index_1() {
let vec1 = vec!["dings", "dings", "dingens", "dings", "dingens"].iter().map(|s| s.to_string()).collect();
let vec2 = vec!["dings", "dings", "dingens", "dings"].iter().map(|s| s.to_string()).collect();
let last_maching = asciidoctor::matching_from_start(&vec1, &vec2);
assert_eq!(last_maching, 4);
}
#[test]
fn path_between_0() {
let path1 = "./docs/dings";
let path2 = "./dist/dings";
let path_between = asciidoctor::path_between(path1.to_string(), path2.to_string());
assert_eq!(path_between, "../../dist/dings");
}
#[test]
fn path_between_1() {
let path1 = "./dist/slides/core/";
let path2 = "./dist/slides/revealjs";
let path_between = asciidoctor::path_between(path1.to_string(), path2.to_string());
assert_eq!(path_between, "../revealjs")
}

View File

@@ -5,5 +5,5 @@ fn test_fetch_asciidoctor_paths_recursive() {
let paths = fs_util::fetch_paths_recursive("res/test/docs").unwrap();
let len = paths.len();
dbg!(paths);
assert_eq!(len, 5);
assert_eq!(len, 6);
}