valid-xlsx v0.0.5

valid-xlsx

A simple module and CLI for validation reporting on specified columns within an excel worksheet.

For the CLI, you pass in a file containing your column constraint functions:

validate-xlsx --sheet=SheetName                      \
              --constraints=your.column.constraints.js file.xlsx

Usage

npm install -g valid-xlsx
npm run test
npm run demo
npm run cli-demo

Example

Using the following sample file (sample.xlsx) ...

CLI

validate-xlsx --sheet=Transcript \
              --constraints=sample.constraints.js sample.xlsx

Output ...

4 invalid values

REC 2:
  LRB = `L+ ` is an invalid value
REC 3:
  XYZ = `q` is an invalid value
REC 4:
  LRB = `L+R+X` is an invalid value
  XYZ = `b` is an invalid value

Module

You'll typically require a file containing a constraints object:

var validate = require('valid-xlsx');
var constraints = require('sample.constraints');

var file = 'sample.xlsx',
    sheet = 'Transcript'

var results = validate(file, sheet, constraints);

console.log(results.report);

This should yield the following results:

{ errors: 4,
  invalid: 
   { '2': [ 'LRB = `L+ ` is an invalid value' ],
     '3': [ 'XYZ = `q` is an invalid value' ],
     '4': 
      [ 'LRB = `L+R+X` is an invalid value',
        'XYZ = `b` is an invalid value' ] } }

The constraints object should contain functions to check the validity of column values. The key of each constraint function should reflect the name of the column values it validates.

In the example below, we define the constraints object inline. It contains one column constraint function, viz., a simple constraint on valid values for the XYZ column:

var validate = require('valid-xlsx');

var file = 'sample.xlsx',
    sheet = 'Transcript',
    constraints = {
        XYZ: function(v) {
            if (v) {
                if (!/^[xyz]$/.test(v)) {
                    return { XYZ: v + ' is not a valid value!' };
                }
            }
        }
    };

var results = validate(file, sheet, constraints);
console.log(results.report);

This produces the following results:

{
  errors: 2,
  invalid: {
    '3': [ { XYZ: "q is not a valid value!" } ],
    '4': [ { XYZ: "b is not a valid value!" } ]
  }
}

See demo.js for a slight elaboration of this example.

See Also

• parse-xlsx - parse excel worksheets with column headers
• valid-records - validate specified fields within a set of records (ndjson)