gitignore-template-generator

A binary crate to generate templates for .gitignore files

Installation

Current release: 0.13.0

cargo install gitignore-template-generator

Usage

Available options:

Usage: gitignore-template-generator [OPTIONS] [TEMPLATE_NAMES]...

Generate templates for .gitignore files

Arguments:
  [TEMPLATE_NAMES]...  A non-empty list of gitignore template names

Options:
  -c, --check                          Enable robust template names check
  -g, --generator-uri <GENERATOR_URI>  The template generator uri [default: /developers/gitignore/api]
  -l, --list                           List available templates
  -i, --lister-uri <LISTER_URI>        The template lister uri [default: /developers/gitignore/api/list]
  -s, --server-url <SERVER_URL>        The template manager url [default: https://www.toptal.com]
  -t, --timeout <TIMEOUT>              The template generation and listing service calls timeout [default: 5s/5000ms]
  -u, --timeout-unit <TIMEOUT_UNIT>    The timeout unit [default: second] [possible values: millisecond, second]
  -h, --help                           Print help
  -V, --version                        Print version
  -a, --author                         Print author

Version: 0.13.0
Author: Patacode <pata.codegineer@gmail.com>

The CLI tool is a simple API binder to toptal gitignore template generation service. It takes gitignore template names as positional arguments and generates a gitignore template for you.

It also supports a variety of CLI options that allow you to customize its behavior. Have a look at the official crate documentation for more details.

Examples:

Generate a gitignore template for simple rust projects and store it in a file named .gitignore

gitignore-template-generator rust > .gitignore

Generate a gitignore template for python projects using a custom generator (a fictive one here just for the example)

gitignore-template-generator python \
  --server-url https://myapis.foobar.com
  --generator-uri /gitignore/generate

List available templates

gitignore-template-generator --list

Development

Install cargo-make, dev tools and build the package:

./bootstrap.sh

Run the tests:

cargo test # unit + isolation + integration tests
cargo test --lib # unit tests
cargo test --test isolation_tests # isolation tests
cargo test --test integration_tests # integration tests

Generate code coverage report in HTML format under target/tarpaulin:

cargo tarpaulin \
  --out Html \
  --exclude-files src/lib.rs src/main.rs benches/* tests/* src/constant.rs src/core.rs src/http_client.rs src/parser.rs src/validator.rs src/**/tests.rs src/**/api.rs \
  --output-dir target/tarpaulin

Benchmark the binary crate:

cargo bench

Generate and open documentation:

cargo doc --open

Lint code:

cargo clippy --all-targets --all-features

Format code with nightly features (required to sort imports):

cargo +nightly fmt -- --unstable-features

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution