@homer0/prettier-plugin-jsdoc/src/fns/formatObjects.js

A Prettier plugin to format JSDoc blocks

import * as R from 'ramda';
import { isMatch, replaceDotOnTypeGeneric } from './utils.js';
import { get, createProvider } from './app.js';

/**
 * @typedef {import('../types').PJPTypesOptions} PJPTypesOptions
 */

/**
 * This is the function that actual processes the types and the options of
 * {@link formatObjects}.
 * The reason this is on a separated function is to avoid adding composition inside the
 * `when`.
 *
 * @callback ProcessTypeFn
 * @param {string}          type     The type to format.
 * @param {PJPTypesOptions} options  The customization options.
 * @returns {string}
 */

/**
 * @type {ProcessTypeFn}
 */
export const processType = R.curry((options, type) =>
  R.when(
    R.always(options.jsdocFormatDotForArraysAndObjects),
    get(replaceDotOnTypeGeneric)('Object', options.jsdocUseDotForArraysAndObjects),
  )(type),
);

/**
 * Formats array types depending on the customization options. If the type doesn't contain
 * an array, it will be returned without modifications.
 *
 * @callback FormatObjectsFn
 * @param {string}          type     The type to format.
 * @param {PJPTypesOptions} options  The customization options.
 * @returns {string}
 */

/**
 * @type {FormatObjectsFn}
 */
export const formatObjects = R.curry((type, options) =>
  R.when(get(isMatch)(/Object\s*\.?\s*</i), get(processType)(options))(type),
);

export const provider = createProvider('formatObjects', {
  formatObjects,
  processType,
});