Skip to content
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

Jump to bottom

Link to Knowledge Sharing Sessions #98

Merged
merged 3 commits into from
Oct 3, 2024
Merged

Link to Knowledge Sharing Sessions #98

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5e074e
Add links to knowledge sharing sessions
jafeltra Sep 30, 2024
eb82d62
Fix recording link
jafeltra Oct 3, 2024
2a83bc5
Merge branch 'master' into add-knowledge-sharing-session-links
cmoesel Oct 3, 2024
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
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,22 @@ To run the SUSHI Build task, use VS Code's Run Task feature. The "Run Task" feat

Note that you must have SUSHI installed locally in order for the task to run successfully. See [SUSHI Installation instructions](https://fshschool.org/docs/sushi/installation/) for help installing.

## Compile and Run (for Developers)
## Instructions for Developers

### Intro to FSH VS Code Extension Development

To learn more about the FSH VS Code Extension, watch the Knowledge Sharing Sessions for [Developing FSH Tools](https://vimeo.com/990594228/056b5c075f) (view the slides [here](https://confluence.hl7.org/display/FHIR/FSH+Knowledge+Sharing+Sessions?preview=/256509612/256514908/KSS%203%20-%20Developing%20FSH%20Tools.pdf)) and [Developing FSH VS Code Extension](https://vimeo.com/1008502402/e0d365dc49) (view the slides [here](https://confluence.hl7.org/display/FHIR/FSH+Knowledge+Sharing+Sessions?preview=/256509612/265095834/KSS%207%20-%20Developing%20FSH%20VS%20Code%20Extension.pdf)).
These sessions provide a technical overview of the codebase and summarize key concepts for developers.

### Compile and Run

- run `npm install` in this folder. This installs all necessary npm modules in both the
client and server folder
- open VS Code on this folder.
- Switch to the Debug viewlet.
- Select `Extension` from the drop down.

## NPM Tasks
### NPM Tasks

The following NPM tasks may be useful in development:

Expand All @@ -121,11 +128,11 @@ To run any of these tasks, use `npm run`. For example:
$ npm run build:watch
```

### Note about testing
#### Note about testing

The `test` task will often (but not always) produce an error if it is run while VSCode is open. If you receive this error, close VSCode and run the task from the command line.

## Updating the Grammar
### Updating the Grammar

The `src/lang/` directory contains the FSH lexer and parser. When the FSH grammar changes, the files in this directory will need to be updated. These files are generated in the [SUSHI](https://github.com/FHIR/sushi) project by running ANTLR on the grammar definition files. The files are then copied from the SUSHI project to this project.
The files to copy are:
Expand Down
Loading