Skip to content

Commit

Permalink
Test examples and add docs to Cargo.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
EverlastingBugstopper committed Feb 18, 2020
1 parent a8a61f6 commit 77752b2
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 17 deletions.
5 changes: 4 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "boxx"
description = "Display informational boxes in the terminal."
version = "0.0.0-alpha"
version = "0.0.1-alpha"
repository = "https://github.com/EverlastingBugstopper/boxx"
authors = ["Avery Harnish <averyharnish@gmail.com>"]
categories = ["value-formatting"]
Expand Down Expand Up @@ -30,3 +30,6 @@ path = "examples/hello_world.rs"
console = "0.9"
term_size = "0.3"
unicode-width = "0.1"

[dev-dependencies]
version-sync = "0.8"
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Display informational boxes in the terminal.
Your `Cargo.toml` should include `boxx` as a dependency

```toml
boxx = "0.0.0-alpha"
[dependencies]
boxx = "0.0.1-alpha"
```

```rust
Expand Down
27 changes: 21 additions & 6 deletions src/config/border/components.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,27 @@ use crate::BorderStyle;
/// the border of a `Boxx`
#[derive(Clone, PartialEq, Debug)]
pub struct BorderComponents {
pub(crate) top_left: String,
pub(crate) horizontal: String,
pub(crate) top_right: String,
pub(crate) vertical: String,
pub(crate) bottom_right: String,
pub(crate) bottom_left: String,
/// `String` to display as the top left corner of a `Boxx` border
/// This should be one visual character wide
pub top_left: String,

/// `String` to repeat as the top and bottom of a `Boxx` border
pub horizontal: String,

/// `String` to display as the top right corner of a `Boxx` border
/// This should be one visual character wide
pub top_right: String,

/// `String` to repeat as the left and right of a `Boxx` border
pub vertical: String,

/// `String` to display as the bottom right corner of a `Boxx` border
/// This should be one visual character wide
pub bottom_right: String,

/// `String` to display as the bottom left corner of a `Boxx` border
/// This should be one visual character wide
pub bottom_left: String,
}

impl BorderComponents {
Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![doc(html_root_url = "https://docs.rs/boxx/0.0.1-alpha")]

//! boxx
//!
Expand Down
9 changes: 0 additions & 9 deletions src/tests/mod.rs

This file was deleted.

9 changes: 9 additions & 0 deletions tests/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#[test]
fn test_readme_deps() {
version_sync::assert_markdown_deps_updated!("README.md");
}

#[test]
fn test_html_root_url() {
version_sync::assert_html_root_url_updated!("src/lib.rs");
}

0 comments on commit 77752b2

Please sign in to comment.