wezm / titlecase Goto Github PK

View Code? Open in Web Editor NEW

88.0 5.0 3.0 113 KB

A tool and Rust crate for transforming text into Title Case.

Home Page: https://7bit.org/titlecase/

License: Other

Rust 96.73% Makefile 3.27%

rust titlecase wasm

titlecase's Introduction

Title Case (titlecase)

titlecase is a small tool and library (crate) that capitalizes English text according to a style defined by John Gruber for post titles on his website Daring Fireball. titlecase should run on all platforms supported by Rust including Linux, macOS, FreeBSD, NetBSD, OpenBSD, and Windows.

Try Online

https://7bit.org/titlecase/

Command Line Usage

titlecase reads lines of text from stdin and prints title cased versions to stdout.

Examples

% echo 'Being productive on linux' | titlecase
Being Productive on Linux

% echo 'Finding an alternative to Mac OS X — part 2' | titlecase
Finding an Alternative to Mac OS X — Part 2

% echo 'an example with small words and sub-phrases: "the example"' | titlecase
An Example With Small Words and Sub-Phrases: "The Example"

Install

Pre-compiled binaries

Pre-compiled binaries are available for a some platforms:

Example to download and extract a binary:

curl https://releases.wezm.net/titlecase/3.2.0/titlecase-3.2.0-x86_64-unknown-linux-musl.tar.gz | tar zxf -

From Source

If you have a stable Rust compiler toolchain installed you can install the most recently released titlecase with cargo:

cargo install titlecase

Usage as a Rust Crate

Minimum Supported Rust Version: 1.70.0

See the crate documentation.

Building for WebAssembly

Pre-requisites

Rust 1.73.0+
Rust wasm32-unknown-unknown target (rustup target add wasm32-unknown-unknown or rust-wasm package on Chimera Linux)
wasm-bindgen (wasm-bindgen package on Arch, or cargo install wasm-bindgen-cli --version 0.2.92)
make (GNU or BSD should work)

Building

There is a Makefile that automates building for WebAssembly.

make

The output is put into a wasm directory. See https://github.com/wezm/7bit.org/tree/main/public/titlecase for an example that uses the wasm build.

Style

Instead of simply capitalizing each word titlecase does the following (amongst other things):

Lower case small words like an, of, or in.
Don't capitalize words like iPhone.
Don't interfere with file paths, URLs, domains, and email addresses.
Always capitalize the first and last words, even if they are small words or surrounded by quotes.
Don't interfere with terms like "Q&A", or "AT&T".
Capitalize small words after a colon.

Credits

This tool makes use of prior work by John Gruber, Aristotle Pagaltzis, and David Gouch.

titlecase's People

Contributors

Stargazers

Watchers

Forkers

spitlo icodein alerque

titlecase's Issues

Capitalise hyphenated words

The following test cases are not currently supported:

testcase!(
    in_flight,
    "The in-flight entertainment was excellent",
    "The In-Flight Entertainment Was Excellent"
);

testcase!(
    stand_in,
    "The Stand-in teacher gave us homework",
    "The Stand-In Teacher Gave Us Homework"
);

No help available at runtime

Running titlecase --help does not deliver the expected assistance.

Markdown mode

Provide a way to opt-into a Markdown aware mode where leading puctuation (#, *, -, etc.) would be ignored as would formatting like backticks and bold/italic.

ASCII Only mode

From discussion in #11 it might be useful to have a mode where only ASCII characters are upper-cased:

@wezm I mean I want to leave small greek letters as are when they are used as special mathematical operators or constants:
* π → π

* λ-calculus → λ-Calculus

Ahh interesting. I see that it's upper-casing the greek letters too.

I can see why you'd want to avoid that. I think it would be fairly easy to support a mode where only ASCII characters were upper-cased.

Originally posted by @wezm in #11 (comment)

tag and github release for v2.0.0?

Just wanted to flag this in case it wasn't intentional. It would be nice to have a tag (and optionally, a GitHub release) for 2.0.0 version that is already on crates.io.

Just bringing it up since it seems like you were doing tags/github releases in the past.

Ignore markdown hash/heading marks?

Shouldn't:

echo '### A small tool and library (crate) that capitalizes English text' | titlecase

produce:

### A Small Tool and Library (Crate) That Capitalizes English Text

instead of:

### a Small Tool and Library (Crate) That Capitalizes English Text

Do not capitalize inline code, markdown style

Do not capitalize stuff surrounded by backticks:

echo 'The general synopsis of the `grep` command line' | titlecase
The General Synopsis of the `grep` Command Line

Doesn't lowercase small words

For example

$ echo 'Way Of The Dragon' | titlecase
Way Of The Dragon

Publish to crates.io

It seems the latest release v3.2.0 did not get pushed to cates.io.

Strips punctuation

echo 'they're bill's friends from the UK' | titlecase
Theyre Bills Friends From the UK

Expected result: "They're Bill's Friends From the UK"