-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix eslint issues #25352
Fix eslint issues #25352
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -3,20 +3,20 @@ const gitRepoOwner = 'WordPress'; | |||||||||||||||||
/** | ||||||||||||||||||
* @typedef WPPluginCLIConfig | ||||||||||||||||||
* | ||||||||||||||||||
* @property {string} slug Slug. | ||||||||||||||||||
* @property {string} name Name. | ||||||||||||||||||
* @property {string} team Github Team Name. | ||||||||||||||||||
* @property {string} versionMilestoneFormat printf template for milestone | ||||||||||||||||||
* @property {string} slug Slug. | ||||||||||||||||||
* @property {string} name Name. | ||||||||||||||||||
* @property {string} team Github Team Name. | ||||||||||||||||||
* @property {string} versionMilestoneFormat printf template for milestone | ||||||||||||||||||
* version name. Expected to be called | ||||||||||||||||||
* with a merged object of the config | ||||||||||||||||||
* and semver-parsed version parts. | ||||||||||||||||||
Comment on lines
+9
to
12
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Identation of the subsequent lines should align with the start of the first comment |
||||||||||||||||||
* @property {string} githubRepositoryOwner Github Repository Owner. | ||||||||||||||||||
* @property {string} githubRepositoryName Github Repository Name. | ||||||||||||||||||
* @property {string} pluginEntryPoint Plugin Entry Point File. | ||||||||||||||||||
* @property {string} buildZipCommand Build Plugin ZIP command. | ||||||||||||||||||
* @property {string} githubRepositoryOwner Github Repository Owner. | ||||||||||||||||||
* @property {string} githubRepositoryName Github Repository Name. | ||||||||||||||||||
* @property {string} pluginEntryPoint Plugin Entry Point File. | ||||||||||||||||||
* @property {string} buildZipCommand Build Plugin ZIP command. | ||||||||||||||||||
* @property {string} wpRepositoryReleasesURL WordPress Repository Tags URL. | ||||||||||||||||||
* @property {string} gitRepositoryURL Git Repository URL. | ||||||||||||||||||
* @property {string} svnRepositoryURL SVN Repository URL. | ||||||||||||||||||
* @property {string} gitRepositoryURL Git Repository URL. | ||||||||||||||||||
* @property {string} svnRepositoryURL SVN Repository URL. | ||||||||||||||||||
*/ | ||||||||||||||||||
|
||||||||||||||||||
/** | ||||||||||||||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,9 +28,9 @@ async function clone( repositoryUrl ) { | |
/** | ||
* Commits changes to the repository. | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} message Commit message. | ||
* @param {string[]} filesToAdd Files to add. | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} message Commit message. | ||
* @param {string[]} filesToAdd Files to add. | ||
* | ||
* @return {Promise<string>} Commit Hash | ||
*/ | ||
|
@@ -47,7 +47,7 @@ async function commit( gitWorkingDirectoryPath, message, filesToAdd = [] ) { | |
* Creates a local branch. | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} branchName Branch Name | ||
* @param {string} branchName Branch Name | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not a blocker, but we should look at standardizing either including or excluding the |
||
*/ | ||
async function createLocalBranch( gitWorkingDirectoryPath, branchName ) { | ||
const simpleGit = SimpleGit( gitWorkingDirectoryPath ); | ||
|
@@ -58,7 +58,7 @@ async function createLocalBranch( gitWorkingDirectoryPath, branchName ) { | |
* Checkout a local branch. | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} branchName Branch Name | ||
* @param {string} branchName Branch Name | ||
*/ | ||
async function checkoutRemoteBranch( gitWorkingDirectoryPath, branchName ) { | ||
const simpleGit = SimpleGit( gitWorkingDirectoryPath ); | ||
|
@@ -70,7 +70,7 @@ async function checkoutRemoteBranch( gitWorkingDirectoryPath, branchName ) { | |
* Creates a local tag. | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} tagName Tag Name | ||
* @param {string} tagName Tag Name | ||
*/ | ||
async function createLocalTag( gitWorkingDirectoryPath, tagName ) { | ||
const simpleGit = SimpleGit( gitWorkingDirectoryPath ); | ||
|
@@ -81,7 +81,7 @@ async function createLocalTag( gitWorkingDirectoryPath, tagName ) { | |
* Pushes a local branch to the origin. | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} branchName Branch Name | ||
* @param {string} branchName Branch Name | ||
*/ | ||
async function pushBranchToOrigin( gitWorkingDirectoryPath, branchName ) { | ||
const simpleGit = SimpleGit( gitWorkingDirectoryPath ); | ||
|
@@ -112,7 +112,7 @@ async function discardLocalChanges( gitWorkingDirectoryPath ) { | |
* Reset local branch against the origin. | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} branchName Branch Name | ||
* @param {string} branchName Branch Name | ||
*/ | ||
async function resetLocalBranchAgainstOrigin( | ||
gitWorkingDirectoryPath, | ||
|
@@ -128,7 +128,7 @@ async function resetLocalBranchAgainstOrigin( | |
* Cherry-picks a commit into master | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} commitHash Branch Name | ||
* @param {string} commitHash Branch Name | ||
*/ | ||
async function cherrypickCommitIntoBranch( | ||
gitWorkingDirectoryPath, | ||
|
@@ -143,7 +143,7 @@ async function cherrypickCommitIntoBranch( | |
* Replaces the local branch's content with the content from another branch. | ||
* | ||
* @param {string} gitWorkingDirectoryPath Local repository path. | ||
* @param {string} sourceBranchName Branch Name | ||
* @param {string} sourceBranchName Branch Name | ||
*/ | ||
async function replaceContentFromRemoteBranch( | ||
gitWorkingDirectoryPath, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,8 +12,8 @@ const STORE_KEY = 'core/annotations'; | |
/** | ||
* Applies given annotations to the given record. | ||
* | ||
* @param {Object} record The record to apply annotations to. | ||
* @param {Array} annotations The annotation to apply. | ||
* @param {Object} record The record to apply annotations to. | ||
* @param {Array} annotations The annotation to apply. | ||
* @return {Object} A record with the annotations applied. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
export function applyAnnotations( record, annotations = [] ) { | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If
@return
descriptions are not destined to be aligned with@param
descriptions then I think this also requires some changes:This aligns the descriptions of both lines:
Or, this removes the additional whitespece preceding the @return description
Possibly, another convention observed further below is a blank line between the last @param and the @Raturn: