6 Commits

42 changed files with 1416 additions and 2660 deletions

6
.dockerignore Normal file
View File

@@ -0,0 +1,6 @@
**
!src
!Cargo.toml
!Cargo.lock
!flake.nix
!flake.lock

Binary file not shown.

Before

Width:  |  Height:  |  Size: 181 KiB

23
.github/workflows/docker.yml vendored Normal file
View File

@@ -0,0 +1,23 @@
name: Docker
on:
push:
branches: ["main", "feature/docker"]
pull_request:
branches: ["main"]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: hustcer/setup-nu@v3
- name: Get Cargo version
run: version=$(nu -c "cargo metadata --format-version=1 --no-deps | from json | get packages | first | get version")
- name: Build docker image
run: docker build -t docki:$version .

View File

@@ -1,40 +0,0 @@
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

29
.github/workflows/rust.yml vendored Normal file
View File

@@ -0,0 +1,29 @@
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

View File

@@ -1,26 +0,0 @@
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 --release --bin docki
- name: Run tests
run: cargo test --verbose
- name: Publish to crates.io
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
run: |
cargo publish --verbose

View File

@@ -1,24 +0,0 @@
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

2
.gitignore vendored
View File

@@ -1,6 +1,6 @@
/target /target
dist dist
/docs
res/test/docs/slides/revealjs res/test/docs/slides/revealjs
res/test/asciidocs/slides/revealjs
res/test/result res/test/result
result result

20
.gitlab-ci.yml Normal file
View File

@@ -0,0 +1,20 @@
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

View File

Before

Width:  |  Height:  |  Size: 18 MiB

After

Width:  |  Height:  |  Size: 18 MiB

2933
Cargo.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,26 +1,20 @@
[package] [package]
name = "docki" name = "docki"
version = "1.3.0" version = "1.2.1"
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 = [".gitlab", ".github"] exclude = [
default-run = "docki" ".gitlab"
]
[[bin]]
name = "docki"
path = "src/main.rs"
[[bin]]
name = "util"
path = "src/util.rs"
# 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"
@@ -31,7 +25,3 @@ 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"
config = { version = "0.15.18", features = ["toml"] }
serde = "1.0.228"
toml = "0.9.6"

11
Dockerfile Normal file
View File

@@ -0,0 +1,11 @@
FROM nixos/nix AS build
WORKDIR /app
COPY . /app
RUN nix --extra-experimental-features nix-command --extra-experimental-features flakes build \
&& nix --extra-experimental-features nix-command --extra-experimental-features flakes store gc
RUN mkdir /out && cp result/bin/docki .

View File

@@ -1,22 +1,19 @@
# Docki # Docki
> [!NOTE]
> This project is under renovations. It can be used, but it might not be completely stable yet.
## Preview ## Preview
![screencast](.github/assets/screencast.gif) ![screencast](.gitlab/screencast.gif)
Docki is cli for converting asciidoctor files into html files. Docki is cli for converting asciidoctor files into html files.
## Usage ## Usage
Docki must be run in a directory with the following structure
![docki directory structure](.github/assets/directory_structure.png)
1. Will be converted into asciidoc format
2. Will be converted into asciidocs slides
> [!NOTE] > [!NOTE]
> The input directory can be defined either with a cli argument or the config file. Default is `./docs` > This works in a directory with a directory called `docs`, which contains the asciidoctor documentation.
### Building the documentation ### Building the documentation
@@ -24,7 +21,7 @@ Docki must be run in a directory with the following structure
docki build docki build
``` ```
### Serving the documentation with a live server ### Serving the documentation on a live server
```shell ```shell
docki serve docki serve
@@ -32,26 +29,29 @@ docki serve
## Installation ## Installation
### Homebrew ### 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 ```shell
brew tap quirinecker/homebrew-docki https://github.com/quirinecker/homebrew-docki nix profile install github:quirinecker/docki
```
### Homebrew
> [!NOTE]
> Installing it via homebrew will not include asciidoctor_revealjs. It can be installed afterwards with `docki install-reveal`
```shell
brew tap quirinecker/docki-homebrew https://github.com/quirinecker/docki-homebrew
``` ```
``` ```
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,19 +61,6 @@ This will open a shell evnironment with docki installed. If you want to install
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)
@@ -115,10 +102,6 @@ home.packages = with pkgs; [
] ]
``` ```
## Configuration
You can configure some of the cli arguments with a config file. It is always located relatively to the current directory under `./docki.config.toml`. Available options and their defaults can be found in the [docki.config.toml](config/docki.config.toml) file. CLI arguments with the same names as in the config usually have also the same default values. As a fallback you can also use the [config.rs](src/app/config/config.rs) file for reference.
## Development ## Development
### Running it ### Running it

