Generate index.js when --out-dir option is used

[gregberge]

As suggested in #161, we could generate an index.js containing all icons when we use --out-dir option.

Be careful to be compatible with #182.

[sis]

This package may help https://github.com/gajus/create-index

[kvedantmahajan]

@sis @gregberge the package above doesn't have options to generate index.ts. Rest all good.

Open issue here - gajus/create-index#48

[kvedantmahajan]

Here, I have written a tiny nodejs script to achieve the same after create-index generates an index.js ( I have a Typescript project ).
Basically I had to replace .tsx from all import statements in index.js. Second, I had to rename it to index.ts.

const path = require("path");
const fs = require("fs");

const filePath = path.join("src", "icons");
const fileName = "index.js";

fs.readFile(`${filePath}/${fileName}`, "utf8", (err, data) => {
	if (err) throw err;
	const newStr = data.replace(/.tsx/g, "");
	fs.writeFile(`${filePath}/${fileName}`, newStr, writeErr => {
		if (writeErr) throw err;
		fs.rename(`${filePath}/${fileName}`, `${filePath}/index.ts`, renameErr => {
			if (renameErr) throw renameErr;
			console.log("rename completed");
		});
	});
});

package.json scripts as follows:

"build-icons": "rm -rf src/icons && npx @svgr/cli -d src/icons svg-icons --ext tsx",
"create-index": "npx create-index src/icons --extensions tsx",
"recreate-index": "node scripts/regenerate-icon-index.js",
"lint:icons": "eslint './src/icons/*.{ts,tsx}' --fix",
"generate-icons": "yarn run build-icons && yarn run create-index && yarn run recreate-index && yarn run lint:icons"

[kelly-tock]

could we have semicolons at the end of the default template or an example of how to customize it?

[gregberge]

Custom templates are now supported. A next step would be to run prettier on the index file. Do you want to submit a PR to do it?

[kelly-tock]

Figured it out in a different issue, thanks!

[gucolin]

I understand it's nice to have index.js auto generated, but is there a way to not forcing it? I had to specify -d in the CLI but don't want to index.js, is it possible?

[antonhalim]

I concur with @gucolin, any update on not generating index file? Thanks in advance!
cc @gregberge

[jwpjrdev]

I have the same request as @gucolin and @antonhalim… I’m currently using a simple bash script to reformat and move my SVGs from a zip file exported from Figma. I could just delete index.js via the script but I’d really rather a configuration option for the CLI.