From 61b2a920d86c68e32da8437ca47eaf961e9611aa Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 01:48:52 +0530 Subject: [PATCH 01/10] add lint actions and readme structure --- .github/lint.yml | 46 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 22 +++++++++++++++++++--- 2 files changed, 65 insertions(+), 3 deletions(-) create mode 100644 .github/lint.yml diff --git a/.github/lint.yml b/.github/lint.yml new file mode 100644 index 0000000..be11683 --- /dev/null +++ b/.github/lint.yml @@ -0,0 +1,46 @@ +name: lint +on: + pull_request: + push: + branches: + - main + +jobs: + awesome-lint: + strategy: + fail-fast: false + matrix: + files: + - "readme-template.md" + runs-on: ubuntu-latest + steps: + - name: "checkout repo" + uses: actions/checkout@v2 + with: + fetch-depth: 0 + - name: asdf_install + uses: asdf-vm/actions/install@v1 + - name: "linting: ${{ matrix.files }}" + run: npx -y awesome-lint ${{ matrix.files }} + awesome-bot: + strategy: + fail-fast: false + matrix: + files: + - "readme-template.md" + runs-on: ubuntu-latest + steps: + - name: "checkout repo" + uses: actions/checkout@v2.0.0 + with: + fetch-depth: 0 + - name: "setup ruby" + uses: ruby/setup-ruby@v1 + with: + ruby-version: 3.0.1 + bundler-cache: true + - name: "install awesome-bot" + run: gem install awesome_bot + - name: "linting: ${{ matrix.files }}" + run: awesome_bot --allow-redirect ${{ matrix.files }} + \ No newline at end of file diff --git a/README.md b/README.md index 5f3fa26..e9762c9 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,36 @@ This is your one-stop shop to find *incredible* community projects built with the [Charm][charm] stack. Get inspired, and most importantly, get building! This is an entirely community-driven repo for members of the community to share -their projects. You can PR your completed projects to be included in the list. +their projects. You can PR your completed projects to be included in the list. -You're also welcome to contribute ideas without building them out. +You're also welcome to contribute ideas without building them out. ## What is a "Complete" Project A project is considered complete when: + 1. It implements the minimum viable product for the idea 2. It includes a `README` with screenshots or a GIF describing the application's behavior. See [Freeze][freeze] or [VHS][vhs] for easy demos. - + > [!NOTE] > Please include an overview of what Charm libraries you used to build your project. +## Contents + +- [Applications](#applications) + - [Bubbletea](#bubbleatea) +- [Other](#other) + - [Editor Plugins](#editor-plugins) + +## Applications + +### Bubbletea + +## Other + +### Editor Plugins + ## Feedback We’d love to hear your thoughts on this project. Join the chatter happening on [Discord](https://charm.sh/chat). From 3c1c8bf77d48d8770f66b6ff03bb8facdae983e0 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 01:52:12 +0530 Subject: [PATCH 02/10] fix proper action path and readme stuff --- .github/{ => workflows}/lint.yml | 1 - README.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) rename .github/{ => workflows}/lint.yml (99%) diff --git a/.github/lint.yml b/.github/workflows/lint.yml similarity index 99% rename from .github/lint.yml rename to .github/workflows/lint.yml index be11683..a271c1d 100644 --- a/.github/lint.yml +++ b/.github/workflows/lint.yml @@ -43,4 +43,3 @@ jobs: run: gem install awesome_bot - name: "linting: ${{ matrix.files }}" run: awesome_bot --allow-redirect ${{ matrix.files }} - \ No newline at end of file diff --git a/README.md b/README.md index e9762c9..d7f7aab 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ A project is considered complete when: ## Contents - [Applications](#applications) - - [Bubbletea](#bubbleatea) + - [Bubbletea](#bubbletea) - [Other](#other) - [Editor Plugins](#editor-plugins) From 61804e02002d2c1374f5ba3e39c15830af74b4f5 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 02:27:24 +0530 Subject: [PATCH 03/10] try another lint --- .github/workflows/lint.yml | 57 ++++++++++---------------------------- 1 file changed, 14 insertions(+), 43 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index a271c1d..5481103 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,45 +1,16 @@ -name: lint -on: - pull_request: +name: Lint +on: push: - branches: - - main - + branches: [master] + pull_request: + types: [opened, synchronize] jobs: - awesome-lint: - strategy: - fail-fast: false - matrix: - files: - - "readme-template.md" - runs-on: ubuntu-latest - steps: - - name: "checkout repo" - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - name: asdf_install - uses: asdf-vm/actions/install@v1 - - name: "linting: ${{ matrix.files }}" - run: npx -y awesome-lint ${{ matrix.files }} - awesome-bot: - strategy: - fail-fast: false - matrix: - files: - - "readme-template.md" - runs-on: ubuntu-latest - steps: - - name: "checkout repo" - uses: actions/checkout@v2.0.0 - with: - fetch-depth: 0 - - name: "setup ruby" - uses: ruby/setup-ruby@v1 - with: - ruby-version: 3.0.1 - bundler-cache: true - - name: "install awesome-bot" - run: gem install awesome_bot - - name: "linting: ${{ matrix.files }}" - run: awesome_bot --allow-redirect ${{ matrix.files }} + test: + name: Run awesome linter + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-node@v3 + with: + node-version: 16 + - run: npx awesome-lint README.md From 39082cfb89ad47953b6767d5c819bdf5f96ba371 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 02:49:26 +0530 Subject: [PATCH 04/10] chore: follow awesome spec --- CONTRIBUTING.md | 19 +++++++++++++++++++ LICENSE | 21 +++++++++++++++++++++ README.md | 31 ++----------------------------- 3 files changed, 42 insertions(+), 29 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9befd97 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing + +## What is a "Complete" Project + +A project is considered complete when: + +1. It implements the minimum viable product for the idea +2. It includes a `README` with screenshots or a GIF describing the + application's behavior. See [Freeze][freeze] or [VHS][vhs] for easy demos. + +> [!NOTE] +> Please include an overview of what Charm libraries you used to build your project. + +## Feedback + +We'd love to hear your thoughts on this project. Join the chatter happening on [Discord](https://charm.sh/chat). + +[freeze]: https://github.com/charmbracelet/freeze +[vhs]: https://github.com/charmbracelet/vhs diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..07f073a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Charm Community + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index d7f7aab..a07865a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Strutt your stuff +# Awesome Charm [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) This is your one-stop shop to find *incredible* community projects built with the [Charm][charm] stack. Get inspired, and most importantly, get building! @@ -8,16 +8,7 @@ their projects. You can PR your completed projects to be included in the list. You're also welcome to contribute ideas without building them out. -## What is a "Complete" Project - -A project is considered complete when: - -1. It implements the minimum viable product for the idea -2. It includes a `README` with screenshots or a GIF describing the - application's behavior. See [Freeze][freeze] or [VHS][vhs] for easy demos. - -> [!NOTE] -> Please include an overview of what Charm libraries you used to build your project. +To contribute, see [CONTRIBUTING.md](./CONTRIBUTING.md) ## Contents @@ -34,22 +25,4 @@ A project is considered complete when: ### Editor Plugins -## Feedback - -We’d love to hear your thoughts on this project. Join the chatter happening on [Discord](https://charm.sh/chat). - -## License - -[MIT](https://github.com/charmbracelet/skate/raw/main/LICENSE) - -*** - -Part of [Charm](https://charm.sh). - -The Charm logo - -Charm热爱开源 • Charm loves open source - [charm]: https://github.com/charmbracelet/ -[freeze]: https://github.com/charmbracelet/freeze -[vhs]: https://github.com/charmbracelet/vhs From 6f22cffc607f11de4767437b32d3c95ec656fe11 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 02:54:31 +0530 Subject: [PATCH 05/10] chore: follow awesome spec x2 --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index a07865a..57842a0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Awesome Charm [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) This is your one-stop shop to find *incredible* community projects built with -the [Charm][charm] stack. Get inspired, and most importantly, get building! +the [Charm](https://github.com/charmbracelet/) stack. Get inspired, and most importantly, get building! This is an entirely community-driven repo for members of the community to share their projects. You can PR your completed projects to be included in the list. @@ -24,5 +24,3 @@ To contribute, see [CONTRIBUTING.md](./CONTRIBUTING.md) ## Other ### Editor Plugins - -[charm]: https://github.com/charmbracelet/ From 6dae5134335809d91e77565c5e020108af758992 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 03:08:32 +0530 Subject: [PATCH 06/10] README: add lint rules --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 57842a0..67d0d46 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ + + + + # Awesome Charm [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) This is your one-stop shop to find *incredible* community projects built with From d2a20d61c864c5dae2df6bfe9ee319a7216d3a9b Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 03:10:31 +0530 Subject: [PATCH 07/10] README: modify lint rules --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 67d0d46..1d0eb2c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ - - - + + + # Awesome Charm [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) From 32e5b649dfcc52a19e011259942db8972ec386c8 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 03:12:08 +0530 Subject: [PATCH 08/10] README: exp with lint rules --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d0eb2c..6a714fd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + From a44908adda7fbd74a945f15078f3f0a79b877b79 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 03:14:20 +0530 Subject: [PATCH 09/10] README: finish up with lint --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a714fd..492f550 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ + - - # Awesome Charm [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) From f4d6b666abaa0271ab8d57941a08ae17994a77f9 Mon Sep 17 00:00:00 2001 From: Swastik Date: Sat, 1 Jun 2024 03:16:48 +0530 Subject: [PATCH 10/10] README: fix lint rules --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 492f550..2b0d6f1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - + # Awesome Charm [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re)