View File

@@ -1,4 +0,0 @@
port = 8080
input_dir = "./docs"
offline_reveal = false
output_dir = "./dist"

View File

@@ -64,11 +64,6 @@
libiconv libiconv
makeWrapper makeWrapper
]; ];
binaries = [ "docki" ];
# only including the main binary in build
# There is no better option at the time of writing this
# https://github.com/nix-community/naersk/issues/127
copyBinsFilter = ''select(.reason == "compiler-artifact" and .executable != null and .profile.test == false and .target.name == "docki")'';
postInstall = '' postInstall = ''
mkdir -p $out/share/bash-completion/completions mkdir -p $out/share/bash-completion/completions
mkdir -p $out/share/zsh/site-functions mkdir -p $out/share/zsh/site-functions
@@ -125,26 +120,6 @@
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

@@ -1,16 +0,0 @@
= My Project
:toc:
:toc-title:
:toclevels: 2
== Introduction
This is my project.
== Slides
* link:slides/index.html[Presentation]
== License
This project is licensed under the MIT License - see the link:LICENSE[LICENSE] file for details.

View File

@@ -1,19 +0,0 @@
# Slides
## Slide 1
* First
* Second
* Third
## Slide 2
* First
* Second
* Third
### Slide 3
* First
* Second
* Third

View File

@@ -1,3 +0,0 @@
docs_dir = "./asciidocs"
port = 6969
offline_reveal = false

View File

View File

0
res/test/docs/fail.txt Normal file
View File

View File

View File

@@ -1,16 +0,0 @@
= My Project
:toc:
:toc-title:
:toclevels: 2
== Introduction
This is my project.
== Slides
* link:slides/index.html[Presentation]
== License
This project is licensed under the MIT License - see the link:LICENSE[LICENSE] file for details.

View File

@@ -1,19 +0,0 @@
# Slides
## Slide 1
* First
* Second
* Third
## Slide 2
* First
* Second
* Third
### Slide 3
* First
* Second
* Third

View File

@@ -1,10 +1,10 @@
use clap::Parser; use clap::Parser;
use self::arguments::Args; use self::structure::Args;
pub mod arguments; pub mod structure;
pub mod config;
pub fn args() -> Args { pub fn args() -> Args {
return Args::parse(); return Args::parse();
} }

35
src/app/args/structure.rs Normal file
View File

@@ -0,0 +1,35 @@
use clap::{Parser, Subcommand};
#[derive(Parser)]
pub struct Args {
#[command(subcommand)]
pub command: CommandArg,
}
#[derive(Subcommand)]
pub enum ShellArg {
Bash,
Fish,
Zsh,
}
#[derive(Subcommand)]
pub enum CommandArg {
/// Builds the documentation into a dist folder
Build,
/// Checks if everything required for docki is installed
Health,
/// Helper command for installing asciidoctor-reveal-js
InstallReveal,
/// Starts a Webserver with the live preview of the Documentation
Serve {
/// Port for the Live Server
#[arg(short, long)]
port: Option<u16>,
},
/// Generates completions for the desired shell
Completions {
#[command(subcommand)]
shell: ShellArg,
},
}

View File

