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

CI/CD Plugin for typos-cli
https://github.com/fluentci-io/typos-plugin

cicd typos wasm

Last synced: about 1 month ago
JSON representation

CI/CD Plugin for typos-cli

• Host: GitHub
• URL: https://github.com/fluentci-io/typos-plugin
• Owner: fluentci-io
• License: mit
• Created: 2024-08-01T03:16:02.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-01T10:34:01.000Z (5 months ago)
• Last Synced: 2024-08-02T08:38:00.801Z (5 months ago)
• Topics: cicd, typos, wasm
• Language: Rust
• Homepage:
• Size: 7.81 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Typos Plugin

[![fluentci pipeline](https://shield.fluentci.io/x/typos)](https://pkg.fluentci.io/typos)

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

This plugin sets up your CI/CD pipeline with a specific version of [typos](https://github.com/crate-ci/typos).

## 🚀 Usage

Add the following command to your CI configuration file:

```bash

fluentci run --wasm typos setup

```

## Functions

| Name   | Description                                |

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

| setup  | Installs a specific version of typos.      |

| check  | Finds typos in the source code.            |

## 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: typos

    args: |

      check

  env:

    GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```