SUSHI (SUSHI Unshortens Short Hand Inputs)

After making changes to the .g4 grammar files, you must regenerate the parser and lexer classes. Run the following Gradle command from the antlr/ directory:

./gradlew generateGrammarSource

This process generates the resulting parser/lexer files into the following directory: ../src/import/generated

SUSHI is a TypeScript project. Developers should use Node.js 22. To set up the development environment, clone the repository and run npm install from the root folder.

$ npm install

When adding new dependencies to the project, follow these requirements:

1. Use the latest versions: Always use the latest published version from npm. You can verify this using npm outdated.
2. Document exceptions: If you must use a version other than the latest, add the dependency and the reason for the version choice to DEPENDENCY-NOTES.md.
3. Check for vulnerabilities: Run npm audit to ensure no new security vulnerabilities are introduced by your changes.

SUSHI supports publishing implementation guides using the template-based IG Publisher. SUSHI populates the output directory based on inputs from:

1. FSH files
2. sushi-config.yaml
3. The IG project directory.

For detailed information on IG projects, refer to the SUSHI documentation.

For the best development experience, use Visual Studio Code with the following extensions:

• ESLint
• Prettier - Code formatter
• vscode-language-fsh

To enable automatic formatting for TypeScript, add this to your VS Code settings:

"[typescript]": {
    "editor.formatOnSave": true
}

The FSH Grammar is defined using ANTLR4. To modify the grammar, edit the following files located in the antlr/ directory:

• ./src/main/antlr/FSH.g4
• ./src/main/antlr/FSHLexer.g4
• ./src/main/antlr/MiniFSH.g4
• ./src/main/antlr/MiniFSHLexer.g4

It is recommended to use the ANTLR4 grammar syntax support VS Code extension for editing and debugging.

SUSHI requires Node.js to be installed. While Node.js 18 and 20 are supported, Node.js 22 is the recommended version.

To install or update SUSHI globally, use npm install -g fsh-sushi.

$ npm install -g fsh-sushi

To maintain consistent code style, SUSHI uses ESLint for linting and Prettier for formatting. Use the following commands to check and fix issues:

Linting (ESLint)

• Check for issues: Run npm run lint.
• Automatically fix issues: Run npm run lint:fix to apply ESLint's --fix option to as many problems as possible.

Formatting (Prettier)

• Check formatting: Run npm run prettier.
• Automatically fix formatting: Run npm run prettier:fix to rewrite files using Prettier's --write option.

SUSHI uses Jest for testing. To ensure your changes are correct and maintain high code quality, follow these steps:

1. Run the full test suite: Execute npm test to verify all existing and new functionality.
2. Review coverage: After running the tests, execute npm run coverage to generate a report. Ensure that your new code is fully covered by tests.

The FSHTank class acts as a central container for all parsed FSH (FHIR Structure Definition Language) content. It manages a collection of FSHDocument objects and a global Configuration. It provides high-level methods to retrieve all entities of a specific type (e.g., Profiles, Extensions, Resources) and powerful searching capabilities via the fish and fishAll methods.

Key capabilities include:

• Bulk Retrieval: Access all entities of a type (e.g., getAllProfiles(), getAllResources(), getAllValueSets()).
• Entity Searching: Find specific entities by name, ID, URL, or version using the fish API.
• Metadata Extraction: Retrieve FHIR-compatible metadata (ID, name, URL, version, resource type) for any entity using fishForMetadata.
• Alias Resolution: Resolve FSH aliases to their actual definitions.