@@ -1,8 +1,5 @@
use regex::Regex;
use std::process; use std::process;
use crate::app::config::config::Config;
fn exec_command(command: &mut process::Command) -> Result<(), String> { fn exec_command(command: &mut process::Command) -> Result<(), String> {
let result = command.output(); let result = command.output();
@@ -14,13 +11,9 @@ fn exec_command(command: &mut process::Command) -> Result<(), String> {
} }
} else { } else {
println!("{}", result.unwrap_err()); println!("{}", result.unwrap_err());
return Err(
let binary_name = command.get_program().to_str().unwrap_or("Something is"); "asciidoctor not installed. For more information run docki health!".to_string(),
);
return Err(format!(
"{} not installed. For more information run docki health!",
binary_name
));
} }
} }
@@ -34,17 +27,9 @@ fn asciidoctor_docs(in_path: &str, out_path: &str) -> process::Command {
return command; return command;
} }
fn asciidoctor_slides(in_path: &str, out_path: &str, config: &Config) -> process::Command { fn asciidoctor_slides(in_path: &str, out_path: &str) -> process::Command {
let mut command = process::Command::new(format!("asciidoctor-revealjs")); 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 config.offline_reveal {
path_between(
out_dir.to_string(),
format!("{}/slides/revealjs", config.output_dir),
)
} else {
"https://cdn.jsdelivr.net/npm/reveal.js@5.2.1".to_string()
};
command command
.arg(format!("{in_path}")) .arg(format!("{in_path}"))
@@ -55,67 +40,13 @@ fn asciidoctor_slides(in_path: &str, out_path: &str, config: &Config) -> process
return command; return command;
} }
fn parent_path(child_path: &str) -> String { pub fn build_doc(in_path: &str, out_path: &str) -> Result<(), 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, _: &Config) -> 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, config: &Config) -> Result<(), String> { pub fn build_slide(in_path: &str, out_path: &str) -> Result<(), String> {
let mut command = asciidoctor_slides(in_path, out_path, config); let mut command = asciidoctor_slides(in_path, out_path);
return exec_command(&mut command); return exec_command(&mut command);
} }

View File

