# json-schema-sensitivity-checker

> Check the sensitivity of your JSON Schema (including OpenAPI!) documents

Latest version **1.1.0** (published 2023-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install json-schema-sensitivity-checker
pnpm add json-schema-sensitivity-checker
yarn add json-schema-sensitivity-checker
bun add json-schema-sensitivity-checker
```

Provides the command `json-schema-sensitivity-checker`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2023-11-17 |
| First published | 2019-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 823.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Cristiano Betta |
| Maintainers | cbetta |
| Keywords | openapi, oas, check, sensitivity |

## Links

- npm: https://www.npmjs.com/package/json-schema-sensitivity-checker
- npm.io page: https://npm.io/package/json-schema-sensitivity-checker

## Dependencies (7)

- [alex](https://npm.io/package/alex.md) ^11.0.1
- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [remark](https://npm.io/package/remark.md) ^15.0.1
- [yamljs](https://npm.io/package/yamljs.md) ^0.3.0
- [jsonpath](https://npm.io/package/jsonpath.md) ^1.0.2
- [commander](https://npm.io/package/commander.md) ^11.1.0
- [remark-plain-text](https://npm.io/package/remark-plain-text.md) ^0.2.0

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2023-11-17
- 1.0.9 — 2021-05-12
- 1.0.8 — 2021-05-12
- 1.0.7 — 2021-05-12
- 1.0.6 — 2020-06-09
- 1.0.5 — 2020-04-06
- 1.0.4 — 2019-12-30
- 1.0.3 — 2019-12-13
- 1.0.2 — 2019-12-13
- 1.0.1 — 2019-12-13
- 1.0.0 — 2019-12-13

## README

# json-schema-sensitivity-checker

[![npm
version](https://badge.fury.io/js/json-schema-sensitivity-checker.svg)](https://badge.fury.io/js/json-schema-sensitivity-checker)
![ci status](https://github.com/cbetta/json-schema-sensitivity-checker/workflows/Node%20CI/badge.svg)

This CLI allows you to provide a JSONPath expression and run
[`alex`](https://alexjs.com) against any matching lines.

> This tool is currently in alpha and has primarily been tested against OpenAPI
> files. PRs are welcome!

This project is very much inspired by and based on the work done on the
[`json-schema-spell-checker`](https://github.com/mheap/json-schema-spell-checker)
by Michael Heap.

## Installation

```bash
npm install -g json-schema-sensitivity-checker
```

## Usage

Check against specific field names at any depth:

```bash
json-schema-sensitivity-checker -f 'description,title' path/to/openapi.json
```

Alternatively, you can specify a JSONPath expression yourself.

```bash
json-schema-sensitivity-checker -j '$..["description","title"]' path/to/openapi.json
```

## Options

```bash
Usage: bin [options] source-file

Options:
  -V, --version           output the version number
  -t, --text              treat input as plain-text (not markdown)
  -l, --html              treat input as html (not markdown)
  -d, --diff              ignore unchanged lines (affects Travis only)
  -j, --json-path [path]  specify a jsonpath expression to match
  -c, --config [path]     specify a JSON formatted Alex config to pass to every match
  -f, --fields [fields]   specify a comma separated l
```

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