Quick Start

Get up and running with FSH Lint in just a few minutes.

Prerequisites

• Rust 1.80 or later (if building from source)
• OR use pre-built binaries

Step 1: Install FSH Lint

cargo install maki

Verify the installation:

maki --version

Step 2: Initialize Configuration

Create a default configuration file in your FSH project:

cd your-fsh-project
maki init

This creates maki.json with recommended settings:

{
  "$schema": "https://octofhir.github.io/maki/schema/v1.json",
  "root": true,
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  }
}

Step 3: Lint Your Files

Lint all FSH files in the current directory:

maki lint **/*.fsh

Or lint specific files:

maki lint input/fsh/profiles.fsh

Step 4: Review Diagnostics

FSH Lint will show you any issues found:

error[correctness/duplicate-definition]: Duplicate profile definition

  > 15 │ Profile: PatientProfile
       │          ^^^^^^^^^^^^^^ Profile 'PatientProfile' is already defined
    16 │ * name 1..1 MS

  i First defined at line 8

Step 5: Auto-fix Issues

Many issues can be fixed automatically:

maki lint --fix **/*.fsh

FSH Lint will apply safe fixes and report what was changed.

Step 6: Customize Rules

Edit maki.json to customize rule behavior:

{
  "linter": {
    "rules": {
      "recommended": true,
      "style": {
        "naming-convention": "error"  // Upgrade to error
      },
      "documentation": {
        "title-required": "off"  // Disable this rule
      }
    }
  }
}

Next Steps

• Configure rules to match your project’s needs
• Learn about built-in rules to understand what FSH Lint checks
• Write custom rules for project-specific validation
• Integrate with CI/CD to automate linting

Common Commands

# Lint with automatic fixes
maki lint --fix **/*.fsh

# Lint and show only errors
maki lint --severity error **/*.fsh

# List all available rules
maki rules

# Get detailed information about a specific rule
maki rules --detailed style/naming-convention

# Format FSH files
maki format **/*.fsh

# Format with automatic fixes
maki format --fix **/*.fsh

Help and Support

• Run maki --help for command-line help
• Run maki <command> --help for command-specific help
• Check the Troubleshooting Guide for common issues