Webpack throws "ReferenceError: describe is not defined" when bundling mocha test - node.js

I have a node.js mocha test that when I run it through webpack I get:
"ReferenceError: describe is not defined"
How do I make webpack ignore this global method that mocha has defined when when it runs?
Here is my test case with a work-around hack
// This is a nasty hack so webpack can compile without throwing "ReferenceError: describe is not defined"
// This global is replaced via sed before mocha runs it
global.describe = function() {};
describe('My services', async function() { ... });
I'd prefer to not include my full webpack config, but can if required. Here are the important parts
cache: true,
mode: 'development',
target: 'node',
// Per https://github.com/liady/webpack-node-externals#quick-usage
externalsPresets: {node: true}, // ignore built-in modules like path, fs, etc.
externals: [nodeExternals()], // ignore all modules in node_modules folder
watchOptions: {
ignored: ['**/node_modules', '**/build'],
},
// Don't want source maps
devtool: undefined,
module: {
rules:{
test: /\.c?js$/,
exclude: /node_modules/,
use: {
loader: 'babel-loader',
options: {
presets: [
[
'#babel/preset-env',
{
// #see https://babeljs.io/docs/en/options#targets (added in #babel/core 7.13)
targets: 'node 18.0',
// Per https://babeljs.io/docs/en/babel-preset-env#modules
// > If you are using a bundler with Babel, the default modules: "auto" is always preferred.
modules: 'auto',
useBuiltIns: 'usage',
corejs: '3.6',
},
],
],
plugins:[omitted],
},
},
},
},
Here is my sed trick that removes global describe from the bundled js:
sed 's|global.describe = function () {};||' build/serviceTests.cjs > build/serviceTestsNoGlobalDescribe.cjs && mocha build/serviceTestsNoGlobalDescribe.cjs
Environment info:
Node.js: v18
package.json:
"type": "module",
"[dev]dependencies": {
"mocha": "10.2.0",
"#babel/core": "7.20.12",
"#babel/plugin-proposal-class-properties": "7.18.6",
"#babel/plugin-proposal-decorators": "7.20.13",
"#babel/plugin-proposal-throw-expressions": "7.18.6",
"#babel/plugin-transform-runtime": "7.19.6",
"#babel/preset-env": "7.20.2",
"babel-loader": "8.0.6",
"webpack": "5.75.0",
"webpack-cli": "5.0.1",
"webpack-node-externals": "3.0.0"
},

Related

Upgrade to Webpack 5 failing

