pub struct Config {
pub columns: Option<usize>,
pub hidden: Option<bool>,
pub no_ignore: Option<bool>,
pub no_ignore_parent: Option<bool>,
pub no_ignore_dot: Option<bool>,
pub no_ignore_vcs: Option<bool>,
pub treat_doc_strings_as_comments: Option<bool>,
pub sort: Option<Sort>,
pub types: Option<Vec<LanguageType>>,
pub for_each_fn: Option<fn(_: LanguageType, _: Report)>,
}
Expand description
A configuration struct for how Languages::get_statistics
searches and
counts languages.
use tokei::Config;
let config = Config {
treat_doc_strings_as_comments: Some(true),
..Config::default()
};
Fields§
§columns: Option<usize>
Width of columns to be printed to the terminal. This option is ignored in the library. Default: Auto detected width of the terminal.
Count hidden files and directories. Default: false
.
no_ignore: Option<bool>
Don’t respect ignore files (.gitignore, .ignore, etc.). This implies –no-ignore-parent,
–no-ignore-dot, and –no-ignore-vcs. Default: false
.
no_ignore_parent: Option<bool>
Don’t respect ignore files (.gitignore, .ignore, etc.) in parent directories.
Default: false
.
no_ignore_dot: Option<bool>
Don’t respect .ignore and .tokeignore files, including those in parent directories.
Default: false
.
no_ignore_vcs: Option<bool>
Don’t respect VCS ignore files (.gitignore, .hgignore, etc.), including those in
parent directories. Default: false
.
treat_doc_strings_as_comments: Option<bool>
Whether to treat doc strings in languages as comments. Default:
false
.
sort: Option<Sort>
Sort languages. Default: None
.
types: Option<Vec<LanguageType>>
Filters languages searched to just those provided. E.g. A directory
containing C
, Cpp
, and Rust
with a Config.types
of [Cpp, Rust]
will count only Cpp
and Rust
. Default: None
.
for_each_fn: Option<fn(_: LanguageType, _: Report)>
Whether to output only the paths for downstream batch processing Default: false adds a closure for each function, e.g., print the result
Implementations§
source§impl Config
impl Config
sourcepub fn from_config_files() -> Self
pub fn from_config_files() -> Self
Creates a Config
from three configuration files if they are available.
Files can have two different names tokei.toml
and .tokeirc
.
Firstly it will attempt to find a config in the configuration directory
(see below), secondly from the home directory, $HOME/
,
and thirdly from the current directory, ./
.
The current directory’s configuration will take priority over the configuration
directory.
Platform | Value | Example |
---|---|---|
Linux | $XDG_CONFIG_HOME or $HOME /.config | /home/alice/.config |
macOS | $HOME /Library/Application Support | /Users/Alice/Library/Application Support |
Windows | {FOLDERID_RoamingAppData} | C:\Users\Alice\AppData\Roaming |
Example
columns = 80
types = ["Python"]
treat_doc_strings_as_comments = true