roc-lang/roc
1
1
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2024-07-14 22:00:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add --output CLI flag for roc docs

Browse Source
This commit is contained in:
Richard Feldman 2023-10-19 17:21:27 -04:00
parent 77d2136d00
commit a96752a65a
No known key found for this signature in database
GPG Key ID: F1F21AA5B1D9E43B
4 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
crates/cli/src/lib.rs
View File

@ -63,6 +63,7 @@ pub const FLAG_LINKER: &str = "linker";
pub const FLAG_PREBUILT: &str = "prebuilt-platform";
pub const FLAG_CHECK: &str = "check";
pub const FLAG_WASM_STACK_SIZE_KB: &str = "wasm-stack-size-kb";
pub const FLAG_OUTPUT: &str = "output";
pub const ROC_FILE: &str = "ROC_FILE";
pub const ROC_DIR: &str = "ROC_DIR";
pub const GLUE_DIR: &str = "GLUE_DIR";
@ -71,6 +72,7 @@ pub const DIRECTORY_OR_FILES: &str = "DIRECTORY_OR_FILES";
pub const ARGS_FOR_APP: &str = "ARGS_FOR_APP";
const VERSION: &str = include_str!("../../../version.txt");
const DEFAULT_GENERATED_DOCS_DIR: &str = "generated-docs";
pub fn build_app() -> Command {
let flag_optimize = Arg::new(FLAG_OPTIMIZE)
@ -276,6 +278,13 @@ pub fn build_app() -> Command {
.subcommand(
Command::new(CMD_DOCS)
.about("Generate documentation for a Roc package")
.arg(Arg::new(FLAG_OUTPUT)
.long(FLAG_OUTPUT)
.help("Output directory for the generated documentation files.")
.value_parser(value_parser!(OsString))
.required(false)
.default_value(DEFAULT_GENERATED_DOCS_DIR),
)
.arg(Arg::new(ROC_FILE)
.help("The package's main .roc file")
.value_parser(value_parser!(PathBuf))

7
crates/cli/src/main.rs
View File

@ -4,8 +4,8 @@ use roc_build::program::{check_file, CodeGenBackend};
use roc_cli::{
build_app, format, test, BuildConfig, FormatMode, CMD_BUILD, CMD_CHECK, CMD_DEV, CMD_DOCS,
CMD_FORMAT, CMD_GEN_STUB_LIB, CMD_GLUE, CMD_REPL, CMD_RUN, CMD_TEST, CMD_VERSION,
DIRECTORY_OR_FILES, FLAG_CHECK, FLAG_DEV, FLAG_LIB, FLAG_NO_LINK, FLAG_TARGET, FLAG_TIME,
GLUE_DIR, GLUE_SPEC, ROC_FILE,
DIRECTORY_OR_FILES, FLAG_CHECK, FLAG_DEV, FLAG_LIB, FLAG_NO_LINK, FLAG_OUTPUT, FLAG_TARGET,
FLAG_TIME, GLUE_DIR, GLUE_SPEC, ROC_FILE,
};
use roc_docs::generate_docs_html;
use roc_error_macros::user_error;
@ -213,8 +213,9 @@ fn main() -> io::Result<()> {
Some((CMD_REPL, _)) => Ok(roc_repl_cli::main()),
Some((CMD_DOCS, matches)) => {
let root_path = matches.get_one::<PathBuf>(ROC_FILE).unwrap();
let out_dir = matches.get_one::<OsString>(FLAG_OUTPUT).unwrap();
generate_docs_html(root_path.to_owned());
generate_docs_html(root_path.to_owned(), out_dir.as_ref());
Ok(0)
}

5
crates/docs/src/lib.rs
View File

@ -17,12 +17,9 @@ use roc_region::all::Region;
use std::fs;
use std::path::{Path, PathBuf};
const BUILD_DIR: &str = "./generated-docs";
const LINK_SVG: &str = include_str!("./static/link.svg");
pub fn generate_docs_html(root_file: PathBuf) {
let build_dir = Path::new(BUILD_DIR);
pub fn generate_docs_html(root_file: PathBuf, build_dir: &Path) {
let loaded_module = load_module_for_docs(root_file);
// TODO get these from the platform's source file rather than hardcoding them!

5
crates/docs_cli/src/main.rs
View File

@ -20,7 +20,10 @@ fn main() -> io::Result<()> {
.get_matches();
// Populate roc_files
generate_docs_html(matches.get_one::<PathBuf>(ROC_FILE).unwrap().to_owned());
generate_docs_html(
matches.get_one::<PathBuf>(ROC_FILE).unwrap().to_owned(),
&PathBuf::from("./generated-docs"),
);
Ok(())
}