gitignore-template-generator

A binary crate to generate templates for .gitignore files

Installation

Current release: 0.6.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:
  -s, --server-url <SERVER_URL>        The template manager url [default: https://www.toptal.com]
  -g, --generator-uri <GENERATOR_URI>  The template generator uri [default: /developers/gitignore/api]
  -i, --lister-uri <LISTER_URI>        The template lister uri [default: /developers/gitignore/api/list]
  -l, --list                           List available templates
  -h, --help                           Print help
  -V, --version                        Print version
  -a, --author                         Print author

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

The cli tool binds to any template manager service able to manage templates over HTTP. It defaults to toptal template manager, using https://www.toptal.com/developers/gitignore/api/{templateNames} to generate templates (with {templateNames} being a comma-separated list of template names), and https://www.toptal.com/developers/gitignore/api/list to list them.

It is possible to provide a custom template manager service to the cli tool. One can easily change the template manager service base url and related endpoint uris using the server-url, generator-uri and lister-uri options.

Examples:

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

$ gitignore-template-generator rust > .gitignore
$ cat .gitignore
# Created by https://www.toptal.com/developers/gitignore/api/rust
# Edit at https://www.toptal.com/developers/gitignore?templates=rust

### Rust ###
# Generated by Cargo
# will have compiled files and executables
debug/
target/

# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
Cargo.lock

# These are backup files generated by rustfmt
**/*.rs.bk

# MSVC Windows builds of rustc generate these, which store debugging information
*.pdb

# End of https://www.toptal.com/developers/gitignore/api/rust

Generate a gitignore template for python projects using a custom generator:

$ gitignore-template-generator python \
  --server-url https://myapis.com
  --generator-uri /gitignore/generate
# Created by https://myapis.com/gitignore/generate/python

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*.pyo

# Virtual environment
venv/
.env/

# Distribution / packaging
build/
dist/
*.egg-info/

# Logs
*.log

# OS-specific files
.DS_Store
Thumbs.db

# End of https://myapis.com/gitignore/generate/python

List available templates:

$ gitignore-template-generator --list
redis,remix,remix+arc,remix+cloudflarepages,remix+cloudflareworkers
remix+netlify,remix+vercel,renpy,replit,retool
rhodesrhomobile,rider,robotframework,root,ros
ros2,ruby,rubymine,rubymine+all,rubymine+iml
rust,rust-analyzer,salesforce,salesforcedx,sam

Development

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

./bootstrap.sh

Run the tests:

cargo test # unit + 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/* \
  --output-dir target/tarpaulin

Benchmark binary and library crates:

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