https://github.com/avo-hq/avo-cli

The linter will show you errors that you might have missed in the Avo files along with improvements that you could make.
https://github.com/avo-hq/avo-cli

admin avo content-management-system linter ruby-on-rails

Last synced: 3 months ago
JSON representation

The linter will show you errors that you might have missed in the Avo files along with improvements that you could make.

• Host: GitHub
• URL: https://github.com/avo-hq/avo-cli
• Owner: avo-hq
• License: mit
• Created: 2024-01-11T08:44:38.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-11T13:16:54.000Z (12 months ago)
• Last Synced: 2024-09-28T12:04:18.099Z (3 months ago)
• Topics: admin, avo, content-management-system, linter, ruby-on-rails
• Language: Ruby
• Homepage: https://avohq.io
• Size: 77.1 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Avo CLI

> [!WARNING]

> This is highly experimental.

This CLI is used by Avo, the Avo LSP (coming soon), and other products to do some common actions like linting the Avo configuration files.

It will show you errors that you might have missed in the Avo files along with improvements that you could make.

![](./linter.png)

## Running it

```bash

gem install avo-cli

avo

```

## Overview

The linter uses different techniques to figure out if Avo configuration files are invalid or could be improved

#### Using Prism

The linter is using [prism](https://github.com/ruby/prism) to parse the files and create an AST for each one.

We the linter is run it will scan the files and return errors it found in the files.

It's doing that by scanning the AST for common patterns using user-defined rules similar to how rubocop is working.

### Installation

Run `bundle install` to install the dependencies.

```bash

bundle

```

### Testing

Rspec is used for tests. Run `bin/rspec` to run all tests.