npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@styra/highlightjs-rego

v0.1.2

Published

Rego policy language syntax highlighting plugin for highlight.js

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

srenatussrenatusmmacxmmmacxmstyraincstyrainc

Keywords

regopolicypacpolicy as codeOPAOpen Policy Agentauthorizationpermissions

Readme

highlightjs-rego

highlight.js syntax highlighting for the Rego language of Open Policy Agent (OPA).

Screenshot

How to use

Head over to the releases page and grab the minified version of the Rego syntax definition file (rego.min.js or rego.es.min.js). Include it in your HTML file, and use the language-rego class for the <code> block you want to highlight:

<!DOCTYPE html>
<html>
<head>
  <title>Highlight.js Rego Demo</title>
  <link rel="stylesheet" href="path/to/theme.css">
  <script type="text/javascript" src="path/to/highlight.min.js"></script>
  <script type="text/javascript" src="path/to/rego.min.js"></script>
  <script type="text/javascript">hljs.highlightAll();</script>
</head>

<body>
  <pre><code class="language-rego">
# METADATA
# description: Your Rego policy here!
package policy

default allow := false

allow if {
    # ..conditions..
}
  </code></pre>
</body>

</html>

How to build

Building from source can either be done by running the build.sh script in this repository, or manually following the steps below.

  1. Clone the highlight.js repository
    git clone https://github.com/highlightjs/highlight.js.git
  2. Clone this repository
    git clone https://github.com/StyraInc/highlightjs-rego.git
  3. In the extra directory of the highlight.js repository, create a symlink to this repository
    ln -s /path/to/highlightjs-rego /path/to/highlight.js/extra/highlightjs-rego
  4. In the root of the highlight.js repository, run:
    node ./tools/build.js -t cdn
  5. You'll now find rego.min.js in the build directory

More detailed instructions for building 3rd party language support for highlight.js can be found here.

Community

For questions, discussions and announcements related to Styra products, services and open source projects, please join the Styra community on Slack!