# shush

> Sugar for silencing JSON comments.

Latest version **1.0.4** (published 2023-05-22) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-05-22 |
| First published | 2013-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 89 |
| Author | Erik Toth |
| Maintainers | aredridel, totherik, shaunwarman, kumarrishav, shirhuang |

## Links

- npm: https://www.npmjs.com/package/shush
- Repository: https://github.com/totherik/shush
- Issues: https://github.com/totherik/shush/issues
- npm.io page: https://npm.io/package/shush

## Dependencies (2)

- [caller](https://npm.io/package/caller.md) ^1.1.0
- [strip-json-comments](https://npm.io/package/strip-json-comments.md) ^3.1.1

## Recent versions

- 1.0.4 (latest) — 2023-05-22
- 1.0.3 — 2023-04-03
- 1.0.2 — 2022-07-06
- 1.0.1 — 2022-03-05
- 1.0.0 — 2015-04-14
- 0.0.1 — 2013-12-22

## README

##### shush
Hush up those JSON comments.

`shush` is a simple node module that allows JSON files containing comments to be read into
a module using a `require`-like syntax.

```json
/* jsonWithComments.js */
{
    // a property
    "myProp": "isCool"
}
```
```javascript
// foo.js
var shush = require('shush'),
    config = shush('./jsonWithComments');

console.log(config); // {"myProp": "isCool"}
```

```javascript
// foo.js es6 modules
import shush from 'shush';
const config = shush('./jsonWithComments.json');

console.log(config); // {"myProp": "isCool"}
```

Forthcoming feature: streaming.

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