parcel-codegen-loader

parcel-codegen-loader

The parcel-codegen-loader resolves import / require() on a file into a Node.js module that is evaluated during the compilation. It expects the Node.js module to generate a webpack module on the fly establishing meta programming.

It follows pretty much the parcel-plugin-codegen implementation.

Getting Started

To begin, you'll need to install parcel-codegen-loader:

npm install parcel-codegen-loader --save-dev

Import (or require) the target file(s) in one of the bundle's files:

file.js

import { entries } from './file.codegen';

where file.codegen could be written as follows:

module.exports = function() {
  const entries = [1, 2, 3];
  return `export const entries = ${JSON.stringify(entries)};`;
};

Then add the loader to your webpack config. For example:

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.codegen$/i,
        use: [
          {
            loader: 'parcel-codegen-loader',
          },
        ],
      },
    ],
  },
};

And run webpack via your preferred method. This will emit file.png as a file in the output directory (with the specified naming convention, if options are specified to do so) and returns the public URI of the file.

ℹ️ By default the filename of the resulting file is the hash of the file's contents with the original extension of the required resource.

Options

(No options yet.)

Examples

The following examples show how one might use parcel-codegen-loader and what the result would be.

Get Infos from a Remote Source

Let's say you want to get a static set of users for your module from an API.

remote.codegen

const axios = require('axios');

module.exports = async function() {
  const res = await axios.get('https://jsonplaceholder.typicode.com/users');
  const users = res.data.map(m => ({ id: m.id, name: m.name, mail: m.email }));
  return `export const users = ${JSON.stringify(users)};`;
};

You can now use the following code to retrieve this static info:

import { users } from './remote.codegen';

Contributing

Contributions in any form are appreciated and much welcome!

License

This plugin is released using the MIT license. For more information see the LICENSE file.

Changelog

2.1.0 (December 26, 2024)

• Fixed issue in parcel-codegen-loader
• Added bun-codegen-loader package
• Added restriction in parcel-plugin-codegen to only consider cjs