6048492526

Committed 01 Sep 2023 10:44AM UTC coverage: 89.654% (-0.04%) from 89.697%

Build # 6048492526

Build Type

push

github

Committed by

web-flow

Commit Message

feat(conventional-changelog-preset-loader): throw error if preset does not export a function (#1115)

Run Details

1227 of 1391 branches covered (0.0%)

2 of 4 new or added lines in 1 file covered. (50.0%)

3293 of 3673 relevant lines covered (89.65%)

37136.09 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.86

/packages/conventional-changelog-preset-loader/index.js

'use strict'

const path = require('path')

module.exports.loadPreset = createPresetLoader((preset) => import(preset))
module.exports.createPresetLoader = createPresetLoader

/**
 * @typedef {((moduleName: string) => any) | ((moduleName: string) => Promise<any>)} ModuleLoader
 */

/**
 * @typedef {{ name: string }} PresetParams
 */

/**
 * Trying to add 'conventional-changelog-' prefix to preset name if it is a shorthand.
 * @param {string} preset - Absolute path, package name or shorthand preset name.
 * @returns Variants of preset names.
 */
function resolvePresetNameVariants (preset) {
  if (path.isAbsolute(preset)) {
    return [preset]
  }

  let scope = ''
  let name = preset.toLocaleLowerCase()

  if (preset[0] === '@') {
    const parts = preset.split('/')

    scope = parts.shift() + '/'

    if (scope === '@conventional-changelog/') {
      return [preset]
    }

    name = parts.join('/')
  }

  if (!name.startsWith('conventional-changelog-')) {
    name = `conventional-changelog-${name}`
  }

  const altPreset = `${scope}${name}`

  if (altPreset !== preset) {
    return [altPreset, preset]
  }

  return [preset]
}

/**
 * Loads module with fallbacks.
 * @param {ModuleLoader} moduleLoader - Function that loads module.
 * @param {string[]} variants - Variants of module name to try.
 * @returns {Promise<any>} Loaded module.
 */
async function loadWithFallbacks (moduleLoader, variants) {
  let error = null

  for (const variant of variants) {
    try {
      return await moduleLoader(variant)
    } catch (err) {
      if (!error) {
        error = err
      }
    }
  }

  throw error
}

/**
 * Gets default export from CommonJS or ES module.
 * @param {object} module
 * @returns {object}
 */
function getModuleDefaultExport (module) {
  if ((module.__esModule || Object.getPrototypeOf(module) === null) && module.default) {
    return module.default
  }

  return module
}

/**
 * Creates preset loader.
 * @param {ModuleLoader} moduleLoader - Function that loads module.
 * @returns {(presetOrParams: string | PresetParams) => Promise<any>} Function that loads preset.
 */
function createPresetLoader (moduleLoader) {
  return async function loadPreset (presetOrParams) {
    let preset = ''
    let params = null

    if (typeof presetOrParams === 'string') {
      preset = presetOrParams
    } else
      if (typeof presetOrParams === 'object' && typeof presetOrParams.name === 'string') {
        preset = presetOrParams.name
        params = presetOrParams
      } else {
        throw Error('Preset must be string or object with property `name`')
      }

    const presetNameVariants = resolvePresetNameVariants(preset)
    let createPreset = null

    try {
      createPreset = getModuleDefaultExport(await loadWithFallbacks(moduleLoader, presetNameVariants))
    } catch (err) {
      throw Error(`Unable to load the "${preset}" preset. Please make sure it's installed.`, { cause: err })
    }

    if (typeof createPreset !== 'function') {
      throw Error(`The "${preset}" preset does not export a function. Maybe you are using an old version of the preset. Please upgrade.`)
    }

    return params
      ? await createPreset(params)
      : await createPreset()
  }
}

1	'use strict'	9✔
2		9✔
3	const path = require('path')	9✔
4		9✔
5	module.exports.loadPreset = createPresetLoader((preset) => import(preset))	9✔
6	module.exports.createPresetLoader = createPresetLoader	9✔
7		9✔
8	/**	9✔
9	* @typedef {((moduleName: string) => any) \| ((moduleName: string) => Promise<any>)} ModuleLoader	9✔
10	*/	9✔
11		9✔
12	/**	9✔
13	* @typedef {{ name: string }} PresetParams	9✔
14	*/	9✔
15		9✔
16	/**	9✔
17	* Trying to add 'conventional-changelog-' prefix to preset name if it is a shorthand.	9!
18	* @param {string} preset - Absolute path, package name or shorthand preset name.	57✔
19	* @returns Variants of preset names.	57!
20	*/	×
21	function resolvePresetNameVariants (preset) {	39✔
22	if (path.isAbsolute(preset)) {	39✔
23	return [preset]	6✔
24	}	6✔
25		33✔
26	let scope = ''	33✔
27	let name = preset.toLocaleLowerCase()	33✔
28		33✔
29	if (preset[0] === '@') {	39✔
30	const parts = preset.split('/')	18✔
31		18✔
32	scope = parts.shift() + '/'	18✔
33		18✔
34	if (scope === '@conventional-changelog/') {	18✔
35	return [preset]	3✔
36	}	3✔
37		15✔
38	name = parts.join('/')	15✔
39	}	15✔
40		30✔
41	if (!name.startsWith('conventional-changelog-')) {	39!
42	name = `conventional-changelog-${name}`	18✔
43	}	18✔
44		30✔
45	const altPreset = `${scope}${name}`	30✔
46		30✔
47	if (altPreset !== preset) {	39✔
48	return [altPreset, preset]	18✔
49	}	18✔
50		12✔
51	return [preset]	12✔
52	}	12✔
53		9✔
54	/**	9✔
55	* Loads module with fallbacks.	9✔
56	* @param {ModuleLoader} moduleLoader - Function that loads module.	57✔
57	* @param {string[]} variants - Variants of module name to try.	57✔
58	* @returns {Promise<any>} Loaded module.	66✔
59	*/	18✔
60	async function loadWithFallbacks (moduleLoader, variants) {	39✔
61	let error = null	39✔
62		39✔
63	for (const variant of variants) {	39✔
64	try {	45✔
65	return await moduleLoader(variant)	45✔
66	} catch (err) {	48✔
67	if (!error) {	48✔
68	error = err	48✔
69	}	48✔
70	}	48✔
71	}	48✔
72		48!
73	throw error	48✔
74	}	48✔
75		48✔
76	/**	48✔
77	* Gets default export from CommonJS or ES module.	48✔
78	* @param {object} module	48!
79	* @returns {object}	9✔
80	*/	9✔
81	function getModuleDefaultExport (module) {	39✔
82	if ((module.__esModule \|\| Object.getPrototypeOf(module) === null) && module.default) {	39!
83	return module.default	×
84	}	×
85		39✔
86	return module	39✔
87	}	9✔
88		9✔
89	/**	9✔
90	* Creates preset loader.	9✔
91	* @param {ModuleLoader} moduleLoader - Function that loads module.	9✔
92	* @returns {(presetOrParams: string \| PresetParams) => Promise<any>} Function that loads preset.	57✔
93	*/	39✔
94	function createPresetLoader (moduleLoader) {	42✔
95	return async function loadPreset (presetOrParams) {	42✔
96	let preset = ''	39✔
97	let params = null	39✔
98		39✔
99	if (typeof presetOrParams === 'string') {	39✔
100	preset = presetOrParams	36!
101	} else	39✔
102	if (typeof presetOrParams === 'object' && typeof presetOrParams.name === 'string') {	3✔
103	preset = presetOrParams.name	3✔
104	params = presetOrParams	3✔
105	} else {	3!
106	throw Error('Preset must be string or object with property `name`')	×
107	}	×
108		39✔
109	const presetNameVariants = resolvePresetNameVariants(preset)	39✔
110	let createPreset = null	39✔
111		39✔
112	try {	39✔
113	createPreset = getModuleDefaultExport(await loadWithFallbacks(moduleLoader, presetNameVariants))	39!
114	} catch (err) {	39!
115	throw Error(`Unable to load the "${preset}" preset. Please make sure it's installed.`, { cause: err })	✔
116	}	×
117		39✔
118	if (typeof createPreset !== 'function') {	39!
NEW 119	throw Error(`The "${preset}" preset does not export a function. Maybe you are using an old version of the preset. Please upgrade.`)	×
NEW 120	}	×
121		39✔
122	return params	39✔
123	? await createPreset(params)	39✔
124	: await createPreset()	39✔
125	}	39✔
126	}	42✔

conventional-changelog / conventional-changelog / 6048492526

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous