# tur

> Create a composed YAML file using $include tag.

Latest version **0.0.1** (published 2018-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install tur
pnpm add tur
yarn add tur
bun add tur
```

Provides the command `tur`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2018-02-28 |
| First published | 2018-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 21.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Francesco Bianco |
| Maintainers | francescobianco |

## Links

- npm: https://www.npmjs.com/package/tur
- Repository: https://github.com/javanile/tur
- Homepage: https://github.com/javanile/tur#readme
- Issues: https://github.com/javanile/tur/issues
- npm.io page: https://npm.io/package/tur

## Dependencies (5)

- [cuid](https://npm.io/package/cuid.md) ^2.1.0
- [colors](https://npm.io/package/colors.md) ^1.1.2
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0
- [chokidar](https://npm.io/package/chokidar.md) ^1.6.1
- [deepmerge](https://npm.io/package/deepmerge.md) ^2.0.1

## Recent versions

- 0.0.1 (latest) — 2018-02-28

## README

# Yamlinc
Create a composed YAML file using $include tag. 

[![Build Status](https://travis-ci.org/javanile-bot/yamlinc.svg?branch=master)](https://travis-ci.org/javanile-bot/yamlinc)
[![Test Coverage](https://api.codeclimate.com/v1/badges/43662de1f27dc3629953/test_coverage)](https://codeclimate.com/github/javanile-bot/yamlinc/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/43662de1f27dc3629953/maintainability)](https://codeclimate.com/github/javanile-bot/yamlinc/maintainability)

## Simple usage

1. Install global tur command-line utility
```bash
$ npm install tur -g
```

2. Create "my_swagger_doc.yml" and split it into multiple file  
```yaml
## file: my_swagger_doc.yml
version: '2.0'
$include: ./tags.yml
$include: ./paths.yml
```
```yaml
## file: tags.yml
tags:
- FirstTag
- SecondTag
```
```yaml
## file: paths.yml
paths:
  /api/me:
    get: ...      
  /api/you:
    post: ...
  $include: others-paths.yml
```
```yaml
## file: others-paths.yml
/api/other/one:
  get: ...      
/api/other/two:
  post: ...
```

3. Simply compile the entry point 'my_swagger_doc.yml'
```
$ tur my_swagger_doc.yml
```

4. Get your compiled file 'my_swagger_doc.inc.yml'
> **NOTICE:** Ymalinc append '*.inc.yml' extension to compiled file.

## Develompment watcher
During development you need costantily updated compiled file by watching changes of dependences

```
$ tur --watch spectacle -d my_swagger_doc.yml
```

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