https://github.com/uhyo/ts-satisfactory-plugin

https://github.com/uhyo/ts-satisfactory-plugin

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/uhyo/ts-satisfactory-plugin
• Owner: uhyo
• License: mit
• Created: 2023-02-05T03:31:26.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-05T03:41:55.000Z (almost 2 years ago)
• Last Synced: 2024-10-05T01:04:41.116Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/ts-satisfactory-plugin
• Size: 71.3 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ts-satisfactory-plugin

A TypeScript Language Service Plugin that satisfies you.

![Screenshot of how ts-satisfies-plugin works](./docs/sceenshot.png)

This plugin provides inlay hints for expressions constrained by the `satisfies` syntax.

This is especially helpful when a function has a `satisfies` constraint. With this plugin, an inlay hint for the `satisfies` constraint is shown right above its declaration.

You often want to see other function interface and `satisfies` constraint at the same time. This plugin is here fore you.

## Installation

Install with your package manager.

```sh

npm i -D ts-satisfactory-plugin

```

Add this plugin to your `tsconfig.json`.

```json

{

  "compilerOptions": {

    // ...

    "plugins": [

      {

        "name": "ts-satisfactory-plugin"

      }

    ]

  }

}

```

## Options

### `minLines`: number

```json

"plugins": [

  {

    "name": "ts-satisfactory-plugin",

    "minLines": 3

  }

]

```

Minimum number of lines occupied by an expression in order for an inlay hint to appear.

Default value: 1 (inlay hints shown to all `satisfies`-constrained expressions)

# License

MIT