blob42/rusty-man
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3a20d662c5
rusty-man/Cargo.toml

46 lines
1.1 KiB
TOML
Raw Normal View History

Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
2020-01-12 10:50:40 +00:00
# SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
# SPDX-License-Identifier: CC0-1.0
[package]
name = "rusty-man"
Release v0.1.3 This patch release adds support for documentation generated with Rust 1.45.0 and fixes some minor bugs in the documentation parser. It also adds the documentation downloaded using rustup to the default sources.
2020-07-28 12:59:12 +00:00
version = "0.1.3"
Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
2020-01-12 10:50:40 +00:00
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.
2020-07-19 15:24:38 +00:00
description = "Command-line viewer for rustdoc documentation"
Add homepage and repository links to Cargo.toml
2020-07-24 12:23:31 +00:00
homepage = "https://sr.ht/~ireas/rusty-man"
repository = "https://git.sr.ht/~ireas/rusty-man"
Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
2020-01-12 10:50:40 +00:00
keywords = ["doc", "cli", "rustdoc"]
Update keywords and excludes in Cargo.toml
2020-07-24 11:47:55 +00:00
categories = ["command-line-utilities", "development-tools"]
Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
2020-01-12 10:50:40 +00:00
readme = "README.md"
license = "MIT"
Update keywords and excludes in Cargo.toml
2020-07-24 11:47:55 +00:00
exclude = [".builds/*"]
Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
2020-01-12 10:50:40 +00:00
[dependencies]
Implement command-line interface using structopt This patch adds the structopt dependency and implements a simple command-line interface for rusty-man.
2020-01-12 11:11:31 +00:00
anyhow = "1.0.31"
Use crossterm instead of termion With this patch, we replace the termion dependency with crossterm. This should make it possible to compile and run rusty-man on other platforms than Unix.
2020-07-24 11:18:35 +00:00
crossterm = "0.17.7"
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.
2020-07-16 19:01:29 +00:00
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.
2020-01-13 15:04:38 +00:00
kuchiki = "0.8.0"
Add basic logging with env_logger This patch adds some basic info log messages to make it easier to debug incompatible rustdoc output. To show the messages, run rusty-man with the environment variable RUST_LOG=info.
2020-07-24 16:10:53 +00:00
log = "0.4.11"
List variants for enums This patch updates parse_item_doc to look for variants.
2020-07-22 17:07:12 +00:00
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.
2020-07-17 13:41:08 +00:00
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.
2020-07-19 20:23:47 +00:00
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.
2020-07-22 14:21:27 +00:00
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.
2020-07-19 20:23:47 +00:00
serde_tuple = "0.5.0"
Implement command-line interface using structopt This patch adds the structopt dependency and implements a simple command-line interface for rusty-man.
2020-01-12 11:11:31 +00:00
Add basic logging with env_logger This patch adds some basic info log messages to make it easier to debug incompatible rustdoc output. To show the messages, run rusty-man with the environment variable RUST_LOG=info.
2020-07-24 16:10:53 +00:00
[dependencies.env_logger]
version = "0.7.1"
default-features = false
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.
2020-07-19 20:23:47 +00:00
[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.
2020-01-12 11:11:31 +00:00
[dependencies.structopt]
version = "0.3.15"
default-features = false
Add syntax highlighting for code snippets This patch uses syntect to add syntax highlighting for code snippets in the rich text output. Currently, this only applies to the examples printed with the -e/--examples option.
2020-08-10 17:30:12 +00:00
[dependencies.syntect]
version = "4.3.0"
default-features = false
features = ["parsing", "regex-onig", "assets", "dump-load"]
Reference in New Issue Copy Permalink