thrift-fmt-ts/README.md

A formatter of Thrift, re-implement of python thrift-fmt

# thrift-fmt-ts

typescript implement of `thrift-fmt` https://github.com/thrift-labs/thrift-fmt

typescript parser `thrift-parser-ts` https://github.com/thrift-labs/thrift-parser/tree/master/typescript

## Usage

```typescript
import { ThriftData } from 'thrift-parser-ts';
import { ThriftFormatter, newOption } from 'thrift-fmt-ts'

const thrift = ThriftData.fromString(`const string name="hello"//hello`);
const fmt = new ThriftFormatter(thrift);
fmt.option(newOption({keepComment: true, alignByAssign: true}));
const content = fmt.format();

// const string name = "hello" // hello
console.log(content);
```

## Feature

1. keep and align all comments
2. patch list separator
3. patch missed field's `required` flag
4. align by the field's assign (like go)
5. align by each field's part
6. format only part of the parsed thrift

## Other

used by https://github.com/thrift-labs/thrift-fmt-vscode

# LICENSE

some thrift files in fixtures thrift was copy from https://github.com/apache/thrift/blob/master/tutorial/ , The Apache LICENSE

the Thrift.g4 in thrift-parser package was copy from https://github.com/antlr/grammars-v4