open-index/open-npm huggingface dataset:
npm package: @salesforce/sfdx-plugin-lwc-test
Description: Tools for unit testing Lightning web components in a Salesforce DX workspace
Latest version: 1.2.1

@salesforce/sfdx-plugin-lwc-test
=============

Tools for unit testing Lightning web components in a Salesforce DX workspace

## Usage

Install as a plugin in the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). While this plugin is in pilot you will need to manually install the plugin into your CLI.
```sh-session
$ sfdx plugins:install @salesforce/sfdx-plugin-lwc-test
$ sfdx force:lightning:lwc:test --help
```

## Commands 

### `sfdx force:lightning:lwc:test:create -f <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]`

create a Lightning web component test with boilerplate code inside a __tests__ directory

```
USAGE
  $ sfdx force:lightning:lwc:test:create -f <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -f, --filepath=filepath                         (required) path to Lightning web component .js file to create a test
                                                  for

  --json                                          format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx force:lightning:lwc:test:create -f force-app/main/default/lwc/myButton/myButton.js
```

_See code: [src/commands/force/lightning/lwc/test/create.ts](https://github.com/trevor-bliss/sfdx-lwc-test/blob/v0.0.6/src/commands/force/lightning/lwc/test/create.ts)_

### `sfdx force:lightning:lwc:test:run [-d] [--watch] [--json] [--loglevel trace|debug|info|warn|error|fatal]`

invoke Lightning web component Jest unit tests

```
USAGE
  $ sfdx force:lightning:lwc:test:run [-d] [--watch] [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -d, --debug                                     run tests in debug mode
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation
  --watch                                         run tests in watch mode

EXAMPLES
  $ sfdx force:lightning:lwc:test:run
  $ sfdx force:lightning:lwc:test:run -w
```

_See code: [src/commands/force/lightning/lwc/test/run.ts](https://github.com/trevor-bliss/sfdx-lwc-test/blob/v0.0.6/src/commands/force/lightning/lwc/test/run.ts)_

### `sfdx force:lightning:lwc:test:setup [--json] [--loglevel trace|debug|info|warn|error|fatal]`

install Jest unit testing tools for Lightning web components

```
USAGE
  $ sfdx force:lightning:lwc:test:setup [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx force:lightning:lwc:test:setup
```

_See code: [src/commands/force/lightning/lwc/test/setup.ts](https://github.com/trevor-bliss/sfdx-lwc-test/blob/v0.0.6/src/commands/force/lightning/lwc/test/setup.ts)_
npm package: @salesforce/soql-builder-ui
Description: SOQL Builder UI with LWC
Author: Salesforce
Latest version: 1.0.0
Deprecated: We no longer publish this package to npm, but still use it internally as part of the VSCode SOQL Extension.  Please open an issue at https://github.com/forcedotcom/salesforcedx-vscode/issues if you need it published to npm

# app

Here will be some information about the app.

## How to start?

Start simple by running `yarn watch`. This will start the project with a local development server.

The source files are located in the [`src`](./src) folder. All web components are within the [`src/modules`](./src/modules) folder. The folder hierarchy also represents the naming structure of the web components.

Find more information on the main repo on [GitHub](https://github.com/muenzpraeger/create-lwc-app).
npm package: @salesforce/soql-common
Description: Common SOQL parsing utilities
Latest version: 2.0.0

# @salesforce/soql-common

Common SOQL parsing utilities and comment handling for SOQL (Salesforce Object Query Language).

## Features

- SOQL parser based on ANTLR4
- Header comment extraction and handling
- TypeScript type definitions

## Installation

```bash
npm install @salesforce/soql-common
```

## Usage

```typescript
import { parseHeaderComments, SOQLParser } from '@salesforce/soql-common';

// Parse SOQL with comments
const result = parseHeaderComments(soqlString);
console.log(result.headerComments);
console.log(result.soqlText);
```

## License

BSD-3-Clause
npm package: @salesforce/soql-data-view
Description: This is the web assests for viewing SOQL Results
Author: Salesforce
Latest version: 0.1.0
Deprecated: We no longer publish this package to npm, but still use it internally as part of the VSCode SOQL Extension.  Please open an issue at https://github.com/forcedotcom/salesforcedx-vscode/issues if you need it published to npm

ERROR: No README data found!
npm package: @salesforce/soql-model
Description: SOQL Model
Author: Salesforce
Latest version: 1.0.0
Deprecated: We no longer publish this package to npm, but still use it internally as part of the VSCode SOQL Extension.  Please open an issue at https://github.com/forcedotcom/salesforcedx-vscode/issues if you need it published to npm

ERROR: No README data found!
npm package: @salesforce/soql-tmlanguage
Description: SOQL TextMate Language grammar
Author: Salesforce
Latest version: 0.1.1

## Introduction

This repository contains the language grammar for Salesforce's SOQL query language.

## Development

- Run `yarn` to install dependencies.
- Run `yarn build` to generate the final (.json) grammar file for VS Code.
- Run `yarn test` to run unit tests (based on https://github.com/PanAeon/vscode-tmgrammar-test)

This package is used from VS Code extension `salesforcedx-vscode-soql`. With that extension installed, you can see the grammar in action and debug/inspect it by opening a `.soql` file
(with the VS Code text editor) and then runnning command `Developer: Inspect Editor Tokens and Scopes`.

## Grammar file

    grammars/
    |-- soql.tmLanguage.yaml         ;; The source of the SOQL grammar
    `-- soql.tmLanguage.json         ;; Generated .json version of the grammar (git ignored)

VSCode only reads grammars in json format. `yarn build` generates the `.json` version of the SOQL grammar using `js-yaml`.

## Tests

Tests are executed with [vscode-tmgrammar-tests](https://github.com/PanAeon/vscode-tmgrammar-test).

    test/                   "Manually" created test case
    |-- simple_account.soql
    `-- snapshots/          "Snapshot-based" test cases
        |-- example-*.soql
        |-- example-*.soql.snap
        `-- ...

- `yarn test:source` validates "manually created" queries.
- `yarn test:snapshots` validates "snapshot-based" queries.
- `yarn test` validates both.

The difference between manual vs. snapshot tests is that the latter are auto-generated and can be updated with command `vscode-tmgrammar-snap -u`. They are useful to quickly see the output of applying the grammar and catch regressions.

The example-\* queries were taken from [Example SELECT clauses](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_examples.htm).