Skip to content

fix: add README.md to package.json files array#37

Open
eli0shin wants to merge 1 commit intomainfrom
claude/issue-36-20260202-1922
Open

fix: add README.md to package.json files array#37
eli0shin wants to merge 1 commit intomainfrom
claude/issue-36-20260202-1922

Conversation

@eli0shin
Copy link
Owner

@eli0shin eli0shin commented Feb 2, 2026

The npm registry was missing the readme because README.md was not included in the files array. This ensures the README will be published with the package.

Fixes #36

Generated with Claude Code

The npm registry was missing the readme because README.md was not
included in the files array. This ensures the README will be published
with the package.

Fixes #36

Co-authored-by: Eli Oshinsky <eli0shin@users.noreply.github.com>
@claude
Copy link

claude bot commented Feb 3, 2026

Pull Request Review

Overview

This PR addresses issue #36 by adding README.md to the files array in package.json to ensure it's included when publishing to npm.

✅ Code Quality & Best Practices

  • Clean and focused: The change is minimal and directly addresses the issue
  • Proper placement: README.md is added at the end of the files array, maintaining logical grouping (binaries/scripts first, then documentation)
  • Follows npm conventions: Including README.md in published packages is a standard practice for better package documentation visibility

✅ Correctness

  • Valid JSON syntax: The comma placement is correct
  • File exists: Verified that README.md exists in the repository (18,995 bytes)
  • Proper fix: This will ensure the README appears on the npm package page

✅ No Issues Found

  • No bugs detected: The change is straightforward string addition to an array
  • No performance impact: This only affects the publishing process, not runtime
  • No security concerns: Adding a documentation file to the package manifest poses no security risk
  • Test coverage: Not applicable - this is a build configuration change that doesn't require automated tests

📋 Verification Recommendations

Before merging, consider:

  1. Manual verification after publish: After the next release, check that the README appears on the npm package page (https://www.npmjs.com/package/cli-lsp-client)
  2. Package size check: Run npm pack --dry-run locally to verify the README is included and review the package contents

✅ Recommendation

LGTM (Looks Good To Me) - This is a correct and necessary fix. The change is minimal, follows best practices, and directly resolves the reported issue. Safe to merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix missing package readme

1 participant