Skip to content

prep markdown plugin for publishment #3759

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 1 commit into from
Nov 22, 2025
Merged

prep markdown plugin for publishment #3759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/publish-plugin-md.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@lix-js/plugin-md": minor
---

Prepare the Markdown plugin for its first public publish on npm.
7 changes: 5 additions & 2 deletions packages/lix/plugin-md/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
{
"name": "@lix-js/plugin-md",
"type": "module",
"private": true,
"version": "0.1.3",
"license": "Apache-2.0",
"types": "./dist/index.d.ts",
"exports": {
".": "./dist/index.js"
},
"publishConfig": {
"access": "public"
Comment on lines +10 to +11
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Nov 22, 2025

Choose a reason for hiding this comment

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

P1 Badge Publishing omits dist artifacts

With publishConfig.access set to public this package is now publishable, but there is still no files whitelist or local .npmignore to override the repo-wide .gitignore that ignores every dist directory. When npm/changesets publish runs, the dist/index.js/index.d.ts outputs referenced by exports and types will be excluded from the tarball, so consumers will install a package without its entry point. Consider adding a files list or .npmignore so the built artifacts are shipped.

Useful? React with 👍 / 👎.

},
"scripts": {
"build": "rolldown -c",
"typecheck": "tsc --noEmit",
Expand Down Expand Up @@ -36,4 +39,4 @@
"typescript": "^5.5.4",
"vitest": "4.0.0-beta.11"
}
}
}
Copy link

@cursor cursor bot Nov 22, 2025

Choose a reason for hiding this comment

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

Bug: Missing files field for npm publication

The package is being prepared for publication but lacks a files field in package.json. Without this field, npm will publish all files in the directory except those in .gitignore or .npmignore, potentially including test files, configuration files, and other development artifacts. Other published packages in this repository like @lix-js/sdk and @lix-js/html-diff use "files": ["dist", "src"] to control what gets published.

Fix in Cursor Fix in Web