⚠️ THIS IS AN EXPERIMENTAL BETA RECOMMENDED FOR ESTABLISHED USERS ONLY ⚠️
SUSHI 0.13.0-beta.1 adds a new approach to configuring SUSHI. Details below:
Configuring SUSHI with config.yaml
In the current non-beta release of SUSHI, the following files are used for configuration package.json, ig-data/ig.ini, and ig-data/package-list.json. Additionally, there is no way for the user to give custom configuration that would go into the ImplementationGuide resource representing the IG. This release replaces the current system with a single config.yaml file that can be used to give custom configuration for the ImplementationGuide resource.
This config.yaml file is loosely based on the ImplementationGuide resource, but also allows for defining other necessary aspects of files like ig.ini or package-list.json. There is a detailed breakdown of the contents and usage of config.yaml in the beta version of the FSH documentation.
NOTE: To make the transition to config.yaml easier for users with existing FSH projects, we have added functionality to generate a config.yaml based on the existing configuration files in your project. This happens automatically when SUSHI 0.13.0-beta.1 runs on a FSH project with old configuration files and no config.yaml. You will notice a config.yaml file gets added to your FSH project input, and should double check this file for accuracy against your current configuration. Once the config.yaml is generated, SUSHI will use that file for configuration on future runs.
NOTE: As stated in the warning above, this is an experimental beta, and the approach taken here is subject to change based on user feedback. New users of SUSHI are best off using the most recent non-beta version of SUSHI.
Install or Update
To install or update to the beta version, run the following command:
$ npm install -g fsh-sushi@beta