[documentation only] minor error in sample code

[warren-bank]

Reproduction

https://github.com/remix-run/remix/blob/main/docs/file-conventions/remix-config.md#servernodebuiltinspolyfill

System Info

N/A

Used Package Manager

npm

Expected Behavior

typeof module.exports.serverNodeBuiltinsPolyfill.globals === 'object'
typeof module.exports.globals === 'undefined'

Actual Behavior

typeof module.exports.serverNodeBuiltinsPolyfill.globals === 'undefined'
typeof module.exports.globals === 'object'

[brophdawg11]

Can you elaborate a bit? I'm not sure quite what you're suggesting the docs be updated to?

[warren-bank]

sorry.. I thought that would be sufficiently clear;
please correct me if I'm wrong, as I'm new to this framework..
but it would seem to me that:

/** @type {import('@remix-run/dev').AppConfig} */
module.exports = {
  serverNodeBuiltinsPolyfill: {
    modules: {
      buffer: true, // Provide a JSPM polyfill
      fs: "empty", // Provide an empty polyfill
    },
  },
  globals: {
    Buffer: true,
  },
};

should be:

/** @type {import('@remix-run/dev').AppConfig} */
module.exports = {
  serverNodeBuiltinsPolyfill: {
    modules: {
      buffer: true, // Provide a JSPM polyfill
      fs: "empty", // Provide an empty polyfill
    },
    globals: {
      Buffer: true,
    },
  },
};

[brophdawg11]

ahh ok even with that side by side it took me a while to spot the difference! Just fixed in a5d10eb. Thanks for the callout!