README.md

Test the internals of a JS or TS module

Available as

• a babel plugin
• a typescript compiler extension

Usage

Babel plugin

1. Install package

$ npm install -D babel-plugin-test-internal
$ yarn add -D babel-plugin-test-internal

2. Add the plugin to Babel configuration in your babel.config.js

// configuration example

module.exports = api => {
  //  1. 👇 are we in a test context?
  const isTest = api.env('test')
  // 2. if yes register the plugin 👇
  const plugins = isTest ? ["test-internal"]: []

  return {
  presets: [
  "@babel/preset-env",
  "@babel/preset-typescript",
  "@babel/preset-react",
  ],
  plugins, // 👈  3. don't forget to add the plugins property to the configuration object
  }
}

3. In your code, where you want to use internal content (i.e: your tests)

// 1. 👇 import __internal__ from the module you want to test
import {__internal__} from "./your-file"

test("testing some internal things", () => {
  const expected = ...
  // 2. use properties you need 👇
  assert(__internal__.doSomething(), expected)
})

Typescript compiler plugin

1. Install package

$ npm install -D typescript-plugin-test-internal
$ yarn add -D typescript-plugin-test-internal

2. Add the plugin to ts-loader configuration in your webpack.config.js

// configuration example

// 👇 1. import the plugin
const testInternalTranformer = require('typescript-plugin-test-internal').default;

module.exports = {
  mode: 'development',
  entry: './index.ts',
  module: {
    rules: [
      {
        test: /\.ts$/,
        loader: 'ts-loader',
        options: { // 👈 2. add ts-loader 'options' object
          // 3. 👇 add the method 'getCustomTransformers'
          getCustomTransformers: program => ({
            // 4. register the plugin 👇
            before: [testInternalTransformer(program)]
          })
        }
      }
    ]
  }
}

3. In your code, where you want to use internal content (i.e: your tests)

// 1. 👇 import '__internal__' from the module you want to test
import {__internal__} from "./your-file"

test("testing some internal things", () => {
  const expected = ...
  // 2. use properties you need 👇
  assert(__internal__.doSomething(), expected)
})

Development

Install all dependencies, build and test everything

# from the project root
$ yarn install
$ yarn build
$ yarn test

Babel plugin

$ cd ./babel
$ yarn install
$ yarn test
$ yarn build

Typescript plugin

$ cd ./typescript
$ yarn install
$ yarn test
$ yarn build