@vctqs1/vite-plugin-resource-collector

A Vite plugin designed to help developers collect and log transpiled source files during the build process.

Installation

You can install the plugin via npm or yarn:

npm install @vctqs1/vite-plugin-resource-collector --save-dev

or

yarn add @vctqs1/vite-plugin-resource-collector --dev

Usage

To use the plugin, add it to your Vite configuration (vite.config.js):

// vite.config.js
import { defineConfig } from 'vite';
import resourceCollector from '@vctqs1/vite-plugin-resource-collector';

export default defineConfig({
  plugins: [
    resourceCollector({
      outputDir: 'build/raw-sources',
      mode: 'log', // or 'copy' to copy and log
    }),
  ],
});

Options

• baseDir (optional, default: cwd()): Specifies the base directory to search for source files.
• outputDir (optional, default: 'build/raw-sources'): Specifies the directory where collected source files will be stored.
• mode (optional, default: 'log'): Specifies the mode of operation. Use 'copy' to copy source files and 'log' to log file paths only.
• logType (optional, default: 'md'): Specifies the type of log file to generate. Use 'md', 'csv', or 'json'.

type VitePluginResourceCollectorOptions = {
    outputDir?: string;
    baseDir?: string;
    mode?: "copy" | "log";
    logType?: "md" | "csv" | "json";
};

Example

Suppose you have a Vite project with the following directory structure:

my-vite-project/
├── src/
│   ├── main.ts
│   └── components/
│       └── Button.ts
└── vite.config.js

After configuring and running Vite with the vite-plugin-resource-collector plugin, the plugin will collect transpiled source files into the specified outputDir directory (build/raw-sources by default).

Output During Build

When building the project, the plugin will log the following output:

9:47:59 PM [vite-plugin-resource-collector] Collecting source files to /path/to/your/project/build/raw-sources

...
...

9:48:24 PM [vite-plugin-resource-collector] Collected source files to /path/to/your/project/build/raw-sources/README.md

Contents of README.md

The generated README.md will contain a structured list of collected source files:

### Vite Plugin Source Collector

| # | File Name | Size (KB) |
| --- | --- | --- |
| 1 | /path/to/your/project/src/main.ts | 5.80 |
| 2 | /path/to/your/project/src/components/Button.ts | 3.40 |

This table lists each source file's path relative to the project root and its size in kilobytes (KB).

License

This project is licensed under the MIT License - see the LICENSE file for details.

Additional Notes:

• Compatibility: Ensure your Vite version is compatible with this plugin. Check compatibility in the npm package or GitHub repository.
• Contributing: Contributions are welcome! Feel free to fork and submit pull requests.
• Issues: If you encounter any issues or have suggestions, please report them.