diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..882a380 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Bug Report + url: https://github.com/amazingandyyy/gofuzzyclone/issues/new + about: Thank you for using! Feel free report any bug you encounter. + - name: Feature request + url: https://github.com/amazingandyyy/gofuzzyclone/issues/new + about: Love to have a feature? Let me know! + - name: Follow author + url: https://github.com/amazingandyyy + about: Feel free to follow me! diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md new file mode 100644 index 0000000..ff510d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template.md @@ -0,0 +1,16 @@ +# Report issue + +## Background + +- version: +- operating system: +- terminal(zsh/bash?): + +## Description + +- What do you expect to do? +- What does it really do? + +## How to reproduce + +## Extra notes diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..5c2f3df --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,14 @@ +# PR + +## Related issue + +fix: #1 + +## Features + +- what does this add: +- testing/demo: + +## Extra + +- notes: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 817d8d4..60771a7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -29,6 +29,7 @@ repos: - id: shfmt - id: script-must-have-extension - id: markdownlint # Configure in .mdlrc + args: ["-r ~MD013,~MD033,~MD002"] - repo: https://github.com/rhysd/actionlint rev: v1.6.8 hooks: diff --git a/README.md b/README.md index e3ac453..5147947 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ -# gofuzzyclone - +

+ +

+

+gofuzzysearch +

+

Go fuzzy search repos with regex or wildcard +

+

+Never clone repos one by one +

## Installation +It's easy! + ```sh bash <(curl -sL https://raw.githubusercontent.com/amazingandyyy/gofuzzyclone/main/scripts/install.sh) ``` @@ -20,19 +31,48 @@ bash <(curl -sL https://raw.githubusercontent.com/amazingandyyy/gofuzzyclone/mai # get instructions gofuzzyclone -help -# fastline mode +# regex mode gofuzzyclone -owner amazingandyyy -search ".*-deployments$" -output ./code -gofuzzyclone -owner amazingandyyy -search "*-template" -mode wildcard -output ./projects +# wildcard mode +gofuzzyclone -owner amazingandyyy -search "*-deployments" -mode wildcard -output ./projects # interactive mode gofuzzyclone ``` +## Development + +### Initialization + +```sh +git clone https://github.com/amazingandyyy/gofuzzyclone.git +cd gofuzzyclone +./scripts/set +``` + +### Trigger pre-commit hook manually + +```sh +pre-commit run --all-files +``` + +--- + +![banner](assets/repo-banner.jpg) + +## Contribution + +- Try out this tool +- Star this repo +- Share with your friend! +- [Create issue](https://github.com/amazingandyyy/gofuzzyclone/issues/new) +- Create PRs + ## Resources -- [regex](http://regex101.com) +- [regex101](http://regex101.com) - wildcard ## LICENSE -[MIT](./LICENSE) +[MIT](LICENSE) diff --git a/assets/repo-banner.jpg b/assets/repo-banner.jpg new file mode 100644 index 0000000..83ae105 Binary files /dev/null and b/assets/repo-banner.jpg differ