I am attempting upgrade to Webpack 4 to Webpack 5. However when I run npm start I get this error. Funny thing is I don't use applyWebpackOptionsDefaults anywhere and after scouring the node_modules I see that it is used in the webpack lib quite a few times. Can anyone tell me what I am doing wrong? Is there a package I haven't updated? What am I missing?
Failed to compile.
Invalid configuration object. Webpack has been initialized using a configuration object
that does not match the API schema.
configuration has an unknown property 'applyWebpackOptionsDefaults'. These properties are valid:
object { amd?, bail?, cache?, context?, dependencies?, devServer?, devtool?, entry?,
experiments?, externals?, externalsPresets?, externalsType?, ignoreWarnings?, infrastructureLogging?, loader?, mode?, module?, name?, node?, optimization?, output?, parallelism?, performance?, plugins?, profile?, recordsInputPath?, recordsOutputPath?, recordsPath?, resolve?, resolveLoader?, snapshot?, stats?, target?, watch?, watchOptions? }
-> Options object as provided by the user.
For typos: please correct them.
For loader options: webpack >= v2.0.0 no longer allows custom properties in configuration.
Loaders should be updated to allow passing options via loader options in module.rules.
Until loaders are updated one can use the LoaderOptionsPlugin to pass these options to the loader:
plugins: [
new webpack.LoaderOptionsPlugin({
// test: /.xxx$/, // may apply this only for some modules
options: {
applyWebpackOptionsDefaults: …
}
})
]
webpack.config.dev.js file:
const autoprefixer = require('autoprefixer');
const path = require('path');
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const CaseSensitivePathsPlugin = require('case-sensitive-paths-webpack-plugin');
const InterpolateHtmlPlugin = require('react-dev-utils/InterpolateHtmlPlugin');
const WatchMissingNodeModulesPlugin = require('react-dev-utils/WatchMissingNodeModulesPlugin');
const eslintFormatter = require('react-dev-utils/eslintFormatter');
const ModuleScopePlugin = require('react-dev-utils/ModuleScopePlugin');
const ProgressBarPlugin = require('progress-bar-webpack-plugin');
const getClientEnvironment = require('./env');
const paths = require('./paths');
// Webpack uses `publicPath` to determine where the app is being served from.
// In development, we always serve from the root. This makes config easier.
const publicPath = '/';
// `publicUrl` is just like `publicPath`, but we will provide it to our app
// as %PUBLIC_URL% in `index.html` and `process.env.PUBLIC_URL` in JavaScript.
// Omit trailing slash as %PUBLIC_PATH%/xyz looks better than %PUBLIC_PATH%xyz.
const publicUrl = '';
// Get environment variables to inject into our app.
const env = getClientEnvironment(publicUrl);
// This is the development configuration.
// It is focused on developer experience and fast rebuilds.
// The production configuration is different and lives in a separate file.
module.exports = {
// You may want 'eval' instead if you prefer to see the compiled output in DevTools.
// See the discussion in https://github.com/facebookincubator/create-react-app/issues/343.
context: __dirname + '/src',
devtool: 'cheap-module-source-map',
// devServer: {
// inline: false,
// contentBase: '../dist',
// },
// These are the "entry points" to our application.
// This means they will be the "root" imports that are included in JS bundle.
// The first two entry points enable "hot" CSS and auto-refreshes for JS.
entry: [
// We ship a few polyfills by default:
require.resolve('./polyfills'),
// Include an alternative client for WebpackDevServer. A client's job is to
// connect to WebpackDevServer by a socket and get notified about changes.
// When you save a file, the client will either apply hot updates (in case
// of CSS changes), or refresh the page (in case of JS changes). When you
// make a syntax error, this client will display a syntax error overlay.
// Note: instead of the default WebpackDevServer client, we use a custom one
// to bring better experience for Create React App users. You can replace
// the line below with these two lines if you prefer the stock client:
// require.resolve('webpack-dev-server/client') + '?/',
// require.resolve('webpack/hot/dev-server'),
require.resolve('react-dev-utils/webpackHotDevClient'),
// Finally, this is your app's code:
paths.appIndexJs,
// We include the app code last so that if there is a runtime error during
// initialization, it doesn't blow up the WebpackDevServer client, and
// changing JS code would still trigger a refresh.
],
output: {
// Add /* filename */ comments to generated require()s in the output.
pathinfo: true,
// This does not produce a real file. It's just the virtual path that is
// served by WebpackDevServer in development. This is the JS bundle
// containing code from all our entry points, and the Webpack runtime.
filename: 'static/js/bundle.js',
// There are also additional JS chunk files if you use code splitting.
chunkFilename: 'static/js/[name].chunk.js',
// This is the URL that app is served from. We use "/" in development.
publicPath: publicPath,
// Point sourcemap entries to original disk location (format as URL on Windows)
devtoolModuleFilenameTemplate: info =>
path.resolve(info.absoluteResourcePath).replace(/\\/g, '/'),
},
externals: {
'node-fetch': 'fetch',
},
resolve: {
// This allows you to set a fallback for where Webpack should look for modules.
// We placed these paths second because we want `node_modules` to "win"
// if there are any conflicts. This matches Node resolution mechanism.
// https://github.com/facebookincubator/create-react-app/issues/253
modules: ['node_modules', paths.appNodeModules].concat(
// It is guaranteed to exist because we tweak it in `env.js`
process.env.NODE_PATH.split(path.delimiter).filter(Boolean),
),
// These are the reasonable defaults supported by the Node ecosystem.
// We also include JSX as a common component filename extension to support
// some tools, although we do not recommend using it, see:
// https://github.com/facebookincubator/create-react-app/issues/290
// `web` extension prefixes have been added for better support
// for React Native Web.
extensions: ['.web.js', '.mjs', '.js', '.json', '.web.jsx', '.jsx'],
alias: {
react: path.resolve('node_modules/react'),
'react-dom': path.resolve('node_modules/react-dom'),
// Support React Native Web
// https://www.smashingmagazine.com/2016/08/a-glimpse-into-the-future-with-react-native-for-web/
'react-native': 'react-native-web',
'adp-react-components': path.resolve('node_modules/adp-react-components'),
},
plugins: [
// Prevents users from importing files from outside of src/ (or node_modules/).
// This often causes confusion because we only process files within src/ with babel.
// To fix this, we prevent you from importing files out of src/ -- if you'd like to,
// please link the files into your node_modules/ and let module-resolution kick in.
// Make sure your source files are compiled, as they will not be processed in any way.
new ModuleScopePlugin(paths.appSrc, [paths.appPackageJson]),
],
},
module: {
strictExportPresence: true,
rules: [
// TODO: Disable require.ensure as it's not a standard language feature.
// We are waiting for https://github.com/facebookincubator/create-react-app/issues/2176.
// { parser: { requireEnsure: false } },
// First, run the linter.
// It's important to do this before Babel processes the JS.
{
test: /\.(js|jsx|mjs)$/,
enforce: 'pre',
use: [
{
options: {
formatter: eslintFormatter,
eslintPath: require.resolve('eslint'),
},
loader: require.resolve('eslint-loader'),
},
],
include: paths.appSrc,
},
{
test: /\.(graphql|gql)$/,
include: paths.appSrc,
loader: 'graphql-tag/loader',
},
{
// "oneOf" will traverse all following loaders until one will
// match the requirements. When no loader matches it will fall
// back to the "file" loader at the end of the loader list.
oneOf: [
// "url" loader works like "file" loader except that it embeds assets
// smaller than specified limit in bytes as data URLs to avoid requests.
// A missing `test` is equivalent to a match.
{
test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/],
loader: require.resolve('url-loader'),
options: {
limit: 10000,
name: 'static/media/[name].[hash:8].[ext]',
},
},
{
test: /\.woff$/,
loader: 'file-loader',
options: {
name: '[name].[ext]',
outputPath: './fonts/',
publicPath: '',
},
},
// Process JS with Babel.
{
test: /\.(js|jsx|mjs)$/,
include: paths.appSrc,
loader: require.resolve('babel-loader'),
options: {
// This is a feature of `babel-loader` for webpack (not Babel itself).
// It enables caching results in ./node_modules/.cache/babel-loader/
// directory for faster rebuilds.
cacheDirectory: true,
},
},
// "postcss" loader applies autoprefixer to our CSS.
// "css" loader resolves paths in CSS and adds assets as dependencies.
// "style" loader turns CSS into JS modules that inject <style> tags.
// In production, we use a plugin to extract that CSS to a file, but
// in development "style" loader enables hot editing of CSS.
{
test: /\.css$/,
use: [
require.resolve('style-loader'),
{
loader: require.resolve('css-loader'),
options: {
importLoaders: 1,
},
},
{
loader: require.resolve('postcss-loader'),
options: {
// Necessary for external CSS imports to work
// https://github.com/facebookincubator/create-react-app/issues/2677
ident: 'postcss',
plugins: () => [
require('postcss-flexbugs-fixes'),
autoprefixer({
browsers: [
'>1%',
'last 4 versions',
'Firefox ESR',
'not ie < 9', // React doesn't support IE8 anyway
],
flexbox: 'no-2009',
}),
],
},
},
],
},
// JSON is not enabled by default in Webpack but both Node and Browserify
// allow it implicitly so we also enable it.
{
test: /\.json$/,
loader: 'json',
},
// "file" loader makes sure those assets get served by WebpackDevServer.
// When you `import` an asset, you get its (virtual) filename.
// In production, they would get copied to the `build` folder.
// This loader doesn't use a "test" so it will catch all modules
// that fall through the other loaders.
{
// Exclude `js` files to keep "css" loader working as it injects
// its runtime that would otherwise processed through "file" loader.
// Also exclude `html` and `json` extensions so they get processed
// by webpacks internal loaders.
exclude: [
/\.(js|jsx|mjs)$/,
/\.html$/,
/\.json$/,
/\.(graphql|gql)$/,
],
loader: require.resolve('file-loader'),
options: {
name: 'static/media/[name].[hash:8].[ext]',
},
},
],
},
// ** STOP ** Are you adding a new loader?
// Make sure to add the new loader(s) before the "file" loader.
],
},
plugins: [
// Makes some environment variables available in index.html.
// The public URL is available as %PUBLIC_URL% in index.html, e.g.:
// <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
// In development, this will be an empty string.
new InterpolateHtmlPlugin(env.raw),
// Generates an `index.html` file with the <script> injected.
new HtmlWebpackPlugin({
inject: true,
template: paths.appHtml,
}),
// Add module names to factory functions so they appear in browser profiler.
// new webpack.NamedModulesPlugin(),
// Makes some environment variables available to the JS code, for example:
// if (process.env.NODE_ENV === 'development') { ... }. See `./env.js`.
// new webpack.DefinePlugin(env.stringified),
new webpack.DefinePlugin({ 'process.env.NODE_ENV': env.stringified }),
// This is necessary to emit hot updates (currently CSS only):
new webpack.HotModuleReplacementPlugin(),
// Watcher doesn't work well if you mistype casing in a path so we use
// a plugin that prints an error when you attempt to do this.
// See https://github.com/facebookincubator/create-react-app/issues/240
new CaseSensitivePathsPlugin(),
// If you require a missing module and then `npm install` it, you still have
// to restart the development server for Webpack to discover it. This plugin
// makes the discovery automatic so you don't have to restart.
// See https://github.com/facebookincubator/create-react-app/issues/186
new WatchMissingNodeModulesPlugin(paths.appNodeModules),
// Moment.js is an extremely popular library that bundles large locale files
// by default due to how Webpack interprets its code. This is a practical
// solution that requires the user to opt into importing specific locales.
// https://github.com/jmblog/how-to-optimize-momentjs-with-webpack
// You can remove this if you don't use Moment.js:
new webpack.IgnorePlugin({
resourceRegExp: /^\.\/locale$/,
resourceRegExp: /moment$/,
}),
new ProgressBarPlugin(),
new webpack.LoaderOptionsPlugin({
options: {
applyWebpackOptionsDefaults: {},
},
}),
],
// Some libraries import Node modules but don't use them in the browser.
// Tell Webpack to provide empty mocks for them so importing them works.
node: {
dgram: 'empty',
fs: 'empty',
net: 'empty',
tls: 'empty',
child_process: 'empty',
},
// Turn off performance hints during development because we don't do any
// splitting or minification in interest of speed. These warnings become
// cumbersome.
performance: {
hints: false,
},
mode: env.raw.NODE_ENV || 'development',
optimization: {
checkWasmTypes: false,
chunkIds: 'named',
concatenateModules: false,
emitOnErrors: true,
flagIncludedChunks: false,
mangleExports: false,
minimize: false,
moduleIds: 'named',
nodeEnv: 'development',
occurrenceOrder: false,
removeAvailableModules: false,
splitChunks: {
hidePathInfo: false,
minSize: 10000,
maxAsyncRequests: Infinity,
maxInitialRequests: Infinity,
},
},
};
Here is the package.json:
{
"name": "project",
"version": "1.0.827-beta.0",
"private": true,
"homepage": "/home",
"dependencies": {
"apollo-cache-inmemory": "^1.6.6",
"apollo-client": "^2.6.10",
"apollo-link": "^1.2.14",
"apollo-link-context": "^1.0.20",
"apollo-link-error": "^1.1.13",
"apollo-link-http": "^1.5.17",
"apollo-link-logger": "^1.2.3",
"apollo-link-state": "^0.4.2",
"chalk": "1.1.3",
"dotenv": "4.0.0",
"dotenv-expand": "4.2.0",
"flow-bin": "^0.122.0",
"fontawesome": "^4.7.2",
"fs-extra": "3.0.1",
"graphql": "^15.0.0",
"graphql-tag": "^2.10.3",
"highcharts": "^7.1.1",
"isomorphic-fetch": "^2.2.1",
"lodash": "^4.17.15",
"moment": "^2.24.0",
"nanoid": "^2.0.2",
"node-fetch": "^2.6.0",
"object-assign": "4.1.1",
"postcss-flexbugs-fixes": "3.2.0",
"promise": "8.0.1",
"prop-types": "^15.7.2",
"raf": "3.4.0",
"react": "^17.0.1",
"react-apollo": "2.5.8",
"react-copy-to-clipboard": "^5.0.1",
"react-dev-utils": "^11.0.1",
"react-dom": "^17.0.1",
"react-dropzone": "^4.3.0",
"react-fast-compare": "^2.0.4",
"react-mailto": "^0.4.0",
"react-quill": "^1.3.1",
"react-redux": "^5.0.7",
"react-router": "^5.2.0",
"react-select": "^2.0.0",
"react-show-more-text": "1.3.0",
"redux": "^4.0.0",
"redux-immutable-state-invariant": "^2.1.0",
"redux-thunk": "^2.3.0",
"resolve": "1.6.0",
"uniqid": "5.0.3",
"url-loader": "0.6.2",
"victory": "^0.24.2",
"victory-core": "21.1.3",
"xlsx": "^0.14.3"
},
"scripts": {
"boot:start": "cd ../../ && npm run bootstrap:f && cd packages/client && npm start",
"build": "node --max_old_space_size=4096 scripts/build.js",
"i": "npm install",
"regenlock": "npm install --package-lock",
"scorch": "rmdir \"node_modules\" /S /Q && del \"package-lock.json\" /S /Q",
"start": "node scripts/start.js",
"test": "jest --runInBand --coverage",
"write:tests": "jest --watchAll --runInBand",
"flow": "flow"
},
"devDependencies": {
"#apollo/react-testing": "^3.1.4",
"#babel/core": "^7.7.7",
"#babel/plugin-proposal-class-properties": "^7.8.3",
"#babel/plugin-transform-runtime": "^7.8.3",
"#babel/polyfill": "^7.7.0",
"#babel/preset-env": "^7.7.7",
"#babel/preset-react": "^7.7.4",
"autoprefixer": "7.1.6",
"babel-jest": "^24.9.0",
"babel-loader": "^8.0.6",
"babel-plugin-transform-flow-strip-types": "^6.22.0",
"case-sensitive-paths-webpack-plugin": "^2.3.0",
"css-loader": "0.28.7",
"enzyme": "^3.11.0",
"enzyme-adapter-react-16": "^1.15.2",
"eslint-loader": "^2.1.0",
"expect": "^1.20.2",
"extract-text-webpack-plugin": "^3.0.2",
"file-loader": "1.1.5",
"handlebars": "^4.7.1",
"html-webpack-plugin": "^4.5.1",
"jest": "^24.9.0",
"jest-junit": "^10.0.0",
"jest-transform-graphql": "^2.1.0",
"jsdom": "11.11.0",
"json-loader": "^0.5.7",
"postcss-loader": "2.0.8",
"precommit": "^1.2.2",
"progress-bar-webpack-plugin": "^2.1.0",
"redux-mock-store": "^1.5.4",
"style-loader": "0.19.0",
"sw-precache-webpack-plugin": "^1.0.0",
"url-loader": "0.6.2",
"webpack": "^5.17.0",
"webpack-cli": "^4.4.0",
"webpack-dev-server": "^3.11.2",
"webpack-manifest-plugin": "^3.0.0",
"whatwg-fetch": "2.0.3"
}
}
You need to fix scripts/start.js file.
There is a line in this file:
const compiler = createCompiler(webpack, config, appName, urls, useYarn);
You need to change it to
const compiler = createCompiler({ webpack, config, appName, urls, useYarn });
This change will fix your current error but probably you'll get the next one :)
new webpack.LoaderOptionsPlugin({
options: {
applyWebpackOptionsDefaults: {},
From your code...
Try updating your node part for webpack 5 as well. What was
node: {
dgram: 'empty',
fs: 'empty',
net: 'empty',
tls: 'empty',
child_process: 'empty',
}
has to be under resolve.fallback.
Source: https://webpack.js.org/migrate/5/#clean-up-configuration

How can I use Webpack to create bundle for a Rest API Express NodeJS Server

Hope you are all well :)
I was working on a REST API server with Nodejs and after completing an alpha version, I wanted to create a bundle for it with build tools, Although I succeeded at some point in bundling the app still could not make the Express Rest API scripts to be bundled. As I am not really experienced with the Webpack, I am pretty sure that I am doing something wrong and there has to be a way to do this. You can also see my my webpack.config.js, .babelrc and package.json below:
Webpack.config.js
var debug = process.env.NODE_ENV !== "production";
var webpack = require('webpack');
var module_dir = `${__dirname}/node_modules`;
const path = require('path');
module.exports = {
entry: {
app: [
'babel-polyfill',
'./index.js',
],
},
output: {
path: path.resolve(__dirname, 'build'),
filename: 'app.bundle.js',
},
module: {
rules: [{
test: /\.js?$/,
exclude: /node_modules/,
loader: 'babel-loader',
query: {
presets: ['env', 'stage-0']
}
}]
},
resolveLoader: {
modules: [
__dirname + '/node_modules'
]
}
}
.Babelrc
{
"presets": ["#babel/env"]
}
package.json
{
"name": "",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "nodemon index.js",
"build": "webpack --mode production --progress"
},
"keywords": [
"log",
"npm",
"node",
"rest",
"api",
"debug",
"bug"
],
"author": "Mehdi Roshan Fekr",
"license": "ISC",
"dependencies": {
"#babel/core": "^7.3.4",
"#babel/preset-env": "^7.3.4",
"express": "^4.16.4",
"joi": "^14.3.1",
"nodemon": "^1.18.10"
},
"devDependencies": {
"#babel/core": "^7.1.6",
"#babel/preset-env": "^7.1.6",
"#babel/preset-react": "^7.0.0",
"babel-loader": "^8.0.4",
"webpack": "^4.25.1",
"webpack-cli": "^3.1.2"
}
}
I also have read this article about using express with webpack but I couldn't implement it properly, which I think one the reason for, is it is for a ReactJS app:
How can I use webpack with express?
----Updates-----
Error
ERROR in ./index.js
Module build failed (from ./node_modules/babel-loader/lib/index.js):
Error: Cannot find module 'babel-preset-env' from 'C:\Projects\# App Projects\Qcentic-Log'
- Did you mean "#babel/env"?
at Function.module.exports [as sync] (C:\Projects\# App Projects\Qcentic-Log\node_modules\resolve\lib\sync.js:58:15)
at resolveStandardizedName (C:\Projects\# App Projects\Qcentic-Log\node_modules\#babel\core\lib\config\files\plugins.js:101:31)
at resolvePreset (C:\Projects\# App Projects\Qcentic-Log\node_modules\#babel\core\lib\config\files\plugins.js:58:10)
at loadPreset (C:\Projects\# App Projects\Qcentic-Log\node_modules\#babel\core\lib\config\files\plugins.js:77:20)
at createDescriptor (C:\Projects\# App Projects\Qcentic-Log\node_modules\#babel\core\lib\config\config-descriptors.js:154:9)
at items.map (C:\Projects\# App Projects\Qcentic-Log\node_modules\#babel\core\lib\config\config-descriptors.js:109:50)
index.js
const express = require('express');
const app = express();
const CustomModule = require('./CustomModule');
app.use(express.json());
//My Endpoints...
app.listen(80, () => console.log('Listening on port 80'));
Since you are passing babel config directly to the loader, you do not need the .babelrc file. Also, you are using babel v7, so below is the updated config (your config and package.json contain mixed packages of babel v6 and v7 and they don't work together):
module.exports = {
target: "node",
entry: './index.js',
output: {
path: path.resolve(__dirname, 'build'),
filename: 'app.bundle.js',
},
module: {
rules: [{
test: /\.js?$/,
exclude: /node_modules/,
loader: 'babel-loader',
options: {
presets: [
[
"#babel/preset-env",
{
targets: {
node: "8.10"
}
}
]
]
}
}]
},
resolveLoader: {
modules: [
__dirname + '/node_modules'
]
}
}
Note that I removed #babel/polyfill, you don't need it for the server environment (I am sure because I am also bundling my server code with webpack and never needed it).
Make sure to set the version of node to whatever your target version is.
Also note that query is a very old way of passing options to webpack loaders, so I updated it to the new syntax, using options. And it is always best to pass full name of babel plugins, e.g.: #babel/preset-env instead of just env. The old way of resolving plugin names would generate a babel-preset-env based on env, but since babel v7 they restructured the project to "scoped packages", thus the #babel/ prefix, so best to specify full name.

npm package in ES6 not getting bundled in webpack

In my project
package.json (listed only babel related packages):
"#babel/core": "7.0.0-beta.37",
"#babel/plugin-syntax-dynamic-import": "7.0.0-beta.37",
"#babel/register": "7.0.0-beta.37",
"babel-eslint": "https://github.com/kesne/babel-eslint.git#patch-1",
"babel-helper-annotate-as-pure": "^7.0.0-beta.3",
"babel-loader": "^8.0.0-beta.0",
"babel-minify-webpack-plugin": "^0.2.0",
"babel-plugin-istanbul": "^4.1.5",
"babel-plugin-transform-class-properties": "^7.0.0-beta.3",
"babel-plugin-transform-decorators": "^7.0.0-beta.3",
"babel-plugin-transform-es2015-modules-commonjs": "^7.0.0-beta.3",
"babel-plugin-transform-es2015-template-literals": "^7.0.0-beta.3",
"babel-preset-typescript": "^7.0.0-alpha.19",
"webpack": "^3.5.5",
"webpack-dev-server": "^2.7.1"
npm package "ui/base" is written in ES 6.
And I am trying to import it on a page like
import '#ui/base';.
package.json of "ui/base".
"babel-core": "^6.26.0",
"babel-eslint": "^8.0.3",
"babel-loader": "^7.1.2",
"babel-plugin-transform-class-properties": "^6.24.1",
"babel-plugin-transform-decorators-legacy": "^1.3.4",
"babel-plugin-transform-es2015-modules-commonjs": "^6.26.0",
"babel-polyfill": "^6.26.0",
"babili-webpack-plugin": "^0.1.2",
"webpack-dev-server": "^2.7.1",
"webpack-node-externals": "^1.6.0"
The built version of a package is in ui/base/target/package/#ui/base/0/Main.js
Now, during the build process of my project, I am getting an error saying
ERROR in ./node_modules/#ui/base/src/components/accordion/Accordion.js
Module parse failed: Unexpected character '#' (18:0)
You may need an appropriate loader to handle this file type.
| import style from './accordion.css';
|
| #Define(`ui-base-v${__VERSION__}-accordion`, {
| style,
| })
The error is being thrown from the source of components. The built version of a package is not being taken in a build process of a project.
I am using following rules in webpack to build the project.
// Resolve imports to Typescript too without needing .ts
module.exports.resolve = {
extensions: ['.js', '.ts'],
};
module.exports.rules = [
{
test: /\.(js|ts)$/,
exclude: /node_modules/,
use: [{
loader: 'babel-loader',
}],
},
{
test: /\.html$/, // plugin to import HTML as a string
use: [{
loader: 'raw-loader',
options: {
exportAsEs6Default: true,
},
}],
},
{
test: /\.(less|css)$/,
use: [
{
loader: 'css-to-string-loader', // creates style nodes from JS strings
},
{
loader: 'css-loader', // translates CSS into CommonJS,
options: { url: false },
},
{
loader: 'less-loader', // compiles Less to CSS
}],
},
];
Below is the .babelrc in a project.
function istanbulHacks() {
return {
inherits: require("babel-plugin-istanbul").default,
};
}
const config = {
plugins: [
"#babel/plugin-syntax-dynamic-import",
"transform-decorators",
["transform-class-properties", { "loose": true }],
"transform-es2015-modules-commonjs",
["transform-es2015-template-literals", { "loose": true }],
],
presets: [
"typescript"
],
};
if (process.env.BABEL_ENV === "test") {
config.auxiliaryCommentBefore = "istanbul ignore next";
config.plugins.push(istanbulHacks);
}
module.exports = config;
Everything works fine without using the package written in ES6.
UPDATE
If I change "main" in package.json of #ui/base to
"main": "./target/package/#eui/base/0/Main.js",
then it works. Actually, "main" is point to "./src/index.js".
I am confused here as well. Why does "main" not point to the build version of a package ?
How to resolve this issue ? Is there any version incompatibility with babel or webpack ? Why I am not getting built version of npm package written in ES6 ?
Couple options:
Are we sure the import is correct? usually if its npm, there will be es5 code in the package. I see that your import is from /#ui/base/src I've see src contain es6 files, while another directory contains the transpiled es5 code, perhaps lib, or dist. Can you check the node_modules folder to see whats in ui/base?
You can tell webpack to parse ui/base, right now, your webpack will exclude node_modules thats good, you can also tell webpack to include the es6 code. Then it will get transpiled along with your source code.
Quick example of #2:
include: [
path.resolve(__dirname, "app")
],
exclude: [
path.resolve(__dirname, "app/demo-files")
],
https://webpack.js.org/configuration/

Webpack builds on production environment

In React JS starter kits like the one at https://github.com/wallacyyy/reactly-starter-kit, I see package.json files that have content like this:
"scripts": {
"build": "cross-env NODE_ENV=production webpack --config ./webpack.prod.config.js --progress --colors",
...
},
"dependencies": {
"express": "^4.15.2",
"react": "^15.5.4",
"react-dom": "^15.5.4"
},
"devDependencies": {
"webpack": "^2.2.1",
"webpack-dev-server": "^2.4.2"
}
The build script uses webpack to process the production build. How is it able to run on production when webpack is only a devDependency?
Webpack doesn't run on your production environment. Your build script just sets the NODE_ENV variable to equals production and thus letting Webpack and his plugins know they should prepare the bundle for production use. What exactly happens when you run this command depends on your webpack configuration, but among most common things would be code minification. You can also specify different kind of source maps and many other things. See https://webpack.js.org/guides/production/ for more information.
You keep both prod and dev webpack config. And in prod webpack config use definePlugin to set process.env.NODE_ENV as production ( you can also use other env variables ).
Now during transpiling and minification, NODE_ENV will be used in your vendor lib or in you app js.
'use strict';
var webpack = require('webpack');
var uglifyPlugin = new webpack.optimize.UglifyJsPlugin({
minimize: true,
comments: false
});
var definePlugin = new webpack.DefinePlugin({
'process.env': {
'NODE_ENV': JSON.stringify('production')
}
});
var commonChunkPlugin = new webpack.optimize.CommonsChunkPlugin({
name: 'vendor',
chunks: ['vendor', 'source'],
filename: 'vendor.bundle.js'
});
module.exports = {
context: __dirname + '/jsFolder',
entry: {
source: ['./app.jsx'],
vendor: [
'react',
'react-dom',
'redux',
'axios'
]
},
output: {
filename: "[name].bundle.js"
},
resolve: {
extensions: ['.js', '.jsx']
},
module: {
loaders: [
{ test: /\.json$/, loader: 'json-loader' },
{
loader: 'babel-loader',
exclude: /node_modules/,
query: {
presets: ['react', 'es2015', 'stage-0']
}
},
{ test: /\.css$/, loader: "css-loader" },
]
},
plugins: [commonChunkPlugin, definePlugin, uglifyPlugin],
node: {
console: true,
fs: 'empty',
net: 'empty',
tls: 'empty'
},
target: 'web'
};

vue.js with vue-multilanguage My webpack compilate is not translated right

My webpack compilate is not transpiled into the right JS. It writes
exports default MultiLanguage
instead of
module.exports = { MultiLanguage: MultiLanguage};
My .bablerc
{
"presets": ["es2015", "stage-0"],
"plugins": ["transform-runtime"]
}
My package.json
{
"name": "myapp",
"version": "0.0.1",
"description": "My app",
"dependencies": {
"bootstrap": "^3.3.7",
"vue": "^2.4.2",
"vue-multilanguage": "^2.1.1"
},
"devDependencies": {
"babel-cli": "^6.24.1",
"babel-core": "^6.25.0",
"babel-loader": "^6.4.1",
"babel-plugin-transform-runtime": "^6.1.2",
"babel-preset-es2015": "^6.24.1",
"babel-preset-stage-0": "^6.1.2",
"babel-runtime": "^5.8.0",
"webpack": "^1.15.0"
},
"author": "You"
}
My webpack.config.js
module.exports = {
entry: './src/main.js',
output: {
path: './dist',
filename: 'build.js'
},
module: {
loaders: [
{
test: /\.js$/,
loader: 'babel',
exclude: /node_modules/
}
]
}
}
And therefor the error and the code where it hits in the build.js
in Chromium/Chrome und ubuntu:
Uncaught SyntaxError: Unexpected token export
in Firefox:
SyntaxError: export declarations may only appear at top level of a module
export default MultiLanguage
Here also the vue code (main.js):
import Vue from 'vue/dist/vue.js'
import MultiLanguage from 'vue-multilanguage/src/vue-multilanguage.js'
Vue.use(MultiLanguage, {
default: 'en',
en: {
hi: 'Hello',
welcome: 'Welcome, {name}'
},
pt: {
hi: 'Ola',
welcome: 'Bem-vindo, {name}'
}
})
any recommanded tutorials? any idea?
when I replace the line in build.js wit module.exports = { MultiLanguage: MultiLanguage}; the error does not occure
Your problem is linked to your import.
vue-multilanguage.js is not provided pre-compiled by its author (which is rare, usually libraries include a dist file ready to be used...) and as it is in your node_modules folder, it is not transformed from ES6 to ES5 by your babel loader as well. You need to add an exception in your webpack.config.js.
module.exports = {
entry: './src/main.js',
output: {
path: './dist',
filename: 'build.js'
},
module: {
loaders: [
{
test: /\.js$/,
loader: 'babel-loader',
// exclude everything from node_modules, except vue-multilanguage
exclude: /node_modules(?![\\/]vue-multilanguage[\\/])/
}
]
}
}
Not directly related, but not that I also replaced 'babel' by 'babel-loader', to avoid some bugs with older packages. See here.
Also, you can (and you probably should), as mentioned in the comments, import vue this way.
import Vue from 'vue';
Side note:
According to their package.json, there should be a file ready to be used in their library, located at dist/vue-multilanguage.js. But they oddly added their dist folder into their .npmignore file, and so it's not included. That's probably an error. I'll post an issue on their github. Once it's corrected, and if you update your package, you should be able to simply import vue-multi like this (without adding any exception to your webpack config):
import MultiLanguage from 'vue-multilanguage'
I would use next imports:
import Vue from './vue';
import MultiLanguage from './vue-multilanguage';

Resources