dgeni-packages/nunjucks/rendering/filters/change-case.js

A collection of dgeni packages for generating documentation from source code

const changeCase = require('change-case');

/**
 * @dgRenderFilter lowerCase
 * @description Convert the value to lowercase.
 */
/**
 * @dgRenderFilter pascalCase
 * @description Convert the value to PascalCase.
 */
/**
 * @dgRenderFilter upperCase
 * @description Convert the value to UPPERCASE.
 */
/**
 * @dgRenderFilter swapCase
 * @description Swap the case of the letters in value.
 */
/**
 * @dgRenderFilter pathCase
 * @description Convert the value to/a/path.
 */
/**
 * @dgRenderFilter snakeCase
 * @description Convert the value to snake-case.
 */
/**
 * @dgRenderFilter constantCase
 * @description Convert the value to CONSTANT_CASE.
 */
/**
 * @dgRenderFilter paramCase
 * @description Convert the value to a param-case (sometimes called dash-case).
 */
/**
 * @dgRenderFilter dashCase
 * @description Convert the value to a dash-case (sometimes called param-case).
 */
/**
 * @dgRenderFilter dotCase
 * @description Convert the value to dot.case.
 */
/**
 * @dgRenderFilter camelCase
 * @description Convert the value to camelCase.
 */
/**
 * @dgRenderFilter titleCase
 * @description Convert the value to Title Case.
 */
/**
 * @dgRenderFilter sentenceCase
 * @description Convert the value to Sentence case.
 */


const changers = [
  'no',
  'lower',
  'pascal',
  'upper',
  'swap',
  'path',
  'snake',
  'constant',
  'param',
  'dot',
  'camel',
  'title',
  'sentence'
];

module.exports = changers.map(changer => ({
  name: changer + 'Case',
  process: changeCase[changer],
}));

// Aliases
module.exports.push({
  name: 'dashCase',
  process: changeCase.paramCase
});