Add export for monaco converter

[char0n]

In 1.x releases we're no longer to be able to do following:

import { ProtocolToMonacoConverter } from 'monaco-languageclient/lib/monaco-converter.js';

Would it be possible to add new field to exports?

  "exports": {
    ".": {
      "types": "./lib/index.d.ts",
      "default": "./lib/index.js"
    },
    "./monaco-converter": {
      "types": "./lib/monaco-converter.d.ts",
      "default": "./lib/monaco-converter.js"
    },    
    "./amd": {
      "types": "./dist/amd/index.d.ts",
      "default": "./dist/amd/index.js"
    },
    "./vscode-compatibility": {
      "types": "./lib/vscode-compatibility.d.ts",
      "default": "./lib/vscode-compatibility.js"
    },
    "./amd/vscode-compatibility": {
      "types": "./dist/amd/vscode-compatibility.d.ts",
      "default": "./dist/amd/vscode-compatibility.js"
    }
  },

We only need converter part and and only pull converter necessary files from the library.

[kaisalmen]

Hi @char0n you can do just this:

import { ProtocolToMonacoConverter } from 'monaco-languageclient';

[char0n]

@kaisalmen yes, but the distribution fragments are in CommonJS format, which means I'm not able to apply tree-shaking. For the proposed import you mentioned vscode library is required to be installed and it will be pulled in final build. Converter doesn't need vscode at all.

[kaisalmen]

Strange, but the they were in CommonJS format before 1.x. The package still contains the file at same location. How do you build your application?

[char0n]

@kaisalmen in 1.x.y you've introduced exports field in package.json. This makes custom imports impossible in Node.js and bundlers like Webpack@5 as both Node.js and Webpack@5 respects the spec that defines behavior of exports.

Basically anything that is not exported with exports, nobody is able to use it anymore.

You can test this easily with following code in Node.js:

const { ProtocolToMonacoConverter } = require('monaco-languageclient/lib/monaco-converter.js');

monaco-languageclient@0.18.1 executes successfully, but monaco-languageclient@1.0.1 throws error:

Module not found: Error: Package path ./lib/monaco-converter.js is not exported from package /home/char0n/Documents/GitHub//node_modules/monaco-languageclient (see exports field in /home/char0n/Documents/GitHub//node_modules/monaco-languageclient/package.json)

[kaisalmen]

Do you make use of the vscode / vscode-compatibility alias?
https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/client/webpack.config.js#L30-32

[char0n]

@kaisalmen nope, as monaco-converter.js or anything that it imports doesn't need vscode alias to be set.

[kaisalmen]

Yes, I know, but you would not get the full vscode dependencies as a workaround. I wasn't aware that:

    ".": {
      "types": "./lib/index.d.ts",
      "default": "./lib/index.js"
    },

prevents your use case, because the main package export is the same

[kaisalmen]

Yes, we can expose the protocol converters directly. May be there is a better way. I have to see. Can you configure Webpack to be more relaxed? The files are there

[char0n]

Yes, we can expose the protocol converters directly. May be there is a better way. I have to see. Can you configure Webpack to be more relaxed? The files are there

Nope as I mentioned webpack@5 does respect specification for exports field and will trigger errors when you're trying to access something that is not exported.

[kaisalmen]

You could define an alias instruction that links @monaco-converter to some local path as workaround, couldn't you?

[char0n]

You could define an alias instruction that links @monaco-converter to some local path as workaround, couldn't you?

You can, but you will get to the same error as you eventually have to do require('monaco-languageclient/lib/monaco-converter.js');

[kaisalmen]

You can, but you will get to the same error as you eventually have to do require('monaco-languageclient/lib/monaco-converter.js');

You can give a direct node_moduls location on the file system. The it will take this during bundling. Did that before. There must be a way. We will release a new version the upcoming days and fix this, but it will likely not happen today.

[char0n]

You can give a direct node_moduls location on the file system. The it will take this during bundling. Did that before. There must be a way.

Yep, I tried that, but constraints of Create React App prevent to do this. This can be disabled by ejection but I want the bundle process to work without any overrides.

We will release a new version the upcoming days and fix this, but it will likely not happen today.

We'll wait. I can even issue a PR if that will help.

[kaisalmen]

We'll wait. I can even issue a PR if that will help.

Yes, that would be helpful! 👍