open-index/open-npm huggingface dataset:
npm package: @kubev2v/types
Description: Typescript interfaces and types for forklift-console-plugin
Latest version: 0.0.24

# @kubev2v/types

Manual and auto generated typescript models and constants for Forklift console plugin.

## Auto generated

Auto generated [types](/src/generated):

  - [Forklift types](/src/generated/forklift)
  - [Kubernetes types](/src/generated/kubernetes)
  - [Kubevirt types](/src/generated/kubevirt)
  - [Containerized Data Importer types](/src/generated/containerized-data-importer)

## Manual

Manual [types](/src/types):

  - [Forklift inventory](/src/types)

### Setting the models color and abbr.

The [model constants](src/generated/forklift/constants) are auto generated with `abbr` that defaults to first two letters of the kind, and undefined `color`.
It is sometimes advisable to manual change the defaults.

For example:

``` ts
export const HostModel = {
  label: 'Host',
  labelPlural: 'Hosts',

  abbr: 'HO',
  color: undefined,
  ...
};
```
can be manually edited to:

``` ts
export const HostModel = {
  label: 'Forklift Host',
  labelPlural: 'Forklift Hosts',

  abbr: 'H',
  color: '#f00',
  ...
};
```
npm package: @kubev2v/webpack
Description: Allow building openshift console dynamic plugins using the openshift dynamic plugin sdk.
Latest version: 0.0.4

# @kubev2v/webpack

Webpack plugins to allow building `@openshift-console/dynamic-plugin-sdk` plugins using the more general `@openshift/dynamic-plugin-sdk` plugin sdk.

The primary advantage in this configuration is to allow use of typed and compiled TypeScript files instead of a single JSON file.
npm package: @kubevious/helpers
Description: Kubevious Helpers
Author: Ruben Hakopian
Latest version: 1.0.67

