docs: corrected typos in jsdocs
This commit is contained in:
		
							parent
							
								
									b7aeabad93
								
							
						
					
					
						commit
						4652cef1e6
					
				| @ -44,7 +44,7 @@ module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => { | |||||||
|     const gitCredentials = `${GIT_TOKENS[envVar] || ''}${env[envVar] || ''}`; |     const gitCredentials = `${GIT_TOKENS[envVar] || ''}${env[envVar] || ''}`; | ||||||
| 
 | 
 | ||||||
|     if (gitCredentials) { |     if (gitCredentials) { | ||||||
|       // If credentials are set via anvironment variables, convert the URL to http/https and add basic auth, otherwise return `repositoryUrl` as is
 |       // If credentials are set via environment variables, convert the URL to http/https and add basic auth, otherwise return `repositoryUrl` as is
 | ||||||
|       const [match, auth, host, path] = /^(?!.+:\/\/)(?:(.*)@)?(.*?):(.*)$/.exec(repositoryUrl) || []; |       const [match, auth, host, path] = /^(?!.+:\/\/)(?:(.*)@)?(.*?):(.*)$/.exec(repositoryUrl) || []; | ||||||
|       return format({ |       return format({ | ||||||
|         ...parse(match ? `ssh://${auth ? `${auth}@` : ''}${host}/${path}` : repositoryUrl), |         ...parse(match ? `ssh://${auth ? `${auth}@` : ''}${host}/${path}` : repositoryUrl), | ||||||
|  | |||||||
| @ -28,7 +28,7 @@ module.exports = async ({cwd, env, options: {tagFormat}, logger}) => { | |||||||
|   // Generate a regex to parse tags formatted with `tagFormat`
 |   // Generate a regex to parse tags formatted with `tagFormat`
 | ||||||
|   // by replacing the `version` variable in the template by `(.+)`.
 |   // by replacing the `version` variable in the template by `(.+)`.
 | ||||||
|   // The `tagFormat` is compiled with space as the `version` as it's an invalid tag character,
 |   // The `tagFormat` is compiled with space as the `version` as it's an invalid tag character,
 | ||||||
|   // so it's guaranteed to no be present in the `tagFormat`.
 |   // so it's guaranteed to not be present in the `tagFormat`.
 | ||||||
|   const tagRegexp = `^${escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)')}`; |   const tagRegexp = `^${escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)')}`; | ||||||
|   const tags = (await getTags({cwd, env})) |   const tags = (await getTags({cwd, env})) | ||||||
|     .map(tag => ({gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]})) |     .map(tag => ({gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]})) | ||||||
|  | |||||||
| @ -4,7 +4,7 @@ const AggregateError = require('aggregate-error'); | |||||||
| const {extractErrors} = require('../utils'); | const {extractErrors} = require('../utils'); | ||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * A Function that execute a list of function sequencially. If at least one Function ins the pipeline throw an Error or rejects, the pipeline function rejects as well. |  * A Function that execute a list of function sequencially. If at least one Function ins the pipeline throws an Error or rejects, the pipeline function rejects as well. | ||||||
|  * |  * | ||||||
|  * @typedef {Function} Pipeline |  * @typedef {Function} Pipeline | ||||||
|  * @param {Any} input Argument to pass to the first step in the pipeline. |  * @param {Any} input Argument to pass to the first step in the pipeline. | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user