fsh-sushi
Sushi Unshortens Short Hand Inputs (FSH Compiler)
Last updated 16 days ago by cmoesel .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install fsh-sushi 
SYNC missed versions from official npm registry.

GitHub Workflow Status npm

SUSHI (WORK IN PROGRESS)

SUSHI (aka "SUSHI Unshortens Short Hand Inputs") is a reference implementation command-line interpreter/compiler for FHIR Shorthand (FSH).

FHIR Shorthand (FSH) is a specially-designed language for defining the content of FHIR Implementation Guides (IG). It is simple and compact, with tools to produce Fast Healthcare Interoperability Resources (FHIR) profiles, extensions and implementation guides (IG). Because it is a language, written in text statements, FHIR Shorthand encourages distributed, team-based development using conventional source code control tools such as Github.

For more information about the evolving FSH syntax see the FHIR Shorthand Reference Manual.

Installation for SUSHI Users

SUSHI requires Node.js to be installed on the user's system. Users should install Node.js 12 (LTS), although earlier LTS versions (8, 10) are also expected to work.

Once Node.js is installed, run the following command to install or update SUSHI:

$ npm install -g fsh-sushi

After installation, the sushi commandline will be available on your path:

$ sushi --help
Usage: sushi [path-to-fsh-defs] [options]

Options:
  -o, --out <out>  the path to the output folder
  -d, --debug      output extra debugging information
  -s, --snapshot   generate snapshot in Structure Definition output (default: false)
  -v, --version    print SUSHI version
  -h, --help       output usage information

Additional information:
  [path-to-fsh-defs]
    Default: "."
    If fsh/ subdirectory present, it is included in [path-to-fsh-defs]
  -o, --out <out>
    Default: "build"
    If fsh/ subdirectory present, default output is one directory above fsh/

IG Generation

SUSHI supports publishing implementation guides via the new template-based IG Publisher. The template-based publisher is still being developed by the FHIR community. See the Guidance for HL7 IG Creation for more details.

If the input folder (i.e., "FSH Tank") contains a sub-folder named "ig-data", then SUSHI will generate a basic Implementation Guide project that can be built using the template-based IG Publisher. SUSHI currently supports limited customization of the IG via the following files:

  • ig-data/ig.ini: If present, the user-provided igi.ini values will be merged with SUSHI-generated ig.ini.
  • ig-data/package-list.json: If present, it will be used instead of a generated package-list.json.
  • ig-data/input/ignoreWarnings.txt: If present, will be copied into the corresponding location in the IG input folder
  • ig-data/input/images/*: If present, image files will be copied into the IG input and can be referenced by user-provided pages.
  • ig-data/input/pagecontent/index.[md|xml]: If present, it will provide the content for the IG's main page.
  • ig-data/input/pagecontent/*.[md|xml]: If present, these files will be generated as individual pages in the IG and will be present in the table of contents.
  • ig-data/input/pagecontent/{name-of-resource-file}-[intro|notes].[md|xml]: If present, these files will place content directly on the relevant resource page. Intro files will place content before the resource definition; notes files will place content after.
  • ig-data/input/pagecontent/*: If present, all other files of any type that do not match the above patterns will be copied into the IG input, but will not appear in the table of contents.
  • ig-data/input/{supported-resource-input-folder}: JSON files found in supported subfolders will be processed as additional resources in the IG, added to the IG JSON file, and copied to the corresponding locations in the IG input. This allows for a "Bring Your Own JSON" capability when you already have resources that were generated via another method. If a provided JSON file has the same URL as a FSH-defined resource, the provided JSON file will overwrite the FSH-defined one. Supported folders match those documented in the Guidance for FHIR IG Creation: capabilities, examples, extensions, models, operations, profiles, resources, vocabulary.

After running SUSHI, change to the output folder and run the _updatePublisher script and enter y|Y to download latest publisher when prompted. Then run the _genonce or _gencontinuous script. _genonce will generate the IG one time. _gencontinuous will continuously run the genonce script, which will regenerate the IG with any changes that were made to the input of the IG build.

If the input folder does not contain a sub-folder named "ig-data", then only the resources (e.g., profiles, extensions, etc.) will be generated.

Installation for Developers

SUSHI is a TypeScript project. At a minimum, SUSHI requires Node.js to build, test, and run the CLI. Developers should install Node.js 12 (LTS), although earlier LTS versions (8, 10) are also expected to work.

Once Node.js is installed, run the following command from this project's root folder:

$ npm install

NPM tasks

The following NPM tasks are useful in development:

Task Description
build compiles src/**/*.ts files to dist/**/*.js files using the TypeScript compiler (tsc)
build:watch similar to build but automatically builds when changes are detected in src files
build:grammar builds the ANTLR grammar from 'antlr/src/main/antlr' to 'src/import/generated'
test runs all unit tests using Jest
test:watch similar to test, but automatically runs affected tests when changes are detected in src files
lint checks all src files to ensure they follow project code styles and rules
lint:fix fixes lint errors when automatic fixes are available for them
prettier checks all src files to ensure they follow project formatting conventions
prettier:fix fixes prettier errors by rewriting files using project formatting conventions
check runs all the checks performed as part of ci (test, lint, prettier)

To run any of these tasks, use npm run. For example:

$ npm run check

Recommended Development Environment

For the best experience, developers should use Visual Studio Code with the following plugins:

License

Copyright 2019 Health Level Seven International

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Current Tags

  • 0.13.0-beta.2                                ...           beta (11 days ago)
  • 0.12.7                                ...           latest (16 days ago)

28 Versions

  • 0.13.0-beta.2                                ...           11 days ago
  • 0.12.7                                ...           16 days ago
  • 0.13.0-beta.1                                ...           24 days ago
  • 0.12.6                                ...           24 days ago
  • 0.12.5                                ...           a month ago
  • 0.12.4                                ...           a month ago
  • 0.12.3                                ...           a month ago
  • 0.12.2                                ...           2 months ago
  • 0.12.1                                ...           2 months ago
  • 0.12.0                                ...           2 months ago
  • 0.11.2                                ...           2 months ago
  • 0.11.1                                ...           2 months ago
  • 0.10.0                                ...           3 months ago
  • 0.9.1                                ...           4 months ago
  • 0.9.0                                ...           4 months ago
  • 0.8.0                                ...           4 months ago
  • 0.7.0                                ...           4 months ago
  • 0.6.3                                ...           4 months ago
  • 0.6.2                                ...           4 months ago
  • 0.6.1                                ...           5 months ago
  • 0.6.0                                ...           5 months ago
  • 0.5.0                                ...           5 months ago
  • 0.4.1                                ...           6 months ago
  • 0.4.0                                ...           6 months ago
  • 0.3.0                                ...           6 months ago
  • 0.2.1                                ...           7 months ago
  • 0.2.0                                ...           7 months ago
  • 0.1.0                                ...           7 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 6
Last Month 57
Dependencies (15)
Dev Dependencies (24)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |