dependency-cruiser/src/cli/initRules.js

Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

"use strict";

const fs           = require('fs');
const starterRules = require('./rules.starter.json');

/*
  We could have used utl.fileExists - but that one is cached.
  Not typically what we want for this util.
 */
function fileExists(pFile) {
    try {
        fs.accessSync(pFile, fs.R_OK);
    } catch (e) {
        return false;
    }
    return true;
}

/**
 * Creates a .dependency-cruiser config with a set of basic validations
 * to the current directory.
 *
 * @returns {void} Nothing
 * @param  {string} pFileName The file name to write the rules to
 * @throws {Error}  An error object with the root cause of the problem
 *                  as a description:
 *                  - file already exists
 *                  - writing to the file doesn't work
 *
 */
module.exports = (pFileName) => {
    if (fileExists(pFileName)) {
        throw Error(`A '${pFileName}' already exists here - leaving it be.\n`);
    } else {
        try {
            fs.writeFileSync(
                pFileName,
                JSON.stringify(starterRules, null, "  "),
                {encoding: "utf8", flag: "w"}
            );
        } catch (e) {

            /* istanbul ignore next  */
            throw Error(`ERROR: Writing to '${pFileName}' didn't work. ${e}\n`);
        }
    }
};