40 Commits

Author SHA1 Message Date
131bf15240 now displaying missing binary instead of allways asciidoctro. Tested 2025-11-10 13:43:07 +01:00
fd1fe0d896 printing missing binary in the case something is missing. testing later 2025-11-09 22:11:19 +01:00
5996db8d80 Merge pull request #6 from quirinecker/4-make-serving-link-a-clickable-link
Serving link is now clickable
2025-11-09 22:05:32 +01:00
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
23 changed files with 314 additions and 148 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

View File

@@ -1,29 +0,0 @@
name: Rust
on:
push:
branches: [ "main" ]
paths:
- 'Cargo.toml'
pull_request:
branches: [ "main" ]
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

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

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

39
Cargo.lock generated
View File

@@ -630,17 +630,6 @@ dependencies = [
"unicode-width", "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]] [[package]]
name = "concurrent-queue" name = "concurrent-queue"
version = "2.1.0" version = "2.1.0"
@@ -859,16 +848,16 @@ checksum = "212d0f5754cb6769937f4501cc0e67f4f4483c8d2c3e1e922ee9edbe4ab4c7c0"
[[package]] [[package]]
name = "docki" name = "docki"
version = "1.2.1" version = "1.2.3"
dependencies = [ dependencies = [
"bytes", "bytes",
"clap 4.1.8", "clap 4.1.8",
"clap_complete", "clap_complete",
"colored",
"futures", "futures",
"home", "home",
"live-server", "live-server",
"notify 5.1.0", "notify 5.1.0",
"nu-ansi-term",
"regex", "regex",
"reqwest", "reqwest",
"text_io", "text_io",
@@ -1872,6 +1861,15 @@ dependencies = [
"windows-sys 0.42.0", "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]] [[package]]
name = "num-integer" name = "num-integer"
version = "0.1.45" version = "0.1.45"
@@ -3206,6 +3204,12 @@ version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
[[package]]
name = "windows-link"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
[[package]] [[package]]
name = "windows-sys" name = "windows-sys"
version = "0.42.0" version = "0.42.0"
@@ -3230,6 +3234,15 @@ dependencies = [
"windows-targets", "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]] [[package]]
name = "windows-targets" name = "windows-targets"
version = "0.42.1" version = "0.42.1"

View File

@@ -1,20 +1,17 @@
[package] [package]
name = "docki" name = "docki"
version = "1.2.1" version = "1.2.3"
edition = "2021" edition = "2021"
description = "cli for building and publishing documentation using asciidoctor" description = "cli for building and publishing documentation using asciidoctor"
license-file = "LICENSE.txt" license-file = "LICENSE.txt"
authors = ["Quirin Ecker"] authors = ["Quirin Ecker"]
exclude = [ exclude = [".gitlab", ".github"]
".gitlab"
]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
bytes = "1.4.0" bytes = "1.4.0"
clap = { version = "4.1.8", features = ["derive"] } clap = { version = "4.1.8", features = ["derive"] }
colored = "2.0.0"
futures = "0.3.26" futures = "0.3.26"
home = "0.5.4" home = "0.5.4"
live-server = "0.6.0" live-server = "0.6.0"
@@ -25,3 +22,4 @@ text_io = "0.1.12"
tokio = { version = "1.26.0", features = ["full"] } tokio = { version = "1.26.0", features = ["full"] }
zip-extract = "0.1.1" zip-extract = "0.1.1"
clap_complete = "4.1.4" 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

View File

@@ -6,7 +6,7 @@
## Preview ## Preview
![screencast](.gitlab/screencast.gif) ![screencast](.github/assets/screencast.gif)
Docki is cli for converting asciidoctor files into html files. Docki is cli for converting asciidoctor files into html files.
@@ -29,29 +29,26 @@ docki serve
## Installation ## Installation
### Nix
This installation method is recommended, because it will include both asciidoctor and asciidoctor_revealjs.
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.
```shell
nix profile install github:quirinecker/docki
```
### Homebrew ### Homebrew
> [!NOTE]
> Installing it via homebrew will not include asciidoctor_revealjs. It can be installed afterwards with `docki install-reveal`
```shell ```shell
brew tap quirinecker/docki-homebrew https://github.com/quirinecker/docki-homebrew brew tap quirinecker/homebrew-docki https://github.com/quirinecker/homebrew-docki
``` ```
``` ```
brew install 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 ### Cargo
> [!NOTE] > [!NOTE]
@@ -61,6 +58,19 @@ brew install docki
cargo install docki 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) ### Nix (Advanced, Flake)

View File

@@ -120,6 +120,26 @@
naerskLib = naerskLib; naerskLib = naerskLib;
pkgs = pkgs; 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

@@ -16,10 +16,15 @@ pub enum ShellArg {
#[derive(Subcommand)] #[derive(Subcommand)]
pub enum CommandArg { pub enum CommandArg {
/// Builds the documentation into a dist folder /// 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 /// Checks if everything required for docki is installed
Health, Health,
/// Helper command for installing asciidoctor-reveal-js /// Deprecated: Helper command for installing asciidoctor-reveal-js
InstallReveal, InstallReveal,
/// Starts a Webserver with the live preview of the Documentation /// Starts a Webserver with the live preview of the Documentation
Serve { Serve {

View File

@@ -1,3 +1,4 @@
use regex::Regex;
use std::process; use std::process;
fn exec_command(command: &mut process::Command) -> Result<(), String> { fn exec_command(command: &mut process::Command) -> Result<(), String> {
@@ -11,9 +12,13 @@ fn exec_command(command: &mut process::Command) -> Result<(), String> {
} }
} else { } else {
println!("{}", result.unwrap_err()); println!("{}", result.unwrap_err());
return Err(
"asciidoctor not installed. For more information run docki health!".to_string(), let binary_name = command.get_program().to_str().unwrap_or("Something is");
);
return Err(format!(
"{} not installed. For more information run docki health!",
binary_name
));
} }
} }
@@ -27,9 +32,14 @@ fn asciidoctor_docs(in_path: &str, out_path: &str) -> process::Command {
return 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 mut command = process::Command::new(format!("asciidoctor-revealjs"));
let revealjs_path = "/slides/revealjs"; let out_dir = parent_path(out_path);
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 command
.arg(format!("{in_path}")) .arg(format!("{in_path}"))
@@ -40,13 +50,67 @@ fn asciidoctor_slides(in_path: &str, out_path: &str) -> process::Command {
return command; return command;
} }
fn parent_path(child_path: &str) -> String {
let split: Vec<&str> = child_path.split("/").collect();
let slice = &split[..split.len() - 1];
return slice.join("/");
}
pub fn path_between(from: String, to: String) -> String {
let from_segments = transform_input_to_clone_split(&from);
let to_segments = transform_input_to_clone_split(&to);
let last_matching_index = matching_from_start(&from_segments, &to_segments);
let number_of_backs = from_segments.len() - last_matching_index;
let mut path_between = path_back(number_of_backs);
let path_to_to_path = &to_segments[last_matching_index..];
path_between.push_str(&path_to_to_path.join("/"));
return path_between;
}
fn transform_input_to_clone_split(input: &String) -> Vec<String> {
let regex = Regex::new(r"/$").unwrap();
let first_transformation = input.clone().replace("./", "");
return regex
.replace_all(&first_transformation, "")
.to_string()
.split("/")
.collect::<Vec<&str>>()
.iter()
.map(|s| s.to_string())
.collect();
}
fn path_back(count: usize) -> String {
let mut path = "".to_string();
for _ in 0..count {
path.push_str("../");
}
return path;
}
pub fn matching_from_start(from_segments: &Vec<String>, to_segments: &Vec<String>) -> usize {
for (index, from_segment) in from_segments.iter().enumerate() {
if let Some(to_segment) = to_segments.get(index) {
if from_segment != to_segment {
return index;
}
} else {
return index;
}
}
return from_segments.len();
}
pub fn build_doc(in_path: &str, out_path: &str) -> Result<(), String> { pub fn build_doc(in_path: &str, out_path: &str) -> Result<(), String> {
let mut command = asciidoctor_docs(in_path, out_path); let mut command = asciidoctor_docs(in_path, out_path);
return exec_command(&mut command); return exec_command(&mut command);
} }
pub fn build_slide(in_path: &str, out_path: &str) -> Result<(), String> { pub fn build_slide(in_path: &str, out_path: &str, offline_reveal: bool) -> Result<(), String> {
let mut command = asciidoctor_slides(in_path, out_path); let mut command = asciidoctor_slides(in_path, out_path, offline_reveal);
return exec_command(&mut command); return exec_command(&mut command);
} }

View File

@@ -6,12 +6,12 @@ use super::fs_util;
pub mod asciidoctor; pub mod asciidoctor;
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 out_path = in_path.replace("/docs/", "/dist/");
let convert_out_path = out_path.replace(".adoc", ".html"); let convert_out_path = out_path.replace(".adoc", ".html");
if in_path.starts_with("./docs/slides/") && in_path.ends_with(".adoc") { 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); return DockiBuildResult::Err(err);
} }
@@ -23,6 +23,10 @@ pub fn docki_build(in_path: &str) -> DockiBuildResult {
DockiBuildResult::Doc(convert_out_path) DockiBuildResult::Doc(convert_out_path)
} else { } else {
if in_path.starts_with("./docs/slides/revealjs") && !offline_reveal {
return DockiBuildResult::Silent;
}
if let Err(err) = copy(&in_path, &out_path) { if let Err(err) = copy(&in_path, &out_path) {
return DockiBuildResult::Err(err); return DockiBuildResult::Err(err);
} }
@@ -46,4 +50,5 @@ pub enum DockiBuildResult {
Doc(String), Doc(String),
Copy(String), Copy(String),
Err(String), Err(String),
Silent,
} }

View File

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

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(); let path = "./docs/".to_string();
if !fs_util::directory_exists(&path) { 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 Err(error);
} }
return self.build_dir(&path); return self.build_dir(&path, offline_reveal);
} }
async fn prepare() -> Result<(), String> { async fn prepare(offline_reveal: bool) -> Result<(), String> {
let reveal_version = "3.9.2"; if !offline_reveal {
return Ok(())
}
let reveal_version = "5.2.1";
let target = format!("https://github.com/hakimel/reveal.js/archive/{reveal_version}.zip"); let target = format!("https://github.com/hakimel/reveal.js/archive/{reveal_version}.zip");
create_dir_recursive("./docs/slides"); create_dir_recursive("./docs/slides");
reqwest::get(target.clone()).await.unwrap();
let Ok(response) = reqwest::get(target).await else { let Ok(response) = reqwest::get(target).await else {
return Err("could not downlaod revealjs".to_string()) return Err("could not downlaod revealjs".to_string())
}; };
@@ -61,7 +66,7 @@ impl BuildExecution {
return Ok(()); 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 result = fs_util::fetch_paths_recursive(&path);
let Ok(paths) = result else { let Ok(paths) = result else {
@@ -71,7 +76,7 @@ impl BuildExecution {
for (index, in_path) in paths.iter().enumerate() { for (index, in_path) in paths.iter().enumerate() {
self.progress = index + 1; self.progress = index + 1;
self.goal = paths.len(); self.goal = paths.len();
let result = docki_build(&in_path); let result = docki_build(&in_path, offline_reveal);
match result { match result {
DockiBuildResult::Err(err) => { DockiBuildResult::Err(err) => {
@@ -80,7 +85,8 @@ impl BuildExecution {
}, },
DockiBuildResult::Copy(out_path) => self.display_building_status("Copy", &in_path, &out_path), 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::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 nu_ansi_term::Color::{LightGray, LightGreen, LightRed};
use colored::Colorize; use std::{io::ErrorKind, process::Command};
const INFO_ASCIIDOC: &str = " const INFO_ASCIIDOC: &str = "
Install the binary with your package manager! Install the binary with your package manager!
@@ -37,7 +37,7 @@ fn check_reveal() -> () {
} }
fn reveal_is_installed() -> bool { fn reveal_is_installed() -> bool {
return check_command("asciidoctor-revealjs") return check_command("asciidoctor-revealjs");
} }
fn check_asciidoc() -> () { fn check_asciidoc() -> () {
@@ -49,23 +49,21 @@ fn check_asciidoc() -> () {
} }
fn asciidoc_is_installed() -> bool { fn asciidoc_is_installed() -> bool {
return check_command("asciidoctor") return check_command("asciidoctor");
} }
fn check_command(command: &str) -> bool { fn check_command(command: &str) -> bool {
return match Command::new(command) return match Command::new(command).output() {
.output() {
Ok(_) => true, Ok(_) => true,
Err(e) => ErrorKind::NotFound != e.kind() Err(e) => ErrorKind::NotFound != e.kind(),
} };
} }
fn print_health_ok(name: &str) { fn print_health_ok(name: &str) {
println!("- ✔️ {}", name.bright_green()); println!("- ✔️ {}", LightGreen.paint(name));
} }
fn print_health_not_ok(name: &str, info: &str) { fn print_health_not_ok(name: &str, info: &str) {
println!("- ❗{}", name.bright_red()); println!("- ❗{}", LightRed.paint(name));
println!("{}", info.bright_black()) println!("{}", LightGray.paint(info))
} }

View File

@@ -1,4 +1,4 @@
use colored::Colorize; use nu_ansi_term::Color::Green;
use futures::StreamExt; use futures::StreamExt;
use live_server::listen; use live_server::listen;
use notify::{ use notify::{
@@ -11,7 +11,7 @@ use crate::app::{ watcher::watcher, build::{docki_build, DockiBuildResult}, comm
pub async fn serve(port: Option<u16>) { pub async fn serve(port: Option<u16>) {
build().await; build(false).await;
tokio::join!(watch_and_build(), start_server(port)); tokio::join!(watch_and_build(), start_server(port));
} }
@@ -21,15 +21,18 @@ async fn watch_and_build() {
.expect("something went wrong") .expect("something went wrong")
} }
async fn start_server(port: Option<u16>) { 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!( println!(
"\nServing at {}{} ", "\nServing at {}",
"http://localhost:".bold(), hyperlink
unwrapped_port.to_string().bold()
); );
let Ok(()) = listen("localhost", port.unwrap_or(8080), "./dist").await else { let Ok(()) = listen("localhost", port, "./dist").await else {
panic!("could not start server") panic!("could not start server")
}; };
} }
@@ -59,13 +62,13 @@ fn build_file(paths: Vec<std::path::PathBuf>) {
let in_path = paths let in_path = paths
.first() .first()
.expect(invalid_path_message) .expect(invalid_path_message)
.strip_prefix(&current_dir())
.expect(invalid_path_message)
.to_str() .to_str()
.expect(invalid_path_message) .expect(invalid_path_message);
.replace(&current_dir(), "")
.replace("/./", "./");
let in_path = format!("./{}", in_path);
let result = docki_build(&in_path); let result = docki_build(&in_path, false);
match result { match result {
DockiBuildResult::Slide(out_path) => display_rebuilding_status("Slide", &in_path, &out_path), 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, ""); display_rebuilding_status("Error", &in_path, "");
println!("{}", err); 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) { 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!( println!(
"({}) [{}] {} -> {}", "({}) [{}] {} -> {}",
context1.bold(), Style::new().paint(context1),
colored_context, colored_context,
in_path, in_path,
out_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,7 +23,7 @@ impl App {
Self::setup_environment_variables(); Self::setup_environment_variables();
match args.command { match args.command {
CommandArg::Build => build().await, CommandArg::Build { offline_reveal } => build(offline_reveal).await,
CommandArg::Health => health(), CommandArg::Health => health(),
CommandArg::InstallReveal => install_reveal().await, CommandArg::InstallReveal => install_reveal().await,
CommandArg::Serve { port } => serve(port).await, CommandArg::Serve { port } => serve(port).await,

View File

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