KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

compiler

★ 69 Open GitHub ↗

Riot.js compiler

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Compiler logo](https://raw.githubusercontent.com/riot/branding/main/compiler/compiler-horizontal.svg)](https://github.com/riot/compiler/)

[![Build Status][ci-image]][ci-url]
[![Issue Count][qlty-image]][qlty-url]
[![Coverage Status][coverage-image]][coverage-url]
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![MIT License][license-image]][license-url]

## Important

This compiler will not work with older Riot.js versions.
It's designed to work with Riot.js > 4.0.0.
For Riot.js < 4.0.0 please check the [v3](https://github.com/riot/compiler/tree/v3) branch

## Installation

```
npm i @riotjs/compiler -D
```

## Usage

The riot compiler can compile only strings:

```js
import { compile } from '@riotjs/compiler'

const { code, map } = compile('<p>{hello}</p>')
```

You can compile your tags also using the new `registerPreprocessor` and `registerPostprocessor` APIs for example:

```js
import {
  compiler,
  registerPreprocessor,
  registerPostprocessor,
} from '@riotjs/compiler'
import pug from 'pug'
import * as babel from '@babel/core'

// process your tag template before it will be compiled
registerPreprocessor('template', 'pug', function (code, { options }) {
  const { file } = options
  console.log('your file path is:', file)

return {
    code: pug.render(code),
    // no sourcemap here
    map: null,
  }
})

// your compiler output will pass from here
registerPostprocessor(function (code, { options }) {
  const { file } = options
  console.log('your file path is:', file)

// notice that babel.transformSync returns {code, map}
  return babel.transformSync(code)
})

const { code, map } = compile('<p>{hello}</p>', {
  // specify the template preprocessor
  template: 'pug',
})
```

## API

### compile(string, options)

#### @returns `{ code, map }` output that can be used by Riot.js

- _string_: is your tag source code
- _options_: the options should contain the `file` key identifying the source of the string to compile and
  the `template` preprocessor to use as string

Note: specific preprocessors like the `css` or the `javascript` ones can be enabled simply specifying the `type` attribute
in the tag source code for example

```html
<my-tag>
  <style type="scss">
    // ...
  </style>
</my-tag>
```

### registerPreprocessor(type, id, preprocessorFn)

#### @returns `Object` containing all the preprocessors registered

- _type_: either one of `template` `css` or `javascript`
- _id_: unique preprocessor identifier
- _preprocessorFn_: function receiving the code as first argument and the current options as second

### registerPostprocessor(postprocessorFn)

#### @returns `Set` containing all the postprocessors registered

- _postprocessorFn_: function receiving the compiler output as first argument and the current options as second

### generateTemplateFunctionFromString(string, parserOptions)

#### @returns `string` with the code to execute the @riotjs/bindings `template` function

### generateSlotsFromString(string, parserOptions)

#### @returns `string` with the code to generate components slots in runtime

[ci-image]: https://img.shields.io/github/actions/workflow/status/riot/compiler/test.yml?style=flat-square
[ci-url]: https://github.com/riot/compiler/actions
[license-image]: https://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
[license-url]: LICENSE
[npm-version-image]: https://img.shields.io/npm/v/@riotjs/compiler.svg?style=flat-square
[npm-downloads-image]: https://img.shields.io/npm/dm/@riotjs/compiler.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@riotjs/compiler
[coverage-image]: https://qlty.sh/gh/riot/projects/compiler/coverage.svg
[coverage-url]: https://qlty.sh/gh/riot/projects/compiler
[qlty-image]: https://qlty.sh/gh/riot/projects/compiler/maintainability.svg
[qlty-url]: https://qlty.sh/gh/riot/projects/compiler

compiler

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README