@prantlf/jsonlint 11.1.1 → 11.2.0

package/README.md

@@ -74,7 +74,7 @@ By default, `jsonlint` will either report a syntax error with details or pretty-
 
     $ jsonlint -h
 
-    Usage: jsonlint [options] [<file or directory> ...]
+    Usage: jsonlint [options] [<file, directory, pattern> ...]
 
     JSON parser, syntax and schema validator and pretty-printer.
 
@@ -95,7 +95,9 @@ By default, `jsonlint` will either report a syntax error with details or pretty-
       -V, --validate [file]        JSON schema file to use for validation
       -e, --environment [env]      which specification of JSON Schema the
                                    validation file uses
-      -q, --quiet                  do not print the parsed json to stdin
+      -l, --log-files              print only the parsed file names to stdout
+      -q, --quiet                  do not print the parsed json to stdout
+      -n, --continue               continue with other files if an error occurs
       -p, --pretty-print           prettify the input instead of stringifying
                                    the parsed object
       -P, --pretty-print-invalid   force pretty-printing even for invalid input
@@ -112,6 +114,10 @@ By default, `jsonlint` will either report a syntax error with details or pretty-
       -v, --version                output the version number
       -h, --help                   output usage information
 
+    You can use BASH patterns for including and excluding files (only files).
+    Patterns are case-sensitive and have to use slashes as a path separators.
+    A pattern to exclude from processing starts with "!".
+
     Parsing mode can be "cjson" or "json5" to enable other flags automatically.
     If no files or directories are specified, stdin will be parsed. Environments
     for JSON schema validation are "json-schema-draft-04", "json-schema-draft-06"

package/lib/cli.js

@@ -1,24 +1,23 @@
 #!/usr/bin/env node
 
-const fs = require('fs')
-const path = require('path')
-const parser = require('./jsonlint')
-const formatter = require('./formatter')
-const printer = require('./printer')
-const sorter = require('./sorter')
-const validator = require('./validator')
-const pkg = require('../package')
+const { readdirSync, readFileSync, statSync, writeFileSync } = require('fs')
+const { extname, join, normalize } = require('path')
+const { isDynamicPattern, sync } = require('fast-glob')
+const { parse, tokenize } = require('./jsonlint')
+const { format } = require('./formatter')
+const { print } = require('./printer')
+const { sortObject } = require('./sorter')
+const { compile } = require('./validator')
+const { description, version } = require('../package')
 
-function collectExtensions (extension) {
-  return extension.split(',')
-}
+const collectValues = extension => extension.split(',')
 
 const commander = require('commander')
   .name('jsonlint')
-  .usage('[options] [<file or directory> ...]')
-  .description(pkg.description)
+  .usage('[options] [<file, directory, pattern> ...]')
+  .description(description)
   .option('-s, --sort-keys', 'sort object keys (not when prettifying)')
-  .option('-E, --extensions [ext]', 'file extensions to process for directory walk', collectExtensions, ['json', 'JSON'])
+  .option('-E, --extensions [ext]', 'file extensions to process for directory walk', collectValues, ['json', 'JSON'])
   .option('-i, --in-place', 'overwrite the input files')
   .option('-t, --indent [num|char]', 'number of spaces or specific characters to use for indentation', 2)
   .option('-c, --compact', 'compact error display')
@@ -29,7 +28,9 @@ const commander = require('commander')
   .option('-D, --no-duplicate-keys', 'report duplicate object keys as an error')
   .option('-V, --validate [file]', 'JSON schema file to use for validation')
   .option('-e, --environment [env]', 'which specification of JSON Schema the validation file uses')
-  .option('-q, --quiet', 'do not print the parsed json to stdin')
+  .option('-l, --log-files', 'print only the parsed file names to stdout')
+  .option('-q, --quiet', 'do not print the parsed json to stdout')
+  .option('-n, --continue', 'continue with other files if an error occurs')
   .option('-p, --pretty-print', 'prettify the input instead of stringifying the parsed object')
   .option('-P, --pretty-print-invalid', 'force pretty-printing even for invalid input')
   .option('-r, --trailing-newline', 'ensure a line break at the end of the output')
@@ -39,8 +40,12 @@ const commander = require('commander')
   .option('--enforce-double-quotes', 'surrounds all strings with double quotes')
   .option('--enforce-single-quotes', 'surrounds all strings with single quotes (JSON5)')
   .option('--trim-trailing-commas', 'omit trailing commas from objects and arrays (JSON5)')
