Lux

0.5.0

Star

A Swift library with a dedicated command-line tool to highlight plain code (e.g. for terminal output), HTML files code blocks or attributed strings (e.g. for macOS or iOS apps)

swift-package command-line-tool color

ABridoux/lux

What's New

0.5.0

2021-02-21T21:03:46Z

Added

YAML support [#92]

Changed

FileInjectionService: Use SwiftSoup to parse the HTML file

Fixed

Zsh +option was not parsed properly [#91]
Zsh '&' keyword was not parsed

Note

The FileInjectionService now uses SwiftSoup and there is an issue with newlines being added when the code is Plist or XML. While this is being resolved, it's still possible to use the command-line tool to highlight a block of code with those formats.

Swift package

Install

Lux

A Swift library with a dedicated command-line tool to colorise plain code (e.g. for terminal output), HTML files code blocks or attributed strings (e.g. for macOS or iOS apps).

Currently supported languages:

Zsh/Bash
Swift (with Splash)
Xml
Xml enhanced (better visualisation of the tags)
Plist
Json
Yaml

Currently offered themes:

Dracula
Xcode light (default)
Xcode dark

Themes to be added:

[] Obsidian
[] Tomorrow

You can ask for a language support or a theme by opening an issue. You can also implement a language support if you prefer. The following screenshots show the different usages of Lux.

Plist in macOS app

iOS app with an enhanced XML format

Octory (new) wiki sample

Swift in the terminal

Zsh on iPad. A script from Scripting OSX to notarise a command-line tool.

Zsh in the terminal

Quick example

With the following Plist file

<key>properties</key>
<dict>
    <key>Type</key>
    <string>Input</string>
    <key>InputType</key>
    <string>List</string>
    <key>IsAllowed</key>
    <true/>
</dict>

Here is how the library could inject terminal colors:

\033[38;5;8m<key>\033[39m\033[38;5;161mproperties\033[39m\033[38;5;8m</key>\033[39m
\033[38;5;8m<dict>\033[39m
	\033[38;5;8m<key>\033[39m\033[38;5;161mType\033[39m\033[38;5;8m</key>\033[39m
	\033[38;5;8m<string>\033[39m\033[39mInput\033[39m\033[38;5;8m</string>\033[39m
	\033[38;5;8m<key>\033[39m\033[38;5;161mInputType\033[39m\033[38;5;8m</key>\033[39m
	\033[38;5;8m<string>\033[39m\033[39mList\033[39m\033[38;5;8m</string>\033[39m\
	\033[38;5;8m<key>\033[39m\033[38;5;161mIsAllowed\033[39m\033[38;5;8m</key>\033[39m
\033[38;5;8m<true/>\033[39m\n\033[38;5;8m</dict>\033[39m"

Or Css classes:

<span class="plist-tag">&lt;key&gt;</span><span class="plist-key-name">properties</span><span class="plist-tag">&lt;/key&gt;</span>
<span class="plist-tag">&lt;dict&gt;</span>
    <span class="plist-tag">&lt;key&gt;</span><span class="plist-key-name">Type</span><span class="plist-tag">&lt;/key&gt;</span>
    <span class="plist-tag">&lt;string&gt;</span><span class="plist-key-value">Input</span><span class="plist-tag">&lt;/string&gt;</span>
    <span class="plist-tag">&lt;key&gt;</span><span class="plist-key-name">InputType</span><span class="plist-tag">&lt;/key&gt;</span>
    <span class="plist-tag">&lt;string&gt;</span><span class="plist-key-value">List</span><span class="plist-tag">&lt;/string&gt;</span>
    <span class="plist-tag">&lt;key&gt;</span><span class="plist-key-name">IsAllowed</span><span class="plist-tag">&lt;/key&gt;</span>
    <span class="plist-tag">&lt;true/&gt;</span>
<span class="plist-tag">&lt;/dict&gt;</span>

You can then customise those classes in your CSS file. This wiki page describes each format CSS classes.

Note: For HTML text, the library will take a HTML string as input. In HTML, & is specified with &, chevrons are written with < for < and > for >. Thus, when using a HTML injector, you can call its function escapingHTML() if you give it plain text as input. Otherwise, nothing has to be done when the input is already HTML encoded.

For the command line tool inject command, the default behavior is to replace those special characters before injecting colors. You can change this behavior with the --no-escape-html flag if you already have a HTML-encoded string as input. To escape those characters, Lux uses the following extension.

How to install it

Homebrew

Use the following command.

brew install ABridoux/formulae/lux

It will download the notarized executable from the latest release.

Download

You can download the latest version of the executable from the releases. Note that the executable is notarized. Also, a notarized lux package is provided.

After having unzipped the file, you can install it if you want to:

install lux /usr/local/bin/

Here is a command which downloads the latest version of the program and install it in /usr/local/bin. Run it to download and install the latest version of the program. It erases the current version you may have.

curl -LO https://github.com/ABridoux/lux/releases/latest/download/lux.zip && \
unzip lux.zip && \
rm lux.zip && \
install lux /usr/local/bin && \
rm lux

Lux 0.4.3 and later are compatible with Linux. You can download the tar archive "lux-linux" in the releases. In case you got an error regarding "libswiftCore.so" when executing the binary, you can checkout this solution.

Note

To find all lux versions, please browse the releases page.
When deploying a package (with a MDM for example), it might be useful to add the version to the name. To get lux latest version: simply run lux version to get your installed lux version. Also, if you are using scout, you can run curl --silent "https://api.github.com/repos/ABridoux/lux/releases/latest" | scout tag_name to get the latest version available on the Github repository.

Swift package

Start by importing the package in your file Packages.swift.

let package = Package (
    ...
    dependencies: [
        .package(url: "https://github.com/ABridoux/lux", from: "0.1.0")
    ],
    ...
)

You can then import Lux in a file.

How to use it

Command-line

Swift package

Special thanks

Thanks to all the contributors of Lux, especially to Damien Rivet who makes code reviews when he has the time. Also, many thanks to the team behind swift-argument-parser who keeps doing an incredible work. Also, many thanks to John Sundell for his several articles regarding an API development, and for the Splash library as well as all its contributors.

Acknowlegdments

Font used for the logo: Flashlight by Bexxtype]

Contributing

Report a bug

Lux aims to be community project, and anyone is welcome to contribute. As it is still a young project, some bugs may appear, or some text not colorised correctly. If you encounter such problem, please open a issue to describe it and try to add a use case to reproduce the bug. Hopefully, it should be resolved in the following release.

Add a new language or theme

You can read here how to add a new language to Lux. A wiki page explaining theming will be available soon.

Miscellaneous

Colorize terminal with Swift to colorise the output in the terminal.
Terminal colors list
Encode code block to HTML

Description

Swift Tools 5.1.0

Description

{
  "name": "Lux",
  "path": "/usr/src/package",
  "targets": [
    {
      "name": "LuxTests",
      "path": "Tests/LuxTests",
      "type": "test",
      "c99name": "LuxTests",
      "sources": [
        "Extensions/StringProtocol+Extensions.swift",
        "Extensions/URL+Extensions.swift",
        "Extensions/XCTestCase+Extensions.swift",
        "FileInjectionTest.swift",
        "Formats/JsonInjectorTests.swift",
        "Formats/PlistInjectorTests.swift",
        "Formats/XMLEnhancedInjectorTests.swift",
        "Formats/XmlInjectorTests.swift",
        "Formats/ZshInjectorTests.swift",
        "Formats/ZshTestDelegate.swift",
        "InjectorTests.swift",
        "XCTestManifests.swift"
      ],
      "module_type": "SwiftTarget",
      "target_dependencies": [
        "Lux"
      ]
    },
    {
      "name": "LuxCLT",
      "path": "Sources/LuxCLT",
      "type": "executable",
      "c99name": "LuxCLT",
      "sources": [
        "CSSCommand.swift",
        "Extensions/ColorTheme+Extensions.swift",
        "Extensions/String+Extensions.swift",
        "Extensions/TypeText+Extensions.swift",
        "Format.swift",
        "InjectCommand.swift",
        "RuntimeError.swift",
        "VersionCommand.swift",
        "main.swift"
      ],
      "module_type": "SwiftTarget",
      "product_memberships": [
        "LuxCLT"
      ],
      "target_dependencies": [
        "Lux"
      ],
      "product_dependencies": [
        "ArgumentParser"
      ]
    },
    {
      "name": "Lux",
      "path": "Sources/Lux",
      "type": "library",
      "c99name": "Lux",
      "sources": [
        "Constants/DataFormat.swift",
        "Constants/Version.swift",
        "Extensions/Bool+KeyPath.swift",
        "Extensions/NSRegularExpression+Extensions.swift",
        "Extensions/String+Extensions.swift",
        "Extensions/StringProtocol+Extensions.swift",
        "Injection/AttributedInjector.swift",
        "Injection/BaseInjector.swift",
        "Injection/FileInjectionService.swift",
        "Injection/InjectionService.swift",
        "Injection/InjectorDelegate.swift",
        "Injection/TextInjector.swift",
        "InjectorImplementations/Json/JSONCategory.swift",
        "InjectorImplementations/Json/JSONDelegate.swift",
        "InjectorImplementations/Json/JSONInjector.swift",
        "InjectorImplementations/Plist/PlistCategory.swift",
        "InjectorImplementations/Plist/PlistDelegate.swift",
        "InjectorImplementations/Plist/PlistInjector.swift",
        "InjectorImplementations/Swift/HTMLCustomCSSOutputFormat.swift",
        "InjectorImplementations/Swift/SwiftCategory.swift",
        "InjectorImplementations/Swift/SwiftDelegate.swift",
        "InjectorImplementations/Swift/SwiftInjector.swift",
        "InjectorImplementations/Swift/TerminalOutputFormat.swift",
        "InjectorImplementations/Swift/TokenType+SwiftCategory.swift",
        "InjectorImplementations/XMLEnhanced/XMLEnhancedCategory.swift",
        "InjectorImplementations/XMLEnhanced/XMLEnhancedDelegate.swift",
        "InjectorImplementations/XMLEnhanced/XMLEnhancedInjector.swift",
        "InjectorImplementations/Xml/XMLCategory.swift",
        "InjectorImplementations/Xml/XMLDelegate.swift",
        "InjectorImplementations/Xml/XMLInjector.swift",
        "InjectorImplementations/Yaml/YAMLCategory.swift",
        "InjectorImplementations/Yaml/YAMLDelegate.swift",
        "InjectorImplementations/Yaml/YAMLInjector.swift",
        "InjectorImplementations/Zsh/ZshCategory.swift",
        "InjectorImplementations/Zsh/ZshDelegate.swift",
        "InjectorImplementations/Zsh/ZshInjector.swift",
        "Models/Appendable.swift",
        "Models/AttributedString.swift",
        "Models/CSSClass.swift",
        "Models/Category.swift",
        "Models/Color.swift",
        "Models/InjectionType.swift",
        "Models/InjectorType.swift",
        "Models/RegexPattern.swift",
        "Models/TerminalModifier.swift",
        "Models/TextType.swift",
        "Themes/ColorTheme.swift",
        "Themes/Dracula/DraculaPalette.swift",
        "Themes/Dracula/DraculaThemeInjectorDelegate.swift",
        "Themes/Dracula/JSONDracula.swift",
        "Themes/Dracula/PlistDracula.swift",
        "Themes/Dracula/SwiftDracula.swift",
        "Themes/Dracula/XMLEnhancedDracula.swift",
        "Themes/Dracula/XmlDracula.swift",
        "Themes/Dracula/YAMLDracula.swift",
        "Themes/Dracula/ZshDracula.swift",
        "Themes/ThemeInjectorDelegate.swift",
        "Themes/Xcode Dark/JSONXcodeDarkDelegate.swift",
        "Themes/Xcode Dark/PlistXcodeDarkDelegate.swift",
        "Themes/Xcode Dark/SwiftXcodeDarkDelegate.swift",
        "Themes/Xcode Dark/XMLEnhancedXcodeDarkDelegate.swift",
        "Themes/Xcode Dark/XcodeDarkPalette.swift",
        "Themes/Xcode Dark/XcodeDarkThemeInjectorDelegate.swift",
        "Themes/Xcode Dark/XmlXcodeDarkDelegate.swift",
        "Themes/Xcode Dark/YAMLXcodeDarkDelegate.swift",
        "Themes/Xcode Dark/ZshXcodeDarkDelegate.swift",
        "Themes/Xcode Light/JSONXcodeDefaultDelegate.swift",
        "Themes/Xcode Light/PlistXcodeDefaultDelegate.swift",
        "Themes/Xcode Light/SwiftXcodeDefaultDelegate.swift",
        "Themes/Xcode Light/XcodeLightPalette.swift",
        "Themes/Xcode Light/XcodeLightThemeInjectorDelegate.swift",
        "Themes/Xcode Light/XmlEnhancedXcodeDefaultDelegate.swift",
        "Themes/Xcode Light/XmlXcodeDefaultDelegate.swift",
        "Themes/Xcode Light/YAMLXcodeDefaultLightDelegate.swift",
        "Themes/Xcode Light/ZshXcodeLightDelegate.swift"
      ],
      "module_type": "SwiftTarget",
      "product_memberships": [
        "Lux",
        "LuxCLT"
      ],
      "product_dependencies": [
        "Splash",
        "SwiftSoup"
      ]
    }
  ],
  "products": [
    {
      "name": "Lux",
      "type": {
        "library": [
          "automatic"
        ]
      },
      "targets": [
        "Lux"
      ]
    },
    {
      "name": "LuxCLT",
      "type": {
        "executable": null
      },
      "targets": [
        "LuxCLT"
      ]
    }
  ],
  "platforms": [
    {
      "name": "macos",
      "version": "10.13"
    },
    {
      "name": "ios",
      "version": "10.0"
    }
  ],
  "dependencies": [
    {
      "url": "https://github.com/apple/swift-argument-parser",
      "type": "sourceControl",
      "identity": "swift-argument-parser",
      "requirement": {
        "range": [
          {
            "lower_bound": "0.0.1",
            "upper_bound": "1.0.0"
          }
        ]
      }
    },
    {
      "url": "https://github.com/scinfu/SwiftSoup.git",
      "type": "sourceControl",
      "identity": "swiftsoup",
      "requirement": {
        "range": [
          {
            "lower_bound": "1.7.4",
            "upper_bound": "2.0.0"
          }
        ]
      }
    },
    {
      "url": "https://github.com/JohnSundell/Splash",
      "type": "sourceControl",
      "identity": "splash",
      "requirement": {
        "range": [
          {
            "lower_bound": "0.15.0",
            "upper_bound": "1.0.0"
          }
        ]
      }
    }
  ],
  "tools_version": "5.1",
  "manifest_display_name": "Lux"
}

View More Packages from this Author

Package Dump

{
  "name": "Lux",
  "targets": [
    {
      "name": "Lux",
      "type": "regular",
      "exclude": [],
      "settings": [],
      "resources": [],
      "dependencies": [
        {
          "byName": [
            "Splash",
            null
          ]
        },
        {
          "byName": [
            "SwiftSoup",
            null
          ]
        }
      ],
      "packageAccess": false
    },
    {
      "name": "LuxCLT",
      "type": "regular",
      "exclude": [],
      "settings": [],
      "resources": [],
      "dependencies": [
        {
          "byName": [
            "Lux",
            null
          ]
        },
        {
          "byName": [
            "ArgumentParser",
            null
          ]
        }
      ],
      "packageAccess": false
    },
    {
      "name": "LuxTests",
      "type": "test",
      "exclude": [],
      "settings": [],
      "resources": [],
      "dependencies": [
        {
          "byName": [
            "Lux",
            null
          ]
        }
      ],
      "packageAccess": false
    }
  ],
  "products": [
    {
      "name": "Lux",
      "type": {
        "library": [
          "automatic"
        ]
      },
      "targets": [
        "Lux"
      ]
    },
    {
      "name": "LuxCLT",
      "type": {
        "executable": null
      },
      "targets": [
        "LuxCLT"
      ]
    }
  ],
  "pkgConfig": null,
  "platforms": [
    {
      "options": [],
      "version": "10.13",
      "platformName": "macos"
    },
    {
      "options": [],
      "version": "10.0",
      "platformName": "ios"
    }
  ],
  "providers": null,
  "packageKind": {
    "root": [
      "/usr/src/package"
    ]
  },
  "dependencies": [
    {
      "sourceControl": [
        {
          "identity": "swift-argument-parser",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/apple/swift-argument-parser"
              }
            ]
          },
          "requirement": {
            "range": [
              {
                "lowerBound": "0.0.1",
                "upperBound": "1.0.0"
              }
            ]
          },
          "productFilter": null
        }
      ]
    },
    {
      "sourceControl": [
        {
          "identity": "swiftsoup",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/scinfu/SwiftSoup.git"
              }
            ]
          },
          "requirement": {
            "range": [
              {
                "lowerBound": "1.7.4",
                "upperBound": "2.0.0"
              }
            ]
          },
          "productFilter": null
        }
      ]
    },
    {
      "sourceControl": [
        {
          "identity": "splash",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/JohnSundell/Splash"
              }
            ]
          },
          "requirement": {
            "range": [
              {
                "lowerBound": "0.15.0",
                "upperBound": "1.0.0"
              }
            ]
          },
          "productFilter": null
        }
      ]
    }
  ],
  "toolsVersion": {
    "_version": "5.1.0"
  },
  "cLanguageStandard": null,
  "cxxLanguageStandard": null,
  "swiftLanguageVersions": null
}

Dependencies

swift-argument-parser0.3.2
SwiftSoup1.7.5
Splash0.15.0

Dependencies

{
  "url": "/usr/src/package",
  "name": "Lux",
  "path": "/usr/src/package",
  "version": "unspecified",
  "identity": "package",
  "dependencies": [
    {
      "url": "https://github.com/apple/swift-argument-parser",
      "name": "swift-argument-parser",
      "path": "/usr/src/package/.build/checkouts/swift-argument-parser",
      "version": "0.3.2",
      "identity": "swift-argument-parser",
      "dependencies": []
    },
    {
      "url": "https://github.com/scinfu/SwiftSoup.git",
      "name": "SwiftSoup",
      "path": "/usr/src/package/.build/checkouts/SwiftSoup",
      "version": "1.7.5",
      "identity": "swiftsoup",
      "dependencies": []
    },
    {
      "url": "https://github.com/JohnSundell/Splash",
      "name": "Splash",
      "path": "/usr/src/package/.build/checkouts/Splash",
      "version": "0.15.0",
      "identity": "splash",
      "dependencies": []
    }
  ]
}

Last updated: Sat Oct 19 2024 08:53:36 GMT-0900 (Hawaii-Aleutian Daylight Time)