Skip to content

chore: add README with instructions for installing #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2022
Merged

chore: add README with instructions for installing #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8042709
chore: add README with instructions for installing
May 27, 2022
b68a8e8
fix: minor fix to readme
May 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
# replace this
# Functionless Language Service Plugin

[![npm version](https://badge.fury.io/js/@functionless%2Flanguage-service.svg)](https://badge.fury.io/js/@functionless%2Flanguage-service)

The `@functionless/language-service` package configures a plugin for the TypeScript language service plugin that adds real-time errors to the IDE for [Functionless](https://github.com/functionless/functionless)'s semantic errors.

To configure, first install the module as a devDependency.

```shell
# if using NPM
npm install --save-dev @functionless/language-service

# if using yarn
yarn add -D @functionless/language-service
```

Then add as a plugin to your `tsconfig.json`.

```json
{
"compilerOptions": {
"plugins": [
{
"name": "@functionless/language-service"
}
]
}
}
```