https://github.com/fluentci-io/sqlfluff-plugin

Set up sqlfluff in your CI/CD Pipeline
https://github.com/fluentci-io/sqlfluff-plugin

continuous-delivery continuous-integration linter plugin rust sql wasm webassembly

Last synced: about 1 month ago
JSON representation

Set up sqlfluff in your CI/CD Pipeline

• Host: GitHub
• URL: https://github.com/fluentci-io/sqlfluff-plugin
• Owner: fluentci-io
• License: mit
• Created: 2024-04-23T13:07:04.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-26T06:08:12.000Z (5 months ago)
• Last Synced: 2024-07-26T07:28:01.336Z (5 months ago)
• Topics: continuous-delivery, continuous-integration, linter, plugin, rust, sql, wasm, webassembly
• Language: Rust
• Homepage:
• Size: 9.77 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sqlfluff Plugin

[![ci](https://github.com/fluentci-io/sqlfluff-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/fluentci-io/sqlfluff-plugin/actions/workflows/ci.yml)

This plugin sets up [sqlfluff](https://www.sqlfluff.com/) in your CI/CD pipeline.

## 🚀 Usage

Add the following command to your CI configuration file:

```bash

fluentci run --wasm sqlfluff setup

```

## Functions

| Name   | Description              |

| ------ | ------------------------ |

| setup  | Install sqlfluff.        |

| lint   | Lint SQL files.          |

| fix    | Fix SQL files.           |

| format | Format SQL files.        |

## Code Usage

Add `fluentci-pdk` crate to your `Cargo.toml`:

```toml

[dependencies]

fluentci-pdk = "0.1.9"

```

Use the following code to call the plugin:

```rust

use fluentci_pdk::dag;

// ...

dag().call("https://pkg.fluentci.io/[email protected]?wasm=1", "setup", vec!["latest"])?;

```

## 📚 Examples

Github Actions:

```yaml

- name: Setup Fluent CI CLI

  uses: fluentci-io/setup-fluentci@v5

  with:

    wasm: true

    plugin: sqlfluff

    args: |

      setup

- name: Show sqlfluff version

  run: |

    type sqlfluff

    sqlfluff --version

```