https://github.com/cedar-policy/highlightjs-cedar

highlight.js support for Cedar policy language
https://github.com/cedar-policy/highlightjs-cedar

Last synced: 6 days ago
JSON representation

highlight.js support for Cedar policy language

• Host: GitHub
• URL: https://github.com/cedar-policy/highlightjs-cedar
• Owner: cedar-policy
• License: apache-2.0
• Created: 2023-09-19T02:26:54.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-22T02:53:25.000Z (7 months ago)
• Last Synced: 2024-08-01T09:24:30.511Z (3 months ago)
• Language: HTML
• Homepage:
• Size: 170 KB
• Stars: 1
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• cedar-awesome - Highlight.js syntax

README

        
# highlight.js support for Cedar policy language and Cedar human-readable schema

[highlight.js](https://highlightjs.org/) (syntax highlighting for the Web) support for Cedar based on [Grammar specification for Cedar policy syntax](https://docs.cedarpolicy.com/syntax-grammar.html) and for Cedar human-readable schema based on [Grammar specification for human-readable schemas](https://docs.cedarpolicy.com/schema/human-readable-schema-grammar.html). Project structure derived from [language contributor checklist](https://highlightjs.readthedocs.io/en/latest/language-contribution.html) and mapped to the [Stylable Scopes](https://highlightjs.readthedocs.io/en/latest/css-classes-reference.html).

See it in action on 

## Use

Web browser `` usage example from `test/static/index.html` (adjust the script `src` paths as required):

```html

    <script src="highlight.min.js">

    

    

      window.onload = () => {

        hljs.registerLanguage('cedar', hljsCedar);

        hljs.registerLanguage('cedarschema', hljsCedarschema);

        hljs.highlightAll();

      };

    

```

ECMAScript module `import` usage example from `test/vite/index.html` (adjust the import `from` paths as required):

```javascript

import hljs from 'highlight.js';

import { hljsCedar, hljsCedarschema } from 'hljs-cedar.mjs';

hljs.registerLanguage('cedar', hljsCedar);

hljs.registerLanguage('cedarschema', hljsCedarschema);

hljs.highlightAll();

```

## Development

### Install

Install the project dependencies using `npm install`.

`src/cedar.js` is the main source file in ECMAScript module format.

### Build

The `npm run build` script uses [esbuild](https://esbuild.github.io/api/)to create multiple files in the `dist` folder:

- `hljs-cedar.js` - Web browser `` compatible version.  Sets `window.hljsCedar` and `window.hljsCedarschema` to highlight functions.

- `hljs-cedar.min.js` - Minified web browser `<script src=>` compatible version.

- `hljs-cedar.mjs` - ECMAScript module version with default export.  Used by `test/cedar-esm.test.js` test cases and `test\vite\main.js` from Vite web app.

  - `import hljsCedar from '../dist/hljs-cedar.mjs';`

- `hljs-cedar.cjs` - CommonJS module version with default export.  Used by `test/cedar-commonjs.test.js` test cases.

  - `const hljsCedar = require('../dist/hljs-cedar.cjs').default;`

### Test

`npm run test` uses [vitest](https://vitest.dev) to syntax highlight `test/data/*.cedar` and `test/data/*.cedarschema` files and compares against a generated `.html`

[File Snapshots](https://vitest.dev/guide/snapshot.html#file-snapshots) for each Cedar and Cedar human-readable schema file.

View either the static `test/static/index.html` on your browser or `npm run dev` and `test/vite/index.html` renders in your browser:  <http://localhost:5173/>

When new `test/data/*.cedar` or `test/data/*.cedarschema` files are created, `npm run testdata` will update the contents of each `index.html` file.

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## License

This project is licensed under the Apache-2.0 License.