npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

babel-plugin-ember-test-metadata

v3.2.0

Published

A Babel plugin for Ember apps that adds a test's file path to test metadata

Downloads

114

Readme

babel-plugin-ember-test-metadata

A Babel plugin for Ember apps that adds a test's file path to test metadata available through @ember/test-helpers.

CI Build License Package Version Code Style: prettier

Why use this plugin

A test file's path can enable downstream consumers of test results to process, and potentially associate a specific test failure to a file path. This can assist with the analysis of test infrastructure, specifically where identifying ownership over a test file is useful or required.

This Babel plugin transforms a test so that its file path is added to @ember/test-helpers test metadata, where other utilities can subsequently read that data.

Installation

npm install babel-plugin-ember-test-metadata --save-dev

# or

yarn add babel-plugin-ember-test-metadata -D

Usage

This plugin needs to be configured in your ember-cli-build.js file by adding it your babel's plugins array:

'use strict';

const EmberApp = require('ember-cli/lib/broccoli/ember-app');

module.exports = function (defaults) {
  let app = new EmberApp(defaults, {
    babel: {
      plugins: [
        [
          require.resolve('babel-plugin-ember-test-metadata'),
          {
            enabled: !!process.env.BABEL_TEST_METADATA,
            packageName: defaults.project.pkg.name,
          },
        ],
      ],
    },
  });

  // additional configuration

  return app.toTree();
};

If you're using Embroider instead of Ember CLI, you need to tell the plugin how to process the file paths:

'use strict';

const EmberApp = require('ember-cli/lib/broccoli/ember-app');

module.exports = function (defaults) {
  let app = new EmberApp(defaults, {
    babel: {
      plugins: [
        [
          require.resolve('babel-plugin-ember-test-metadata'),
          {
            enabled: !!process.env.BABEL_TEST_METADATA,
            packageName: defaults.project.pkg.name,
            isUsingEmbroider: true,
          },
        ],
      ],
    },
  });

  // additional configuration

  return app.toTree();
};

Set the environment variable BABEL_TEST_METADATA=true to enable the plugin to perform its transformations.

You can additionally pass in a projectRoot relative path to the options to accommodate more complex project structures like workspaces.

'use strict';

const EmberApp = require('ember-cli/lib/broccoli/ember-app');

module.exports = function (defaults) {
  let app = new EmberApp(defaults, {
    babel: {
      plugins: [
        [
          require.resolve('babel-plugin-ember-test-metadata'),
          {
            enabled: !!process.env.BABEL_TEST_METADATA,
            packageName: defaults.project.pkg.name,
            packageRoot: '../..',
          },
        ],
      ],
    },
  });

  // additional configuration

  return app.toTree();
};

You can also pass a custom function to normalize the test file path.

/**
  * Get a normalized file path
  * @param {string} options.packageName the name of the package as specified in Babel plugin options
  * @param {boolean} options.isUsingEmbroider whether building using Embroider as specified in Babel plugin options
  * @param {boolean} options.projectRoot custom relative path to the project's root as specified in Babel plugin options
  * @param {string} options.filename the absolute perceived path of the file being visited
  * @param {string} options.root the absolute root project path as seen on disk
}
*/
module.exports = function customNormalizedFilePath(options) {
    // Custom normalization
}
'use strict';

const EmberApp = require('ember-cli/lib/broccoli/ember-app');

module.exports = function (defaults) {

  let app = new EmberApp(defaults, {
    babel: {
      plugins: [
        [
          require.resolve('babel-plugin-ember-test-metadata'),
          {
            enabled: !!process.env.BABEL_TEST_METADATA,
            packageName: defaults.project.pkg.name,
            packageRoot: '../..',
            getCustomNormalizedFilePath: require.resolve('path/to/your/customNormalizedFilePath/function'),
          },
        ],
      ],
    },
  });

  // additional configuration

  return app.toTree();
};