62 lines
1.5 KiB
Markdown
62 lines
1.5 KiB
Markdown
|
# @riotjs/register
|
||
|
|
|
||
|
|
Allow `.riot` files importing in node.
|
||
|
|
|
||
|
|
**Notice**: you can't import directly `.riot` files in [deno](https://github.com/denoland/deno/issues/1739) yet.
|
||
|
|
In that case you will need to compile your tags first
|
||
|
|
|
||
|
|
[![Build Status][ci-image]][ci-url]
|
||
|
|
|
||
|
|
[![NPM version][npm-version-image]][npm-url]
|
||
|
|
[![NPM downloads][npm-downloads-image]][npm-url]
|
||
|
|
[![MIT License][license-image]][license-url]
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```
|
||
|
|
npm i @riotjs/register @riotjs/compiler
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
You can enable the `.riot` files import by simply preloading this module
|
||
|
|
|
||
|
|
```shell
|
||
|
|
node -r @riotjs/register your-app.js
|
||
|
|
```
|
||
|
|
|
||
|
|
### Advanced usage
|
||
|
|
|
||
|
|
If you need to disable the `.riot` files import you can use the teardown function exported:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const register = require('@riotjs/register')
|
||
|
|
|
||
|
|
// create the optional teardown function
|
||
|
|
const teardown = register()
|
||
|
|
|
||
|
|
// import you riot files here
|
||
|
|
const App = require('./app.riot')
|
||
|
|
|
||
|
|
// disable the .riot files import
|
||
|
|
teardown()
|
||
|
|
|
||
|
|
// this call will fail
|
||
|
|
require('./app.riot')
|
||
|
|
```
|
||
|
|
|
||
|
|
If you use `mocha` for your unit tests you can require it with the `mocha -r @riotjs/register`
|
||
|
|
|
||
|
|
[ci-image]:https://img.shields.io/github/workflow/status/riot/register/test?style=flat-square
|
||
|
|
[ci-url]:https://github.com/riot/register/actions
|
||
|
|
|
||
|
|
[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
|
||
|
|
[license-url]:LICENSE
|
||
|
|
|
||
|
|
[npm-version-image]:http://img.shields.io/npm/v/@riotjs/register.svg?style=flat-square
|
||
|
|
[npm-downloads-image]:http://img.shields.io/npm/dm/@riotjs/register.svg?style=flat-square
|
||
|
|
[npm-url]:https://npmjs.org/package/@riotjs/register
|
||
|
|
|
||
|
|
|
||
|
|
|