7 releases
0.0.6 | Sep 24, 2022 |
---|---|
0.0.5 | Sep 6, 2022 |
0.0.4 | Aug 21, 2022 |
#310 in Development tools
45KB
1K
SLoC
Git-Ignored
An Offline-first CLI application that let the developer generate various .gitignore
templates
The templates are taken from the web application Gitignored, which is the GUI application of this application, check out the repository if you are interested
Side note: The GUI application takes the templates from gitignore of Github
Here's what the developers can do with this application
- View the name of all available templates
- Search to find out whether a name of a template exists
- Preview each template(s) searched, it will include the closest template if there's typo in the name searched, i.e JetBrains for jetbrain
- Generate template(s) to a
.gitignore
file, will not override current.gitignore
, pass-f
to forcefully override - Generate template(s) to a specified directory, i.e
temp/temp1
, it will auto generate at astemp/temp1/.gitignore
- Append template(s) to an existing
.gitignore
file, it will create one if it does not exist - Append template(s) to an existing
.gitignore
file of a specified directory, again it will create one if it does not exist - Update the cache to receive latest templates
You don't need to have an internet connection to use it, unless you want to update the cache
Click to preview!
Default or Help
Update Available
Default Listing
Listing with column number specified
Search
Preview
Default Generate
Force Generate
Generate with outdir specified
Default Append
Append with outdir specified
Updated Cache
Updating Cache
Of course, input validation
How To Use
Install it
cargo install gitignored-cli
Run it
gitignored-cli (commands)
Tech Used
Aspect | Name |
---|---|
Language | Rust |
Linting | Clippy |
Format | Rustfmt |
Build Automation Tool | Make |
Text Editor | NeoVim |
Package Manager | Cargo |
Continuous Integration, Continuous Delivery, and Continuous Deployment | GitHub Actions |
Make Commands
Below are the listed commands that you can use to build/develop/test this app
Command | Usage |
---|---|
make test-dev | Run all test code in development environment |
make test-prod | Run all test code in ci-cd |
make build | Bundle, build and release the app as executable |
make check | Run compiler checking on code |
make lint | Run linter for code |
make format | Run formatter to format the code |
Development
I used localhost instead of using the url of a production-ready web application to speed up development process as the API call can be processed much quicker
Contribution
Make sure you can run make
, otherwise you need to run commands listed in Makefile
separately
- Open an issue
- Fork this repo and this repo
- Write test
Changes
Refer to here
Dependencies
~8–16MB
~312K SLoC