Method loadFile

lib/util.js:1126–1179

* Load a file and add it to the configuration * * @param {string} fullFilename an absolute file path * @param {DataConvert=} convert * @returns {null}

(fullFilename, convert)

   * @returns {null}
   */
  loadFile(fullFilename, convert) {
    let configObject = null;
    let fileContent = null;

    // Note that all methods here are the Sync versions.  This is appropriate during
    // module loading (which is a synchronous operation), but not thereafter.

    try {
      // Try loading the file.
      fileContent = FileSystem.readFileSync(fullFilename, 'utf-8');
      fileContent = fileContent.replace(/^\uFEFF/, '');
    }
    catch (e2) {
      if (e2.code !== 'ENOENT') {
        throw new Error('Config file ' + fullFilename + ' cannot be read. Error code is: '+e2.code
          +'. Error message is: '+e2.message);
      }
      return null;  // file doesn't exists
    }

    // Parse the file based on extension
    try {

      // skip if it's a gitcrypt file and CONFIG_SKIP_GITCRYPT is true
      if (!this.options.gitCrypt) {
        if (GIT_CRYPT_REGEX.test(fileContent)) {
          console.error('WARNING: ' + fullFilename + ' is a git-crypt file and CONFIG_SKIP_GITCRYPT is set. skipping.');
          return null;
        }
      }

      configObject = this.parser.parse(fullFilename, fileContent);
    } catch (e3) {
      if (GIT_CRYPT_REGEX.test(fileContent)) {
        console.error('ERROR: ' + fullFilename + ' is a git-crypt file and CONFIG_SKIP_GITCRYPT is not set.');
      }
      throw new Error("Cannot parse config file: '" + fullFilename + "': " + e3);
    }

    if (typeof configObject == 'function') {
      /** @type bootstrapCallback */
      let fn = configObject;

      configObject = fn({ defer: deferConfig, util: Util, raw: RawConfig.raw });
    }

    if (convert) {
      configObject = convert(configObject);
    }

    this.addConfig(fullFilename, configObject, fileContent);

    return configObject;
  }

  /**
   * load custom-environment-variables