Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Add small info about extension. #258

Merged
merged 12 commits into from
May 26, 2020
Merged
19 changes: 15 additions & 4 deletions packages/language-server/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
# Change Log
All notable changes to the "hegel-language-server" extension will be documented in this file.
# Changelog
All notable changes to this project will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
- Initial release
- Extension settings.
- Detailed informaion of completion items.
- Autoimport.
- Suggestion of types that are exported from other modules.
- Trey icon and status.

## [0.0.43] - 2020-05-25
### Added
- Types validation.
- Hover.
- Autocompletion.
62 changes: 12 additions & 50 deletions packages/language-server/README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,27 @@
# hegel-language-server README
# @hegel/language-server

This is the README for your extension "hegel-language-server". After writing up a brief description, we recommend including the following sections.
This is an extension of [hegel](https://github.com/JSMonk/hegel) type system for VSCode.

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
At current time it can:

For example if there is an image subfolder under your extension project workspace:
- [x]: show diagnostic information.

\!\[feature X\]\(images/feature-x.png\)
![Diagonstics](images/diagnostics.png)

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
- [x]: show information on hovering an element.

## Requirements
![Hover](images/hover.png)

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
- [x]: autocomplete variables on typing.

## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

For example:
![Autocompletion](images/autocompletion.png)

This extension contributes the following settings:
## Extension Settings

* `myExtension.enable`: enable/disable this extension
* `myExtension.thing`: set to `blah` to do something
Under development.

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.

-----------------------------------------------------------------------------------------------------------

## Working with Markdown

**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets

### For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

**Enjoy!**
Please, create issues [here](https://github.com/JSMonk/hegel/issues).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/language-server/images/diagnostics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/language-server/images/hover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/language-server/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 12 additions & 4 deletions packages/language-server/package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
{
"name": "@hegel/language-server",
"name": "hegel-language-server",
"displayName": "Hegel",
"description": "Language server for Hegel Type Checker",
"version": "0.0.43",
"engines": {
"vscode": "^1.31.0"
},
"publisher": "JSMonk",
"icon": "images/logo.png",
"categories": [
"Programming Languages",
"Linters"
],
"repository": {
"type": "git",
"url": "https://github.com/JSMonk/hegel"
},
"activationEvents": [
"onLanguage:javascript",
"workspaceContains:**/.hegelrc"
Expand Down Expand Up @@ -49,15 +55,17 @@
]
},
"scripts": {
"test": "No tests defined yet."
"test": "No tests defined yet.",
"compile": "vsce package --yarn"
},
"devDependencies": {
"@types/mocha": "^7.0.2",
"@types/node": "^13.13.2",
"@types/vscode": "1.14.0",
"vscode-test": "1.3.0",
"eslint": "^6.8.0",
"typescript": "^3.8.3"
"typescript": "^3.8.3",
"vsce": "^1.75.0",
"vscode-test": "1.3.0"
},
"dependencies": {
"@babel/parser": "^7.9.4",
Expand Down
2 changes: 1 addition & 1 deletion packages/language-server/server/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function onDidChange(change) {
timeoutId = setTimeout(async () => {
const diagnostics = await validateTextDocument(change.document);
connection.sendDiagnostics(diagnostics);
}, 200);
}, 100);
}

connection.onHover(onHover);
Expand Down
35 changes: 0 additions & 35 deletions packages/language-server/vsc-extension-quickstart.md

This file was deleted.

Loading