Skip to content

Exclude unnecessary files from npm package #875

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

Jump to bottom
Merged
Tyriar merged 1 commit into from
Jan 17, 2026
Merged

Exclude unnecessary files from npm package #875

Tyriar merged 1 commit into from
Jan 17, 2026
+5 −9

Conversation

@lydell
Copy link
Contributor

@lydell lydell commented Jan 17, 2026 •
edited
Loading

Diff of npm pack output, before and after this PR:

diff --git a/before.txt b/after.txt
index e01b6be..0c8f79e 100644
--- a/before.txt
+++ b/after.txt
@@ -4,81 +4,29 @@ npm notice Tarball Contents
 npm notice 3.3kB LICENSE
 npm notice 8.0kB README.md
 npm notice 4.6kB binding.gyp
-npm notice 55B deps/.editorconfig
 npm notice 721B lib/conpty_console_list_agent.js
-npm notice 475B lib/conpty_console_list_agent.js.map
 npm notice 1.6kB lib/eventEmitter2.js
-npm notice 1.2kB lib/eventEmitter2.js.map
-npm notice 1.3kB lib/eventEmitter2.test.js
-npm notice 1.4kB lib/eventEmitter2.test.js.map
 npm notice 2.0kB lib/index.js
-npm notice 987B lib/index.js.map
 npm notice 233B lib/interfaces.js
-npm notice 124B lib/interfaces.js.map
 npm notice 348B lib/shared/conout.js
-npm notice 204B lib/shared/conout.js.map
 npm notice 7.5kB lib/terminal.js
-npm notice 5.8kB lib/terminal.js.map
-npm notice 6.3kB lib/terminal.test.js
-npm notice 4.2kB lib/terminal.test.js.map
-npm notice 807B lib/testUtils.test.js
-npm notice 622B lib/testUtils.test.js.map
 npm notice 228B lib/types.js
-npm notice 114B lib/types.js.map
 npm notice 13.4kB lib/unixTerminal.js
-npm notice 9.7kB lib/unixTerminal.js.map
-npm notice 20.9kB lib/unixTerminal.test.js
-npm notice 12.4kB lib/unixTerminal.test.js.map
 npm notice 1.5kB lib/utils.js
-npm notice 1.1kB lib/utils.js.map
 npm notice 6.1kB lib/windowsConoutConnection.js
-npm notice 1.7kB lib/windowsConoutConnection.js.map
 npm notice 9.9kB lib/windowsPtyAgent.js
-npm notice 7.3kB lib/windowsPtyAgent.js.map
-npm notice 4.1kB lib/windowsPtyAgent.test.js
-npm notice 3.0kB lib/windowsPtyAgent.test.js.map
 npm notice 7.8kB lib/windowsTerminal.js
-npm notice 5.0kB lib/windowsTerminal.js.map
-npm notice 10.5kB lib/windowsTerminal.test.js
-npm notice 8.7kB lib/windowsTerminal.test.js.map
 npm notice 848B lib/worker/conoutSocketWorker.js
-npm notice 635B lib/worker/conoutSocketWorker.js.map
-npm notice 1.6kB package.json
-npm notice 260B scripts/gen-compile-commands.js
-npm notice 2.2kB scripts/increment-version.js
-npm notice 225B scripts/linux/checksums.txt
-npm notice 5.6kB scripts/linux/install-sysroot.js
-npm notice 1.4kB scripts/linux/verify-glibc-requirements.sh
+npm notice 1.7kB package.json
 npm notice 2.4kB scripts/post-install.js
 npm notice 1.2kB scripts/prebuild.js
-npm notice 582B src/conpty_console_list_agent.ts
-npm notice 975B src/eventEmitter2.test.ts
-npm notice 1.1kB src/eventEmitter2.ts
-npm notice 2.2kB src/index.ts
-npm notice 3.3kB src/interfaces.ts
-npm notice 1.3kB src/native.d.ts
-npm notice 291B src/shared/conout.ts
-npm notice 4.4kB src/terminal.test.ts
-npm notice 6.7kB src/terminal.ts
-npm notice 567B src/testUtils.test.ts
-npm notice 323B src/tsconfig.json
-npm notice 306B src/types.ts
 npm notice 21.9kB src/unix/pty.cc
 npm notice 494B src/unix/spawn-helper.cc
