style: Update style for Prettier 1.8.0
This commit is contained in:
		
							parent
							
								
									470697c01d
								
							
						
					
					
						commit
						17a600672f
					
				| @ -59,7 +59,7 @@ | |||||||
|     "npm-registry-couchapp": "^2.6.12", |     "npm-registry-couchapp": "^2.6.12", | ||||||
|     "nyc": "^11.2.1", |     "nyc": "^11.2.1", | ||||||
|     "p-map-series": "^1.0.0", |     "p-map-series": "^1.0.0", | ||||||
|     "prettier": "^1.8.0", |     "prettier": "~1.8.0", | ||||||
|     "proxyquire": "^1.8.0", |     "proxyquire": "^1.8.0", | ||||||
|     "rimraf": "^2.5.0", |     "rimraf": "^2.5.0", | ||||||
|     "sinon": "^4.0.0", |     "sinon": "^4.0.0", | ||||||
|  | |||||||
| @ -8,7 +8,7 @@ const logger = require('./logger'); | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Commit message. |  * Commit message. | ||||||
|  *  |  * | ||||||
|  * @typedef {Object} Commit |  * @typedef {Object} Commit | ||||||
|  * @property {string} hash The commit hash. |  * @property {string} hash The commit hash. | ||||||
|  * @property {string} message The commit message. |  * @property {string} message The commit message. | ||||||
| @ -16,7 +16,7 @@ const logger = require('./logger'); | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Last release. |  * Last release. | ||||||
|  *  |  * | ||||||
|  * @typedef {Object} LastRelease |  * @typedef {Object} LastRelease | ||||||
|  * @property {string} version The version number of the last release. |  * @property {string} version The version number of the last release. | ||||||
|  * @property {string} [gitHead] The commit sha used to make the last release. |  * @property {string} [gitHead] The commit sha used to make the last release. | ||||||
| @ -24,7 +24,7 @@ const logger = require('./logger'); | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Result object. |  * Result object. | ||||||
|  *  |  * | ||||||
|  * @typedef {Object} Result |  * @typedef {Object} Result | ||||||
|  * @property {Array<Commit>} commits The list of commits since the last release. |  * @property {Array<Commit>} commits The list of commits since the last release. | ||||||
|  * @property {LastRelease} lastRelease The updated lastRelease. |  * @property {LastRelease} lastRelease The updated lastRelease. | ||||||
| @ -32,7 +32,7 @@ const logger = require('./logger'); | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Retrieve the list of commits on the current branch since the last released version, or all the commits of the current branch if there is no last released version. |  * Retrieve the list of commits on the current branch since the last released version, or all the commits of the current branch if there is no last released version. | ||||||
|  *  |  * | ||||||
|  * The commit correspoding to the last released version is determined as follow: |  * The commit correspoding to the last released version is determined as follow: | ||||||
|  * - Use `lastRelease.gitHead` if defined and present in `branch` history. |  * - Use `lastRelease.gitHead` if defined and present in `branch` history. | ||||||
|  * - If `lastRelease.gitHead` is not in the `branch` history, unshallow the repository and try again. |  * - If `lastRelease.gitHead` is not in the `branch` history, unshallow the repository and try again. | ||||||
| @ -41,9 +41,9 @@ const logger = require('./logger'); | |||||||
|  * @param {LastRelease} lastRelease The lastRelease object obtained from the getLastRelease plugin. |  * @param {LastRelease} lastRelease The lastRelease object obtained from the getLastRelease plugin. | ||||||
|  * @param {string} branch The branch to release from. |  * @param {string} branch The branch to release from. | ||||||
|  * @param {Object} logger Global logger. |  * @param {Object} logger Global logger. | ||||||
|  *  |  * | ||||||
|  * @return {Promise<Result>} The list of commits on the branch `branch` since the last release and the updated lastRelease with the gitHead used to retrieve the commits. |  * @return {Promise<Result>} The list of commits on the branch `branch` since the last release and the updated lastRelease with the gitHead used to retrieve the commits. | ||||||
|  *  |  * | ||||||
|  * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `lastRelease.gitHead` or the commit sha derived from `config.lastRelease.version` is not in the direct history of `branch`. |  * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `lastRelease.gitHead` or the commit sha derived from `config.lastRelease.version` is not in the direct history of `branch`. | ||||||
|  * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `lastRelease.gitHead` is undefined and no commit sha can be found for the `config.lastRelease.version`. |  * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `lastRelease.gitHead` is undefined and no commit sha can be found for the `config.lastRelease.version`. | ||||||
|  */ |  */ | ||||||
| @ -68,13 +68,13 @@ module.exports = async ({version, gitHead}, branch) => { | |||||||
|   } |   } | ||||||
| 
 | 
 | ||||||