-  .version(pkg.version, '-v, --version')
+  .version(version, '-v, --version')
   .on('--help', () => {
+    console.log()
+    console.log('You can use BASH patterns for including and excluding files (only files).')
+    console.log('Patterns are case-sensitive and have to use slashes as a path separators.')
+    console.log('A pattern to exclude from processing starts with "!".')
     console.log()
     console.log('Parsing mode can be "cjson" or "json5" to enable other flags automatically.')
     console.log('If no files or directories are specified, stdin will be parsed. Environments')
@@ -50,8 +55,12 @@ const commander = require('commander')
   .parse(process.argv)
 
 const options = commander.opts()
+const extensions = options.extensions.map(extension => '.' + extension)
 
 function logNormalError (error, file) {
+  if (process.exitCode > 0) {
+    console.log()
+  }
   console.log('File:', file)
   console.error(error.message)
 }
@@ -61,7 +70,7 @@ function logCompactError (error, file) {
     ', col ' + error.location.start.column + ', ' + error.reason + '.')
 }
 
-function parse (source, file) {
+function processContents (source, file) {
   let parserOptions, parsed, formatted
   try {
     parserOptions = {
@@ -74,9 +83,9 @@ function parse (source, file) {
     if (options.validate) {
       let validate
       try {
-        const schema = fs.readFileSync(path.normalize(options.validate), 'utf8')
+        const schema = readFileSync(normalize(options.validate), 'utf8')
         parserOptions.environment = options.environment
-        validate = validator.compile(schema, parserOptions)
+        validate = compile(schema, parserOptions)
       } catch (error) {
         const message = 'Loading the JSON schema failed: "' +
           options.validate + '".\n' + error.message
@@ -84,13 +93,13 @@ function parse (source, file) {
       }
       parsed = validate(source, parserOptions)
     } else {
-      parsed = parser.parse(source, parserOptions)
+      parsed = parse(source, parserOptions)
     }
     if (options.prettyPrint) {
       parserOptions.rawTokens = true
-      const tokens = parser.tokenize(source, parserOptions)
+      const tokens = tokenize(source, parserOptions)
       // TODO: Support sorting tor the tokenized input too.
-      return printer.print(tokens, {
+      return print(tokens, {
         indent: options.indent,
         pruneComments: options.pruneComments,
         stripObjectKeys: options.stripObjectKeys,
@@ -100,7 +109,7 @@ function parse (source, file) {
       })
     }
     if (options.sortKeys) {
-      parsed = sorter.sortObject(parsed)
+      parsed = sortObject(parsed)
     }
     return JSON.stringify(parsed, null, options.indent)
   } catch (e) {
@@ -111,9 +120,9 @@ function parse (source, file) {
        * manual formatter because the automatic one is faster and probably more reliable.
        */
       try {
-        formatted = formatter.format(source, options.indent)
+        formatted = format(source, options.indent)
         // Re-parse so exception output gets better line numbers
-        parsed = parser.parse(formatted)
+        parsed = parse(formatted)
       } catch (e) {
         if (options.compact) {
           logCompactError(e, file)
@@ -130,14 +139,21 @@ function parse (source, file) {
         logNormalError(e, file)
       }
     }
-    process.exit(1)
+    if (options.continue) {
+      process.exitCode = 1
+    } else {
+      process.exit(1)
+    }
   }
 }
 
 function processFile (file) {
-  file = path.normalize(file)
-  const original = fs.readFileSync(file, 'utf8')
-  let source = parse(original, file)
+  file = normalize(file)
+  if (options.logFiles) {
+    console.log(file)
+  }
+  const original = readFileSync(file, 'utf8')
+  let source = processContents(original, file)
   if (options.inPlace) {
     const lines = original.split(/\?r\n/)
     const newLine = !lines[lines.length - 1]
@@ -145,56 +161,75 @@ function processFile (file) {
         (options.trailingNewline !== false && newLine)) {
       source += '\n'
     }
-    fs.writeFileSync(file, source)
+    writeFileSync(file, source)
   } else {
-    if (!options.quiet) {
+    if (!(options.quiet || options.logFiles)) {
       console.log(source)
     }
   }
 }
 
-function processSources (src, checkExtension) {
-  const extensions = options.extensions.map(function (extension) {
-    return '.' + extension
-  })
-  let srcStat
+function processSource (src, checkExtension) {
   try {
-    srcStat = fs.statSync(src)
+    const srcStat = statSync(src)
     if (srcStat.isFile()) {
       if (checkExtension) {
-        const ext = path.extname(src)
+        const ext = extname(src)
         if (extensions.indexOf(ext) < 0) {
           return
         }
       }
       processFile(src)
     } else if (srcStat.isDirectory()) {
-      const sources = fs.readdirSync(src)
-      for (let i = 0; i < sources.length; i++) {
-        processSources(path.join(src, sources[i]), true)
+      const sources = readdirSync(src)
+      for (const source of sources) {
+        processSource(join(src, source), true)
       }
     }
-  } catch (err) {
-    console.log('WARN', err.message)
+  } catch ({ message }) {
+    console.log('WARN', message)
+  }
+}
+
+function processPatterns (patterns) {
+  const files = sync(patterns, { onlyFiles: true })
+  if (!files.length) {
+    console.log('no files found')
+    process.exit(1)
+  }
+  for (const file of files) {
+    try {
+      processFile(file)
+    } catch ({ message }) {
+      console.log('WARN', message)
+    }
   }
 }
 
 function main () {
-  const files = commander.args
-  let source = ''
+  const { args: files } = commander
   if (files.length) {
-    for (let i = 0; i < files.length; i++) {
-      processSources(files[i], false)
+    const dynamic = files.some(file => isDynamicPattern(file))
+    if (dynamic) {
+      processPatterns(files)
+    } else {
+      for (const file of files) {
+        processSource(file, false)
+      }
     }
   } else {
+    let source = ''
     const stdin = process.openStdin()
     stdin.setEncoding('utf8')
-    stdin.on('data', function (chunk) {
+    stdin.on('data', chunk => {
       source += chunk.toString('utf8')
     })
-    stdin.on('end', function () {
-      const parsed = parse(source, '<stdin>')
-      if (!options.quiet) {
+    stdin.on('end', () => {
+      if (options.logFiles) {
+        console.log('<stdin>')
+      }
+      const parsed = processContents(source, '<stdin>')
+      if (!(options.quiet || options.logFiles)) {
         console.log(parsed)
       }
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prantlf/jsonlint",
-  "version": "11.1.1",
+  "version": "11.2.0",
   "description": "JSON/CJSON/JSON5 parser, syntax and schema validator and pretty-printer.",
   "author": "Ferdinand Prantl <prantlf@gmail.com> (http://prantl.tk)",
   "contributors": [
@@ -76,7 +76,8 @@
   },
   "dependencies": {
     "ajv": "6.12.6",
-    "commander": "9.2.0"
+    "commander": "9.2.0",
+    "fast-glob": "3.2.11"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",