PR: code review #1
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "liveServer.settings.port": 5501 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,14 @@ | ||
| # README Medcodelogic Editor | ||
|
|
||
| ## Brief description | ||
| This is the parser for medcodelogic. | ||
|
|
||
| In the file medcodelogic.pegjs you can find the current medcodelogic grammar rules. | ||
|
|
||
| Based on this rules the parser will be generated using the following commands (make sure peggy is installed globally): | ||
|
|
||
| create the parser.js from your grammar: -peggy medcodelogic.pegjs <br> | ||
|
|
||
|
|
||
| ## Libraries | ||
| - Peggy for parser (use typescript) https://github.com/peggyjs/peggy. | ||
|
|
@@ -20,6 +28,12 @@ | |
| - Use self declaring code (f.e. method & variable names). | ||
|
|
||
| ## Setup | ||
| ### Monaco Editor | ||
| https://microsoft.github.io/monaco-editor/monarch.html | ||
|
|
||
| Running the `/Monaco/main.html` requires the "live server" extension. | ||
| To run it: right click `/Monaco/main.html` and click open with live server. | ||
|
There was a problem hiding this comment. Try to be as precise as possible. We're not working with vscode and thus I wasted time to find out what you mean by "live server" extension. It was not clear for me to use vscode and to find the live server extension there... |
||
|
|
||
| ### Development | ||
| Use `yarn` command to install all packages and dependencies from package.json. | ||
| Use `yarn start` to start local dev server. | ||
|
|
@@ -43,3 +57,27 @@ Use `yarn test` to start headless server and tests. You can also just test singl | |
| For further question: | ||
| - [[email protected]]([email protected]) -> eonum contact | ||
| - [eonum.ch/de/kontakt/](https://eonum.ch/de/kontakt/) -> eonum website | ||
|
|
||
| ## Monaco | ||
|
There was a problem hiding this comment. Why is there a section under Setup for Monaco-Editor and again a Monaco section here? |
||
| - See [this](https://microsoft.github.io/monaco-editor/typedoc/enums/languages.CompletionItemKind.html) for additional information about the CompletionItemKind | ||
| - See [this](https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.CompletionItem.html#documentation) for additional information about CompletionItems | ||
|
|
||
| <h1>Peggy Parser</h1> | ||
|
|
||
|
|
||
| This is the parser for medcodelogic.<br> | ||
| In the file medcodelogic.pegjs you can find the current medcodelogic grammar rules. | ||
| Based on this rules the parser will be generated using the following commands (make sure peggy is installed globally): | ||
| create the parser.js from your grammar use the command peggy medcodelogic.pegjs (note here its peggy src/Peggy/medcodelogic.pegjs) | ||
|
There was a problem hiding this comment. Update to new folder structure, i.e. Peggy folder doesn't exist anymore. |
||
|
|
||
| The generated parser can be used as an object in JS. But for use in the browser we had to bundle it. | ||
| Therefore we used Webpack. All the necessary configurations are in the webpack.config.js | ||
|
|
||
| webpack.config.js if you want to use the function .parse from the bundled file (bundle.js) use Parser.parse(). We only use the .prase() function. | ||
|
There was a problem hiding this comment. typo: .prase() should be parse() |
||
| This function is exported (see webpack.config.js). | ||
| In the HTML the script for the bundle (actual Parser) needs to be initialized BEFORE the loader of the Monaco Code Editor. | ||
|
|
||
| If you change something in the grammar (medcodelogic.pegjs) run peggy src/Peggy/medcodelogic.pegjs after your changes. | ||
|
There was a problem hiding this comment. same comment on deprecated folder "Peggy" |
||
| This will generate a new parser (medcodelogic.js). Then use npm run build to bundle the parser. Make sure to delet the old bundle.js file in the Monaco directory and replace the newly generated bundle.js file in the Monaco folder. | ||
|
There was a problem hiding this comment. Did you go with yarn or npm? Same goes of course using "yarn run build"... |
||
|
|
||
| ## Running | ||
| The submit button is disabled as long as there is no content or an error. Pressing the submit button will log the valid content into the console. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,101 @@ | ||
| { | ||
| "name": "mcl-editor", | ||
| "version": "1.0.0", | ||
| "description": "This is the parser for medcodelogic.", | ||
| "main": "webpack.config.js", | ||
| "dependencies": { | ||
| "acorn": "^8.8.2", | ||
| "acorn-import-assertions": "^1.8.0", | ||
| "ajv": "^6.12.6", | ||
| "ajv-keywords": "^3.5.2", | ||
| "browserslist": "^4.21.5", | ||
| "buffer-from": "^1.1.2", | ||
| "caniuse-lite": "^1.0.30001486", | ||
| "chrome-trace-event": "^1.0.3", | ||
| "clone-deep": "^4.0.1", | ||
| "colorette": "^2.0.20", | ||
| "commander": "^2.20.3", | ||
| "cross-spawn": "^7.0.3", | ||
| "electron-to-chromium": "^1.4.385", | ||
| "enhanced-resolve": "^5.13.0", | ||
| "envinfo": "^7.8.1", | ||
| "es-module-lexer": "^1.2.1", | ||
| "escalade": "^3.1.1", | ||
| "eslint-scope": "^5.1.1", | ||
| "esrecurse": "^4.3.0", | ||
| "estraverse": "^4.3.0", | ||
| "events": "^3.3.0", | ||
| "fast-deep-equal": "^3.1.3", | ||
| "fast-json-stable-stringify": "^2.1.0", | ||
| "fastest-levenshtein": "^1.0.16", | ||
| "find-up": "^4.1.0", | ||
| "function-bind": "^1.1.1", | ||
| "glob-to-regexp": "^0.4.1", | ||
| "graceful-fs": "^4.2.11", | ||
| "has": "^1.0.3", | ||
| "has-flag": "^4.0.0", | ||
| "import-local": "^3.1.0", | ||
| "interpret": "^3.1.1", | ||
| "is-core-module": "^2.12.0", | ||
| "is-plain-object": "^2.0.4", | ||
| "isexe": "^2.0.0", | ||
| "isobject": "^3.0.1", | ||
| "jest-worker": "^27.5.1", | ||
| "json-parse-even-better-errors": "^2.3.1", | ||
| "json-schema-traverse": "^0.4.1", | ||
| "kind-of": "^6.0.3", | ||
| "loadash": "^1.0.0", | ||
| "loader-runner": "^4.3.0", | ||
| "locate-path": "^5.0.0", | ||
| "merge-stream": "^2.0.0", | ||
| "mime-db": "^1.52.0", | ||
| "mime-types": "^2.1.35", | ||
| "neo-async": "^2.6.2", | ||
| "node-releases": "^2.0.10", | ||
| "p-limit": "^2.3.0", | ||
| "p-locate": "^4.1.0", | ||
| "p-try": "^2.2.0", | ||
| "path-exists": "^4.0.0", | ||
| "path-key": "^3.1.1", | ||
| "path-parse": "^1.0.7", | ||
| "picocolors": "^1.0.0", | ||
| "pkg-dir": "^4.2.0", | ||
| "punycode": "^2.3.0", | ||
| "randombytes": "^2.1.0", | ||
| "rechoir": "^0.8.0", | ||
| "resolve": "^1.22.2", | ||
| "resolve-cwd": "^3.0.0", | ||
| "resolve-from": "^5.0.0", | ||
| "safe-buffer": "^5.2.1", | ||
| "schema-utils": "^3.1.2", | ||
| "serialize-javascript": "^6.0.1", | ||
| "shallow-clone": "^3.0.1", | ||
| "shebang-command": "^2.0.0", | ||
| "shebang-regex": "^3.0.0", | ||
| "source-map": "^0.6.1", | ||
| "source-map-support": "^0.5.21", | ||
| "supports-color": "^8.1.1", | ||
| "supports-preserve-symlinks-flag": "^1.0.0", | ||
| "tapable": "^2.2.1", | ||
| "terser": "^5.17.2", | ||
| "terser-webpack-plugin": "^5.3.8", | ||
| "update-browserslist-db": "^1.0.11", | ||
| "uri-js": "^4.4.1", | ||
| "watchpack": "^2.4.0", | ||
| "webpack": "^5.82.0", | ||
| "webpack-cli": "^5.1.0", | ||
| "webpack-merge": "^5.8.0", | ||
| "webpack-sources": "^3.2.3", | ||
| "which": "^2.0.2", | ||
| "wildcard": "^2.0.1" | ||
| }, | ||
| "devDependencies": {}, | ||
| "scripts": { | ||
| "build":"webpack", | ||
| "test": "jest" | ||
|
|
||
| }, | ||
| "keywords": [], | ||
| "author": "", | ||
| "license": "ISC" | ||
| } |
|
There was a problem hiding this comment. Why did you delete the public folder? |
Binary file not shown.
Empty file.
Zediwan marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| const Parser = require("./bundle.js") | ||
|
|
||
| console.log(Parser.parse("age_years in table(MDC1)")) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move specific information like how to generate the parser to the "Setup" section where you should have a "Parser" subsection.