@cybermindworks/frontend-logger

@cybermindworks/frontend-logger is a logging utility that seamlessly captures console output, window interactions, and API request data within your applications.

Installation

npm install @cybermindworks/frontend-logger

Usage

Refer Development Docs frontend logging

Local Development

We can use pnpm link command to do local development

Step A: Creating a Link from Your Package

1. Package Directory: Navigate to the directory of the npm package you are developing.

   cd path/to/your/package

2. Creating a Link: Instead of npm link, pnpm uses pnpm link --global to create a global symlink of your package. This link will be stored in a global pnpm store.

   pnpm link --global

   This step makes your package globally available on your system under the name specified in your package’s package.json.

Step B: Linking the Package to Another Project

1. Project Directory: Move to your other project directory where you want to use the locally developed package.

   cd path/to/your/project

2. Linking the Local Package: To link your globally linked package, use pnpm link followed by the name of your package.

   pnpm link package-name --global

   This command tells pnpm to create a symlink in your project's node_modules directory that points to the global symlink of your package.

Notes on Using pnpm link

• Global Store: pnpm stores all packages and their dependencies in a global content-addressable store. Symlinks in node_modules directories are created to point to this store, which avoids duplication of files on disk and speeds up operations.

• Development Workflow: Like with npm, when you make changes to your package, you might need to rebuild it if it involves compilation steps (like TypeScript or Babel). Make sure that your package is correctly updating in the project where it is linked.

• Unlinking: If you need to unlink the package, you can go into the project directory and use pnpm unlink package-name or simply remove the symlink from the node_modules directory and reinstall the package if necessary.

Using pnpm for local package development and linking can be particularly efficient and effective, especially in larger projects or monorepos due to its efficient handling of dependencies and disk space.

How to Publish the Package

Step 1: Update Package Version

In your package.json file, update the version number:

{
"name": "@cybermindworks/frontend-logger",
"version": "1.0.0",
// ... other package.json fields
}

Step 2: Publish to npm

Run the following command to publish your package to npm:

npm publish