Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Expressif.LanguageServer

Logo

Transform your structured YAML, JSON, XML, CSV or FrontMatter data into beautiful, fully-customized HTML pages or plain text in seconds with Expressif.LanguageServer. This command-line tool seamlessly generates renders from data files using your preferred templates through Scriban, Handlebars, DotLiquid, Fluid, StringTemplate or SmartFormat. Whether you're building static sites, documentation, or reporting tools, Expressif.LanguageServer makes it easy to turn raw data into polished, web-ready content.

About | Installing | Quickstart

About

Social media: website twitter badge

Releases: GitHub releases GitHub Release Date licence badge

Dev. activity: GitHub last commit Still maintained GitHub commit activity

Continuous integration builds: Build CodeFactor codecov

Status: stars badge Bugs badge Top language

Installing

Install from GitHub Releases

Step 1: Download the ZIP from the GitHub Release

  1. Navigate to the GitHub repository of the project.
  2. Go to the Releases section, usually found under the "Code" tab.
  3. Download the .zip file containing the executable from the desired release.

Example:

https://github.com/Seddryck/Expressif.LanguageServer/releases/latest/

Step 2: Extract the ZIP File

  1. Right-click the downloaded .zip file and choose Extract All.
  2. Extract the contents to a directory of your choice, such as C:\Program Files\Expressif.LanguageServer.

Tip: Choose a path that is easy to remember and doesn't contain special characters.

Step 3: Add the Executable to the System PATH

To run the executable from any location in the command line, you need to add its folder to your system's PATH.

  1. Open the Start Menu and search for Environment Variables.
  2. Click Edit the system environment variables.
  3. In the System Properties window, click Environment Variables.
  4. In the System Variables section, scroll down, select Path, and click Edit.
  5. In the Edit Environment Variable dialog, click New and enter the path to your extracted folder, e.g., C:\Program Files\Expressif.LanguageServer.
  6. Click OK to close all windows.

Step 4: Verify Installation

  1. Open Command Prompt (CMD).
  2. Type Expressif-LanguageServer.exe and hit Enter.
  3. If everything is set up correctly, the program should run.

QuickStart

Expressif.LanguageServer is a command-line tool designed for generating files based on templating. It supports YAML, JSON, and XML as source data formats and provides flexibility in templating through both Scriban, Liquid, Handlebars, StringTemplate and SmartFormat templates languages. With Expressif.LanguageServer, you can easily automate file generation by combining structured data from YAML, JSON, or XML files with customizable templates using Scriban or Liquid.

Supported Data Formats:

  • YAML: Files with the .yaml or .yml extension are parsed using a YAML source parser.
  • JSON: Files with the .json extension are parsed using a JSON source parser.
  • XML: Files with the .xml extension are parsed using an XML source parser.
  • CSV: Files with the .csv extension are parsed using an CSV source parser. The CSV dialect can be described using the -P option (see below).
  • FrontMatterMarkdown: Files with the .md extension are parsed using an YAML parser for the FrontMatter and the Markdown content is added in the entry content.
  • FrontMatter: using an YAML parser for the FrontMatter, the Markdown content is not appended to the result.

Supported Templating Engines:

Expressif.LanguageServer utilizes some templating engines, which allow for powerful and flexible templating.

  • Scriban: Templates with the .scriban extension are parsed using a Scriban template engine. Scriban is a lightweight and fast template engine with rich support for multiple output formats.
    • Highly performant, designed to handle large-scale template processing.
    • Supports customizable scripting with rich expressions and filters.
    • Can work with JSON and YAML data sources.
    • Typical Use Case: Config file generation, reports, email templates, or any templating scenario not tied to a specific web framework.
  • Liquid: Templates with the .liquid extension are parsed using a dotLiquid template engine. DotLiquid is a .NET port of the Liquid templating engine used by platforms like Shopify.
    • Secure (no access to system objects), making it ideal for user-generated templates.
    • Allows both dynamic and static templating.
    • Supports filters, tags, and various control flow structures.
    • Typical Use Case: SaaS applications, dynamic content rendering, email templates.
  • Handlebars: Templates with the .hbs extension are parsed using a Handlebars template engine. Handlebars C# port of the popular JavaScript Handlebars templating engine.
    • Simple syntax for generating HTML or text files from templates.
    • Support for helpers, partial templates, and block helpers.
    • Good separation of logic from presentation.
    • Typical Use Case: Email templates, reports, and content generation.
  • SmartFormat: Templates with the .smart extension are parsed using a SmartFormat template engine. SmartFormat.Net is a A lightweight templating engine primarily used for string formatting.
    • Provides more advanced formatting capabilities than standard string formatting in C#.
    • Supports nested templates, conditional formatting, and more.
    • Typical Use Case: Log messages, report generation, and dynamic text formatting.
  • StringTemplate: Templates with the .st and .stg extension are parsed using the StringTemplate engine. StringTemplate is a powerful template engine specifically designed to enforce strict separation of logic from presentation.
    • Focused on generating structured text, such as code, XML, and reports.
    • Strong emphasis on enforcing Model-View separation.
    • Supports conditionals, loops, and automatic escaping to prevent security issues.
    • Typical Use Case: Code generation, configuration files, and situations where strict separation between logic and template is required.

