open-index/open-npm huggingface dataset:
npm package: @koma-analytics/ui
Description: Koma Analytics React SDK for event tracking and analytics
Author: Fedjio Raymond
Latest version: 2.5.3

# @react-demo/ui

This library was generated with [Nx](https://nx.dev).

## Running unit tests

Run `nx test @react-demo/ui` to execute the unit tests via [Vitest](https://vitest.dev/).
npm package: @komaci/cli
Description: CLI utility that enables developers to use komaci from the command line.
Latest version: 262.22.0

# `@komaci/cli`

CLI tool to test out functionality for komaci. Currently supports only one command, `modgen`.

## `modgen` Command

This command will generate a komaci module, similar to what [komaci-tester](https://github.com/salesforce/komaci-tester) did, but with some improvements. Some example components can be found in `./sandbox`.

One important difference is that the component's namespace is no longer hardcoded to "c". It will now be derived from the module structure. For instance;

```text
sandbox
├── jsconfig.json
└── modules              // LWC 'modules' directory; not required
    ├── c                // "c" is the namespace for the modules within this directory
    │   └── komaciAction // "lightning/komaciAction" component — komaciAction in the "c" namespace
    └── lightning        // "lightning" is the namespace for the modules below
        ├── komaciAction // "lightning/komaciAction" component — Same as c/komaciAction, but in a trusted namespace
        └── recordForm   // "lightning/recordForm" component — copied from ui-lightning-components
```

### Usage

Run the following from the `packages/@komaci/cli` directory:

```sh
yarn
yarn build
# Run modgen on the component defined @ <path>
yarn komaci modgen <path>
```

### Examples

```sh
# Run modgen on c/komaciAction:
yarn komaci modgen sandbox/modules/c/komaciAction
# Print only the lwc metadata for c/komaciAction:
yarn komaci modgen sandbox/modules/c/komaciAction --only lwc
```

Modgen can also take in a list of paths:

```sh
yarn komaci modgen sandbox/modules/lightning/komaciAction sandbox/modules/lightning/recordForm
```

If all the modules are in the same subdirectory, you can use a glob pattern:

```sh
# Run modgen on all modules in the lightning namespace:
yarn komaci modgen sandbox/modules/lightning/*
# Run modgen on all modules in all namespaces:
yarn komaci modgen sandbox/modules/*/*
```
npm package: @komaci/static-analyzer
Description: Komaci Diagnostics API
Latest version: 262.22.0

# Static Analyzer

This library is used to analyze LWC modules for compatibility with Komaci. This is used internally by `@komaci/esm-generator` to determine if code is valid to encapsulate within a Resolvable Module, and externally by ESLint to aid LWC developers in ensuring their components are written in a way that ensures that Komaci is able to prefetch data for offline-ability and performance.

## Rules

There are a number of diagnostic rules that are produced when analyzing an LWC bundle with `@komaci/static-analyzer`. Diagnostics will be produced for each violation detected within a module bundle.

A detailed breakdown for the rules and how each can be addressed can be found in [RULES.md](./RULES.md).