├── .npmrc ├── .gitattributes ├── .gitignore ├── fixture.json ├── .editorconfig ├── test.js ├── .github └── workflows │ └── main.yml ├── readme.md ├── cli.js ├── license └── package.json /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /fixture.json: -------------------------------------------------------------------------------- 1 | {/*rainbows*/"unicorn":"cake"} 2 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import execa from 'execa'; 3 | 4 | test('main', async t => { 5 | const {stdout} = await execa('./cli.js', ['fixture.json']); 6 | t.deepEqual(JSON.parse(stdout), {unicorn: 'cake'}); 7 | }); 8 | 9 | test('stdin', async t => { 10 | const {stdout} = await execa('./cli.js', {input: '{/*rainbows*/"unicorn":"cake"}'}); 11 | t.deepEqual(JSON.parse(stdout), {unicorn: 'cake'}); 12 | }); 13 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | - 16 16 | steps: 17 | - uses: actions/checkout@v3 18 | - uses: actions/setup-node@v3 19 | with: 20 | node-version: ${{ matrix.node-version }} 21 | - run: npm install 22 | - run: npm test 23 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # strip-json-comments-cli 2 | 3 | > Strip comments from JSON. Lets you use comments in your JSON files! 4 | 5 | It also strips trailing commas. 6 | 7 | ## Install 8 | 9 | ```sh 10 | npm install --global strip-json-comments-cli 11 | ``` 12 | 13 | ## Usage 14 | 15 | ``` 16 | $ strip-json-comments --help 17 | 18 | Usage 19 | $ strip-json-comments > 20 | $ strip-json-comments < 21 | 22 | Options 23 | --no-whitespace Remove comments instead of replacing them with whitespace 24 | 25 | Example 26 | $ strip-json-comments input.json > output.json 27 | ``` 28 | 29 | ## Related 30 | 31 | - [strip-json-comments](https://github.com/sindresorhus/strip-json-comments) - API for this module 32 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import process from 'node:process'; 3 | import fs from 'node:fs'; 4 | import getStdin from 'get-stdin'; 5 | import meow from 'meow'; 6 | import stripJsonComments from 'strip-json-comments'; 7 | 8 | const cli = meow(` 9 | Usage 10 | $ strip-json-comments > 11 | $ strip-json-comments < 12 | 13 | Options 14 | --no-whitespace Remove comments instead of replacing them with whitespace 15 | 16 | Example 17 | $ strip-json-comments input.json > output.json 18 | `, { 19 | importMeta: import.meta, 20 | flags: { 21 | whitespace: { 22 | type: 'boolean', 23 | default: true, 24 | }, 25 | }, 26 | }); 27 | 28 | const input = cli.input[0]; 29 | 30 | if (!input && process.stdin.isTTY) { 31 | console.error('Specify a file path'); 32 | process.exit(1); 33 | } 34 | 35 | const data = input ? fs.readFileSync(input, 'utf8') : await getStdin(); 36 | console.log(stripJsonComments(data, {...cli.flags, trailingCommas: true})); 37 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "strip-json-comments-cli", 3 | "version": "3.0.0", 4 | "description": "Strip comments from JSON. Lets you use comments in your JSON files!", 5 | "license": "MIT", 6 | "repository": "sindresorhus/strip-json-comments-cli", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "bin": { 15 | "strip-json-comments": "./cli.js" 16 | }, 17 | "engines": { 18 | "node": ">=16" 19 | }, 20 | "scripts": { 21 | "test": "xo && ava" 22 | }, 23 | "files": [ 24 | "cli.js" 25 | ], 26 | "keywords": [ 27 | "cli-app", 28 | "cli", 29 | "json", 30 | "strip", 31 | "remove", 32 | "delete", 33 | "trim", 34 | "comments", 35 | "multiline", 36 | "parse", 37 | "config", 38 | "configuration", 39 | "settings", 40 | "util", 41 | "env", 42 | "environment" 43 | ], 44 | "dependencies": { 45 | "get-stdin": "^9.0.0", 46 | "meow": "^12.0.1", 47 | "strip-json-comments": "^5.0.1" 48 | }, 49 | "devDependencies": { 50 | "ava": "^5.3.1", 51 | "xo": "^0.55.1" 52 | } 53 | } 54 | --------------------------------------------------------------------------------