Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

parcel-codegen-loader

Package Overview
Dependencies
Maintainers
1
Versions
61
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

parcel-codegen-loader

A loader for .codegen files to auto-generate modules on the fly.

  • 1.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

npm node chat size

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!

Just make sure to post an issue or reach out to me on Gitter before starting actual work on anything. It really helps to avoid problems.

License

This plugin is released using the MIT license.

Keywords

FAQs

Package last updated on 27 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc