Writing, Running, and Debugging Node.js Scripts for Automated Component Export

During a morning meeting the author asked a team member to write a Node.js script that automatically exports components from the components folder into a root index.ts file, but none of the developers were comfortable with Node.js.

The article demystifies Node.js scripts, emphasizing that they are simply JavaScript files executed in the Node.js runtime, commonly used for file operations in front‑end projects.

How to run a Node.js script : create an index.js file, add console.log('I am a Node.js script'); , then execute with node ./index.js . The script can also be added to package.json scripts, e.g., "scripts": { "my-script": "node ./scripts/index.js" } , and run via npm run my-script .

Importing third‑party packages : use the built‑in fs module or, for better cross‑platform handling, the fs-extra package. Depending on the Node.js version, import with require() (pre‑12) or ES6 import (12+). For ES6 modules, set "type": "module" in package.json or use the .mjs extension.

The author creates a scripts/autoExport.mjs file, adds an npm script entry, and writes the following import statement:

import fs from 'fs-extra';

Implementing the export functionality : using fs.readdir and fs.writeFile to read component directories and generate export lines. The basic version simply writes all folder names; a more robust version checks that each folder follows PascalCase naming, contains an index.tsx file, and uses fs.lstatSync and fs.existsSync for validation.

import fs from 'fs-extra';

fs.readdir('./src/components')
  .then(res => {
    if (Array.isArray(res)) {
      let exportStr = '';
      res.forEach(item => {
        exportStr = `
${exportStr}
export { default as ${item} } from './components/${item}';`;
      });
      fs.writeFile('./src/index.export.ts', exportStr);
    }
  })
  .catch(err => console.error(err));

After adding validation, the script becomes:

import fs from 'fs-extra';

fs.readdir('./src/components')
  .then(files => {
    if (Array.isArray(files)) {
      let exportStr = '';
      files.forEach(item => {
        // Check for PascalCase folder, directory, and index.tsx file
        if (
          fs.lstatSync(`./src/components/${item}`).isDirectory() &&
          /^[A-Z][a-zA-Z]*$/.test(item) &&
          fs.existsSync(`./src/components/${item}/index.tsx`)
        ) {
          exportStr = `
${exportStr}
export { default as ${item} } from './components/${item}';`;
        }
      });
      fs.writeFile('./src/index.export.ts', exportStr);
    }
  })
  .catch(err => console.error(err));

Debugging Node.js scripts can be done with console.log , but the article recommends using VS Code's built‑in debugger. It walks through creating a launch.json file, selecting a Node.js configuration, specifying the script command, and starting a debugging session, which works similarly to browser DevTools.

Finally, the article lists several useful third‑party Node.js packages for front‑end automation, such as yargs , chalk , cli-table , ora , inquirer , boxen , progress , figlet , execa , and shelljs , encouraging readers to experiment with them.