# ischema-ts

> A TypeScript interface parser for generating JSON schemas.

Latest version **0.1.2-dev** (published 2019-03-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install ischema-ts
pnpm add ischema-ts
yarn add ischema-ts
bun add ischema-ts
```

Provides the command `ischema`.

## 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.1.2-dev |
| Published | 2019-03-27 |
| First published | 2019-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 44.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | envis10n |
| Maintainers | envis10n |

## Links

- npm: https://www.npmjs.com/package/ischema-ts
- npm.io page: https://npm.io/package/ischema-ts

## Dependencies (2)

- [ajv](https://npm.io/package/ajv.md) ^6.10.0
- [@types/node](https://npm.io/package/@types/node.md) ^11.11.8

## Recent versions

- 0.1.2-dev (latest) — 2019-03-27
- 0.1.1-dev — 2019-03-27
- 0.1.0-dev — 2019-03-27

## README

# ischema

A TypeScript interface parser for generating JSON schemas.

## Usage
Install for CLI: `yarn global add ischema-ts` | `npm i ischema-ts -g`
Run: `ischema` for current directory, or `ischema path/to/directory/`

Mark interfaces for transpilation by wrapping them with: `/* SCHEMA */` and `/* END SCHEMA */`.

Example:

```ts
/* SCHEMA */
interface ITest {
	[key: string]: any;
}
/* END SCHEMA */
```

## Options
Create an `ischema.json` file in the root you will be running ischema in.
```js
{
	"options": {
		"rootDir": ".",
		"outDir": "./schemas"
	}
}
```

Use `ischema --init` or `ischema --init path/to/folder` to create this file for you.

## Known Issues

- Issues parsing function types properly.
- Does not conform types to JSON strict types (yet).

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