Skip to content

Commit

Permalink
Release v0.0.2 (#66)
Browse files Browse the repository at this point in the history
Upgrades OML support to 1.4.1 and reduces bundle size by 97%
  • Loading branch information
0x65-e authored Mar 18, 2023
1 parent 681f616 commit 17c61f8
Show file tree
Hide file tree
Showing 10 changed files with 265 additions and 647 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ generated/
!.yarn/releases
!.yarn/plugins
.pnp.*
*.vsix
14 changes: 14 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
.vscode/**
.vscode-test/**
.yarn/*
.gitignore
.github
.gitmodules
.gitpod.yml
oml-sprotty/**
node_modules/**
bin
docs
examples
generated
scripts
src
test
langium-config.json
tsconfig.json
.eslintrc.json
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# OML Alexandria Extension
# OML Alexandria Extension for Visual Studio Code

[![Release](https://img.shields.io/github/v/release/0x65-e/oml-alexandria?label=release)](https://github.com/0x65-e/oml-alexandria/releases/latest)
[![Release](https://img.shields.io/github/v/release/0x65-e/oml-alexandria?label=release&logo=github&style=flat-square)](https://github.com/0x65-e/oml-alexandria/releases/latest)
[![Installs](https://img.shields.io/visual-studio-marketplace/i/pteam-ptolemy.oml-alexandria?logo=visualstudiocode&color=informational&style=flat-square)](https://marketplace.visualstudio.com/items?itemName=pteam-ptolemy.oml-alexandria)
[![License](https://img.shields.io/github/license/0x65-e/oml-alexandria?logo=apache&style=flat-square)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Build Status](https://img.shields.io/github/actions/workflow/status/0x65-e/oml-alexandria/linter.yml?branch=main&logo=github&style=flat-square)](https://github.com/0x65-e/oml-alexandria/actions/workflows/linter.yml)

A proof-of-concept extension to support [OML](https://opencaesar.github.io/oml) in VSCode-based IDEs. Unlike [OML Luxor](https://github.com/opencaesar/oml-luxor/), this is designed from the ground up to support web-based IDEs by running the language server through the extension instead of requiring a separate executable.
A proof-of-concept extension to support [OML](https://opencaesar.github.io/oml) in [VSCode](https://code.visualstudio.com/)-compatible IDEs. Unlike [OML Luxor](https://github.com/opencaesar/oml-luxor/), this extension is designed from the ground up to support web-based IDEs by running the language server through the extension instead of requiring a separate executable.

## Getting Started

Install [nvm](https://github.com/creationix/nvm#install-script):

```shell
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
```

Install `npm` and `node`:
Expand Down Expand Up @@ -56,14 +59,23 @@ You can clean up the build artifacts using ```npm run clean```.

## Install in VSCode

You can install the vsix file manually through the Extensions tab. If a previous version of the extension is already installed, uninstall it first.
You can install the vsix file by searching for "OML Luxor" in the Extensions Marketplace or manually through the Extensions tab. If a previous version of the extension is already installed, uninstall it first.

## Install in Gitpod.io
## Install in Gitpod or GitHub Codespaces

Launch your repo with [gitoid.io](https://www.gitpod.io/), then open the Extension area to drag and drop the vsix file to install it. If a previous version of the extension is already installed, uninstall it first.
Launch your repo with [gitpod.io](https://www.gitpod.io/) or [GitHub Codespaces](https://github.com/features/codespaces), then open the Extension area to drag and drop the vsix file to install it. If a previous version of the extension is already installed, uninstall it first.

## Support for [vscode.dev](https://vscode.dev)

OML Alexandria is not a web extension, and is not compatible with [vscode.dev](https://vscode.dev) (which includes [github.dev](https://github.dev) and any other VS Code for the Web instance).

## OML Version

| Alexandria | OML |
|------------|-----|
| 0.0.2 | 1.4.1 |
| 0.0.1 | 1.4.0 |

## License

See [LICENSE](./LICENSE).
22 changes: 0 additions & 22 deletions examples/UML.plantuml

This file was deleted.

File renamed without changes.
Binary file removed oml-alexandria-0.0.1.vsix
Binary file not shown.
30 changes: 6 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "oml-alexandria",
"displayName": "OML Alexandria",
"description": "Severless VSCode-compatible extension for OML",
"version": "0.0.1",
"version": "0.0.2",
"publisher": "pteam-ptolemy",
"license": "Apache-2.0",
"icon": "images/logo.png",
Expand All @@ -14,7 +14,7 @@
"vscode": "^1.74.0"
},
"config": {
"oml_version": "1.4.0"
"oml_version": "1.4.1"
},
"categories": [
"Programming Languages"
Expand All @@ -40,24 +40,6 @@
"path": "./syntaxes/oml.tmLanguage.json"
}
],
"viewsContainers": {
"activitybar": [
{
"id": "oml-container",
"title": "OML",
"icon": "$(symbol-structure)"
}
]
},
"views": {
"oml-container": [
{
"id": "oml",
"type": "webview",
"name": "OML"
}
]
},
"commands": [
{
"command": "oml.diagram.open",
Expand Down Expand Up @@ -88,6 +70,7 @@
{
"command": "oml.generate.uml",
"title": "Generate UML",
"icon": "$(file-symlink-file)",
"category": "OML"
}
],
Expand Down Expand Up @@ -196,16 +179,15 @@
},
"main": "./pack/extension.js",
"scripts": {
"clean": "npx shx rm -rf pack out && npx shx mkdir pack",
"clean": "npx shx rm -rf pack && npx shx mkdir pack",
"vscode:prepublish": "npm run build:prod",
"esbuild:dev": "esbuild ./src/extension.ts ./src/language-server/main.ts ./src/cli/index.ts --sourcemap --bundle --outdir=pack --external:vscode --format=cjs --platform=node",
"esbuild:prod": "esbuild ./src/extension.ts ./src/language-server/main.ts --bundle --outdir=pack --external:vscode --format=cjs --platform=node",
"esbuild:prod": "esbuild --minify ./src/extension.ts ./src/language-server/main.ts --bundle --outdir=pack --external:vscode --format=cjs --platform=node",
"esbuild:watch": "npm run esbuild:dev --watch",
"test-compile": "tsc -p ./",
"build:sprotty": "cd oml-sprotty && yarn install && yarn build && npx shx mkdir -p ../pack && npx shx cp pack/webview.js ../pack/",
"build:extension": "tsc -b tsconfig.json",
"build": "npm run build:sprotty && npm run esbuild:dev",
"build:win": "npm run build:sprotty:win && npm run esbuild:dev",
"build:prod": "npm run clean && npm run build:sprotty && npm run esbuild:prod",
"watch": "npm run build:sprotty && npm run esbuild:watch",
"lint": "eslint src --ext ts",
Expand All @@ -218,7 +200,6 @@
"chevrotain": "~10.4.2",
"commander": "~10.0.0",
"elkjs": "^0.8.2",
"fs": "^0.0.1-security",
"langium": "~1.1.0",
"langium-sprotty": "^1.1.0",
"sprotty-elk": "^0.13.1",
Expand All @@ -234,6 +215,7 @@
"@typescript-eslint/parser": "~5.51.0",
"esbuild": "^0.17.11",
"eslint": "~8.33.0",
"fs": "^0.0.1-security",
"langium-cli": "~1.1.0",
"typedoc": "^0.23.26",
"typedoc-plugin-merge-modules": "^4.0.1",
Expand Down
Loading

0 comments on commit 17c61f8

Please sign in to comment.