blob42
/
rusty-man
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0d75176f59'
${ noResults }
rusty-man/Cargo.toml

33 lines
723 B
TOML
Raw Normal View History Unescape Escape

Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
5 years ago
# SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
# SPDX-License-Identifier: CC0-1.0
[package]
name = "rusty-man"
version = "0.1.0"
authors = ["Robin Krahl <robin.krahl@ireas.org>"]
edition = "2018"
Replace “interface” with “viewer” in description Previously, we called rusty-man a command-line interface for rustdoc documentation, but “viewer” is a more appropriate term.
4 years ago
description = "Command-line viewer for rustdoc documentation"
Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
5 years ago
keywords = ["doc", "cli", "rustdoc"]
categories = ["command-line-utilities"]
readme = "README.md"
license = "MIT"
[dependencies]
Implement command-line interface using structopt This patch adds the structopt dependency and implements a simple command-line interface for rusty-man.
5 years ago
anyhow = "1.0.31"
Add --viewer option and plain text viewer This patch adds a new --viewer command line option that lets the user select a viewer that displays the documentation. It also adds a default viewer implementation that uses html2text to generate plain text from the HTML documentation. html2text requires the ptr_cast feature and we use the Option::as_deref method in the viewer implementation, so we have to update the minimum supported Rust version to 1.40.
4 years ago
html2text = "0.1.12"
Extract documentation from HTML files This patch adds the parser module that uses kuchiki and html5ever to parse the HTML documentation. As kuchiki requires std::mem::MaybeUninit, we have to bump the minimum supported Rust version to 1.36.
5 years ago
kuchiki = "0.8.0"
List variants for enums This patch updates parse_item_doc to look for variants.
4 years ago
markup5ever = "0.10.0"
Adapt text output to terminal size Previously, we wrapped all lines at 100 characters and just printed to stdout. With this patch, we use the pager crate to spawn a pager (typically less) before printing the text. Also, we try to use the terminal size to determine the line length: The default line length is still 100 characters but can be reduced to fit the terminal.
4 years ago
pager = "0.15.0"
Read search index from search-index.js With this patch, we read the search index generated by rustdoc. It allows us to suggest matching items if we don’t find an exact match.
4 years ago
serde_json = "1.0.56"
Import item types from librustdoc Previously, our ItemType enum only had three values: Module, Item and Member. With this patch we import the ItemType variants from librustdoc (see html/item_type.rs) for better compatibility and easier parsing.
4 years ago
serde_repr = "0.1.6"
Read search index from search-index.js With this patch, we read the search index generated by rustdoc. It allows us to suggest matching items if we don’t find an exact match.
4 years ago
serde_tuple = "0.5.0"
Add rich viewer This patch adds a new viewer with rich text output using html2text’s from_read_rich function. We then use termion to format the generated rich text.
4 years ago
termion = "1.5.5"
Implement command-line interface using structopt This patch adds the structopt dependency and implements a simple command-line interface for rusty-man.
5 years ago
Read search index from search-index.js With this patch, we read the search index generated by rustdoc. It allows us to suggest matching items if we don’t find an exact match.
4 years ago
[dependencies.serde]
version = "1.0.114"
features = ["derive"]
Implement command-line interface using structopt This patch adds the structopt dependency and implements a simple command-line interface for rusty-man.
5 years ago
[dependencies.structopt]
version = "0.3.15"
default-features = false