[![Codefresh build status]( https://g.codefresh.io/api/badges/pipeline/kubevious/Image%20Builds%2Fhelpers?branch=master&key=eyJhbGciOiJIUzI1NiJ9.NWRmYWM4ZGJkYzJlNTkwMDA5MWJmYzM4.nrzBqsKVoTwu9mHe8-HD7RQ1xV9DcdOjeGou95l0MiU&type=cf-1)]( https%3A%2F%2Fg.codefresh.io%2Fpipelines%2Fhelpers%2Fbuilds%3FrepoOwner%3Dkubevious%26repoName%3Dhelpers%26serviceName%3Dkubevious%252Fhelpers%26filter%3Dtrigger%3Abuild~Build%3Bbranch%3Amaster%3Bpipeline%3A5eb9f186d7944307a716cc5a~helpers)

# Kubevious Helper Library
npm package: @kubevious/ui-components
Description: Kubevious UI Components
Author: Ruben Hakopian
Latest version: 1.0.247

# Kubevious UI Common Components

Contains common and basic components such as:
- BurgerMenu
- Button
- Checkbox
- CodeControlBar
- CopyClipboard
- DnComponent
- DnIconComponent
- DnList
- DnPath
- DnResults
- DnShortcutComponent
- ErrorBox
- GoldenLayout
- InnerPage
- Input
- MarkerPreview
- OperationLog
- PageHeader
- PageLink
- PageLinkButton
- Popup
- Select
- SideMenu
- Tabs
- Textarea
npm package: @kubevious/ui-properties
Description: Kubevious UI Properties Components
Author: Ruben Hakopian
Latest version: 1.0.76

# Kubevious UI Properties Components

Contains properties related components such as:
- Properties
- PropertyGroup
- Config
- DnList
- KeyValueList
- PropertiesAlertList
- PropertiesContents
- PropertiesCounters
- PropertiesObjectList
- PropertiesTable
- Summary
npm package: @kubevious/ui-rule-engine
Description: Kubevious UI Rule Engine Components
Author: Ruben Hakopian
Latest version: 1.0.87

# Kubevious UI Rule Engine Components

Contains rule engine related components such as:
- StartPage 
- RuleMainTab
- MarkerMainTab
- RuleEditor
- MarkerEditor
- Editor
- AffectedObjects
- ItemsList
- BurgerMenu
npm package: @kubevirt-ui-ext/kubevirt-api
Description: kubevirt OpenAPI automation for TypeScript
Author: Yaacov Zamir
Latest version: 1.7.0

[![NPM Version](https://img.shields.io/npm/v/gm.svg?style=flat)](https://www.npmjs.org/package/@kubevirt-ui/kubevirt-api)

# kubevirt-api

![alt gopher network](https://raw.githubusercontent.com/kubevirt-ui/kubevirt-api/main/images/logos.png)

kubevirt OpenAPI automation for TypeScript types

## Documentation

Auto generated docs for [KubeVirt API Docs](https://kubevirt-ui.github.io/kubevirt-api/)

## Auto generated using OpenAPI sources:

- Openshift Console - https://github.com/openshift/console
- Kubevirt - https://github.com/kubevirt/kubevirt
- Kubernetes - https://github.com/kubernetes/kubernetes
- Containerized data importer (CDI) - https://github.com/kubevirt/containerized-data-importer

kubevirt API reference:
http://kubevirt.io/api-reference/master/index.html

## Usage

```bash
# Add to your project
yarn add @kubevirt-ui/kubevirt-api
```

```typescript
// Import examples
import { IoK8sApiCoreV1Pod } from '@kubevirt-ui/kubevirt-api/kubernetes';
import { V1VirtualMachine } from '@kubevirt-ui/kubevirt-api/kubevirt';
import { V1beta1DataVolume } from '@kubevirt-ui/kubevirt-api/containerized-data-importer';

import { VirtualMachineModelGroupVersionKind } from '@kubevirt-ui/kubevirt-api/console/models';
import VirtualMachineModel from '@kubevirt-ui/kubevirt-api/console/models/VirtualMachineModel';
```

## Update API

1. Make sure you have all dependencies installed

```bash
yarn
```

2. Go to the `scripts/generate.sh` script and modify the package's version the latest available version.

3. It is essential to remove old API first

```bash
yarn clean:all
```

4. Generate the new API

```bash
yarn generate
```

5. Fix generated API errors:

```bash
yarn generate:fix
```

6. Run linter: (if necesarry fix issues and re-run)

```bash
yarn lint:fix
```

7. Generate docs:

```bash
yarn generate:docs
```
npm package: @kubevirt-ui/components
Description: React Component Library for Kubevirt UI
Author: Yaacov Zamir
Latest version: 0.0.10

[![NPM Version](https://img.shields.io/npm/v/gm.svg?style=flat)](https://www.npmjs.org/package/@kubevirt-ui/components)
[![codecov](https://codecov.io/gh/kubevirt-ui/kubevirt-components/branch/main/graph/badge.svg?token=wkLwgaN6YD)](https://codecov.io/gh/kubevirt-ui/kubevirt-components)
[![DeepSource](https://deepsource.io/gh/kubevirt-ui/kubevirt-components.svg/?label=active+issues&show_trend=true&token=eMPSTlO760qY3rcrQ7I5rK5D)](https://deepsource.io/gh/kubevirt-ui/kubevirt-components/?ref=repository-badge)

# @kubevirt-ui/components

![alt gopher network](https://raw.githubusercontent.com/kubevirt-ui/kubevirt-components/main/images/logos.png)

React Component Library for Kubevirt UI ([API reference](https://kubevirt-ui.github.io/kubevirt-components/))

## Add to your project

```bash
yarn add -D @kubevirt-ui/components
```

## Contributing

When contributing code, use the development server, and check for linting documentation and testing.

Run linter
```bash
yarn lint # or yarn lint:fix to fix trivial linting errors
```

Run tests
```bash
yarn test 
```

Run develpment server (http://localhost:6060):
```bash
yarn styleguide 
```

Run develpment server with cluster proxy (http://localhost:9090):
```bash
yarn styleguide:proxy 
```

Build the static documentation:
```bash
yarn styleguide:build 
```

## When should I contribute my components to this repository?

When a componenet used by an application is stable it can be published in this components repository so public users could: 

- Use the components for exiting new applications
- Study how the component works
- Redistribute the component as they are
- Modified and create better components based on the components in this repository

## How to document my component when contributing to this repository? 

Before moving a component to this repo make sure the code is [documented](https://tsdoc.org/) with descriptions and
examples in a [markdown](https://www.markdownguide.org/) doc as needed to help users who are not familiar with the application
and context understand what is the purpose of the component and how to use it.

## Scope

Kubevirt UI compoents is a curated list of stable and documented components used by Kubevirt UI aplications and libraries.
Kuevirt UI is based on [PatternFly](https://www.patternfly.org/) and [Openshift console](https://github.com/openshift/console), it extend them to create specilized components needed for Kubevirt design.
npm package: @kubevirt-ui/kubevirt-api
Description: kubevirt OpenAPI automation for TypeScript
Author: Yaacov Zamir
Latest version: 1.4.2

[![NPM Version](https://img.shields.io/npm/v/gm.svg?style=flat)](https://www.npmjs.org/package/@kubevirt-ui/kubevirt-api)

# kubevirt-api

![alt gopher network](https://raw.githubusercontent.com/kubevirt-ui/kubevirt-api/main/images/logos.png)

kubevirt OpenAPI automation for TypeScript types

## Documentation

Auto generated docs for [KubeVirt API Docs](https://kubevirt-ui.github.io/kubevirt-api/)

## Auto generated using OpenAPI sources:

- Openshift Console - https://github.com/openshift/console
- Kubevirt - https://github.com/kubevirt/kubevirt
- Kubernetes - https://github.com/kubernetes/kubernetes
- Containerized data importer (CDI) - https://github.com/kubevirt/containerized-data-importer

kubevirt API reference:
http://kubevirt.io/api-reference/master/index.html

## Usage

```bash
# Add to your project
yarn add @kubevirt-ui/kubevirt-api
```

```typescript
// Import examples
import { IoK8sApiCoreV1Pod } from '@kubevirt-ui/kubevirt-api/kubernetes';
import { V1VirtualMachine } from '@kubevirt-ui/kubevirt-api/kubevirt';
import { V1beta1DataVolume } from '@kubevirt-ui/kubevirt-api/containerized-data-importer';

import { VirtualMachineModelGroupVersionKind } from '@kubevirt-ui/kubevirt-api/console/models';
import VirtualMachineModel from '@kubevirt-ui/kubevirt-api/console/models/VirtualMachineModel';
```

## Update API

1. Make sure you have all dependencies installed

```bash
yarn
```

2. Go to the `scripts/generate.sh` script and modify the package's version the latest available version.

3. It is essential to remove old API first

```bash
yarn clean:all
```

4. Generate the new API

```bash
yarn generate
```

5. Fix generated API errors:

```bash
yarn generate:fix
```

6. Run linter: (if necesarry fix issues and re-run)

```bash
yarn lint:fix
```

7. Generate docs:

```bash
yarn generate:docs
```