gitignore-template-generator

A binary crate to generate templates for .gitignore files

Installation

Current release: 0.14.5

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.14.5
Author: Patacode <pata.codegineer@gmail.com>

By default, this 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 supports a variety of CLI options and feature flags to customize its behavior with finer control. Have a look at the official crate documentation for more details.

You might be interested in the local templating feature for example, which allows you to generate gitignore templates from your local file system.

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 necessary dev tools (i.e. cargo-make only here):

./bootstrap.sh

List the available tasks:

cargo make --list-all-steps # list all tasks
cargo make --list-all-steps | grep -e "META TASK" # filter only on meta tasks

Execute the task you want. Here are some examples:

cargo make test # unit/isolation/integration tests + lint + format check
cargo make changelog-build # generate changelogs in CHANGELOG.md
cargo make format-build # format codebase
cargo make release # deploy new patch/minor/major crate version
cargo make doc # build doc locally

Some useful tasks haven't yet been defined in Makefile.toml, such as:

• Generating 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
  

• Benchmarking the binary crate:

  cargo bench
  

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

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.