feat: Allow doc files (.md, .md) to be included with registry

[Asuniia]

Describe the feature

I'd like each component to have a .mdx documentation, and it would be interesting to be able to include all the files contained in the category folders. We could have an argument like this:

npx jsrepo build --include-files

Like this :

Validations

• I have checked other issues to see if my feature was already requested or added

[Asuniia]

Or bypass this :

jsrepo/src/utils/build/index.ts

Lines 93 to 104 in 78bdcbc

	const lang = languages.find((resolver) => resolver.matches(file));
	// warn for unsupported language
	if (!lang) {
	console.warn(
	`${ascii.VERTICAL_LINE} ${ascii.WARN} Skipped \`${color.bold(blockDir)}\` \`*${color.bold(
	path.parse(file).ext
	)}\` files are not currently supported!`
	);
	continue;
	}

[ieedan]

Is there a reason this documentation isn't just jsdoc on the component?

The reason we don't include all file types by default is to prevent you from including massive files like image files that will slow down the registry. (I also have more things coming that this is fairly important for)

[Asuniia]

Is there a reason this documentation isn't just jsdoc on the component?

The reason we don't include all file types by default is to prevent you from including massive files like image files that will slow down the registry. (I also have more things coming that this is fairly important for)

Yes, it's normal, wouldn't it be possible to make adapters so that we can add our own logic? It would also be useful to open up more languages in the future via PRs.

[ieedan]

Yes, it's normal, wouldn't it be possible to make adapters so that we can add our own logic?

The problem with adapters is that there are 2 different users for jsrepo, registry consumers, and registry creators. And they both need to have support for every language. If I have a registry I am building in an adapted language every consumer also needs to install that adapter to use that registry.

[ieedan]

I think maybe a better solution would be to allow md+ files to be sidecar files to blocks kinda like the way that test files work at the moment. That way users can choose whether or not they want to include the documentation instead of being forced to install it every time. What do you think?

[Asuniia]

I think maybe a better solution would be to allow md+ files to be sidecar files to blocks kinda like the way that test files work at the moment. That way users can choose whether or not they want to include the documentation instead of being forced to install it every time. What do you think?

Yes