package-comp-check

package-comp-check

A CLI utility to check which version of a package is compatible with the React version in your project.

Features

• Checks compatibility of npm packages with your project's React version
• Supports scoped packages (e.g., @mui/material, @testing-library/react)
• Simple CLI usage
• Fast and lightweight
• Built with TypeScript for better reliability and type safety

Installation

npm install -g package-comp-check

Usage

package-comp-check <package-name>

Options

• --help Show help information
• --version Show version number
• --debug Show debug information for troubleshooting

Examples

# Regular package
package-comp-check zustand

# Scoped package
package-comp-check @mui/material

# TypeScript types
package-comp-check @types/react

# With debug information
package-comp-check @emotion/react --debug

Scoped Packages

This tool fully supports scoped packages (packages starting with @). When using scoped packages:

• Always include the complete package name: @scope/package-name
• Use quotes if your shell requires them: "@mui/material"
• The tool automatically handles URL encoding for special characters

Common Issues with Scoped Packages

If you encounter issues with scoped packages, try these troubleshooting steps:

• Use quotes around the package name:

  package-comp-check "@mui/material"
  

• Check for typos in the scope or package name:

  # ❌ Incorrect
  package-comp-check @mui
  
  # ✅ Correct
  package-comp-check @mui/material
  

• Use debug mode to see what's being processed:

  package-comp-check @mui/material --debug
  

• Verify the package exists on npm: Visit https://www.npmjs.com/package/@scope/package-name to confirm the package exists.

How It Works

• Reads your project's package.json to find the React version
• Fetches package information from npm registry
• Finds versions that are compatible with your React version by checking peerDependencies
• Returns the latest compatible version

Development

This project is built with TypeScript and includes modern development tooling.

Prerequisites

• Node.js 16.x or higher
• npm or yarn

Setup

git clone https://github.com/abhidiwakar/package-comp-check.git
cd package-comp-check
npm install

Building

# Build once
npm run build

# Build and watch for changes
npm run build:watch

Testing

npm test

Local Development

# Build and test the CLI locally
npm run build
node dist/index.js <package-name>

Publishing

This package uses GitHub Actions for automated CI/CD:

• Continuous Integration: Runs on every push and pull request

  • Tests on Node.js 16.x, 18.x, and 20.x
  • Builds the TypeScript code
  • Runs tests

• Automated Publishing: Publishes to npm when a GitHub release is created

  • Requires NPM_TOKEN secret to be set in GitHub repository settings

Manual Publishing

npm run prepublishOnly  # Cleans and builds
npm publish

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate and ensure TypeScript compilation passes.

License

MIT