dualfroz
085385c3e4
exclude_selectors is the only way the config can reach into a page, and it carries the semantics of data-pagefind-ignore="index". Every other control Pagefind has lives on an attribute, so reaching it from the config meant a new flag per attribute. Add a rules list that pairs a selector with the attributes to set on the elements it matches. The attributes are applied before every other handler, so the rest of the parser reads them exactly as if the page had carried them, and every documented attribute is reachable without new flags. An attribute already present on the element wins, so a rule never overrides markup. A selector that cannot be parsed is reported and skipped. Rules are config-file only: a list of selectors with attribute maps does not fit a CLI flag or an environment variable.
385 lines
13 KiB
Rust
385 lines
13 KiB
Rust
//! Configuration that can be supplied to the `api` module when using Pagefind as a service.
|
|
|
|
use anyhow::{bail, Result};
|
|
use clap::Parser;
|
|
use rust_patch::Patch;
|
|
use serde::{Deserialize, Serialize};
|
|
use std::{collections::BTreeMap, env, path::PathBuf};
|
|
use twelf::config;
|
|
use typed_builder::TypedBuilder;
|
|
|
|
use crate::{
|
|
logging::{LogLevel, Logger},
|
|
utils::WORD_SYMBOLS,
|
|
};
|
|
|
|
//
|
|
// If editing this configuration struct,
|
|
// also make sure to edit the patch config below,
|
|
// (if it makes sense for that option to be set via the service),
|
|
// and also update any wrapper packages to include definitions for that option.
|
|
//
|
|
// No options should be added that are required.
|
|
//
|
|
|
|
/// A selector paired with the Pagefind attributes to set on the elements it matches,
|
|
/// so a site can be configured with the same vocabulary its HTML would use.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)]
|
|
pub(crate) struct PagefindRule {
|
|
pub(crate) selector: String,
|
|
#[serde(default)]
|
|
pub(crate) attributes: BTreeMap<String, String>,
|
|
}
|
|
|
|
#[config]
|
|
#[derive(Parser, Debug, Clone)]
|
|
#[clap(author, version, about, long_about = None)]
|
|
pub(crate) struct PagefindInboundConfig {
|
|
#[clap(long, help = "DEPRECATED: Use the `site` option instead")]
|
|
#[clap(required = false, hide = true)]
|
|
#[serde(default)] // This is actually required, but we validate that later
|
|
pub(crate) source: String,
|
|
|
|
#[clap(long, short, help = "The location of your built static website")]
|
|
#[clap(required = false)]
|
|
#[serde(default)] // This is actually required, but we validate that later
|
|
pub(crate) site: String,
|
|
|
|
#[clap(
|
|
long,
|
|
short,
|
|
help = "DEPRECATED: Use `output_subdir` or `output_path` instead"
|
|
)]
|
|
#[clap(required = false, hide = true)]
|
|
pub(crate) bundle_dir: Option<String>,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Where to output the search bundle, relative to the processed site"
|
|
)]
|
|
#[clap(required = false)]
|
|
pub(crate) output_subdir: Option<String>,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Where to output the search bundle, relative to the working directory of the command"
|
|
)]
|
|
#[clap(required = false)]
|
|
pub(crate) output_path: Option<String>,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "The element Pagefind should treat as the root of the document. Usually you will want to use the data-pagefind-body attribute instead."
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_root_selector")]
|
|
pub(crate) root_selector: String,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Custom selectors that Pagefind should ignore when indexing. Usually you will want to use the data-pagefind-ignore attribute instead."
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default)]
|
|
pub(crate) exclude_selectors: Vec<String>,
|
|
|
|
/// Not a CLI flag: a list of selectors with attribute maps does not fit an argument.
|
|
#[clap(skip)]
|
|
#[serde(default)]
|
|
pub(crate) rules: Vec<PagefindRule>,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "The file glob Pagefind uses to find HTML files. Defaults to \"**/*.{html}\""
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_glob")]
|
|
pub(crate) glob: String,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Ignore any detected languages and index the whole site as a single language. Expects an ISO 639-1 code."
|
|
)]
|
|
#[clap(required = false)]
|
|
pub(crate) force_language: Option<String>,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Include these characters when indexing and searching words. Useful for sites documenting technical topics such as programming languages."
|
|
)]
|
|
#[clap(required = false)]
|
|
pub(crate) include_characters: Option<String>,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Serve the source directory after creating the search index"
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_false")]
|
|
pub(crate) serve: bool,
|
|
|
|
#[clap(
|
|
long,
|
|
short,
|
|
help = "Print verbose logging while indexing the site. Does not impact the web-facing search."
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_false")]
|
|
pub(crate) verbose: bool,
|
|
|
|
#[clap(
|
|
long,
|
|
short,
|
|
help = "Only log errors and warnings while indexing the site. Does not impact the web-facing search."
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_false")]
|
|
pub(crate) quiet: bool,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Only log errors while indexing the site. Does not impact the web-facing search."
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_false")]
|
|
pub(crate) silent: bool,
|
|
|
|
#[clap(
|
|
long,
|
|
short,
|
|
help = "Path to a logfile to write to. Will replace the file on each run"
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default)]
|
|
pub(crate) logfile: Option<String>,
|
|
|
|
#[clap(
|
|
long,
|
|
short,
|
|
help = "Keep \"index.html\" at the end of search result paths. Defaults to false, stripping \"index.html\"."
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_false")]
|
|
pub(crate) keep_index_url: bool,
|
|
|
|
#[clap(
|
|
long,
|
|
help = "Output the Pagefind Playground to <bundle_dir>/playground/ when building the search index. By default, this is only available via --serve."
|
|
)]
|
|
#[clap(required = false)]
|
|
#[serde(default = "defaults::default_false")]
|
|
pub(crate) write_playground: bool,
|
|
|
|
#[clap(long)]
|
|
#[clap(required = false, hide = true)]
|
|
#[serde(default = "defaults::default_false")]
|
|
pub(crate) service: bool,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize, Serialize, Patch, TypedBuilder)]
|
|
#[patch = "PagefindInboundConfig"]
|
|
#[builder(
|
|
doc,
|
|
field_defaults(default, setter(strip_option)),
|
|
builder_method(
|
|
vis = "pub",
|
|
doc = "Create a builder for building `PagefindServiceConfig` for the api."
|
|
),
|
|
builder_type(vis = "pub"),
|
|
build_method(vis = "pub")
|
|
)]
|
|
/// Fields that can be set via the Pagefind service.
|
|
/// In other words, the subset of the Pagefind configuration that makes sense to set globally,
|
|
/// excluding fields that are irrelevant or set when each individual method is called.
|
|
///
|
|
/// Must be constructed through the `PagefindServiceConfigBuilder` interface.
|
|
pub struct PagefindServiceConfig {
|
|
/// The element Pagefind should treat as the root of the document.
|
|
pub(crate) root_selector: Option<String>,
|
|
/// Custom selectors that Pagefind should ignore when indexing.
|
|
pub(crate) exclude_selectors: Option<Vec<String>>,
|
|
#[patch(as_option)]
|
|
/// Ignore any detected languages and index the whole site as a single language. Expects an ISO 639-1 code.
|
|
pub(crate) force_language: Option<String>,
|
|
/// Print verbose logging while indexing the site. Does not impact the web-facing search.
|
|
pub(crate) verbose: Option<bool>,
|
|
#[patch(as_option)]
|
|
/// Path to a logfile to write to. Will replace the file on each run
|
|
pub(crate) logfile: Option<String>,
|
|
/// Keep \"index.html\" at the end of search result paths. Defaults to false, stripping \"index.html\".
|
|
pub(crate) keep_index_url: Option<bool>,
|
|
/// Output the Pagefind Playground to <bundle_dir>/playground/ when building the search index.
|
|
pub(crate) write_playground: Option<bool>,
|
|
#[patch(as_option)]
|
|
/// Include these characters when indexing and searching words.
|
|
pub(crate) include_characters: Option<String>,
|
|
}
|
|
|
|
mod defaults {
|
|
pub fn default_bundle_dir() -> String {
|
|
"pagefind".into()
|
|
}
|
|
pub fn default_root_selector() -> String {
|
|
"html".into()
|
|
}
|
|
pub fn default_glob() -> String {
|
|
"**/*.{html}".into()
|
|
}
|
|
pub fn default_false() -> bool {
|
|
false
|
|
}
|
|
pub fn default_index_chunk_size() -> usize {
|
|
20000
|
|
}
|
|
}
|
|
|
|
// The configuration object used internally
|
|
#[derive(Debug, Clone)]
|
|
pub(crate) struct SearchOptions {
|
|
pub(crate) working_directory: PathBuf,
|
|
pub(crate) site_source: PathBuf,
|
|
pub(crate) bundle_output: PathBuf,
|
|
pub(crate) root_selector: String,
|
|
pub(crate) exclude_selectors: Vec<String>,
|
|
pub(crate) rules: Vec<PagefindRule>,
|
|
pub(crate) glob: String,
|
|
pub(crate) force_language: Option<String>,
|
|
pub(crate) include_characters: Vec<char>,
|
|
pub(crate) version: &'static str,
|
|
pub(crate) logger: Logger,
|
|
pub(crate) keep_index_url: bool,
|
|
pub(crate) running_as_service: bool,
|
|
pub(crate) write_playground: bool,
|
|
pub(crate) config_warnings: ConfigWarnings,
|
|
pub(crate) index_chunk_size: usize,
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub(crate) struct ConfigWarnings {
|
|
pub(crate) unconfigured_bundle_output: bool,
|
|
pub(crate) using_deprecated_source: bool,
|
|
pub(crate) using_deprecated_bundle_dir: bool,
|
|
}
|
|
|
|
impl SearchOptions {
|
|
pub(crate) fn load(config: PagefindInboundConfig) -> Result<Self> {
|
|
if !config.service && config.site.is_empty() && config.source.is_empty() {
|
|
eprintln!("Required argument site not supplied. Pagefind needs to know the root of your built static site.");
|
|
eprintln!("Provide a --site flag, a PAGEFIND_SITE environment variable, or a site key in a Pagefind configuration file.");
|
|
bail!("Missing argument: site");
|
|
} else {
|
|
let log_level = if config.verbose {
|
|
LogLevel::Verbose
|
|
} else if config.quiet {
|
|
LogLevel::Quiet
|
|
} else if config.silent {
|
|
LogLevel::Silent
|
|
} else {
|
|
LogLevel::Standard
|
|
};
|
|
|
|
let log_to_terminal = !config.service;
|
|
let working_directory = env::current_dir().unwrap();
|
|
|
|
let site_source = if !config.site.is_empty() {
|
|
working_directory.join(PathBuf::from(config.site))
|
|
} else {
|
|
working_directory.join(PathBuf::from(config.source.clone()))
|
|
};
|
|
|
|
// For backwards compat pre-1.0, we output files for older defaults
|
|
// when the path hasn't been set
|
|
let configured_bundle_output = config
|
|
.output_path
|
|
.as_ref()
|
|
.or(config.output_subdir.as_ref())
|
|
.or(config.bundle_dir.as_ref())
|
|
.is_some();
|
|
|
|
let warnings = ConfigWarnings {
|
|
unconfigured_bundle_output: !configured_bundle_output,
|
|
using_deprecated_source: !config.source.is_empty(),
|
|
using_deprecated_bundle_dir: config.bundle_dir.is_some(),
|
|
};
|
|
|
|
let bundle_output = if let Some(subdir) = config.output_path {
|
|
working_directory.join(subdir)
|
|
} else {
|
|
let subdir = config
|
|
.output_subdir
|
|
.or(config.bundle_dir)
|
|
.unwrap_or_else(|| defaults::default_bundle_dir());
|
|
site_source.join(subdir)
|
|
};
|
|
|
|
let mut include_characters = WORD_SYMBOLS.to_vec();
|
|
if let Some(custom_include_characters) = config.include_characters {
|
|
include_characters.extend(custom_include_characters.chars());
|
|
}
|
|
|
|
Ok(Self {
|
|
working_directory,
|
|
site_source,
|
|
bundle_output,
|
|
root_selector: config.root_selector,
|
|
exclude_selectors: config.exclude_selectors,
|
|
rules: config.rules,
|
|
glob: config.glob,
|
|
force_language: config.force_language,
|
|
include_characters,
|
|
version: env!("CARGO_PKG_VERSION"),
|
|
logger: Logger::new(
|
|
log_level,
|
|
log_to_terminal,
|
|
config.logfile.map(PathBuf::from),
|
|
),
|
|
keep_index_url: config.keep_index_url,
|
|
running_as_service: config.service,
|
|
write_playground: config.write_playground,
|
|
config_warnings: warnings,
|
|
index_chunk_size: env::var("PAGEFIND_UNSTABLE_INDEX_CHUNK_SIZE")
|
|
.ok()
|
|
.and_then(|s| s.parse().ok())
|
|
.unwrap_or(defaults::default_index_chunk_size()),
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ConfigWarnings {
|
|
pub(crate) fn get_strings(&self) -> Vec<String> {
|
|
let mut strings = vec![];
|
|
if self.using_deprecated_bundle_dir {
|
|
strings.push(
|
|
"\n\
|
|
The `bundle-dir` option is deprecated as of Pagefind 1.0. \
|
|
Use either `output-subdir` or `output-path` instead:\n\n\
|
|
cli: --output-subdir\n\
|
|
config: output_subdir\n\
|
|
env: PAGEFIND_OUTPUT_SUBDIR\n\
|
|
└─ \"Where to output the search files, relative to the processed site\"\n\n\
|
|
cli: --output-path\n\
|
|
config: output_path\n\
|
|
env: PAGEFIND_OUTPUT_PATH\n\
|
|
└─ \"Where to output the search files, relative to the working directory of the command\"\n"
|
|
.into(),
|
|
);
|
|
}
|
|
|
|
if self.using_deprecated_source {
|
|
strings.push(
|
|
"\n\
|
|
The `source` option is deprecated as of Pagefind 1.0. \
|
|
The `source` option has been renamed to `site`:\n\n\
|
|
cli: --site\n\
|
|
config: site\n\
|
|
env: PAGEFIND_SITE\n\
|
|
└─ \"The location of your built static website\"\n"
|
|
.into(),
|
|
);
|
|
}
|
|
|
|
strings
|
|
}
|
|
}
|