Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | 5x 5x 5x 5x 5x 5x 5x 5x 5x 55x 5x 5x 198x 2x 401x 196x 78x 118x 1x 117x 117x 117x 5x 1x 2x 1x 1x 1x 1x 1x 5x | const { join } = require('path');
const commitTypes = require('conventional-commit-types');
/**
* @module Global
*/
/**
* ANSI color codes for console output formatting.
*
* This object provides a set of color constants that can be used to format
* console output text. Each property is an ANSI escape sequence string.
*
* @type {object} Color constants
* @property {string} BLACK - Black text color code
* @property {string} BLUE - Blue text color code
* @property {string} CYAN - Cyan text color code
* @property {string} GREEN - Green text color code
* @property {string} GREY - Grey text color code
* @property {string} MAGENTA - Magenta text color code
* @property {string} NOCOLOR - Reset color code (returns to default)
* @property {string} RED - Red text color code
* @property {string} WHITE - White text color code
* @property {string} YELLOW - Yellow text color code
*/
const color = {
BLACK: '\x1b[30m',
BLUE: '\x1b[34m',
CYAN: '\x1b[36m',
GREEN: '\x1b[32m',
GREY: '\x1b[90m',
MAGENTA: '\x1b[35m',
NOCOLOR: '\x1b[0m',
RED: '\x1b[31m',
WHITE: '\x1b[37m',
YELLOW: '\x1b[33m'
};
/**
* Base directory path for file operations.
*
* This constant determines the working directory for file operations based on the
* current environment. It uses different paths for test, development, and production
* environments.
*
* @type {string} Path to the working directory
* @private
*/
const contextPath =
(process.env.NODE_ENV === 'test' && join('..', 'src', '__fixtures__')) ||
(process.env.NODE_ENV === 'development' && join(__dirname, './__fixtures__')) ||
process.cwd();
/**
* Fallback commit type for non-conventional commits.
*
* This object defines a generic commit type that can be used to categorize commits
* that don't follow the conventional commit format. It's used when the
* "isAllowNonConventionalCommits" option is enabled.
*
* @type {object} General commit type definition
* @property {object} general - General commit type
* @property {string} general.description - Description of the general commit type
* @property {string} general.title - Display title for the general commit type
* @property {string} general.value - Value used for identifying general commits
*/
const generalCommitType = {
general: {
description: 'Commits without category',
title: 'General',
value: 'general'
}
};
/**
* Standard conventional commit types with enhanced structure.
*
* This object transforms the conventional commit types from the 'conventional-commit-types'
* package by adding the key as a 'value' property to each type object. This makes it
* easier to reference the type key when processing commits.
*
* @type {object} Conventional commit types
* @property {object} feat - Feature commit type
* @property {string} feat.description - Description of feature commits
* @property {string} feat.title - Display title for feature commits
* @property {string} feat.value - Value used for identifying feature commits (equals "feat")
* @property {object} fix - Bug fix commit type
* @property {string} fix.description - Description of bug fix commits
* @property {string} fix.title - Display title for bug fix commits
* @property {string} fix.value - Value used for identifying bug fix commits (equals "fix")
* @property {object} chore - Chore commit type
* @property {string} chore.description - Description of chore commits
* @property {string} chore.title - Display title for chore commits
* @property {string} chore.value - Value used for identifying chore commits (equals "chore")
* @property {object} [other] - Other conventional commit types as defined in 'conventional-commit-types'
*/
const conventionalCommitType = (types => {
const updatedTypes = {};
try {
Object.entries(types).forEach(([key, value]) => {
updatedTypes[key] = {
...value,
value: key
};
});
} catch (e) {
console.error(color.RED, `Conventional commit types: ${e.message}`, color.NOCOLOR);
}
return updatedTypes;
})(commitTypes.types);
/**
* Confirm a value is a valid URL or URL-like.
*
* @param {string} str - Confirm a string is a URL
* @param {object} [settings={}] - Configuration options
* @param {Array} [settings.allowedProtocols=['http', 'https']] - List of allowed URL protocols.
* @param {boolean} [settings.isStrict=true] - If `true`, only strict URL validation is performed.
* @returns {boolean}
*/
const isUrl = (str, { allowedProtocols = ['file', 'http', 'https', 'data', 'node', 'git'], isStrict = true } = {}) => {
if (typeof str !== 'string' || !str.trim()) {
return false;
}
const isAllowed = allowedProtocols.some(type => str.toLowerCase().startsWith(`${type}:`));
// Strict and not allowed protocols
if (isStrict && !isAllowed) {
return false;
}
// Not strict and allowed protocols
if (!isStrict && isAllowed) {
return true;
}
// URL validation
try {
new URL(str);
return true;
} catch {
return false;
}
};
/**
* Global configuration options for the changelog generator.
*
* This object stores all configuration options used throughout the application.
* It has a special '_set' property that allows for one-time initialization of
* options, after which the object is frozen to prevent further modifications.
*
* @type {object} Global options
* @property {string} contextPath - Base directory path for file operations
* @property {Function} _set - Setter function for initializing options (used once then removed)
* @property {string} [changelogFile] - Path to the changelog file (set during initialization)
* @property {string} [commitPath] - Path segment for commit links (set during initialization)
* @property {string} [comparePath] - Path segment for compare links (set during initialization)
* @property {boolean} [isDryRun] - Whether to perform a dry run without writing files (set during initialization)
* @property {boolean} [isCommit] - Whether to commit changes to git (set during initialization)
* @property {string} [linkUrl] - Base URL for repository links (set during initialization)
* @property {string} [overrideVersion] - Version to use instead of a calculated version (set during initialization)
* @property {string} [packagePath] - Path to the package.json file (set during initialization)
* @property {string} [remoteDomain] - Domain to use if linkUrl is not provided (set during initialization)
* @property {string} [prPath] - Path segment for pull request links (set during initialization)
*/
const OPTIONS = {
contextPath,
set _set(obj) {
Object.entries(obj).forEach(([key, value]) => {
if (typeof value === 'function') {
this[key] = value.call(this);
return;
}
this[key] = value;
});
delete this._set;
Object.freeze(this);
}
};
module.exports = { color, contextPath, conventionalCommitType, generalCommitType, isUrl, OPTIONS };
|