https://github.com/finnfiddle/tidy-bot

GitHub workflow that use AI to clean up source files.
https://github.com/finnfiddle/tidy-bot

Last synced: 12 months ago
JSON representation

GitHub workflow that use AI to clean up source files.

• Host: GitHub
• URL: https://github.com/finnfiddle/tidy-bot
• Owner: finnfiddle
• Created: 2025-05-07T15:37:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-11T14:05:52.000Z (about 1 year ago)
• Last Synced: 2025-06-20T00:02:11.398Z (about 1 year ago)
• Language: TypeScript
• Size: 358 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 🧹 TidyBot

TidyBot is a GitHub Action that selects a random source file once a day (or on demand) and uses OpenAI to refactor it using your preferred style guides and custom rules.

## 📦 Setup

1. Add `.tidy-bot.yml` to the root of your repo:

```yaml

srcDir: "./src"

extensions:

  - ".js"

  - ".ts"

  - ".tsx"

styleGuides:

  - "Airbnb JavaScript/TypeScript style guide"

  - "React best practices"

customInstructions: |

  - Use const where possible.

  - Prefer arrow functions.