feat: support `platform: 'node'` for esbuild plugin

[JounQin]

Add dependencies as external automatically at the same time

[ai]

What do you mean?

[JounQin]

 eslint-import-resolver-typescript on  master [✘+] ❯ p size-limit
⠋ Adding to empty esbuild project✘ [ERROR] Could not resolve "node:fs"

    lib/index.js:1:15:
      1 │ import fs from 'node:fs';
        ╵                ~~~~~~~~~

  You can mark the path "node:fs" as external to exclude it from the bundle, which will remove this
  error.

✘ [ERROR] Could not resolve "node:path"

    lib/index.js:2:17:
      2 │ import path from 'node:path';
        ╵                  ~~~~~~~~~~~

  You can mark the path "node:path" as external to exclude it from the bundle, which will remove
  this error.

✘ [ERROR] Could not resolve "node:url"

    lib/index.js:3:30:
      3 │ import { fileURLToPath } from 'node:url';
        ╵                               ~~~~~~~~~~

  You can mark the path "node:url" as external to exclude it from the bundle, which will remove this
  error.

✖ Adding to empty esbuild project
 ERROR  Error: Build failed with 3 errors:
lib/index.js:1:15: ERROR: Could not resolve "node:fs"
lib/index.js:2:17: ERROR: Could not resolve "node:path"
lib/index.js:3:30: ERROR: Could not resolve "node:url"
    at failureErrorWithLog (/Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:1605:15)
    at /Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:1251:28
    at runOnEndCallbacks (/Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:1164:65)
    at buildResponseToResult (/Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:1249:7)
    at /Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:1358:14
    at /Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:666:9
    at handleIncomingPacket (/Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:763:9)
    at Socket.readFromStdout (/Users/JounQin/Workspaces/GitHub/eslint-import-resolver-typescript/node_modules/.pnpm/esbuild@0.14.49/node_modules/esbuild/lib/main.js:632:7)
    at Socket.emit (node:events:527:28)
    at addChunk (node:internal/streams/readable:315:12)

[ai]

You do not need Size Limi for Node’s project. Node’s project is not care about bundle size. It is only important for client-side or universal project.

[ai]

If you have an universal project, you need to have browsers section in your package.json https://github.com/ai/nanoid/blob/main/package.json#L36-L40

[JounQin]

It is not universal, it is node only.

[JounQin]

diff --git a/get-config.js b/get-config.js
index caf78653fda1c3464ffb12ff10e19cd82fce644a..ddd3f4a229791a633668bd66d7fb3a63217b5e70 100644
--- a/get-config.js
+++ b/get-config.js
@@ -16,7 +16,9 @@ module.exports = async function getConfig(limitConfig, check, output) {
     bundle: true,
     minifyWhitespace: true,
     minifyIdentifiers: true,
-    minifySyntax: true
+    minifySyntax: true,
+    
+    platform: 'node'
   }

   return config

Something like this.

[ai]

It is not universal, it is node only.

Why do you need Size Limit if it is Node-only project?

[JounQin]

Why do you need Size Limit if it is Node-only project?

Why not? Doesn't package size on node matter?

[ai]

Size Limit doesn’t track package size, it tracks bundle JS size.

It has a reason only for browser or universal projects.

There is no reason to use Size Limit for node-specific project.

To track package size, you can call npm publish and it will print the package size.

[JounQin]

There is no reason to use Size Limit for node-specific project.

Or third-party plugins like size-limit-* can be supported in https://github.com/ai/size-limit/blob/main/packages/size-limit/load-plugins.js?

[ai]

Yes, you can write custom plugin if you have a free time

[JounQin]

Yes, you can write custom plugin if you have a free time

But they are not supported for now, shall I add size-limit-* plugins support in a PR?

https://github.com/ai/size-limit/blob/dfd4b2757c0a7bf976f2532f144260029ca33772/packages/size-limit/load-plugins.js#L12

https://github.com/ai/size-limit/blob/dfd4b2757c0a7bf976f2532f144260029ca33772/packages/size-limit/load-plugins.js#L22

[ai]

We can but only if we will have a good reason

[JounQin]

Yes, you can write custom plugin if you have a free time

We can but only if we will have a good reason

Not all approaches meet your opinion, so third-party plugins can be chosen by users.

I want to use https://github.com/andresz1/size-limit-action to report on PR for node projects for whatever reason.

[ai]

OK, send PR with tests, docs end everything, so I will be able release it without my extra work

[JounQin]

OK, send PR with tests, docs end everything, so I will be able release it without my extra work

OK, will do it tomorrow. Thanks for accepting.

[miridius]

There is no reason to use Size Limit for node-specific project.

Sure there is! People complain constantly about the size of node_modules, it's become a meme that it is the heaviest thing in the universe. In general it's preferable to everyone to have their dependencies be smaller.

Don't forget that nodejs apps still get bundled in some way (e.g. docker image) and deployed, so file size matters there too

The main use case where it really matters though are serverless functions like AWS lambda, where having a large node app makes the startup much slower and every extra kB matters a lot.

[ai]

People complain constantly about the size of node_modules

Using esbuild will get you numbers irrelevant to npm package size. It change the files a lot.

The better way is to get all files size directly. For instance, you can use @size-limit/file plugin.

[miridius]

Ok but for serverless functions I would use esbuild to bundle my nodejs app into a single js file that can be used by the function, so that's the file size that matters

[miridius]

There's a solution for this now though which is:

• uninstall @size-limit/preset-small-lib
• install 3rd party plugins size-limit-node-esbuild and size-limit-preset-node-lib

[ai]

Ok but for serverless functions I would use esbuild to bundle my nodejs app into a single js file that can be used by the function, so that's the file size that matters

In this case you should run @size-limit/file after build step.

If you have your own esbuild with your own settings, you should not use other esbuild to estimate size (because it could have different settings).

Just call "test": "npm build && size-limit"