@a-la/context

@a-la/context

@a-la/context is a a test context for @a-la packages used in alamode transpiler. It will provide a means to record the result of transforms for given rules, as well as emitted events.

yarn add -E @a-la/context

Table Of Contents

• Table Of Contents
• API
• async stream(rules: Rule|Rule[], text: string, eventKeys?: string[]): ReturnType
  • ReturnType
• setConfig(config: Object)
• TODO
• Copyright

API

The package is available by importing its default function:

import ALaContext from '@a-la/context'

The context is then passed to the context property of zoroaster tests suites.

async stream(
  rules: Rule|Rule[],
  text: string,
  eventKeys?: string[],
): ReturnType

Creates a Replaceable stream according to a rule or set of rules, asynchronously ends it with passed text and returns the outcome.

In the example below, a transform rule is used to replace an export statement with a module.exports statement, and emit an exports event.

/**
 * A rule to replace an `export function` statement with `module.exports`.
 */
export const exportFunctionRule = {
  re: / *export function ([$_\w][$_\w\d]*)/gm,
  replacement(_, fn) {
    // async
    this.emit('exports', fn)

    // sync
    this.exports = this.exports || []
    this.exports.push(fn)

    return `module.exports.${fn} = function ${fn}`
  },
}

Now, this rule can be tested using the @a-la/context and zoroaster testing framework.

/* yarn example/ */
import { equal, deepEqual } from 'zoroaster/assert'
import ALaContext from '@a-la/context'
import { exportFunctionRule as rule } from '../../src/rule'

/** @type {Object.<string, (c: ALaContext)>} */
const T = {
  context: ALaContext,
  async 'replaces the export function'({ stream }) {
    const fn = 'test'
    const data = `export function ${fn}() {}`

    const {
      result,
      events,
      replaceable,
    } = await stream(rule, data, ['exports'])
    const expected = `module.exports.${fn} = function ${fn}() {}`
    equal(result, expected)
    deepEqual(events, {
      exports: [fn],
    })
    deepEqual(replaceable.exports, [fn])
  },
}

export default T

example/test/spec
  ✓  replaces the export function

🦅  Executed 1 tests.

The output of the stream function is an object described below.

ReturnType: Replaceable instance, string result and events map.

Name	Type	Description	Default
events*	Object.<string, any[]>	Emitted events recorded against passed events keys.	-
result*	string	The caught output of a Replaceable stream as a string.	-
replaceable*	Replaceable	The instance of a Replaceable stream.	-

setConfig(
  config: Object,
): void

This method allows to set the config property of the Replaceable instance created inside of the stream method. Some transform may use config for certain functionality, e.g., replacing of the source string in the @a-la/import transform.

TODO

• Document mask testing.

Copyright

(c) À La Mode 2018

Changelog

1.2.1

• [dep] Update markers to mark escapes regular expressions.