fshlint is a simple CLI tool that lints FSH (FHIR Shorthand) files without compilation, leveraging the ANTLR language
recognizer. Unlike SUSHI, which compiles FSH files into FHIR artifacts, fshlint checks .fsh files for syntax issues,
making it ideal for quick validations in CI pipelines or project Makefiles.
Ensure you have Go 1.18 >= installed on your machine.
You can install the binary directly using go install. Follow these steps:
Set the environment variable for the Go path:
export GOPATH=$(go env GOPATH)Install the binary:
go install github.com/devpies/fshlint@latestThis command will download the package, compile it, and place the binary in your $GOPATH/bin.
Ensure $GOPATH/bin is in your $PATH:
export PATH=$PATH:$GOPATH/binYou can add this line to your shell configuration file (e.g., ~/.bashrc, ~/.zshrc) to make it persistent:
echo 'export PATH=$PATH:$GOPATH/bin' >> ~/.bashrc
source ~/.bashrcYou can also install fshlint by cloning the repository and building it from source. Follow these steps:
git clone https://github.com/devpies/fshlint
cd fshlint
go build -o fshlint fshlint.go
sudo mv fshlint /usr/local/bin/fshlintRun fshlint in a directory containing FSH files to check for syntax and semantic errors.
$ fshlint path/to/files
path/to/files/PatientProfile.fsh:3:7: extraneous input '0..0l' expecting {<EOF>, KW_ALIAS, KW_PROFILE, KW_EXTENSION, KW_INSTANCE, KW_INVARIANT, KW_VALUESET, KW_CODESYSTEM, KW_RULESET, KW_MAPPING, KW_LOGICAL, KW_RESOURCE}
* name 0..0l
^Display help text.
$ fshlint -h
Usage: fshlint <path-to-fsh-file-or-directory>
Options:
--help, -h Show this help messageTo contribute, please create an issue or pull request. For common development tasks, utilize the project's Makefile.
make install
make generate
make test
make buildThis project is licensed under the MIT License. See the LICENSE file for details.