Do a commonjs dist file for node, when using require plus example (#1287)

Author: matux

dist/rollbar.cjs

@@ -0,0 +1 @@
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

dist/rollbar.min.cjs

@@ -0,0 +1,23 @@
+const http = require('http');
+const Rollbar = require('rollbar');
+const PORT = process.env.PORT || 3000;
+
+// Initialize Rollbar with your configuration
+const rollbar = new Rollbar({
+  accessToken: 'POST_CLIENT_ITEM_ACCESS_TOKEN',
+  environment: 'development',
+  captureUncaught: true,
+  captureUnhandledRejections: true,
+});
+
+const server = http.createServer((_req, res) => {
+  res.writeHead(200, { 'Content-Type': 'text/plain' });
+  res.end('👋 Hello, Rollbar!\n');
+});
+
+if (require.main === module) {
+  server.listen(PORT, () => {
+    console.log(`🚀 Server running on http://localhost:${PORT}`);
+    rollbar.info('Server started!');
+  });
+}

dist/rollbar.min.cjs.LICENSE.txt

@@ -0,0 +1,15 @@
+{
+  "name": "require",
+  "version": "1.0.0",
+  "private": true,
+  "main": "index.js",
+  "dependencies": {
+    "rollbar": "file:../rollbar.tgz"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "node -e \"require('./index.js')\"",
+    "start": "node index.js"
+  },
+  "type": "commonjs"
+}

examples/node-require/index.js

@@ -15,7 +15,7 @@
     "javascript"
   ],
   "license": "MIT",
-  "main": "src/server/rollbar.cjs",
+  "main": "dist/rollbar.cjs",
   "browser": "dist/rollbar.umd.min.js",
   "module": "src/browser/rollbar.js",
   "types": "./index.d.ts",