|   Object.assign(gitLogParser.fields, {hash: 'H', message: 'B', gitTags: 'd', committerDate: {key: 'ci', type: Date}}); |   Object.assign(gitLogParser.fields, {hash: 'H', message: 'B', gitTags: 'd', committerDate: {key: 'ci', type: Date}}); | ||||||
|   const commits = (await getStream.array( |   const commits = (await getStream.array(gitLogParser.parse({_: `${gitHead ? gitHead + '..' : ''}HEAD`}))).map( | ||||||
|     gitLogParser.parse({_: `${gitHead ? gitHead + '..' : ''}HEAD`}) |     commit => { | ||||||
|   )).map(commit => { |       commit.message = commit.message.trim(); | ||||||
|     commit.message = commit.message.trim(); |       commit.gitTags = commit.gitTags.trim(); | ||||||
|     commit.gitTags = commit.gitTags.trim(); |       return commit; | ||||||
|     return commit; |     } | ||||||
|   }); |   ); | ||||||
|   logger.log('Found %s commits since last release', commits.length); |   logger.log('Found %s commits since last release', commits.length); | ||||||
|   debug('Parsed commits: %o', commits); |   debug('Parsed commits: %o', commits); | ||||||
|   return {commits, lastRelease: {version, gitHead}}; |   return {commits, lastRelease: {version, gitHead}}; | ||||||
| @ -85,18 +85,24 @@ function noGitHeadMessage(branch, version) { | |||||||
| This means semantic-release can not extract the commits between now and then. | This means semantic-release can not extract the commits between now and then. | ||||||
| This is usually caused by releasing from outside the repository directory or with innaccessible git metadata. | This is usually caused by releasing from outside the repository directory or with innaccessible git metadata. | ||||||
| 
 | 
 | ||||||
| You can recover from this error by creating a tag for the version "${version}" on the commit corresponding to this release: | You can recover from this error by creating a tag for the version "${ | ||||||
|  |     version | ||||||
|  |   }" on the commit corresponding to this release: | ||||||
| $ git tag -f v${version} <commit sha1 corresponding to last release> | $ git tag -f v${version} <commit sha1 corresponding to last release> | ||||||
| $ git push -f --tags origin ${branch} | $ git push -f --tags origin ${branch} | ||||||
| `;
 | `;
 | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| function notInHistoryMessage(gitHead, branch, version) { | function notInHistoryMessage(gitHead, branch, version) { | ||||||
|   return `The commit the last release of this package was derived from is not in the direct history of the "${branch}" branch.
 |   return `The commit the last release of this package was derived from is not in the direct history of the "${ | ||||||
|  |     branch | ||||||
|  |   }" branch. | ||||||
| This means semantic-release can not extract the commits between now and then. | This means semantic-release can not extract the commits between now and then. | ||||||
| This is usually caused by force pushing, releasing from an unrelated branch, or using an already existing package name. | This is usually caused by force pushing, releasing from an unrelated branch, or using an already existing package name. | ||||||
| 
 | 
 | ||||||
| You can recover from this error by restoring the commit "${gitHead}" or by creating a tag for the version "${version}" on the commit corresponding to this release: | You can recover from this error by restoring the commit "${gitHead}" or by creating a tag for the version "${ | ||||||
|  |     version | ||||||
|  |   }" on the commit corresponding to this release: | ||||||
| $ git tag -f v${version || '<version>'} <commit sha1 corresponding to last release> | $ git tag -f v${version || '<version>'} <commit sha1 corresponding to last release> | ||||||
| $ git push -f --tags origin ${branch} | $ git push -f --tags origin ${branch} | ||||||
| `;
 | `;
 | ||||||
