Skip to content

aphp/prism-lang-fsh

BranchesTags

Repository files navigation

prism-lang-fsh

A Prism.js language definition plugin for FHIR Shorthand

License: MIT PRs Welcome Prism.js Compatible

📋 Overview

This project provides a comprehensive language definition plugin for Prism.js to enable syntax highlighting for FHIR Shorthand (FSH) language. FSH is a domain-specific language for defining FHIR implementation guides, profiles, extensions, and other FHIR conformance resources.

🚀 Features

  • Complete FSH v3.0.0 support - All major language constructs
  • Rich syntax highlighting - Comments, aliases, definitions, rules, codes, cardinalities, and more
  • Performance optimized - Regex patterns avoid catastrophic backtracking
  • Comprehensive token types - 15+ distinct token categories for precise highlighting
  • Multiple themes - Light, dark, and high-contrast support
  • Browser compatible - Works with all modern browsers
  • Extensive testing - 100+ test cases covering edge cases and real-world examples
  • Compatible with Prism.js 1.15+

📁 Project Structure

prism-lang-fsh/
├── src/
│   ├── prism-lang-fsh.js         # Main language definition
│   └── prism-lang-fsh.css        # Optional FSH styling
├── test/
│   ├── fixtures/                 # Test code samples
│   ├── prism-lang-fsh.test.js    # Unit tests
│   └── visual.html               # Visual testing page
├── examples/
│   └── demo.html                 # Usage examples
├── dist/                         # Built/minified files
│   ├── prism-lang-fsh.min.js
│   └── prism-lang-fsh.min.css
├── docs/
│   └── LANGUAGE_SPEC.md         # Language specification
├── .github/
│   ├── workflows/               # CI/CD pipelines
│   ├── ISSUE_TEMPLATE/
│   └── PULL_REQUEST_TEMPLATE.md
├── CONTRIBUTING.md              # Contribution guidelines
├── CLAUDE.md                    # Claude Code assistant guide
├── LICENSE                      # MIT License
├── package.json
├── .gitignore
├── .eslintrc.json
└── README.md                    # This file

🔧 Installation

Using npm

npm install prism-lang-fsh

Using CDN

<!-- Include Prism.js core -->
<script src="https://cdn.jsdelivr.net/npm/[email protected]/prism.min.js"></script>

<!-- Include the language definition -->
<script src="https://cdn.jsdelivr.net/npm/[email protected]/prism-lang-fsh.min.js"></script>

Manual Installation

  1. Download the plugin files from the dist/ directory
  2. Include them in your HTML after Prism.js core

📖 Usage

Basic Usage

<!DOCTYPE html>
<html>
  <head>
    <!-- Include Prism CSS -->
    <link
      href="https://cdn.jsdelivr.net/npm/[email protected]/themes/prism-min.css"
      rel="stylesheet"
    />
    <!-- Include FSH theme (optional) -->
    <link
      href="https://cdn.jsdelivr.net/npm/[email protected]/prism-lang-fsh.min.css"
      rel="stylesheet"
    />
  </head>
  <body>
    <pre><code class="language-fsh">
// FHIR Shorthand Profile Example
Profile: MyPatientProfile
Parent: Patient
Id: my-patient
Title: "My Patient Profile"
Description: "A custom patient profile with additional constraints"

* identifier 1..* MS
* name 1..* MS
* birthDate 1..1 MS
* gender from http://hl7.org/fhir/ValueSet/administrative-gender (required)
</code></pre>

    <!-- Include Prism core -->
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/prism.min.js"></script>
    <!-- Include FSH language definition -->
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/prism-lang-fsh.min.js"></script>

    <script>
      // Highlight all code blocks
      Prism.highlightAll();
    </script>
  </body>
</html>

Advanced Usage

// Programmatic highlighting
const fshCode = `
Alias: $sct = http://snomed.info/sct

Profile: ObservationProfile
Parent: Observation
* code from $sct (required)
* value[x] only Quantity
`;

const html = Prism.highlight(fshCode, Prism.languages.fsh, 'fsh');
document.getElementById('output').innerHTML = html;

Supported Token Types

The plugin recognizes and highlights these FSH language elements:

  • Comments: // single-line and /* multi-line */
  • Aliases: Alias: $name = url
  • Definitions: Profile:, Extension:, Instance:, ValueSet:, etc.
  • Metadata: Id:, Parent:, Title:, Description:, etc.
  • Rules: * element 1..* MS
  • Codes: #active, SCT#123456, $alias#code
  • Cardinalities: 0..1, 1..*, 0..5
  • Flags: MS, SU, ?!, D, TU, N
  • Actions: contains, only, from, obeys, insert
  • Bindings: (required), (extensible), (preferred), (example)
  • URLs: http://example.org/ValueSet/test
  • Strings: "text" and """multi-line"""
  • Identifiers: myId, us-core-patient, Patient.name.family

🧪 Development

Prerequisites

  • Node.js >= 16.0.0
  • npm >= 8.0.0
  • Git

Setup

  1. Clone the repository:
git clone https://github.com/aphp/prism-lang-fsh.git
cd prism-lang-fsh
  1. Install dependencies:
npm install
  1. Start development:
npm run dev

Available Scripts

  • npm run dev - Start development mode with watch
  • npm run build - Build production files
  • npm test - Run comprehensive test suite
  • npm run lint - Lint code
  • npm run format - Format code with Prettier
  • npm run test:visual - Open visual test page with FSH examples

Testing

Run the comprehensive test suite:

npm test

For visual testing and manual verification:

# Open the visual test page
npm run test:visual

# Or directly open in browser
open test/visual.html

The test suite includes:

  • Unit tests for all token types
  • Integration tests with real FSH files
  • Performance tests for large files
  • Edge case testing
  • Real-world FSH examples

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on:

  • Code of Conduct
  • Development workflow
  • Submitting pull requests
  • Reporting issues

🐛 Issues

Found a bug or have a feature request? Please check existing issues first, then open a new issue if needed.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Prism.js team for the excellent syntax highlighter
  • Contributors and maintainers
  • FHIR Shorthand community

📚 Resources

FHIR Shorthand

Prism.js

FHIR

🔗 Links

Token Coverage

This plugin provides comprehensive syntax highlighting for all major FSH language constructs:

Feature Support Examples
Comments ✅ Full // comment, /* block */
Aliases ✅ Full Alias: $sct = http://snomed.info/sct
Definitions ✅ Full Profile:, Extension:, ValueSet:
Metadata ✅ Full Id:, Parent:, Title:, Description:
Rules ✅ Full * element 1..* MS
Codes ✅ Full #active, SCT#123456, $sct#code
Cardinalities ✅ Full 0..1, 1..*, 0..5
Flags ✅ Full MS, SU, ?!, D, TU, N
Actions ✅ Full contains, only, from, obeys
Bindings ✅ Full (required), (extensible)
URLs ✅ Full http://example.org/path
Strings ✅ Full "text", """multi-line"""
Paths ✅ Full extension[name].value[x]
Caret Rules ✅ Full * ^status = #active
Identifiers ✅ Full myId, us-core-patient, name.family

Status: ✅ Production Ready - Full FSH v3.0.0 support with comprehensive testing

partially developped with Claude Code

About

A Prism.js language definition plugin for FHIR Shorthand

Resources

Readme

License

MIT license

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages