Webpack

To integrate cpp.js into your project using Webpack as a bundler, you can utilize the @cpp.js/plugin-webpack and @cpp.js/plugin-webpack-loader plugins. Start by installing these packages with the following command:

npm

npm install @cpp.js/plugin-webpack @cpp.js/plugin-webpack-loader --save-dev

Yarn

yarn add @cpp.js/plugin-webpack @cpp.js/plugin-webpack-loader --dev

pnpm

pnpm add @cpp.js/plugin-webpack @cpp.js/plugin-webpack-loader --save-dev

bun

bun add @cpp.js/plugin-webpack @cpp.js/plugin-webpack-loader --dev

To enable the plugin, modify the webpack.config.js file as shown below.

webpack.config.js

+ const CppjsWebpackPlugin = require('@cpp.js/plugin-webpack');
+ const cppjsWebpackPlugin = new CppjsWebpackPlugin();
+ const compiler = cppjsWebpackPlugin.getCompiler();

module.exports = {
  //...
  plugins: [
+   cppjsWebpackPlugin,
  ],
  module: {
    rules: [
+     {
+       test: /\.h$/,
+       loader: '@cpp.js/plugin-webpack-loader',
+       options: { compiler },
+     }
    ],
  },
};

Cpp.js requires a configuration file to work. For a minimal setup, create a cppjs.config.mjs file and add the following content.

cppjs.config.mjs

import getDirName from 'cpp.js/src/utils/getDirName.js';

export default {
    paths: {
        project: getDirName(import.meta.url),
    },
};

Move your C++ code to the src/native directory. For example;

src/native/MySampleClass.h

#pragma once
#include <string>

class MySampleClass {
public:
    static std::string sample() {
        return "Hello World!";
    }
};

Modify the JavaScript file to call the C++ function. For example:

import { initCppJs } from './native/native.h'

initCppJs().then(({ MySampleClass }) => {;
  console.log(MySampleClass.sample());
});

The project is now fully set up and ready to run.

warning

Before proceeding, ensure that you have met all the prerequisites for setting up a working development environment.