@@ -1,147 +1,46 @@
use std::fs;
use self::asciidoctor::{build_doc, build_slide};
use super::fs_util;
pub mod asciidoctor; pub mod asciidoctor;
use std::{ pub fn docki_build(in_path: &str) -> DockiBuildResult {
fs, io::Cursor, path::PathBuf let out_path = in_path.replace("/docs/", "/dist/");
}; let convert_out_path = out_path.replace(".adoc", ".html");
use crate::app::{ if in_path.starts_with("./docs/slides/") && in_path.ends_with(".adoc") {
build::{asciidoctor::build_slide, asciidoctor::build_doc}, config::config::Config, fs_util::{self, create_dir_recursive}, log::display_status if let Err(err) = build_slide(&in_path, &convert_out_path) {
}; return DockiBuildResult::Err(err);
}
pub struct DockiBuilder<'a> { DockiBuildResult::Slide(convert_out_path)
progress: usize, } else if in_path.ends_with(".adoc") {
goal: usize, if let Err(err) = build_doc(&in_path, &convert_out_path) {
config: &'a Config return DockiBuildResult::Err(err);
}
DockiBuildResult::Doc(convert_out_path)
} else {
if let Err(err) = copy(&in_path, &out_path) {
return DockiBuildResult::Err(err);
}
DockiBuildResult::Copy(out_path)
}
} }
impl <'a> DockiBuilder <'a> { fn copy(in_path: &str, out_path: &str) -> Result<(), String> {
pub fn new(config: &'a Config) -> Self { fs_util::create_parent_dir_recursive(out_path);
return Self {
progress: 0, if let Err(err) = fs::copy(in_path, out_path) {
goal: 0, return Err(err.to_string());
config: config
};
}
///
/// Prepares everything for building the documentation
///
/// 1. Checks if the input directory exists and if not, returns an error
/// 2. When offline_reveal is set to true, it downloads revealjs. When it fails, it returns an error
pub async fn prepare(&self) -> Result<(), String> {
if !fs_util::directory_exists(&self.config.input_dir) {
return Err(
"docs directory does not exist it. Create it or use the template".to_string(),
);
}
if !self.config.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(format!("{}/slides", self.config.input_dir).as_str());
reqwest::get(target.clone()).await.unwrap();
let Ok(response) = reqwest::get(target).await else {
return Err("could not downlaod revealjs".to_string())
};
let Ok(bytes) = response.bytes().await else {
return Err("could not extract bytes".to_string())
};
let out = PathBuf::from(format!("{}/slides/revealjs", self.config.input_dir));
if zip_extract::extract(Cursor::new(bytes), &out, true).is_err() {
return Err("could not write extracted archive to disk".to_string());
}
return Ok(());
}
/// Builds all files in the input directory with a pretty output
pub fn build_docs(&mut self) -> Result<(), String> {
let result = fs_util::fetch_paths_recursive(&self.config.input_dir);
let Ok(paths) = result else {
return Err(result.unwrap_err())
};
let reveal_dir = format!("{}/slides/revealjs", self.config.input_dir);
let paths = paths.into_iter()
.filter(|path| self.config.offline_reveal || !path.starts_with(reveal_dir.as_str()))
.collect::<Vec<String>>();
self.goal = paths.len();
for (index, in_path) in paths.iter().enumerate() {
self.progress = index + 1;
let result = self.build_file(&in_path);
match result {
DockiBuildResult::Err(err) => {
self.display_building_status("Error", &in_path, "");
println!("{}", err)
},
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),
}
}
return Ok(());
}
/// Builds a single file without a pretty output
pub fn build_file(&self, path: &str) -> DockiBuildResult {
let out_path = path.replace(&self.config.input_dir, &self.config.output_dir);
let convert_out_path = out_path.replace(".adoc", ".html");
if path.starts_with(format!("{}/slides/", &self.config.input_dir).as_str()) && path.ends_with(".adoc") {
if let Err(err) = build_slide(&path, &convert_out_path, self.config) {
return DockiBuildResult::Err(err);
}
DockiBuildResult::Slide(convert_out_path)
} else if path.ends_with(".adoc") {
if let Err(err) = build_doc(&path, &convert_out_path, self.config) {
return DockiBuildResult::Err(err);
}
DockiBuildResult::Doc(convert_out_path)
} else {
if let Err(err) = Self::copy(&path, &out_path) {
return DockiBuildResult::Err(err);
}
DockiBuildResult::Copy(out_path)
}
}
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());
}
Ok(())
}
fn display_building_status(&self, status_type: &str, in_path: &str, out_path: &str) -> () {
let progress_str = format!("{} / {}", self.progress, self.goal);
display_status(&progress_str, status_type, in_path, out_path);
} }
Ok(())
} }
/// Used for the Result of build_file. This way it is known what the builder did
pub enum DockiBuildResult { pub enum DockiBuildResult {
Slide(String), Slide(String),
Doc(String), Doc(String),

View File

@@ -1,10 +1,6 @@
use crate::app::config::config::Config; use super::executions::build_execution::BuildExecution;
use crate::app::build::DockiBuilder; pub async fn build() -> () {
let mut build_execution = BuildExecution::new();
pub async fn build(config: &Config) -> () { build_execution.execute().await.expect("build failed")
let mut builder = DockiBuilder::new(config);
builder.prepare().await.expect("could not prepare for build");
builder.build_docs().expect("build failed")
} }

View File

@@ -3,7 +3,7 @@ use std::io;
use clap::CommandFactory; use clap::CommandFactory;
use clap_complete::{generate, shells::{Bash, Fish, Zsh}}; use clap_complete::{generate, shells::{Bash, Fish, Zsh}};
use crate::app::config::arguments::{Args, ShellArg}; use crate::app::args::structure::{Args, ShellArg};
pub fn completions(shell: ShellArg) { pub fn completions(shell: ShellArg) {
let mut command = Args::command(); let mut command = Args::command();

View File

@@ -0,0 +1,95 @@
use std::{
io::Cursor,
path::PathBuf
};
use crate::app::{
build::{docki_build, DockiBuildResult},
fs_util::{self, create_dir_recursive}, log::display_status,
};
pub struct BuildExecution {
progress: usize,
goal: usize,
}
impl BuildExecution {
pub fn new() -> Self {
return BuildExecution {
progress: 0,
goal: 0,
};
}
pub async fn execute(&mut self) -> Result<(), String> {
let path = "./docs/".to_string();
if !fs_util::directory_exists(&path) {
return Err(
"docs directory does not exist it. Create it or use the template".to_string(),
);
}
if let Err(error) = Self::prepare().await {
return Err(error);
}
return self.build_dir(&path);
}
async fn prepare() -> Result<(), String> {
let reveal_version = "3.9.2";
let target = format!("https://github.com/hakimel/reveal.js/archive/{reveal_version}.zip");
create_dir_recursive("./docs/slides");
let Ok(response) = reqwest::get(target).await else {
return Err("could not downlaod revealjs".to_string())
};
let Ok(bytes) = response.bytes().await else {
return Err("could not extract bytes".to_string())
};
let out = PathBuf::from("./docs/slides/revealjs");
if zip_extract::extract(Cursor::new(bytes), &out, true).is_err() {
return Err("could not write extracted archive to disk".to_string());
}
return Ok(());
}
fn build_dir(&mut self, path: &str) -> Result<(), String> {
let result = fs_util::fetch_paths_recursive(&path);
let Ok(paths) = result else {
return Err(result.unwrap_err())
};
for (index, in_path) in paths.iter().enumerate() {
self.progress = index + 1;
self.goal = paths.len();
let result = docki_build(&in_path);
match result {
DockiBuildResult::Err(err) => {
self.display_building_status("Error", in_path, "");
println!("{}", err)
},
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)
}
}
return Ok(());
}
fn display_building_status(&self, status_type: &str, in_path: &str, out_path: &str) -> () {
let progress_str = format!("{} / {}", self.progress, self.goal);
display_status(&progress_str, status_type, in_path, out_path);
}
}

View File

@@ -0,0 +1 @@
pub mod build_execution;

View File

@@ -1,5 +1,5 @@
use nu_ansi_term::Color::{LightGray, LightGreen, LightRed}; use std::{process::Command, io::ErrorKind};
use std::{io::ErrorKind, process::Command}; use colored::Colorize;
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,21 +49,23 @@ 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).output() { return match Command::new(command)
.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!("- ✔️ {}", LightGreen.paint(name)); println!("- ✔️ {}", name.bright_green());
} }
fn print_health_not_ok(name: &str, info: &str) { fn print_health_not_ok(name: &str, info: &str) {
println!("- ❗{}", LightRed.paint(name)); println!("- ❗{}", name.bright_red());
println!("{}", LightGray.paint(info)) println!("{}", info.bright_black())
} }

View File

@@ -1,5 +1,6 @@
pub mod build; pub mod build;
pub mod completions; pub mod completions;
pub mod executions;
pub mod health; pub mod health;
pub mod install_reveal; pub mod install_reveal;
pub mod serve; pub mod serve;

View File

@@ -1,4 +1,4 @@
use nu_ansi_term::Color::Green; use colored::Colorize;
use futures::StreamExt; use futures::StreamExt;
use live_server::listen; use live_server::listen;
use notify::{ use notify::{
@@ -7,115 +7,88 @@ use notify::{
}; };
use std::{env, path::Path}; use std::{env, path::Path};
use crate::app::watcher::watcher; use crate::app::{ watcher::watcher, build::{docki_build, DockiBuildResult}, commands::build::build, log::display_status};
use crate::app::log::display_status;
use crate::app::config::config::Config;
use crate::app::build::{DockiBuildResult, DockiBuilder};
pub async fn serve(config: &Config) {
let builder = DockiBuilder::new(config); pub async fn serve(port: Option<u16>) {
let mut server = Server::new(builder, config); build().await;
server.serve().await; tokio::join!(watch_and_build(), start_server(port));
} }
struct Server<'a> { async fn watch_and_build() {
builder: DockiBuilder<'a>, watch(Path::new("./docs"))
config: &'a Config, .await
.expect("something went wrong")
} }
impl <'a> Server <'a> { async fn start_server(port: Option<u16>) {
fn new(builder: DockiBuilder<'a>, config: &'a Config) -> Self { let unwrapped_port = port.unwrap_or(8080);
return Self { println!(
builder, "\nServing at {}{} ",
config: config "http://localhost:".bold(),
} unwrapped_port.to_string().bold()
} );
async fn serve(&mut self) { let Ok(()) = listen("localhost", port.unwrap_or(8080), "./dist").await else {
self.builder.prepare().await.expect("could not prepare for build"); panic!("could not start server")
self.builder.build_docs().expect("build failed"); };
tokio::join!(self.start_server(), self.watch_and_build());
}
async fn start_server(&self) {
let link = &format!("http://localhost:{}", self.config.port);
let hyperlink = Green.paint(link).hyperlink(link);
println!(
"\nServing at {}",
hyperlink
);
let Ok(()) = listen("localhost", self.config.port, self.config.output_dir.clone()).await else {
panic!("could not start server")
};
}
async fn watch_and_build(&self) {
self.watch()
.await
.expect("something went wrong")
}
async fn watch(&self) -> notify::Result<()> {
let path = Path::new(&self.config.input_dir);
let (mut watcher, mut rx) = watcher()?;
watcher.watch(path.as_ref(), RecursiveMode::Recursive)?;
while let Some(res) = rx.next().await {
let event = res.expect("watching failed");
self.file_change(event)
}
Ok(())
}
fn file_change(&self, event: Event) {
match event.kind {
EventKind::Modify(ModifyKind::Data(_)) => self.build_valid_files(event.paths),
_ => (),
}
}
fn build_valid_files(&self, paths: Vec<std::path::PathBuf>) {
let invalid_path_message = "changed path is invalid";
let in_path = paths
.first()
.expect(invalid_path_message)
.strip_prefix(&Self::current_dir())
.expect(invalid_path_message)
.to_str()
.expect(invalid_path_message);
let in_path = format!("./{}", in_path);
let result = self.builder.build_file(&in_path);
match result {
DockiBuildResult::Slide(out_path) => Self::display_rebuilding_status("Slide", &in_path, &out_path),
DockiBuildResult::Doc(out_path) => Self::display_rebuilding_status("Doc", &in_path, &out_path),
DockiBuildResult::Copy(out_path) => Self::display_rebuilding_status("Copy", &in_path, &out_path),
DockiBuildResult::Err(err) => {
Self::display_rebuilding_status("Error", &in_path, "");
println!("{}", err);
},
}
}
fn display_rebuilding_status(context: &str, in_path: &str, out_path: &str) {
display_status("Rebuildng", context, in_path, out_path)
}
fn current_dir() -> String {
let err_message = "something went wrong";
return String::from(
env::current_dir()
.expect(err_message)
.to_str()
.expect(err_message),
);
}
} }
async fn watch(path: &Path) -> notify::Result<()> {
let (mut watcher, mut rx) = watcher()?;
watcher.watch(path.as_ref(), RecursiveMode::Recursive)?;
while let Some(res) = rx.next().await {
let event = res.expect("watching failed");
file_change(event)
}
Ok(())
}
fn file_change(event: Event) {
match event.kind {
EventKind::Modify(ModifyKind::Data(_)) => build_file(event.paths),
_ => (),
}
}
fn build_file(paths: Vec<std::path::PathBuf>) {
let invalid_path_message = "changed path is invalid";
let in_path = paths
.first()
.expect(invalid_path_message)
.to_str()
.expect(invalid_path_message)
.replace(&current_dir(), "")
.replace("/./", "./");
let result = docki_build(&in_path);
match result {
DockiBuildResult::Slide(out_path) => display_rebuilding_status("Slide", &in_path, &out_path),
DockiBuildResult::Doc(out_path) => display_rebuilding_status("Doc", &in_path, &out_path),
DockiBuildResult::Copy(out_path) => display_rebuilding_status("Copy", &in_path, &out_path),
DockiBuildResult::Err(err) => {
display_rebuilding_status("Error", &in_path, "");
println!("{}", err);
},
}
}
fn display_rebuilding_status(context: &str, in_path: &str, out_path: &str) {
display_status("Rebuildng", context, in_path, out_path)
}
fn current_dir() -> String {
let err_message = "something went wrong";
return String::from(
env::current_dir()
.expect(err_message)
.to_str()
.expect(err_message),
);
}

View File

@@ -1,60 +0,0 @@
use clap::{Parser, Subcommand};
use nu_ansi_term::{AnsiGenericString, Style};
fn github_hyperlink() -> AnsiGenericString<'static, str> {
return Style::new()
.bold()
.underline()
.paint("https://github.com/quirinecker/docki")
.hyperlink("https://github.com/quirinecker/docki");
}
#[derive(Parser)]
#[command(after_help = format!("More information like defaults can be found at {}", github_hyperlink()))]
pub struct Args {
#[command(subcommand)]
pub command: CommandArg,
/// The directory where the documentation is located
#[arg(short, long, global = true)]
pub input_dir: Option<String>,
/// The directory where the documentation will be built
#[arg(short, long, global = true)]
pub output_dir: Option<String>,
/// When set to true, docki will download revealjs before building the documentation.
/// Otherwise it will use the cdn for revealjs
#[arg(long, global = true)]
pub offline_reveal: bool,
}
#[derive(Subcommand)]
pub enum ShellArg {
Bash,
Fish,
Zsh,
}
#[derive(Subcommand)]
pub enum CommandArg {
/// Builds the documentation into the specified output_dir
Build,
/// Checks if everything required for docki is installed
Health,
/// 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
#[arg(short, long)]
port: Option<u16>,
},
/// Generates completions for the desired shell
Completions {
#[command(subcommand)]
shell: ShellArg,
},
}
impl Args {}

