https://github.com/robotframework/pygmentslexer

https://github.com/robotframework/pygmentslexer

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/robotframework/pygmentslexer
• Owner: robotframework
• License: apache-2.0
• Created: 2019-01-06T17:50:46.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-14T09:54:12.000Z (about 7 years ago)
• Last Synced: 2025-07-26T00:42:46.114Z (6 months ago)
• Language: Python
• Size: 123 KB
• Stars: 6
• Watchers: 9
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
Pygments lexer for Robot Framework test data

============================================

This project implements a `Pygments `_ lexer

for `Robot Framework `_ test data in plain

text format. It is available as a separate plugin and *included in

Pygments 1.6 and newer*.

What is Pygments

----------------

Pygments_ is a generic library/tool for syntax highlighting. It is used by

many different applications and wikis.

What is Robot Framework

-----------------------

`Robot Framework`_ is a generic open source automation framework for

acceptance testing, acceptance test driven development (ATDD), and robotic

process automation (RPA). It has simple plain text syntax and this project

provides syntax highlighting for it.

Installation

------------

Installation packages are at `PyPI

`_. Installation itself

is easiest with ``pip``:

.. code:: bash

    pip install pygments

    pip install robotframeworklexer

The latter step is only needed if you want to use a newer lexer version than

the one included in Pygments.

Usage

-----

After installation Pygments will recognize ``robotframework``

lexer. It can be used, for example, with the ``pygmentize`` tool:

.. code:: bash

    # Lexer for ``*.robot`` files is found automatically.

    pygmentize tests.robot

    # Explicit lexer configuration needed with ``*.txt`` files.

    pygmentize -l robotframework tests.txt

    # Override built-in robotframework lexer with separately installed version.

    pygmentize -O robotframework=robotframework tests.robot

See `generate.py `_

script for an example of the programmatic usage. For general information about

using Pygments, consult `its documentation `_ and/or

the documentation of the tool you are using it with.

License

-------

`Apache License, Version 2.0 `_.