https://github.com/wasm-fmt/ruff_fmt

A WASM Based Python Formatter
https://github.com/wasm-fmt/ruff_fmt

dprint formatter formatting python ruff wasm webassembly

Last synced: 3 days ago
JSON representation

A WASM Based Python Formatter

• Host: GitHub
• URL: https://github.com/wasm-fmt/ruff_fmt
• Owner: wasm-fmt
• License: mit
• Created: 2023-08-08T14:21:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-15T19:03:42.000Z (30 days ago)
• Last Synced: 2024-10-17T03:36:13.750Z (29 days ago)
• Topics: dprint, formatter, formatting, python, ruff, wasm, webassembly
• Language: Rust
• Homepage:
• Size: 507 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Test](https://github.com/wasm-fmt/ruff_fmt/actions/workflows/test.yml/badge.svg)](https://github.com/wasm-fmt/ruff_fmt/actions/workflows/test.yml)

# Install

[![npm](https://img.shields.io/npm/v/@wasm-fmt/ruff_fmt?color=3572A5)](https://www.npmjs.com/package/@wasm-fmt/ruff_fmt)

```bash

npm install @wasm-fmt/ruff_fmt

```

[![jsr.io](https://jsr.io/badges/@fmt/ruff-fmt?color=3572A5)](https://jsr.io/@fmt/ruff-fmt)

```bash

npx jsr add @fmt/ruff-fmt

```

# Usage

```javascript

import init, { format } from "@wasm-fmt/ruff_fmt";

await init();

const input = `x = {  'a':37,'b':42,

'c':927}

y = 'hello ''world'

z = 'hello '+'world'

a = 'hello {}'.format('world')

class foo  (     object  ):

  def f    (self   ):

    return       37*-+2

  def g(self, x,y=42):

      return y

def f  (   a ) :

  return      37+-+a[42-x :  y**3]`;

const formatted = format(input);

console.log(formatted);

```

with custom options:

```javascript

import init, { format } from "@wasm-fmt/ruff_fmt";

// ...

const formatted = format(input, {

    indent_style: "space",

    indent_width: 4,

    line_width: 88,

    quote_style: "double",

    magic_trailing_comma: "respect",

});

console.log(formatted);

```

For Vite users:

Add `"@wasm-fmt/ruff_fmt"` to `optimizeDeps.exclude` in your vite config:

```JSON

{

    "optimizeDeps": {

        "exclude": ["@wasm-fmt/ruff_fmt"]

    }

}

```

If you cannot change the vite config, you can use another import entry

```JavaScript

import init, { format } from "@wasm-fmt/ruff_fmt/vite";

// ...

```

# dprint plugin

> [!NOTE]

> dpint plugin is deprecated, please use https://dprint.dev/plugins/ruff instead.

```bash

dprint config add wasm-fmt/ruff_fmt

```

# How does it work?

[Ruff] is an extremely fast Python linter, written in Rust.

This package is a WebAssembly build of Ruff formatter, with a JavaScript wrapper.

[Ruff]: https://github.com/astral-sh/ruff