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

71 lines
1.6 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.3.0 This minor release adds support for Rust 1.46.0 and significantly improves the test suite.
2020-09-11 19:57:30 +00:00
version = "0.3.0"
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"
Refactor test suite to check multiple versions This patch refactors the test suite: - Instead of always generating the documentation with the available rustdoc version, we now store generated documentation for all supported rustdoc versions in the test/html directory. - Instead of using one snapshot per test case, we now use one snapshot per test case and rustdoc version.
2020-09-11 16:14:19 +00:00
exclude = [".builds/*", "tests/html/*", "tests/snapshots/*"]
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]
Use ansi_term, atty, terminal_size This patch replaces the crossterm dependency with ansi_term, atty and terminal_size. This allows us for an easier integration with the text_style crate in an upcoming patch, and it reduces the total number of dependencies from 166 to 160. This means that we drop support for non-ANSI terminals, but as this only affects old versions of cmd.exe/PowerShell, we don’t care about it.
2020-10-02 11:05:01 +00:00
ansi_term = "0.12.1"
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 ansi_term, atty, terminal_size This patch replaces the crossterm dependency with ansi_term, atty and terminal_size. This allows us for an easier integration with the text_style crate in an upcoming patch, and it reduces the total number of dependencies from 166 to 160. This means that we drop support for non-ANSI terminals, but as this only affects old versions of cmd.exe/PowerShell, we don’t care about it.
2020-10-02 11:05:01 +00:00
atty = "0.2.14"
Use termion backend for cursive With this patch, we replace cursive’s default ncurses backend with the termion backend. This has multiple reasons: - The ncurses backend has safety issues, see [0]. - ncurses requires a pre-installed library and a C compiler, introducing additional build dependencies. Termion is implemented in Rust only. - ncurses does not work on Windows, while termion works in all terminals that support ANSI escape codes. Per default, the termion backend does not buffer the output which may cause flickering [1]. Therefore, we also use the cursive_buffered_backend that buffers the output and fixes the flickering problem. [0] https://github.com/gyscos/cursive/issues/488 [1] https://github.com/gyscos/cursive/issues/142
2020-10-08 08:19:21 +00:00
cursive_buffered_backend = "0.4"
Use cursive-markup to replace HtmlView We’ve moved the HtmlView into a separate crate, so we can replace our own HtmlView with cursive_markup::MarkupView. We only have to implement a custom Renderer that applies the syntax highlighting to code snippets.
2020-10-08 08:00:26 +00:00
cursive-markup = "0.1"
Update html2text dependency to v0.2.1 This patch updates the html2text dependency to v0.2.1. This release fixed the handling of preformatted blocks, allowing us to add syntax highlighting for code blocks in the next patch.
2020-10-03 17:04:45 +00:00
html2text = "0.2.1"
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"
Use merge to merge arguments and configuration This patch adds the merge dependency to automatically merge the command-line arguments and the settings from the configuration file. This means that we no longer have to manually maintain the Args::merge function.
2020-09-20 20:18:28 +00:00
merge = "0.1.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"
serde_tuple = "0.5.0"
Use ansi_term, atty, terminal_size This patch replaces the crossterm dependency with ansi_term, atty and terminal_size. This allows us for an easier integration with the text_style crate in an upcoming patch, and it reduces the total number of dependencies from 166 to 160. This means that we drop support for non-ANSI terminals, but as this only affects old versions of cmd.exe/PowerShell, we don’t care about it.
2020-10-02 11:05:01 +00:00
terminal_size = "0.1.13"
Add TUI viewer using cursive This patch adds a new viewer, tui, that provides an interactive interface using cursive. This viewer makes it possible to follow links to other documentation items and to open external links in a web browser.
2020-09-15 15:32:06 +00:00
textwrap = "0.12.1"
Add support for configuration files With this patch, we load defaults for the command-line arguments from the configuration file located in the user configuration directory according to the XDG Base Directory Specification.
2020-08-10 21:37:26 +00:00
toml = "0.5.6"
Add TUI viewer using cursive This patch adds a new viewer, tui, that provides an interactive interface using cursive. This viewer makes it possible to follow links to other documentation items and to open external links in a web browser.
2020-09-15 15:32:06 +00:00
url = "2.1.1"
webbrowser = "0.5.5"
Add support for configuration files With this patch, we load defaults for the command-line arguments from the configuration file located in the user configuration directory according to the XDG Base Directory Specification.
2020-08-10 21:37:26 +00:00
xdg = "2.2.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
Use termion backend for cursive With this patch, we replace cursive’s default ncurses backend with the termion backend. This has multiple reasons: - The ncurses backend has safety issues, see [0]. - ncurses requires a pre-installed library and a C compiler, introducing additional build dependencies. Termion is implemented in Rust only. - ncurses does not work on Windows, while termion works in all terminals that support ANSI escape codes. Per default, the termion backend does not buffer the output which may cause flickering [1]. Therefore, we also use the cursive_buffered_backend that buffers the output and fixes the flickering problem. [0] https://github.com/gyscos/cursive/issues/488 [1] https://github.com/gyscos/cursive/issues/142
2020-10-08 08:19:21 +00:00
[dependencies.cursive]
version = "0.15"
default-features = false
features = ["termion-backend"]
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"]
Add integration tests This patch adds an integration test suite using the insta crate for snapshot testing. The test suite is tested for all supported Rust versions and should always succeed for the MSRV (currently 1.40.0) and the current stable Rust version. However there are some minor changes in the configuration format between Rust versions, so tests that don’t work on all supported Rust versions are marked with the ignore attribute. But even the ignored tests should work on the stable Rust release.
2020-07-27 12:49:51 +00:00
Use text-style crate to format text This patch replaces the direct text formatting with ansi_term with the text-style crate. This also allows us to directly convert the syntect annotations to styled strings.
2020-10-02 11:34:17 +00:00
[dependencies.text-style]
version = "0.2.0"
Add TUI viewer using cursive This patch adds a new viewer, tui, that provides an interactive interface using cursive. This viewer makes it possible to follow links to other documentation items and to open external links in a web browser.
2020-09-15 15:32:06 +00:00
features = ["ansi_term", "cursive", "syntect"]
Use text-style crate to format text This patch replaces the direct text formatting with ansi_term with the text-style crate. This also allows us to directly convert the syntect annotations to styled strings.
2020-10-02 11:34:17 +00:00
Add integration tests This patch adds an integration test suite using the insta crate for snapshot testing. The test suite is tested for all supported Rust versions and should always succeed for the MSRV (currently 1.40.0) and the current stable Rust version. However there are some minor changes in the configuration format between Rust versions, so tests that don’t work on all supported Rust versions are marked with the ignore attribute. But even the ignored tests should work on the stable Rust release.
2020-07-27 12:49:51 +00:00
[dev-dependencies]
assert_cmd = "1.0.1"
insta = "0.16.1"
Refactor test suite to check multiple versions This patch refactors the test suite: - Instead of always generating the documentation with the available rustdoc version, we now store generated documentation for all supported rustdoc versions in the test/html directory. - Instead of using one snapshot per test case, we now use one snapshot per test case and rustdoc version.
2020-09-11 16:14:19 +00:00
rustc_version = "0.2.3"
semver = "0.9.0"
Add integration tests This patch adds an integration test suite using the insta crate for snapshot testing. The test suite is tested for all supported Rust versions and should always succeed for the MSRV (currently 1.40.0) and the current stable Rust version. However there are some minor changes in the configuration format between Rust versions, so tests that don’t work on all supported Rust versions are marked with the ignore attribute. But even the ignored tests should work on the stable Rust release.
2020-07-27 12:49:51 +00:00
tempfile = "3.1.0"
Reference in New Issue Copy Permalink