Skip to content

Commit

Permalink
md->html imgs, install link. rm'd boilerplate files, misc formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Mehvix committed Dec 11, 2022
1 parent dfac502 commit 4f1ed68
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 99 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
node_modules
*.vsix
*.vsix
3 changes: 1 addition & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
{
"version": "0.2.0",
"version": "0.2.0",
"configurations": [

{
"name": "Extension",
"type": "extensionHost",
Expand Down
9 changes: 0 additions & 9 deletions CHANGELOG.md

This file was deleted.

12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# NOME3 Language Extension README

This is a [Visual Studio Code](https://code.visualstudio.com/) extension for the NOME3 language used for **3D-computer-aided-design** on the **[JIPCAD](https://jipcad.github.io/docs/)** software, supervised by Prof. Carlo Sequin and developed by the JIPCAD group.
This is a [Visual Studio Code](https://code.visualstudio.com/) extension for the NOME3 language used for **3D-computer-aided-design** on the **[JIPCAD](https://jipcad.github.io/docs/)** software, supervised by Prof. Carlo Sequin and developed by the JIPCAD group. The extension can be installed from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=AaronZheng.nome).

This extension supports files with both the (.nom, .jipcad $*$) endings.
Enjoy!

## Features
### 1. Autocompletion of commands
![](.github/images/autocompletion.gif)
<img src="https://raw.githubusercontent.com/JIPCAD/JIPCAD-vs-code/master/.github/images/autocompletion.gif">

### 2. Syntax coloring
![](.github/images/syntax_highlight.png)
<img src="https://raw.githubusercontent.com/JIPCAD/JIPCAD-vs-code/master/.github/images/syntax_highlight.gif">

### 3. Commenting
![](.github/images/toggle_block_comment.gif)
<img src="https://raw.githubusercontent.com/JIPCAD/JIPCAD-vs-code/master/.github/images/toggle_block_comment.gif">

### 4. Running of Nome Executable
![](.github/images/run_nome.gif)
<img src="https://raw.githubusercontent.com/JIPCAD/JIPCAD-vs-code/master/.github/images/run_nome.gif">

### 5. Customize directory of NOME executable
![](.github/images/remote_running.gif)
<img src="https://raw.githubusercontent.com/JIPCAD/JIPCAD-vs-code/master/.github/images/remote_running.gif">


## Intended Updates/Improvements
Expand Down
1 change: 1 addition & 0 deletions antlr/Nom.g4
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Source: https://github.com/JIPCAD/JIPCAD/blob/master/Application/Parsing/Nom.g4
grammar Nom;

file : command* EOF;
Expand Down
104 changes: 52 additions & 52 deletions language-configuration.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,69 +3,69 @@
// symbol used for single line comment. Remove this entry if your language does not support line comments
"lineComment": "#",
// symbols used for start and end a block comment. Remove this entry if your language does not support block comments
"blockComment": ["(*","*)"],
"blockComment": [ "(*", "*)" ],
"include": "#comments-inline",
},
"comments-inline":{
"patterns": [ "(*","*)"]
"comments-inline": {
"patterns": [ "(*", "*)" ]
},
// symbols used as brackets
"brackets": [
["{", "}"],
["[", "]"],
["(", ")"]
[ "{", "}" ],
[ "[", "]" ],
[ "(", ")" ]
],
// symbols that are auto closed when typing
"autoClosingPairs": [
["{", "}"],
["[", "]"],
["(", ")"],
["\"", "\""],
["'", "'"],
["point","endpoint"],
["surface","endsurface"],
["polyline","endpolyline"],
["bspline","endbspline"],
["sweep","endsweep"],
["group","endgroup"],
["instance","endinstance"],
["torus", "endtorus"],
["bank", "endbank"],
["controlpoint", "endcontrolpoint"],
["sweepmorph","endsweepmorph"],
["morphvisualizer","endmorphvisualizer"],
["circle","endcircle"],
["Disk","enddisk"],
["cylinder","endcylinder"],
["funnel", "endfunnel"],
["sphere","endsphere"],
["ellipsoid","endellipsoid"],
["torus","endtorus"],
["torusknot","endtorusknot"],
["mobiusstrip", "endmobiusstrip"],
["dupin", "enddupin"],
["gencartesiansurf","endgencartesiansurf"],
["genparametricsurf","endgenparametricsurf"],
["genimplicitsurf","endgenimplicitsurf"],
["camera","endcamera"],
["light","endlight"],
["frontcolor","endfrontcolor"],
["backcolor", "endbackcolor"],
["backface","endbackface"],
["subdivision","endsubdivision"],
["offset","endoffset"],
["include", "endinclude"],
["crosssection","endcrosssection"],
["path","endpath"],
["(*", "*)"]
[ "{", "}" ],
[ "[", "]" ],
[ "(", ")" ],
[ "\"", "\"" ],
[ "'", "'" ],
[ "point", "endpoint" ],
[ "surface", "endsurface" ],
[ "polyline", "endpolyline" ],
[ "bspline", "endbspline" ],
[ "sweep", "endsweep" ],
[ "group", "endgroup" ],
[ "instance", "endinstance" ],
[ "torus", "endtorus" ],
[ "bank", "endbank" ],
[ "controlpoint", "endcontrolpoint" ],
[ "sweepmorph", "endsweepmorph" ],
[ "morphvisualizer", "endmorphvisualizer" ],
[ "circle", "endcircle" ],
[ "Disk", "enddisk" ],
[ "cylinder", "endcylinder" ],
[ "funnel", "endfunnel" ],
[ "sphere", "endsphere" ],
[ "ellipsoid", "endellipsoid" ],
[ "torus", "endtorus" ],
[ "torusknot", "endtorusknot" ],
[ "mobiusstrip", "endmobiusstrip" ],
[ "dupin", "enddupin" ],
[ "gencartesiansurf", "endgencartesiansurf" ],
[ "genparametricsurf", "endgenparametricsurf" ],
[ "genimplicitsurf", "endgenimplicitsurf" ],
[ "camera", "endcamera" ],
[ "light", "endlight" ],
[ "frontcolor", "endfrontcolor" ],
[ "backcolor", "endbackcolor" ],
[ "backface", "endbackface" ],
[ "subdivision", "endsubdivision" ],
[ "offset", "endoffset" ],
[ "include", "endinclude" ],
[ "crosssection", "endcrosssection" ],
[ "path", "endpath" ],
[ "(*", "*)" ]

],
// symbols that can be used to surround a selection
"surroundingPairs": [
["{", "}"],
["[", "]"],
["(", ")"],
["\"", "\""],
["'", "'"]
[ "{", "}" ],
[ "[", "]" ],
[ "(", ")" ],
[ "\"", "\"" ],
[ "'", "'" ]
]
}
29 changes: 0 additions & 29 deletions vsc-extension-quickstart.md

This file was deleted.

1 comment on commit 4f1ed68

@Mehvix
Copy link
Collaborator Author

@Mehvix Mehvix commented on 4f1ed68 Dec 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixes #1

Please sign in to comment.