-npm notice 14.5kB src/unixTerminal.test.ts
-npm notice 11.0kB src/unixTerminal.ts
-npm notice 997B src/utils.ts
 npm notice 1.4kB src/win/conpty_console_list.cc
 npm notice 19.6kB src/win/conpty.cc
 npm notice 1.7kB src/win/conpty.h
 npm notice 2.6kB src/win/path_util.cc
 npm notice 695B src/win/path_util.h
-npm notice 2.8kB src/windowsConoutConnection.ts
-npm notice 3.4kB src/windowsPtyAgent.test.ts
-npm notice 8.0kB src/windowsPtyAgent.ts
-npm notice 8.0kB src/windowsTerminal.test.ts
-npm notice 5.7kB src/windowsTerminal.ts
-npm notice 713B src/worker/conoutSocketWorker.ts
 npm notice 106.5kB third_party/conpty/1.23.251008001/win10-arm64/conpty.dll
 npm notice 1.2MB third_party/conpty/1.23.251008001/win10-arm64/OpenConsole.exe
 npm notice 109.6kB third_party/conpty/1.23.251008001/win10-x64/conpty.dll
@@ -89,8 +37,8 @@ npm notice name: node-pty
 npm notice version: 1.1.0
 npm notice filename: node-pty-1.1.0.tgz
 npm notice package size: 1.3 MB
-npm notice unpacked size: 2.9 MB
-npm notice shasum: 96a48faf68f136a0d22f3a2e2f5fd0eb077fdfc2
-npm notice integrity: sha512-/bCqqIKbS4Qtg[...]0Rk8WDSadLnbg==
-npm notice total files: 83
+npm notice unpacked size: 2.7 MB
+npm notice shasum: e8650b7b9ee81f75c654e6cdf36b6ed8c2e70e75
+npm notice integrity: sha512-BK+BLeknwpijP[...]pKtBbYD1edoBw==
+npm notice total files: 31
 npm notice

52 unnecessary files removed.

lydell
lydell commented Jan 17, 2026
View reviewed changes
.npmignore
Comment on lines -1 to -2
*.test.js
*.test.ts
Copy link
Contributor Author

@lydell lydell Jan 17, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

These patterns didn’t work. They would have needed to be:

**/*.test.js
**/*.test.ts

I fixed and moved the exclusions to "files" in package.json instead.

lydell
lydell commented Jan 17, 2026
View reviewed changes
deps/.editorconfig
Copy link
Contributor Author

@lydell lydell Jan 17, 2026

Choose a reason for hiding this comment

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

Since winpty was removed (#868), the deps/ folder contained only this file. I removed the deps/ folder.

@lydell
Copy link
Contributor Author

lydell commented Jan 17, 2026

@microsoft-github-policy-service agree

Tyriar
Tyriar approved these changes Jan 17, 2026
View reviewed changes
Copy link
Member

@Tyriar Tyriar left a comment

Choose a reason for hiding this comment

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

lgtm! At one point I intentionally wanted to keep the sourcemaps for transparency and easier debugging but it's probably best to just omit and use the repo directly if needing to get that deep.

@Tyriar Tyriar added this to the 1.2.0 milestone Jan 17, 2026
@Tyriar Tyriar self-assigned this Jan 17, 2026
@Tyriar Tyriar enabled auto-merge January 17, 2026 08:43
@Tyriar Tyriar merged commit 053d8f1 into microsoft:main Jan 17, 2026
9 checks passed
@lydell lydell deleted the leaner-npm-package branch January 17, 2026 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Tyriar Tyriar Tyriar approved these changes

@dmitrivMS dmitrivMS dmitrivMS approved these changes

Assignees

@Tyriar Tyriar

Labels

None yet

Projects

None yet

Milestone

1.2.0

Development

Successfully merging this pull request may close these issues.

3 participants

@lydell @Tyriar @dmitrivMS