https://github.com/andostronaut/eslint-ai

eslint-ai is an cli tools that help us to lint and view suggestion from ai if we had a code error with eslint support.
https://github.com/andostronaut/eslint-ai

ai code-verification eslint eslint-config javascript openapi suggestions typescript

Last synced: 13 days ago
JSON representation

eslint-ai is an cli tools that help us to lint and view suggestion from ai if we had a code error with eslint support.

• Host: GitHub
• URL: https://github.com/andostronaut/eslint-ai
• Owner: andostronaut
• License: mit
• Created: 2023-04-19T08:41:29.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-09T08:24:50.000Z (over 1 year ago)
• Last Synced: 2024-10-06T06:04:11.519Z (about 1 month ago)
• Topics: ai, code-verification, eslint, eslint-config, javascript, openapi, suggestions, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/eslint-ai
• Size: 194 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ESLint: AI

![build](https://github.com/iamando/eslint-ai/workflows/build/badge.svg)

![license](https://img.shields.io/github/license/iamando/eslint-ai?color=success)

![npm](https://img.shields.io/npm/v/eslint-ai)

![release](https://img.shields.io/github/release-date/iamando/eslint-ai)

eslint-ai is an cli tools that help us to lint and view suggestion from ai if we had a code error with eslint support.

## Setup

Get your OPENAI_KEY from [OpenAi](https://platform.openai.com/account/api-keys)

> You'll have to create a account and get your api key

Set your configuration:

```bash

eslint-ai config set OPENAI_KEY= # for api key

eslint-ai config set OPENAI_MODEL= # for specifing your prefered model

eslint-ai config set OPENAI_API_ENDPOINT= # for specifing your api endpoint

eslint-ai config ui # to use ui prompt directly

```

## Usage

Recommended

```bash

npx eslint-ai # basic usage

npx eslint-ai  # you can specify a list of file to lint

```

Using global installation

```bash

npm install -g eslint-ai # npm

yarn add global eslint-ai # yarn

eslint-ai # basic usage

eslint-ai  # you can specify a list of file to lint

```

### Update

To update to the latest version, use:

```shell

eslint-ai update

```

## Support

eslint-ai is an MIT-licensed open source project. It can grow thanks to the sponsors and support.

## License

eslint-ai is [MIT licensed](LICENSE).