Application of Gitignored. A more UI/UX Friendly Web Application to Preview/Copy/Download Single or Multiple .gitignore File(s)
MIT License
A web application that let the developer generate various .gitignore
templates, available here
The templates are taken from the repo gitignore of GitHub. Hence the templates generated are reliable
Here's what the developers can do with it
Home Page
Templates
Docs Introduction
Docs Content
Docs API
Introduction
Commit Time
Templates
404 Page
Aspect | Name |
---|---|
Development Language | TypeScipt |
Scripting Language | TypeScipt |
Testing | Vitest |
Styling | Chakra-UI |
Framework | NextJS |
Build Automation Tool | Make |
Dependency Management | Pnpm |
Continuous Integration | GitHub Actions |
Below are the non-exhaustive listed commands that you can use to build/develop/test this app. For more command, checkout Makefile
Command | Usage |
---|---|
make start-(development OR production OR testing OR staging) | Start development |
make build-(development OR production OR testing OR staging) | Bundle and build the app |
make install | Install all dependencies |
make test | Run all test code |
make typecheck | Run typechecking for source code |
make lint | Run linter for source and test code |
make format-check | Run prettier to check source and test code format |
make format | Run prettier to format source and test code |
make start-(development OR testing)-database | Start database |
make copy-env-(development OR testing) | Copy environment variables |
It's necessary to UI snapshot test, it's also a must to write test for logical processing functions
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. The TUI application is available here
Side note: The GUI application takes the templates from gitignore of Github
Here's what the developers can do with this application
.gitignore
file, will not override current .gitignore
, pass --force
to forcefully overridetemp/temp1
, it will auto generate at as temp/temp1/.gitignore
.gitignore
file, it will create one if it does not exist.gitignore
file of a specified directory, again it will create one if it does not existYou don't need to have an internet connection to use it, unless you want to update the cache
Note: gitignored-cli is a work-in-progress library, so expect breaking changes in its API
gitignored-cli
OR
gitignored-cli --help
gitignored-cli template --list
gitignored-cli template --list --column 8
gitignored-cli template --search rust node java vscode jetbrain whatever
gitignored-cli template --preview rust node java vscode jetbrain
gitignored-cli template --generate rust node java vscode jetbrain whatever
gitignored-cli template --generate rust node java vscode jetbrain whatever
gitignored-cli template --generate rust node java vscode jetbrain whatever --force
gitignored-cli template --generate rust node java vscode jetbrain whatever --outdir temp-dev/temp-two
gitignored-cli template --append rust node java vscode jetbrain whatever
gitignored-cli template --append rust node java vscode jetbrain whatever
gitignored-cli template --append rust node java vscode jetbrain whatever --outdir temp-dev/temp-two
gitignored-cli template --update
gitignored-cli template --update
gitignored-cli open-link
gitignored-cli uninstall
Install it
cargo install gitignored-cli
Run it
gitignored-cli (commands)
Aspect | Name |
---|---|
Language | Rust |
Linting | Clippy |
Format | Rustfmt |
Build Automation Tool | Make |
Package Manager | Cargo |
Continuous Integration | GitHub Actions |
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 |
Make sure you can run make
, otherwise you need to run commands listed in Makefile
separately
Refer to here