Emmet-Pascal

From Free Pascal wiki

Emmet engine for Delphi and Free Pascal

Emmet is mostly used by web-developers to simplify and speed up editing. Emmet can take an abbreviation and expand it into a structured code block. Standard Emmet is written in JavaScript and available in many text editors or web development tools. Emmet for Delphi and Free Pascal is written from scratch in Delphi and is used in RJ TextEd and CudaText.

Cheat sheets:

Usage

First you need to create an Emmet object.

FEmmet := TEmmet.Create(snippetsPath, loremPath);
  • snippetsPath: The file path to Snippets.ini e.g. "c:\foo\Snipptes.ini"
  • loremPath: The file path to Lorem.txt e.g. "c:\foo\Lorem.txt"

To expand an abbreviation, use

sExpanded := FEmmet.ExpandAbbreviation(sAbbr, sSyntax, sSelText, sSection, bMultiCursorTabs);

Parameters:

  • sAbbr: Abbreviation e.g. "ul>li*5"
  • sSyntax: Code language in lowercase e.g. "html". Available values are: html, css, xsl, svg, xml, jsx, less, sass, scss.
  • sSelText: Text is used to wrap with abbreviation
  • sSection: Gets the section used in snippets.ini e.g. "html"
  • bMultiCursorTabs: Gets True if cursor positions in expanded string should be handled as multi cursor positions

Result: sExpanded is the resulting expanded code. It may contain cursor | positions or selected tab ${1:charset} positions.

Wrap with abbreviation

To use this feature, use parameter sSelText. E.g. if you call ExpandAbbreviation() with:

  • sAbbrev: ul>li*
  • sSelText:
Line 1
Line 2
Line 3
Line 4

You get the result

<ul>
  <li>Line 1</li>
  <li>Line 2</li>
  <li>Line 3</li>
  <li>Line 4</li>
</ul>

Filters

TEmmet can handle some filters. A filter is added at the end of the abbreviation using a pipe |. E.g.

ul>li*|t
  • c - Comment important tags (containing class or id attributes).
  • e - Escape XML-unsafe characters: <, > and &.
  • s - Single line. Expand everything to a single line of code.
  • t - Trim line markers from wrapped lines e.g. "* ", "- " or "1."
  • w - Wordwrap selected or lorem generated text. Default width is 80.
  • w<x> - Wordwrap at column x. E.g. |w120 will wrap lines at column 120.

Example:

        sAbbrev = ul>li*|t
    
        sSelText =
          * Line 1
          * Line 2
    
        Result =
          <ul>
            <li>Line 1</li>
            <li>Line 2</li>
          </ul>

Options

Several options exist in a record "TExpandOptions" that can be passed to the expand function. Options are:

  • AddSlashToEmptyTags: Boolean; // Add a slash to empty tags e.g. <img src="" />
  • AlwaysAddNewLine: Boolean; // Always add linefeed after each tag (usually used in XML)
  • CommentTags: Boolean; // Comment important tags (containing class or id attributes).
  • IndentChilds: Boolean; // Indent child tags. If you set this to false - no indention will be used.
  • SingleLine: Boolean // Expand everything to a single line of code.
  • TabSize: Integer; // Tab size in characters. This is only used with wordwrap.
  • TrimLineMarkers: Boolean; // Trim line markers from wrapped lines e.g. "* ", "- " or "1."
  • Wordwrap: Boolean; // Word wrap selected or lorem generated text.
  • WordwrapAt: Integer; // Wrap at given column. The nearest space or symbol will be used as wrap position.

Use the overloaded version of ExpandAbbreviation to set these options.

var
  rOptions: TExpandOptions;
begin
  rOptions.Wordwrap := True;
  rOptions.AddSlashToEmptyTags := False;
  sExpanded := FEmmet.ExpandAbbreviation(sAbbr, sSyntax, sSelText, sSection, bMultiCursorTabs, rOptions);

Download

GitHub: https://github.com/Alexey-T/Emmet-Pascal

Authors

  • Rickard Johansson - Emmet.pas
  • Alexey Torgashin - Misc files and demos