generateDocs.js

/* eslint import/no-extraneous-dependencies: "off" */

/*
 * Generate cspace-public-browser documentation.
 */

import fs from 'fs';
import glob from 'glob';
import jsonFile from 'jsonfile';

/*
 * Generate documentation for react-intl messages. This must be done after the npm build script has
 * executed, so that messages will have been extracted to build/messages.
 */
const generateMessagesDoc = () => {
  const messages = [];

  glob.sync('build/messages/**/*.json').forEach((filename) => {
    jsonFile.readFileSync(filename).forEach((message) => {
      messages.push(message);
    });
  });

  messages.sort((messageA, messageB) => {
    const a = messageA.id.toLowerCase();
    const b = messageB.id.toLowerCase();

    if (a < b) {
      return -1;
    }

    if (a > b) {
      return 1;
    }

    return 0;
  });

  const docFile = fs.createWriteStream('docs/configuration/messages.js');

  docFile.write('/*\n');
  docFile.write(' * This file contains all messages used in cspace-public-browser, to be used as a reference for customization\n');
  docFile.write(' * or translation. The default export is an object containing the default messages in the\n');
  docFile.write(' * application, keyed by message ID. Messages may be customized by supplying overrides via the\n');
  docFile.write(' * messages configuration option.\n');
  docFile.write(' */\n\n');

  docFile.write('export default {');

  messages.forEach((message) => {
    const {
      id,
      description,
      defaultMessage,
    } = message;

    docFile.write('\n');

    if (description) {
      docFile.write(`  // ${description}\n`);
    }

    docFile.write('  ');
    docFile.write(JSON.stringify(id));
    docFile.write(': ');
    docFile.write(JSON.stringify(defaultMessage));
    docFile.write(',\n');
  });

  docFile.write('}');
  docFile.end();
};

generateMessagesDoc();