View File

@@ -1,44 +0,0 @@
use serde::{Deserialize, Serialize};
use crate::app::config::arguments::CommandArg;
#[derive(Deserialize, Debug, Serialize)]
#[serde(default)]
pub struct Config {
pub port: u16,
pub input_dir: String,
pub offline_reveal: bool,
pub output_dir: String,
}
impl Config {
pub fn load() -> Result<Self, config::ConfigError> {
let s = config::Config::builder()
.add_source(config::File::with_name("./docki.config.toml"))
.build()?;
s.try_deserialize()
}
pub fn merge_with_args(self, args: &super::arguments::Args) -> Self {
Self {
port: match args.command {
CommandArg::Serve { port } => port.unwrap_or(self.port),
_ => self.port,
},
input_dir: args.input_dir.clone().unwrap_or(self.input_dir),
output_dir: args.output_dir.clone().unwrap_or(self.output_dir),
offline_reveal: args.offline_reveal || self.offline_reveal,
}
}
}
impl Default for Config {
fn default() -> Self {
Self {
port: 8080,
input_dir: "./docs".to_string(),
output_dir: "./dist".to_string(),
offline_reveal: false,
}
}
}

View File

@@ -1,19 +1,20 @@
use nu_ansi_term::Color::LightGreen; use colored::Colorize;
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 = if context2 == "Error" { let colored_context = color_context(context2);
LightRed.paint(context2)
} else {
LightGreen.paint(context2)
};
println!( println!(
"({}) [{}] {} -> {}", "({}) [{}] {} -> {}",
Style::new().paint(context1), context1.bold(),
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

@@ -3,13 +3,11 @@ pub mod build;
pub mod fs_util; pub mod fs_util;
pub mod watcher; pub mod watcher;
pub mod log; pub mod log;
pub mod config; mod args;
use std::env; use std::env;
use crate::app::config::config::Config; use self::args::{args, structure::CommandArg};
use self::config::{args, arguments::CommandArg};
use self::commands::build::build; use self::commands::build::build;
use self::commands::completions::completions; use self::commands::completions::completions;
use self::commands::health::health; use self::commands::health::health;
@@ -22,14 +20,13 @@ impl App {
pub async fn start(&self) { pub async fn start(&self) {
let args = args(); let args = args();
let config = Config::load().unwrap_or(Config::default()).merge_with_args(&args);
Self::setup_environment_variables(); Self::setup_environment_variables();
match args.command { match args.command {
CommandArg::Build { .. } => build(&config).await, CommandArg::Build => build().await,
CommandArg::Health => health(), CommandArg::Health => health(),
CommandArg::InstallReveal => install_reveal().await, CommandArg::InstallReveal => install_reveal().await,
CommandArg::Serve { .. } => serve(&config).await, CommandArg::Serve { port } => serve(port).await,
CommandArg::Completions { shell } => completions(shell) CommandArg::Completions { shell } => completions(shell)
}; };
} }

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, 2); assert_eq!(len, 5);
} }

View File

@@ -1,34 +0,0 @@
mod app;
use std::{fs::File, io::Write};
use app::config::config::Config;
use clap::{Parser, Subcommand};
#[derive(Parser)]
pub struct Args {
#[command(subcommand)]
pub command: CommandArg,
}
#[derive(Subcommand)]
pub enum CommandArg {
/// Generates a default docki.config.toml
GenerateDefaultConfig,
}
fn main() {
let args = Args::parse();
match args.command {
CommandArg::GenerateDefaultConfig => generate_default_config(),
}
}
fn generate_default_config() {
let default_config = Config::default();
let target_file = "config/docki.config.toml";
let mut file = File::create(target_file).unwrap();
let output = toml::to_string_pretty(&default_config).unwrap();
file.write_all(output.as_bytes()).unwrap();
}