Use a virtual file system

On a GitHub app the file system and the cloned repo are not available. Currently cosmiconfig browse the filesystem to find the config files, so it cannot be used with a GitHub app.

Would it be possible to pass to the load function a Array of file Objects, which would contains the the file path and the file content as a String or a Buffer? So a GitHub app could retrieve the config files as a String or Buffer and pass them to cosmiconfig.

For example:

const explorer = cosmiconfig('mymodule', [
  {path: 'mymodulerc.yml', content: '....'},
  {path: 'dir/mymodulerc.yml', content: '....'},
]);

explorer.load();
// => use config from `mymodulerc.yml`

explorer.load('dir');
// => use config from `dir/mymodulerc.yml`

explorer.load(null, 'dir/mymodulerc.yml');
// => use config from `dir/mymodulerc.yml`

[davidtheclark]

@sudo-suhas Agreed. It could go into whatever release it’s ready for.

[davidtheclark]

Here are the steps I see to allowing the user to pass in a custom fs module:

• Implement our own isDirectory function, instead of using the is-directory module.
• Document precisely which fs methods we use. That way we can document that the user-provided fs must expose those methods.
• Try it out, maybe with memfs.

Does that sound right?