prettier-plugin-packagejson/lib/index.cjs

Prettier package.json plugin to make the order of properties nice.

const requireSafe = require('./require')
const sortPackageJson = require('./sort-package-json')

const { parsers } =
  requireSafe('prettier/parser-babel') ||
  // istanbul ignore next
  requireSafe('prettier/parser-babylon')

const parser = parsers['json-stringify']

function testPath(path) {
  return /(^|\\|\/)package\.json$/.test(path)
}

exports.testPath = testPath

/** @type {import('prettier').Plugin['parsers']} */
exports.parsers = {
  'json-stringify': {
    ...parser,
    preprocess(text, options) {
      if (parser.preprocess) {
        text = parser.preprocess(text, options)
      }
      const sortPackageJsonOptions =
        options.packageSortOrder.length !== 0
          ? {
              sortOrder: options.packageSortOrder,
            }
          : undefined

      return testPath(options.filepath)
        ? sortPackageJson.default(text, sortPackageJsonOptions)
        : text
    },
  },
}

/** @type {import('prettier').Plugin['options']} */
exports.options = {
  packageSortOrder: {
    category: 'Global',
    type: 'string',
    array: true,
    default: [{ value: [] }],
    description: 'Custom ordering array',
  },
}