# dw-azure-tools-sdk-generation-lib

> This packages includes some basic functionalities and definitions used by sdk generation pipeline.

Latest version **1.0.5** (published 2022-10-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install dw-azure-tools-sdk-generation-lib
pnpm add dw-azure-tools-sdk-generation-lib
yarn add dw-azure-tools-sdk-generation-lib
bun add dw-azure-tools-sdk-generation-lib
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2022-10-31 |
| First published | 2022-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 16 |
| Unpacked size | 129.7 KB |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| Author | Microsoft |
| Maintainers | dw511214992 |

## Links

- npm: https://www.npmjs.com/package/dw-azure-tools-sdk-generation-lib
- npm.io page: https://npm.io/package/dw-azure-tools-sdk-generation-lib

## Dependencies (16)

- [ajv](https://npm.io/package/ajv.md) ^6.12.6
- [colors](https://npm.io/package/colors.md) 1.4.0
- [convict](https://npm.io/package/convict.md) ^6.2.3
- [mongodb](https://npm.io/package/mongodb.md) ^3.6.10
- [typeorm](https://npm.io/package/typeorm.md) ^0.2.37
- [winston](https://npm.io/package/winston.md) 3.7.2
- [hot-shots](https://npm.io/package/hot-shots.md) ^8.5.2
- [memory-fs](https://npm.io/package/memory-fs.md) ^0.5.0
- [node-yaml](https://npm.io/package/node-yaml.md) ^3.2.0
- [jsonc-parser](https://npm.io/package/jsonc-parser.md) ^3.0.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^18.0.3
- [class-validator](https://npm.io/package/class-validator.md) ^0.13.2
- [@azure/event-hubs](https://npm.io/package/@azure/event-hubs.md) ~5.5.1
- [@octokit/auth-app](https://npm.io/package/@octokit/auth-app.md) ^2.4.5
- [@azure/storage-blob](https://npm.io/package/@azure/storage-blob.md) ^12.8.0
- [@azure/swagger-validation-common](https://npm.io/package/@azure/swagger-validation-common.md) ^0.1.2

## Recent versions

- 1.0.5 (latest) — 2022-10-31
- 1.0.1 — 2022-04-19
- 1.0.0 — 2022-04-19

## README

# @azure-tools/sdk-generation-lib

This packages includes some basic functionalities and definitions used by sdk generation pipeline.

## Install

```shell
npm i @azure-tools/sdk-generation-lib
```

# Functionalities

| Functionalities  | Description                                                                  |
|------------------|------------------------------------------------------------------------------|
| runScript        | Run any kind of script/command os supported.                                 |
| createTaskResult | It parses the logs produced by tasks, and generate a summarized task result. |
| executeTask      | The wrapper of `runScript` and `createTaskResult`.                           |
| logger           | The logger instance can be used by sdk generation pipeline.                  |
| getTask          | Get task configuration from sdk repo's task configuration.                   |

# Definitions

| Definitions             | Description                                            |
|-------------------------|--------------------------------------------------------|
| CodegenToSdkConfig      | The configuration type of `codegen_to_sdk_config.json` |
| InitOptions             | The configuration type of init task.                   |
| GenerateAndBuildOptions | The configuration type of generate and build task.     |
| MockTestOptions         | The configuration type of mock test task.              |
| RunOptions              | The configuration type of running script.              |
| LogFilter               | The configuration type of filtering log.               |
| InitOutput              | The output type of init task.                          |
| GenerateAndBuildInput   | The input type of generate and build task.             |
| GenerateAndBuildOutput  | The output type of generate and build task.            |
| MockTestInput           | The input type of mock test task.                      |
| TestOutput              | The output type of mock test task.                     |
| TaskResultStatus        | The task status.                                       |
| TaskResult              | The details of a task result.                          |

---
_Source: https://npm.io/package/dw-azure-tools-sdk-generation-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._