eslint-gpt - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #golang #rust #deep-learning #linux #java #cli #pytorch #openai #open-source

eslint-gpt

(★ 209)

Generate your eslint rule with OpenAI and Vercel Edge Functions.

File Explorer

Download Latest Version (.zip)

- pre-commit
- - index.module.css
  - index.tsx
- - index.tsx
- Banner.tsx
- Chrome.tsx
- DropDown.tsx
- EditButton.tsx
- Footer.tsx
- GitHub.tsx
- Header.tsx
- LoadingCircle.tsx
- LoadingDots.tsx
- Popover.tsx
- ResizablePanel.tsx
- Result.tsx
- RuleCard.tsx
- SaveButton.tsx
- Twitter.tsx
- TwitterIcon.tsx
- UserDropdown.tsx
- useSignInModal.tsx
- useView.ts
- en.json
- zh.json
- - generate.ts
- - rules.tsx
- - [id].tsx
- _app.tsx
- _document.tsx
- explore.tsx
- index.tsx
- schema.prisma
- 1-black.png
- 2-black.png
- favicon.ico
- icon.svg
- screenshot.png
- vercel.svg
- vercelLogo.png
- globals.css
- loading-dots.module.css
- markdown.css
- prism.css
- api.ts
- auth.ts
- fetchWithTimeout.ts
- index.ts
- OpenAIStream.ts
- planetscale.ts
- prisma.ts
- session.ts
- upstash.ts
.env.example
.gitignore
.prettierignore
.prettierrc
lint-staged.config.js
middleware.ts
next.config.js
package-lock.json
package.json
postcss.config.js
privacy.md
README-zh_CN.md
README.md
tailwind.config.js
tsconfig.json
turbo.json

# Installation Guide

1. Get the code

git clone https://github.com/ycjcl868/eslint-gpt

Downloads the entire project code from GitHub to your computer.

cd eslint-gpt

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ESLint GPT 🤖

![](https://user-images.githubusercontent.com/13595509/228750807-aa1e7e2b-e777-4136-96a1-969b4f5bb90f.png)

ESLint GPT is an innovative project that combines the power of OpenAI's GPT model and Vercel's Edge Functions to generate custom ESLint rules. This project aims to simplify the process of creating and maintaining ESLint rules for developers.

## About ESLint GPT

ESLint GPT is a project that uses OpenAI's GPT model to generate custom ESLint rules. With the help of Vercel Edge Functions, the generated rules can be easily integrated into any project. This project is perfect for developers who want to customize their ESLint rules based on their specific needs.

### Key Features

- **Automatic ESLint Rule Generation**: Automatically generate corresponding ESLint rules by inputting example code.
- **Multi-language Support**: Currently supports both English and Chinese, making it accessible for developers of different languages.
- **User-friendly Interface**: A clean and intuitive user interface that is easy to navigate.
- **Save and Share Functionality**: Save generated rules and share them with others.

## Quick Start

To get started with ESLint GPT, follow these steps:

1. Clone the repository: `git clone https://github.com/ycjcl868/eslint-gpt.git`
2. Install dependencies: `npm install`
3. Start the service: `npm run dev`
4. Open your browser and navigate to: `http://localhost:3000`

### Login

![](https://user-images.githubusercontent.com/13595509/231453712-0ed9df97-05b2-469c-8c06-458ab47f4b4a.png)

### Custom OpenAI Config

![](https://user-images.githubusercontent.com/13595509/233825257-24ef5470-3434-4a80-9144-d9d86f090c9c.gif)

### Save Rule

![](https://user-images.githubusercontent.com/13595509/231453228-247ac0aa-5057-4ad0-aea7-c8848f2f9ade.png)

### Sharing Rule

![](https://user-images.githubusercontent.com/13595509/231453277-d8cd5ce1-e46f-40ca-ae23-ed05e9dbd667.png)

### Delete Rule

TODO

## Getting Started

To get started with ESLint GPT, you will need to have an OpenAI API key and a Vercel account. Once you have these, you can simply clone the project and follow the instructions in the README file.

## Benefits of ESLint GPT

- Simplifies the process of creating custom ESLint rules
- Saves time by automating the rule generation process
- Provides developers with more flexibility in creating their own rules
- Makes it easier to maintain and update ESLint rules

## Contributing

If you are interested in contributing to ESLint GPT, please feel free to submit a pull request. We welcome all contributions and appreciate your help in making this project even better.

## License

ESLint GPT is licensed under the MIT License. See the LICENSE file for more information.