refactor: Error handling

cli.js

@@ -26,52 +26,152 @@ If file/glob is omitted, './package.json' file will be processed.
  )
 }
 
-function sortPackageJsonFiles(patterns, { isCheck, shouldBeQuiet }) {
- const files = globbySync(patterns)
- const printToStdout = shouldBeQuiet ? () => {} : console.log
+const getFilesCountText = (count) => (count === 1 ? '1 file' : `${count} files`)
+class Reporter {
+ #hasPrinted = false
+ #options
+ #status
+ #logger
+
+ constructor(files, options) {
+ this.#options = options
+ this.#status = {
+ matchedFilesCount: files.length,
+ failedFilesCount: 0,
+ wellSortedFilesCount: 0,
+ changedFilesCount: 0,
+ }
 
- if (files.length === 0) {
- console.error('No matching files.')
- process.exitCode = 2
- return
+ this.#logger = options.shouldBeQuiet
+ ? { log() {}, error() {} }
+ : {
+ log: (...args) => {
+ this.#hasPrinted = true
+ console.log(...args)
+ },
+ error: (...args) => {
+ this.#hasPrinted = true
+ console.error(...args)
+ },
+ }
  }
 
- let notSortedFiles = 0
- for (const file of files) {
- const packageJson = fs.readFileSync(file, 'utf8')
- const sorted = sortPackageJson(packageJson)
+ // The file is well-sorted
+ reportNotChanged(/* file */) {
+ this.#status.wellSortedFilesCount++
+ }
+
+ reportChanged(file) {
+ this.#status.changedFilesCount++
+ this.#logger.log(this.#options.isCheck ? `${file}` : `${file} is sorted!`)
+ }
+
+ reportFailed(file, error) {
+ this.#status.failedFilesCount++
+
+ console.error('Error on: ' + file)
+ this.#logger.error(error.message)
+ }
+
+ printSummary() {
+ const {
+ matchedFilesCount,
+ failedFilesCount,
+ changedFilesCount,
+ wellSortedFilesCount,
+ } = this.#status
+
+ if (matchedFilesCount === 0) {
+ console.error('No matching files.')
+ process.exitCode = 2
+ return
+ }
+
+ const { isCheck, isQuiet } = this.#options
+
+ if (isCheck && changedFilesCount) {
+ process.exitCode = 1
+ }
+
+ if (failedFilesCount) {
+ process.exitCode = 2
+ }
+
+ if (isQuiet) {
+ return
+ }
+
+ const { log } = this.#logger
+
+ // Print an empty line.
+ if (this.#hasPrinted) {
+ log()
+ }
 
- if (sorted !== packageJson) {
+ // Matched files
+ log('Found %s.', getFilesCountText(matchedFilesCount))
+
+ // Failed files
+ if (failedFilesCount) {
+ log(
+ '%s could not be %s.',
+ getFilesCountText(failedFilesCount),
+ isCheck ? 'checked' : 'sorted',
+ )
+ }
+
+ // Changed files
+ if (changedFilesCount) {
  if (isCheck) {
- notSortedFiles++
- printToStdout(file)
- process.exitCode = 1
+ log(
+ '%s %s not sorted.',
+ getFilesCountText(changedFilesCount),
+ changedFilesCount === 1 ? 'was' : 'were',
+ )
  } else {
- fs.writeFileSync(file, sorted)
-
- printToStdout(`${file} is sorted!`)
+ log('%s successfully sorted.', getFilesCountText(changedFilesCount))
  }
  }
+
+ // Well-sorted files
+ if (wellSortedFilesCount) {
+ log(
+ '%s %s already sorted.',
+ getFilesCountText(wellSortedFilesCount),
+ wellSortedFilesCount === 1 ? 'was' : 'were',
+ )
+ }
  }
+}
 
- if (isCheck) {
- // Print a empty line
- printToStdout()
+function sortPackageJsonFile(file, reporter, isCheck) {
+ const original = fs.readFileSync(file, 'utf8')
+ const sorted = sortPackageJson(original)
+ if (sorted === original) {
+ return reporter.reportNotChanged(file)
+ }
 
- if (notSortedFiles) {
- printToStdout(
- notSortedFiles === 1
- ? `${notSortedFiles} of ${files.length} matched file is not sorted.`
- : `${notSortedFiles} of ${files.length} matched files are not sorted.`,
- )
- } else {
- printToStdout(
- files.length === 1
- ? `${files.length} matched file is sorted.`
- : `${files.length} matched files are sorted.`,
- )
+ if (!isCheck) {
+ fs.writeFileSync(file, sorted)
+ }
+
+ reporter.reportChanged(file)
+}
+
+function sortPackageJsonFiles(patterns, options) {
+ const files = globbySync(patterns)
+ const reporter = new Reporter(files, options)
+ const { isCheck } = options
+
+ for (const file of files) {
+ try {
+ sortPackageJsonFile(file, reporter, isCheck)
+ } catch (error) {
+ reporter.reportFailed(file, error)
  }
  }
+
+ reporter.printSummary()
 }
 
 function run() {

tests/cli.js

@@ -1,5 +1,5 @@
-import fs from 'node:fs'
 import test from 'ava'
+import fs from 'node:fs'
 import { cliScript, macro } from './_helpers.js'
 
 const badJson = {
@@ -438,3 +438,53 @@ test('run `cli --check --quiet` on duplicate patterns', macro.testCLI, {
  ],
  message: 'Should not count `bad-1/package.json` more than once. Exit code 1',
 })
+
+const badFormat = ''
+
+test('run `cli --check` on 1 non-json file', macro.testCLI, {
+ fixtures: [
+ {
+ file: 'notJson/package.json',
+ content: badFormat,
+ expect: badFormat,
+ },
+ ],
+ args: ['*/package.json', '--check'],
+ message: 'Should fail to check, but not end execution.',
+})
+
+test('run `cli --check --quiet` on 1 non-json file', macro.testCLI, {
+ fixtures: [
+ {
+ file: 'notJson/package.json',
+ content: badFormat,
+ expect: badFormat,
+ },
+ ],
+ args: ['*/package.json', '--check', '--quiet'],
+ message: 'Should output error message, but not count.',
+})
+
+test('run `cli` on 1 non-json file', macro.testCLI, {
+ fixtures: [
+ {
+ file: 'notJson/package.json',
+ content: badFormat,
+ expect: badFormat,
+ },
+ ],
+ args: ['*/package.json'],
+ message: 'Should fail to check, but not end execution.',
+})
+
+test('run `cli --quiet` on 1 non-json file', macro.testCLI, {
+ fixtures: [
+ {
+ file: 'notJson/package.json',
+ content: badFormat,
+ expect: badFormat,
+ },
+ ],
+ args: ['*/package.json', '--quiet'],
+ message: 'Should output error message',
+})