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

grunt-ng-apimock

v1.2.0

Published

Grunt plugin that provides the ability to use scenario based api mocking of angular apps

Downloads

14

Readme

grunt-ng-apimock Build Status npm version dependency Status devDependency Status npm downloads

Grunt plugin that wraps around ng-apimock which provides the ability to use scenario based api mocking:

  • for local development
  • for protractor testing

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-ng-apimock --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-ng-apimock');

The "ngApimock" task

Overview

In your project's Gruntfile, add a section named ngApimock to the data object passed into grunt.initConfig().

grunt.initConfig({
  ngApimock: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

This task will process the mock data provided in the configuration and make it accessible for connect as middleware.

Options

options.defaultOutputDir

Type: String Default: '.tmp/mocks/'

Should be the location where the ngApimock plugin will put it's generated files.

options.watch

Type: boolean Default: false Mandatory: false

Indicates if mocks should be watched.

src

Type: String Mandatory: true

Should be the location where the mock json files are located.

Usage Examples

Default Options

grunt.initConfig({
  ngApimocks: {
    options: {
        defaultOutputDir: '...', // the output directory
        watch: boolean // optional: default false
    },
    your_target: {   
       src: '...' // the directory containing all your json mocks
    }
  }
})

Howto write mocks

see Howto write mocks

Howto use global variables

see Howto use global variables

Howto serve selected mocks

To be able to use the selected mocks you need to do two things:

  1. Add the connect middleware
  2. Add the mocking interface to your connect configuration

Add the connect middleware

When running grunt-contrib-connect you can do add the following middleware block to your configuration

{
    connect: {
        yourTarget: {
            options: {
                middleware: function (connect) {
                    return [
                        (require('ng-apimock/lib/utils').ngApimockRequest),
                        ...
                        connect().use('/', serveStatic('some-path-where-your-sources-are'))
                    ];
                }
            }
        }
    }
}

Add the mocking interface to your connect configuration

When running grunt-contrib-connect you can do add the following staticServe block to your configuration

{
    connect: {
        yourTarget: {
            options: {
                middleware: function (connect) {
                    return [
                        ...
                        connect().use('/mocking', serveStatic('path/to/the/generated/mocking/index.html')),
                        connect().use('/', serveStatic('some-path-where-your-sources-are'))
                    ];
                }
            }
        }
    }
}

Howto use for local development

see Howto use for local development

Howto use for your protractor tests.

see Howto use for your protractor tests

Available functions

see Available functions

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.