# adl-vue-components-2

> ## Using Library _TODO:_ This section should describe how to use the compiled npm package in individual service projects.

Latest version **0.0.22** (published 2023-02-10) · 0 weekly downloads

## Install

```sh
npm install adl-vue-components-2
pnpm add adl-vue-components-2
yarn add adl-vue-components-2
bun add adl-vue-components-2
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.22 |
| Published | 2023-02-10 |
| First published | 2023-02-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 18.13.0 |
| Dependencies | 5 |
| Unpacked size | 17.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jeffkynaston |

## Links

- npm: https://www.npmjs.com/package/adl-vue-components-2
- npm.io page: https://npm.io/package/adl-vue-components-2

## Dependencies (5)

- [vue](https://npm.io/package/vue.md) ^3.2.47
- [sass](https://npm.io/package/sass.md) ^1.58.0
- [devextreme](https://npm.io/package/devextreme.md) 22.2.4
- [devextreme-cli](https://npm.io/package/devextreme-cli.md) ^1.5.0
- [devextreme-vue](https://npm.io/package/devextreme-vue.md) 22.2.4

## Recent versions

- 0.0.22 (latest) — 2023-02-10
- 0.0.21 — 2023-02-10
- 0.0.20 — 2023-02-10
- 0.0.19 — 2023-02-10
- 0.0.18 — 2023-02-10
- 0.0.17 — 2023-02-10
- 0.0.16 — 2023-02-10
- 0.0.15 — 2023-02-10
- 0.0.14 — 2023-02-10
- 0.0.13 — 2023-02-10
- 0.0.12 — 2023-02-10
- 0.0.11 — 2023-02-10
- 0.0.10 — 2023-02-10
- 0.0.9 — 2023-02-10
- 0.0.8 — 2023-02-10
- … 1 more at https://npm.io/package/adl-vue-components-2/versions

## README

# Ovation UI Component Library

## Using Library
_TODO:_ This section should describe how to use the compiled npm package in individual service projects.

```sh
# Register with GitLab npm registry
# Reload npm config?
# npm install this package
```

## Setup

1. `git clone git@git.goboomtown.com:services/library/ui-component-library.git` and `cd ui-component-library`
2. `npm ci`
3. `npm run storybook` for storybook and `npm run test` to watch tests.

## Component Structure

All components are inside `src/components`, and should follow the naming convention `CxmDemo` where `Demo` is the component name. This will make it easier for users of the library to use the components, knowing they are all namespaced to `cxm`.

## Storybook

Each component should have a corresponding storybook in the `src/stories` directory. To run storybook, run `npm run storybook`. Build a static version of Storybook with `npm run build-storybook`.

## Testing

Testing is done with a combination of `vitest`, `testing-library/vue`, and `happy-dom`.

### Commands

 - `npm run test` - Runs vitest in watch mode
 - `npm run test:ci` - Runs vitest once, for CI pipeline purposes
 - `npm run test:ui` - Runs Vitest in watch mode, additionally opening a web portal to view test status

## Linting and Formatting

Linting and formatting are both done with `eslint`, configured inside of `package.json` `eslintConfig` configuration property. Your IDE should be able to pick up this eslint configuration and format/lint automatically.

## Building and Publishing

_TODO_

`npm run build` outputs to the `dist` directory.

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## Type Support For `.vue` Imports in TS

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.

---
_Source: https://npm.io/package/adl-vue-components-2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
