roc-validate.js

#!/usr/bin/env node

const program = require('commander');
const fs = require('fs');
const path = require('path');
const { ROCrate } = require('./lib/rocrate');
const { Validator } = require('./lib/validator');

var crateDir;

program
  .version('0.1.0')
  .description('Runs a minimal RO-Crate validation')
  .option(
    '-f, --files-path <csv-path>',
    'Path to a csv file into which the tool will write a summary of which files are in the crate directory and mentioned in the crate'
  )
  .option(
    '-r, --report-path <report-path>',
    'Path to a JSON file into which the tool will write a json file containing errors, warnings and info'
  )
  .arguments('<dir>')
  .action((dir) => {
    crateDir = dir;
  });

program.parse(process.argv);
const outPath = program.outputPath ? program.outputPath : crateDir;

async function main() {
  const rawJson = fs.readFileSync(
    path.join(crateDir, 'ro-crate-metadata.json')
  );
  const validator = new Validator();
  validator.parseJSON(rawJson);
  await validator.validate();

  if (program.filesPath) {
    const files = fs.readdirSync(crateDir, { recursive: true });
    // Initialise a files object which has all the files found in the crate

    const filesObj = Object.fromEntries(
      files.map((value) => [
        path.join(value),
        {
          exists: true,
          inCrate: false,
          isDir: fs.lstatSync(path.join(crateDir, value)).isDirectory(),
        },
      ])
    );

    validator.checkFiles(filesObj);
    //console.log(filesObj)
    var csvString = 'file,exists,inCrate,isDir,dirDescribed\n';

    for (let key of Object.keys(filesObj)) {
      csvString += `"${key.replace(/(["])/g, '$1$1')}",${
        filesObj[key].exists
      },${filesObj[key].inCrate},${filesObj[key].isDir},${filesObj[key].dirDescribed}\n`;
    }
    fs.writeFileSync(program.filesPath, csvString);
  }
  if (program.reportPath) {
    fs.writeFileSync(
      program.reportPath,
      JSON.stringify(validator.result, null, 2)
    );
  } else {
    //console.log(SON.stringify(validator.result, null, 2))
  }
}

main();