Adding filePath to parser results

[fforres]

The parser is able to analyze and return multiple exported components per module/file.

Once we parse multiple files on a single run (reactDocgenTS.parse(arrayOfFiles)) it is non trivial to parse what module a component corresponds to.

In our case, we want to use the filePath to extract some data on the file context (git, projects, etc) to enrich the data returned by the parser.

Worked around this initially by setting a custom componentNameResolver that returns the name and the filename instead of a string (And then updating some types), but it's not ideal, or a future-safe idea for the matter)

{....}
componentNameResolver: (exp, source) => {
  	const name = getComponentName(exp, source)
	return { name, fileName: source.fileName }
}
{....}

[fforres]

cc @pvasek or @brianconnoly for a review :)

[pvasek]

@fforres Thanks for your PR. It seems reasonable to add it but could you cover it with unit tests?

[fforres]

Hi @pvasek will do, and update here as soon as I do :)
Great project btw :D

[fforres]

Updated with some tests @pvasek :)
Sorry it took me some time, things have been hectic

[pvasek]

@fforres no worries. Sorry, I didn't notice before but could you exclude yarn.lock file from the PR? We don't use yarn here.

[fforres]

Oh shoot! 🤦‍♂️

[fforres]

I'm not near a computer, but I'll get it done ASAP :)

[fforres]

Updated @pvasek