Command Usage:

The command to run Expressif.LanguageServer is simply expressif.LanguageServer. When executing it, you need to provide three required arguments:

  • -t, --template (required): Specifies the path to the Scriban, Liquid, Handlebars, StringTemplate or SmartFormat template file.
  • -s, --source: Specifies the path to the source data file, which can be in YAML, JSON, or XML format. If this argument is not provided, the data will be read from the console input. In such cases, the -r, --parser option becomes mandatory.
  • -o, --output: Specifies the path to the output file where the generated content will be saved. If not provided, the output will be displayed directly in the console.

Example:

expressif.LanguageServer -t template.scriban -s data.yaml -o page.html

In this example:

  • template.scriban is the Scriban template file.
  • data.yaml is the source file containing the structured data in YAML format.
  • page.html is the output file that will contain the generated content.

List of options

Template option

  • Shortcut: -t
  • Long: --template
  • Description: Specifies the path to the template file.
  • Accept: single value.
  • Mandatory: yes.
  • Example: -t path/to/template or --template=path/to/template

Engine option

  • Shortcut: -e
  • Long: --engine
  • Description: Specifies the template engine to use (scriban, fluid, dotliquid, handlebars, smartformat, stringtemplate).
  • Accept: single value. When omitted Expressif.LanguageServer will select the engine based on the extension of the template file.
  • Example: -e fluid or --engine=fluid

Engine files' extension association option

  • Shortcut: -x
  • Long: --engine-extension
  • Description: Specifies additional or replacing association between a file extension and an engine for automatic detection
  • Accept: multiple key-value pairs.
  • Mandatory: no.
  • Example: -x txt:handlebars;liquid:fluid or --engine-extension=.txt:handlebars;liquid:fluid

Source option

  • Shortcut: -s
  • Long: --source
  • Accept: single value or multiple key-value pairs.
  • Description:
    • if single value is provided, it specifies the path to the source file. If omitted, input can be taken from StdIn.
    • if multiple key-value pairs are provided, each of them specifies a part of the model and the key representing the tag in the model.
  • Exclusive: can't be set with the parameter --StdIn
  • Example: -s path/to/source or --source=path/to/source or --source=foo:path/to/source1;bar:path/to/source1

Parser option

  • Shortcut: -r
  • Long: --parser
  • Description: Specifies the parser to use (YAML, JSON, XML).
  • Accept: single value.
  • Mandatory: no expect if --stdin is specified. When omitted Expressif.LanguageServer will select the parser based on the extension of the source file
  • Example: -r YAML or --parser=YAML

Parser files' extension association option

  • Shortcut: -X
  • Long: --parser-extension
  • Description: Specifies additional or replacing association between a file extension and a parser for automatic detection
  • Accept: multiple key-value pairs.
  • Mandatory: no.
  • Example: -X txt:yaml;dat:json or --parser-extension=txt:yaml;dat:json

Parser's parameter option

  • Shortcut: -P
  • Long: --parser-parameter
  • Description: Specifies parameters tuning the behavior of the parser
  • Accept: multiple key-value pairs, prefixed by the file's extension followed by an arobas (@).
  • Mandatory: no.
  • Example: -P csv@delimiter=^;csv@commentChar=#

StdIn option

  • Shortcut: -i
  • Long: --stdin
  • Description: Specifies the input to the source data as coming from the StdIn.
  • Accept: switch value.
  • Exclusive: can't be set to true with the parameter --source and must specified to false when --source is not provided.
  • Example: -i or --stdin or --stdin false

Output option

  • Shortcut: -o
  • Long: --output
  • Description: Specifies the path to the generated output file. If omitted, output is rendered to StdOut.
  • Accept: single value.
  • Mandatory: no.
  • Example: -o path/to/output or --output=path/to/output

Example:

With a source file:
expressif.LanguageServer -t template.scriban -s data.yaml -o page.html

In this example:

  • template.scriban is the Scriban template file.
  • data.yaml is the source file containing the structured data in YAML format.
  • page.html is the output file that will contain the generated content.
With data from the console:

CMD:

type "data.json" | expressif.LanguageServer --stdin -t template.hbs -r json

PowerShell:

Get-Content data.json | expressif.LanguageServer --stdin -t template.hbs -r json

Bash:

cat data.json | expressif.LanguageServer --stdin -t template.hbs -r json

In this example:

  • The input data is coming from the console
  • template.hbs is the Handlebars template file.
  • json is the parser of input data.
  • the output is redirected to the console.

Make sure that the template file and source file are correctly formatted and aligned with your data model to produce the desired result.

About

Language Server Protocol implementation for Expressif, providing editor features such as diagnostics, completion, hover information, and navigation based on Expressif.Syntax.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages