https://github.com/kazupon/pnpmc
pnpm catalogs tooling
https://github.com/kazupon/pnpmc
catalogs pnpm
Last synced: 6 months ago
JSON representation
pnpm catalogs tooling
- Host: GitHub
- URL: https://github.com/kazupon/pnpmc
- Owner: kazupon
- License: mit
- Created: 2025-01-30T10:14:16.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-04-06T02:14:31.000Z (6 months ago)
- Last Synced: 2025-04-06T03:21:40.796Z (6 months ago)
- Topics: catalogs, pnpm
- Language: TypeScript
- Homepage:
- Size: 60.7 MB
- Stars: 45
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# pnpmc
[![Version][npm-version-src]][npm-version-href]
[![CI][ci-src]][ci-href]
PNPM Catalogs Tooling
## đ Features
- Show catalogs
- Detect catalogable dependencies in workspace
- Register the dependency to the catalog
## đŋ Installation
```sh
pnpm add -D pnpmc
```
> [!IMPORTANT]
> Notice that this tool is for pnpm workspace feature only.
## đ Usage
### Display of defined catalogs and Detect catalogable dependencies
You can show the defined catalogs and catalogable dependencies on your pnpm workspace projects (`pnpm-workspace.yaml`):
```sh
pnpx pnpmc # or `pnpx pnpm show`
# PNPM Catalogs Tooling (pnpmc v0.4.0)
#
# đ Defined catalogs in pnpm-workspace.yaml:
# (none)
#
# đĻ Catalogable Dependencies (1):
# typescript:
# /packages/package1 (package1) : ^5.7.3
# /packages/package2 (package2) : ^5.6.0
#
```
### Register the dependency to the catalog
You can register the dependency to the catalog on your pnpm workspace projects (`pnpm-workspace.yaml`):
```sh
pnpx pnpmc register --dependency typescript --alias ^5.7.0 --catalog tools
# PNPM Catalogs Tooling (pnpmc v0.1.2)
#
# đ Registered 'typescript' as '5.7.0' in Catalog 'tools'
#
# đĻ Overridden 'typescript' alias on /packages/package1 (package1) : ^5.7.3 -> catalog:tools
# đĻ Overridden 'typescript' alias on /packages/package2 (package2) : ^5.6.0 -> catalog:tools
```
## đ Contributing guidelines
If you are interested in contributing to `pnpmc`, I highly recommend checking out [the contributing guidelines](/CONTRIBUTING.md) here. You'll find all the relevant information such as [how to make a PR](/CONTRIBUTING.md#pull-request-guidelines), [how to setup development](/CONTRIBUTING.md#development-setup)) etc., there.
## đ¤ Sponsors
The development of Gunish is supported by my OSS sponsors!
## Šī¸ License
[MIT](http://opensource.org/licenses/MIT)
[npm-version-src]: https://img.shields.io/npm/v/pnpmc?style=flat
[npm-version-href]: https://npmjs.com/package/pnpmc
[ci-src]: https://github.com/kazupon/pnpmc/actions/workflows/ci.yml/badge.svg
[ci-href]: https://github.com/kazupon/pnpmc/actions/workflows/ci.yml