|  | |||||||
| @ -7,7 +7,7 @@ const {debugShell} = require('./debug'); | |||||||
|  * Get the commit sha for a given tag. |  * Get the commit sha for a given tag. | ||||||
|  * |  * | ||||||
|  * @param {string} tagName Tag name for which to retrieve the commit sha. |  * @param {string} tagName Tag name for which to retrieve the commit sha. | ||||||
|  *  |  * | ||||||
|  * @return {string} The commit sha of the tag in parameter or `null`. |  * @return {string} The commit sha of the tag in parameter or `null`. | ||||||
|  */ |  */ | ||||||
| async function gitTagHead(tagName) { | async function gitTagHead(tagName) { | ||||||
| @ -23,9 +23,9 @@ async function gitTagHead(tagName) { | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Verify if the commist `sha` is in the direct history of the current branch. |  * Verify if the commist `sha` is in the direct history of the current branch. | ||||||
|  *  |  * | ||||||
|  * @param {string} sha The sha of the commit to look for. |  * @param {string} sha The sha of the commit to look for. | ||||||
|  *  |  * | ||||||
|  * @return {boolean} `true` if the commit `sha` is in the history of the current branch, `false` otherwise. |  * @return {boolean} `true` if the commit `sha` is in the history of the current branch, `false` otherwise. | ||||||
|  */ |  */ | ||||||
| async function isCommitInHistory(sha) { | async function isCommitInHistory(sha) { | ||||||
| @ -39,9 +39,9 @@ async function isCommitInHistory(sha) { | |||||||
|  * |  * | ||||||
|  * @param {string} gitHead The commit sha to look for. |  * @param {string} gitHead The commit sha to look for. | ||||||
|  * @param {string} version The version corresponding to the commit sha to look for. Used to search in git tags. |  * @param {string} version The version corresponding to the commit sha to look for. Used to search in git tags. | ||||||
|  *  |  * | ||||||
|  * @return {Promise<string>} A Promise that resolves to the commit sha of the version, either `gitHead` of the commit associated with the `version` tag. |  * @return {Promise<string>} A Promise that resolves to the commit sha of the version, either `gitHead` of the commit associated with the `version` tag. | ||||||
|  *  |  * | ||||||
|  * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `gitHead` or the commit sha dereived from `version` is not in the direct history of `branch`. |  * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `gitHead` or the commit sha dereived from `version` is not in the direct history of `branch`. | ||||||
|  * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `gitHead` is undefined and no commit sha can be found for the `version`. |  * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `gitHead` is undefined and no commit sha can be found for the `version`. | ||||||
|  */ |  */ | ||||||
|  | |||||||
| @ -7,9 +7,9 @@ module.exports = { | |||||||
|   log(...args) { |   log(...args) { | ||||||
|     const [format, ...rest] = args; |     const [format, ...rest] = args; | ||||||
|     console.log( |     console.log( | ||||||
|       `${chalk.grey('[Semantic release]:')}${typeof format === 'string' |       `${chalk.grey('[Semantic release]:')}${ | ||||||
|         ? ` ${format.replace(/%[^%]/g, seq => chalk.magenta(seq))}` |         typeof format === 'string' ? ` ${format.replace(/%[^%]/g, seq => chalk.magenta(seq))}` : '' | ||||||
|         : ''}`,
 |       }`,
 | ||||||
|       ...(typeof format === 'string' ? [] : [format]).concat(rest) |       ...(typeof format === 'string' ? [] : [format]).concat(rest) | ||||||
|     ); |     ); | ||||||
|   }, |   }, | ||||||
|  | |||||||
| @ -5,7 +5,7 @@ import pMapSeries from 'p-map-series'; | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Commit message informations. |  * Commit message informations. | ||||||
|  *  |  * | ||||||
|  * @typedef {Object} Commit |  * @typedef {Object} Commit | ||||||
|  * @property {string} branch The commit branch. |  * @property {string} branch The commit branch. | ||||||
|  * @property {string} hash The commit hash. |  * @property {string} hash The commit hash. | ||||||
| @ -13,13 +13,13 @@ import pMapSeries from 'p-map-series'; | |||||||
|  */ |  */ | ||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|   * Create a temporary git repository and change the current working directory to the repository root. |  * Create a temporary git repository and change the current working directory to the repository root. | ||||||
|   * |  * | ||||||
|   * @method gitCommits |  * @method gitCommits | ||||||
|   * @param {Array<Commit>} commits the created commits. |  * @param {Array<Commit>} commits the created commits. | ||||||
|   *  |  * | ||||||
|   * @return {string} The path of the repository. |  * @return {string} The path of the repository. | ||||||
|   */ |  */ | ||||||
| export async function gitRepo() { | export async function gitRepo() { | ||||||
|   const dir = tempy.directory(); |   const dir = tempy.directory(); | ||||||
| 
 | 
 | ||||||
| @ -34,7 +34,7 @@ export async function gitRepo() { | |||||||
|  * Create commits on the current git repository. |  * Create commits on the current git repository. | ||||||
|  * |  * | ||||||
|  * @param {Array<string>} messages commit messages. |  * @param {Array<string>} messages commit messages. | ||||||
|  *  |  * | ||||||
|  * @returns {Array<Commit>} The created commits, in reverse order (to match `git log` order). |  * @returns {Array<Commit>} The created commits, in reverse order (to match `git log` order). | ||||||
|  */ |  */ | ||||||
| export async function gitCommits(messages) { | export async function gitCommits(messages) { | ||||||
| @ -49,7 +49,7 @@ export async function gitCommits(messages) { | |||||||
|  * Amend a commit (rewriting the sha) on the current git repository. |  * Amend a commit (rewriting the sha) on the current git repository. | ||||||
|  * |  * | ||||||
|  * @param {string} messages commit message. |  * @param {string} messages commit message. | ||||||
|  *  |  * | ||||||
|  * @returns {Array<Commit>} the created commits. |  * @returns {Array<Commit>} the created commits. | ||||||
|  */ |  */ | ||||||
| export async function gitAmmendCommit(msg) { | export async function gitAmmendCommit(msg) { | ||||||
| @ -105,7 +105,7 @@ export async function gitLog() { | |||||||
| /** | /** | ||||||
|  * Create a shallow clone of a git repository and change the current working directory to the cloned repository root. |  * Create a shallow clone of a git repository and change the current working directory to the cloned repository root. | ||||||
|  * The shallow will contain a limited number of commit and no tags. |  * The shallow will contain a limited number of commit and no tags. | ||||||
|  *  |  * | ||||||
|  * @param {string} origin The path of the repository to clone. |  * @param {string} origin The path of the repository to clone. | ||||||
|  * @param {number} [depth=1] The number of commit to clone. |  * @param {number} [depth=1] The number of commit to clone. | ||||||
|  * @return {string} The path of the cloned repository. |  * @return {string} The path of the cloned repository. | ||||||
| @ -120,7 +120,7 @@ export async function gitShallowClone(origin, branch = 'master', depth = 1) { | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Create a git repo with a detached head from another git repository and change the current working directory to the new repository root. |  * Create a git repo with a detached head from another git repository and change the current working directory to the new repository root. | ||||||
|  *  |  * | ||||||
|  * @param {string} origin The path of the repository to clone. |  * @param {string} origin The path of the repository to clone. | ||||||
|  * @param {number} head A commit sha of the origin repo that will become the detached head of the new one. |  * @param {number} head A commit sha of the origin repo that will become the detached head of the new one. | ||||||
|  * @return {string} The path of the new repository. |  * @return {string} The path of the new repository. | ||||||
|  | |||||||
| @ -2,7 +2,7 @@ import nock from 'nock'; | |||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  * Retun a `nock` object setup to respond to a github authentication request. Other expectation and responses can be chained. |  * Retun a `nock` object setup to respond to a github authentication request. Other expectation and responses can be chained. | ||||||
|  *  |  * | ||||||
|  * @param {String} [githubToken='GH_TOKEN'] The github token to return in the authentication response. |  * @param {String} [githubToken='GH_TOKEN'] The github token to return in the authentication response. | ||||||
|  * @param {String} [githubUrl='https://api.github.com'] The url on which to intercept http requests. |  * @param {String} [githubUrl='https://api.github.com'] The url on which to intercept http requests. | ||||||
|  * @return {Object} A `nock` object ready to respond to a github authentication request. |  * @return {Object} A `nock` object ready to respond to a github authentication request. | ||||||
|  | |||||||
| @ -47,7 +47,7 @@ const url = `http://${MOCK_SERVER_HOST}:${MOCK_SERVER_PORT}`; | |||||||
|  * @param {Object} request Request expectation. The http request made on `path` has to match those criteria in order to be valid. |  * @param {Object} request Request expectation. The http request made on `path` has to match those criteria in order to be valid. | ||||||
|  * @param {Object} request.body The JSON body the expected request must match. |  * @param {Object} request.body The JSON body the expected request must match. | ||||||
|  * @param {Object} request.headers The headers the expected request must match. |  * @param {Object} request.headers The headers the expected request must match. | ||||||
|  * @param {Object} response The http response to return when receiving a request on `path`.  |  * @param {Object} response The http response to return when receiving a request on `path`. | ||||||
|  * @param {String} [response.method='POST'] The http method for which to respond. |  * @param {String} [response.method='POST'] The http method for which to respond. | ||||||
|  * @param {number} [response.statusCode=200] The status code to respond. |  * @param {number} [response.statusCode=200] The status code to respond. | ||||||
|  * @param {Object} response.body The JSON object to respond in the response body. |  * @param {Object} response.body The JSON object to respond in the response body. | ||||||
|  | |||||||
| @ -408,7 +408,9 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy | |||||||
|   t.regex( |   t.regex( | ||||||
|     stderr, |     stderr, | ||||||
|     new RegExp( |     new RegExp( | ||||||
|       `You can recover from this error by restoring the commit "${head}" or by creating a tag for the version "${version}" on the commit corresponding to this release` |       `You can recover from this error by restoring the commit "${head}" or by creating a tag for the version "${ | ||||||
|  |         version | ||||||
|  |       }" on the commit corresponding to this release` | ||||||
|     ) |     ) | ||||||
|   ); |   ); | ||||||
| 
 | 
 | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user