Skip to content

Fix broken NPM bundle by publishing in ES-Module format #1958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 15, 2025
+13 −157
Merged

Fix broken NPM bundle by publishing in ES-Module format #1958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cf0204
Remove deprecated "directories" entry
elikoga May 6, 2025
fe29dc6
Convert NPM bundle to ES-Module format
elikoga May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 karma.conf.js → karma.conf.cjs
View file
Open in desktop
File renamed without changes.
14 changes: 5 additions & 9 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,20 @@
"name": "@novnc/novnc",
"version": "1.6.0",
"description": "An HTML5 VNC client",
"browser": "lib/rfb",
"directories": {
"lib": "lib",
"doc": "docs",
"test": "tests"
},
Comment on lines -6 to -10
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these not used anymore?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See npm js docs: directories

The CommonJS Packages spec details a few ways that you can indicate the structure of your package using a directories object. If you look at npm's package.json, you'll see that it has directories for doc, lib, and man.

In the future, this information may be used in other creative ways.

Since this is no longer exported using ComonJS Modules, I am not sure who would use this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds fair. But let's have a separate commit that explicitly states that these are being removed because they are old and unused.

Can probably put the removal of "browser" in the same commit.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi 👋
Just checking in to see if there are any updates on this thread

"type": "module",
"files": [
"lib",
"core",
"vendor",
"AUTHORS",
"VERSION",
"docs/API.md",
"docs/LIBRARY.md",
"docs/LICENSE*"
],
"exports": "./core/rfb.js",
"scripts": {
"lint": "eslint app core po/po2js po/xgettext-html tests utils",
"test": "karma start karma.conf.js",
"prepublish": "node ./utils/convert.js --clean"
"test": "karma start karma.conf.cjs"
},
"repository": {
"type": "git",
Expand Down
6 changes: 3 additions & 3 deletions po/po2js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

const { program } = require('commander');
const fs = require('fs');
const pofile = require("pofile");
import { program } from 'commander';
import fs from 'fs';
import pofile from "pofile";

program
.argument('<input>')
Expand Down
8 changes: 4 additions & 4 deletions po/xgettext-html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
* Licensed under MPL 2.0 (see LICENSE.txt)
*/

const { program } = require('commander');
const jsdom = require("jsdom");
const fs = require("fs");
import { program } from 'commander';
import jsdom from 'jsdom';
import fs from 'fs';

program
.argument('<INPUT...>')
Expand Down Expand Up @@ -106,7 +106,7 @@ let output = "";

for (let str in strings) {
output += "#:";
for (location in strings[str]) {
for (let location in strings[str]) {
output += " " + location;
}
output += "\n";
Expand Down
140 changes: 0 additions & 140 deletions utils/convert.js
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion utils/genkeysymdef.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

"use strict";

const fs = require('fs');
import fs from 'fs';

let showHelp = process.argv.length === 2;
let filename;
Expand Down
Loading