# grunt-approvals-server

> Grunt task to run approvals-server

Latest version **0.5.1** (published 2017-05-08) · MPL 2.0 license · 0 weekly downloads

## Install

```sh
npm install grunt-approvals-server
pnpm add grunt-approvals-server
yarn add grunt-approvals-server
bun add grunt-approvals-server
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2017-05-08 |
| First published | 2016-09-14 |
| Weekly downloads | 0 |
| License | MPL 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chris Stead |
| Maintainers | cmstead |

## Links

- npm: https://www.npmjs.com/package/grunt-approvals-server
- npm.io page: https://npm.io/package/grunt-approvals-server

## Dependencies (2)

- [approvals-server](https://npm.io/package/approvals-server.md) git+https://github.com/cmstead/approvals-server.git
- [approvals-server-runner](https://npm.io/package/approvals-server-runner.md) ^0.1.1

## Recent versions

- 0.5.1 (latest) — 2017-05-08
- 0.5.0 — 2017-05-08
- 0.4.0 — 2016-11-09
- 0.3.3 — 2016-09-20
- 0.3.2 — 2016-09-20
- 0.3.1 — 2016-09-20
- 0.2.0 — 2016-09-20
- 0.1.0 — 2016-09-14

## README

# Grunt Approvals Server

Grunt task to run approvals server for client-side approval testing

Grunt Approvals Server is a Grunt wrapper around approvals-server which is a node server wrapper around Javascript
approvals.  Due to the wrapper nature of the grunt task, the configuration is minimal, simply taking the file location
for your approvals-server configuration.  An example configuration is as follows:

~~~
// ... grunt code above

    grunt.initConfig({
        "approvals-server": {
            start: {
                path: '.config/approvals-server.conf.js' // replace this path with your own
            }
        },
        // other configuration goes here
    });

    grunt.loadNpmTasks('grunt-approvals-server');
    // loading more tasks

    grunt.registerTask('test', ['approvals-server:start', 'test-runner-task']);

// and grunt code below ...
~~~

The gruntfile I used to test proper installation is as follows:

~~~
module.exports = function (grunt) {
    grunt.initConfig({
        karma: {
            test: {
                configFile: '.config/karma.conf.js'
            }
        },
        "approvals-server-start": {
            path: '.config/approvals-server.conf.js'
        }
    });

    grunt.loadNpmTasks('grunt-karma');
    grunt.loadNpmTasks('grunt-approvals-server');

    grunt.registerTask('test', ['approvals-server-start', 'karma:test', 'approvals-server-stop']);
};
~~~

Configuration for approvals-server can be found on the [Approvals Server](https://www.npmjs.com/package/approvals-server) 
NPM page and configuration for approvals can be found on the [Approvals](https://www.npmjs.com/package/approvals) page.

An example configuration for the Approvals/Approvals-Server package looks like the following:

~~~
var BeyondCompare4 = require('beyond-compare-4-reporter');

module.exports = {
    approvals: {
        reporters: [new BeyondCompare4()],

        normalizeLineEndingsTo: '\n',

        appendEOL: true,

        EOL: require('os').EOL,

        errorOnStaleApprovedFiles: true,

        shouldIgnoreStaleApprovedFile: function (/*fileName*/) { return false; },

        stripBOM: false,

        forceApproveAll: false

    },
    port: 3217,
    path: './test/approvals'
}
~~~

An example custom reporter for Beyond Compare 4 is like the following:

~~~
var spawn = require('child_process').spawn;
var fs = require('fs');

function statPath(filePath) {
    try {
        return fs.lstatSync(filePath);
    } catch (e) {
        return false;
    }
}

function BeyondCompare4 () {
    return {
        name: 'BeyondCompare4',
        canReportOn: function () {
            return true;
        },
        report: function (approvedFilePath, receivedFilePath) {
            var executionPath = '/Program Files/Beyond Compare 4/BCompare.exe';
            var approvedPath = './' + approvedFilePath;
            var receivedPath = './' + receivedFilePath;

            var approvedStat = statPath(approvedPath);

            if (!approvedStat) {
                fs.writeFileSync(approvedPath, '');
            }

            spawn(executionPath, [receivedPath, approvedPath], { detached: true });

        }
    };
};
~~~

---
_Source: https://npm.io/package/grunt-approvals-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