@@ -24,7 +24,7 @@
       "types": "./index.d.ts",
       "node": {
         "import": "./src/server/rollbar.js",
-        "require": "./src/server/rollbar.cjs"
+        "require": "./dist/rollbar.cjs"
       },
       "browser": {
         "import": "./src/browser/rollbar.js",
@@ -137,7 +137,8 @@
     "stackframe": "^0.2.2",
     "time-grunt": "^1.0.0",
     "webpack": "^5.98.0",
-    "webpack-cli": "^6.0.1"
+    "webpack-cli": "^6.0.1",
+    "webpack-node-externals": "^3.0.0"
   },
   "scripts": {
     "build": "webpack --mode production",

examples/node-require/package.json

@@ -1,19 +1,21 @@
-var extend = require('util')._extend;
-var path = require('path');
-var webpack = require('webpack');
-var TerserPlugin = require('terser-webpack-plugin');
+const extend = require('util')._extend;
+const path = require('path');
+const nodeExternals = require('webpack-node-externals');
+const TerserPlugin = require('terser-webpack-plugin');
 
-var outputPath = path.resolve(__dirname, 'dist');
+const outputPath = path.resolve(__dirname, 'dist');
 
 // Packages that need to be transpiled to ES5
-var needToTranspile = ['@rrweb', 'error-stack-parser-es'].join('|');
-var excludePattern = new RegExp('node_modules/(?!(' + needToTranspile + ')/)');
+const needToTranspile = ['@rrweb', 'error-stack-parser-es'].join('|');
+const excludePattern = new RegExp(
+  'node_modules/(?!(' + needToTranspile + ')/)',
+);
 
-var uglifyPlugin = new TerserPlugin({
+const uglifyPlugin = new TerserPlugin({
   parallel: true,
 });
 
-var snippetConfig = {
+const snippetConfig = {
   name: 'snippet',
   entry: {
     'rollbar.snippet': './src/browser/bundles/rollbar.snippet.js',
@@ -26,15 +28,15 @@ var snippetConfig = {
   module: {
     rules: [
       {
-        test: /\.js$/,
+        test: /\.m?js$/,
         loader: 'babel-loader',
         exclude: [excludePattern, /vendor/],
       },
     ],
   },
 };
 
-var pluginConfig = {
+const pluginConfig = {
   name: 'plugins',
   entry: {
     jquery: './src/browser/plugins/jquery.js',
@@ -55,7 +57,7 @@ var pluginConfig = {
   },
 };
 
-var vanillaConfigBase = {
+const vanillaConfigBase = {
   entry: {
     rollbar: './src/browser/bundles/rollbar.js',
   },
@@ -75,7 +77,7 @@ var vanillaConfigBase = {
   },
 };
 
-var UMDConfigBase = {
+const UMDConfigBase = {
   entry: {
     'rollbar.umd': ['./src/browser/bundles/rollbar.js'],
   },
@@ -99,20 +101,42 @@ var UMDConfigBase = {
   },
 };
 
-var noConflictConfigBase = extend({}, UMDConfigBase);
+const serverCJSConfigBase = {
+  entry: {
+    rollbar: './src/server/rollbar.js',
+  },
+  output: {
+    path: outputPath,
+    libraryTarget: 'commonjs2',
+    libraryExport: 'default',
+  },
+  target: 'node',
+  externals: [nodeExternals()],
+  module: {
+    rules: [
+      {
+        test: /\.m?js$/,
+        loader: 'babel-loader',
+        exclude: [excludePattern, /vendor/],
+      },
+    ],
+  },
+};
+
+const noConflictConfigBase = extend({}, UMDConfigBase);
 noConflictConfigBase.entry = {
   'rollbar.noconflict.umd': ['./src/browser/bundles/rollbar.noconflict.js'],
 };
 
-var namedAMDConfigBase = extend({}, UMDConfigBase);
+const namedAMDConfigBase = extend({}, UMDConfigBase);
 namedAMDConfigBase.entry = {
   'rollbar.named-amd': namedAMDConfigBase.entry['rollbar.umd'],
 };
 namedAMDConfigBase.output = extend({}, namedAMDConfigBase.output);
 namedAMDConfigBase.output.library = 'rollbar';
 namedAMDConfigBase.output.libraryTarget = 'amd';
 
-var config = [snippetConfig, pluginConfig];
+const config = [snippetConfig, pluginConfig];
 
 function optimizationConfig(minimizer) {
   return {
@@ -122,7 +146,7 @@ function optimizationConfig(minimizer) {
 }
 
 function addVanillaToConfig(webpackConfig, filename, extraPlugins, minimizer) {
-  var vanillaConfig = extend({}, vanillaConfigBase);
+  const vanillaConfig = extend({}, vanillaConfigBase);
   vanillaConfig.name = filename;
 
   vanillaConfig.plugins = extraPlugins;
@@ -135,7 +159,7 @@ function addVanillaToConfig(webpackConfig, filename, extraPlugins, minimizer) {
 }
 
 function addUMDToConfig(webpackConfig, filename, extraPlugins, minimizer) {
-  var UMDConfig = extend({}, UMDConfigBase);
+  const UMDConfig = extend({}, UMDConfigBase);
 
   UMDConfig.plugins = extraPlugins;
 
@@ -152,7 +176,7 @@ function addNoConflictToConfig(
   extraPlugins,
   minimizer,
 ) {
-  var noConflictConfig = extend({}, noConflictConfigBase);
+  const noConflictConfig = extend({}, noConflictConfigBase);
 
   noConflictConfig.plugins = extraPlugins;
 
@@ -167,7 +191,7 @@ function addNoConflictToConfig(
 }
 
 function addNamedAMDToConfig(webpackConfig, filename, extraPlugins, minimizer) {
-  var AMDConfig = extend({}, namedAMDConfigBase);
+  const AMDConfig = extend({}, namedAMDConfigBase);
 
   AMDConfig.plugins = extraPlugins;
 
@@ -178,11 +202,19 @@ function addNamedAMDToConfig(webpackConfig, filename, extraPlugins, minimizer) {
   webpackConfig.push(AMDConfig);
 }
 
+function addServerCJSConfigBase(webpackConfig, filename, minimizer) {
+  const serverConfig = extend({}, serverCJSConfigBase);
+  serverConfig.optimization = optimizationConfig(minimizer);
+  serverConfig.output = extend({ filename }, serverCJSConfigBase.output);
+  webpackConfig.push(serverConfig);
+}
+
 function generateBuildConfig(name, plugins, minimizer) {
   addVanillaToConfig(config, name, plugins, minimizer);
   addUMDToConfig(config, name, plugins, minimizer);
   addNamedAMDToConfig(config, name, plugins, minimizer);
   addNoConflictToConfig(config, name, plugins, minimizer);
+  addServerCJSConfigBase(config, name.replace('.js', '.cjs'), minimizer);
 }
 
 generateBuildConfig('[name].js', []);