# require-strip-json-comments

> Require .json files with comments

Latest version **2.0.0** (published 2020-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install require-strip-json-comments
pnpm add require-strip-json-comments
yarn add require-strip-json-comments
bun add require-strip-json-comments
```

## 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 | 2.0.0 |
| Published | 2020-01-17 |
| First published | 2016-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Dumitru Uzun |
| Maintainers | duzun |
| Keywords | environment, env, util, settings, conf, configuration, config, parse, multiline, comments, trim, delete, remove, strip, json, require |

## Links

- npm: https://www.npmjs.com/package/require-strip-json-comments
- Repository: https://github.com/duzun/require-strip-json-comments
- Homepage: https://github.com/duzun/require-strip-json-comments#readme
- Issues: https://github.com/duzun/require-strip-json-comments/issues
- npm.io page: https://npm.io/package/require-strip-json-comments

## Dependencies (1)

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

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-01-17
- 1.0.2 — 2017-03-24
- 1.0.1 — 2016-03-08
- 1.0.0 — 2016-03-07

## README

# require-strip-json-comments [![Build Status](https://travis-ci.org/duzun/require-strip-json-comments.svg?branch=master)](https://travis-ci.org/duzun/require-strip-json-comments)

Require .json files with comments.

For advanced JSON syntax I recomend using [require-json5](https://www.npmjs.com/package/require-json5),
which can load JSON with trailing commas, unquoted keys, hex numbers, comments, and more.


## Install

```sh
npm i require-strip-json-comments
```

## Usage

1) Load a JSON file which contains comments

```js
var requireJSON = require('require-strip-json-comments');
var config = requireJSON("./config.json");
```

2) Parse a JSON string which contains comments

```js
var requireJSON = require('require-strip-json-comments');
var config = requireJSON.parse('{"name": /*a very important option*/ "value"}');
```

3) Replace `require()`

```js
require('require-strip-json-comments').replace_require();
var config = require("./config");
```

4) Replace `JSON.parse()`

```js
require('require-strip-json-comments').replace_JSON();
var config = JSON.parse('{"name": /*a very important option*/ "value"}');
```

5) Replace `require()` and `JSON.parse()`

```js
require('require-strip-json-comments').replace();
// ...
```

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