check-param-names (#18189)

extensions/.eslintrc.json

@@ -1,5 +1,6 @@
 {
 	"rules": {
-		"no-cond-assign": 2
+		"no-cond-assign": 2,
+		"jsdoc/check-param-names": "error"
 	}
 }

extensions/admin-tool-ext-win/src/main.ts

@@ -47,7 +47,7 @@ function registerCommands(context: vscode.ExtensionContext): void {
 
 /**
  * Handler for command to launch SSMS Server Properties dialog
- * @param connectionId The connection context from the command
+ * @param connectionContext The connection context from the command
  */
 async function handleLaunchSsmsMinPropertiesDialogCommand(connectionContext?: azdata.ObjectExplorerContext): Promise<void> {
 	if (!connectionContext) {
@@ -75,7 +75,7 @@ async function handleLaunchSsmsMinPropertiesDialogCommand(connectionContext?: az
 
 /**
  * Handler for command to launch SSMS "Generate Script Wizard" dialog
- * @param connectionId The connection context from the command
+ * @param connectionContext The connection context from the command
  */
 async function handleLaunchSsmsMinGswDialogCommand(connectionContext?: azdata.ObjectExplorerContext): Promise<void> {
 	const action = 'GenerateScripts';
@@ -92,8 +92,7 @@ async function handleLaunchSsmsMinGswDialogCommand(connectionContext?: azdata.Ob
 /**
  * Launches SsmsMin with parameters from the specified connection
  * @param action The action to launch
- * @param params The params used to construct the command
- * @param urn The URN to pass to SsmsMin
+ * @param connectionContext The connection context from the command
  */
 async function launchSsmsDialog(action: string, connectionContext: azdata.ObjectExplorerContext): Promise<void> {
 	if (!connectionContext.connectionProfile) {

extensions/arc/src/common/utils.ts

@@ -105,8 +105,8 @@ export function getDatabaseStateDisplayText(state: string): string {
 
 /**
  * Opens an input box prompting and validating the user's input.
- * @param options Options for the input box
  * @param title An optional title for the input box
+ * @param options Options for the input box
  * @returns Promise resolving to the user's input if it passed validation,
  * or undefined if the input box was closed for any other reason
  */

extensions/azcli/src/common/childProcess.ts

@@ -82,7 +82,6 @@ export async function executeCommand(command: string, args: string[], additional
  * Executes a command with admin privileges. The user will be prompted to enter credentials for invocation of
  * this function. The exact prompt is platform-dependent.
  * @param command The command to execute
- * @param args The additional args
  */
 export async function executeSudoCommand(command: string): Promise<ProcessOutput> {
 	return new Promise((resolve, reject) => {

extensions/azurecore/src/account-provider/auths/azureAuthCodeGrant.ts

@@ -69,9 +69,6 @@ export class AzureAuthCodeGrant extends AzureAuth {
 	 *
 	 * @param tenant
 	 * @param resource
-	 * @param authCode
-	 * @param redirectUri
-	 * @param codeVerifier
 	 */
 	private async getTokenWithAuthorizationCode(tenant: Tenant, resource: Resource, { authCode, redirectUri, codeVerifier }: AuthCodeResponse): Promise<OAuthTokenResponse | undefined> {
 		const postData: AuthorizationCodePostData = {

extensions/big-data-cluster/src/bigDataCluster/utils.ts

@@ -117,7 +117,7 @@ export function getStateDisplayText(state?: string): string {
 
 /**
  * Gets the localized text to display for a corresponding endpoint
- * @param serviceName The endpoint name to get the display text for
+ * @param endpointName The endpoint name to get the display text for
  * @param description The backup description to use if we don't have our own
  */
 export function getEndpointDisplayText(endpointName?: string, description?: string): string {

extensions/integration-tests/src/test/utils.ts

@@ -276,8 +276,8 @@ export async function assertFileGenerationResult(filepath: string, retryCount: n
 
 /**
  *
- * @param tableName table to look for
  * @param schema schema to look for
+ * @param tableName table to look for
  * @param ownerUri owner uri
  * @param retryCount number of times to retry with a 5 second wait between each try
  * @param checkForData whether or not to check if the table has data

extensions/machine-learning/src/common/utils.ts

@@ -220,7 +220,9 @@ export function getScriptWithDBChange(currentDb: string, databaseName: string, s
 
 /**
  * Returns full name of model registration table
- * @param config config
+ * @param db
+ * @param table
+ * @param schema
  */
 export function getRegisteredModelsThreePartsName(db: string, table: string, schema: string) {
 	const dbName = doubleEscapeSingleBrackets(db);
@@ -231,7 +233,8 @@ export function getRegisteredModelsThreePartsName(db: string, table: string, sch
 
 /**
  * Returns full name of model registration table
- * @param config config object
+ * @param table
+ * @param schema
  */
 export function getRegisteredModelsTwoPartsName(table: string, schema: string) {
 	const schemaName = doubleEscapeSingleBrackets(schema);

extensions/machine-learning/src/modelManagement/deployedModelService.ts

@@ -155,7 +155,6 @@ export class DeployedModelService {
 	/**
 	 * Verifies if the given table name is valid to be used as import table. If table doesn't exist returns true to create new table
 	 * Otherwise verifies the schema and returns true if the schema is supported
-	 * @param connection database connection
 	 * @param table config table name
 	 */
 	public async verifyConfigTable(table: DatabaseTable): Promise<boolean> {

extensions/machine-learning/src/modelManagement/queries.ts

@@ -29,8 +29,7 @@ export function getDeployedModelsQuery(table: DatabaseTable): string {
 
 /**
  * Verifies config table has the expected schema
- * @param databaseName
- * @param tableName
+ * @param table
  */
 export function getConfigTableVerificationQuery(table: DatabaseTable): string {
 	let tableName = table.tableName;

extensions/machine-learning/src/packageManagement/packageManagementService.ts

@@ -45,7 +45,6 @@ export class PackageManagementService {
 	/**
 	 * Updates external script config
 	 * @param connection SQL Connection
-	 * @param enable if true external script will be enabled
 	 */
 	public async enableExternalScriptConfig(connection: azdata.connection.ConnectionProfile): Promise<boolean> {
 		let current = await this._queryRunner.isMachineLearningServiceEnabled(connection);

extensions/machine-learning/src/packageManagement/sqlPythonPackageManageProvider.ts

@@ -57,8 +57,9 @@ export class SqlPythonPackageManageProvider extends SqlPackageManageProviderBase
 
 	/**
 	 * Execute a script to install or uninstall a python package inside current SQL Server connection
-	 * @param packageDetails Packages to install or uninstall
 	 * @param scriptMode can be 'install' or 'uninstall'
+	 * @param packageDetails Packages to install or uninstall
+	 * @param databaseName
 	 */
 	protected async executeScripts(scriptMode: ScriptMode, packageDetails: nbExtensionApis.IPackageDetails, databaseName: string): Promise<void> {
 		let connection = await this.getCurrentConnection();

extensions/machine-learning/src/packageManagement/sqlRPackageManageProvider.ts

@@ -60,8 +60,9 @@ export class SqlRPackageManageProvider extends SqlPackageManageProviderBase impl
 
 	/**
 	 * Execute a script to install or uninstall a r package inside current SQL Server connection
-	 * @param packageDetails Packages to install or uninstall
 	 * @param scriptMode can be 'install' or 'uninstall'
+	 * @param packageDetails Packages to install or uninstall
+	 * @param databaseName
 	 */
 	protected async executeScripts(scriptMode: ScriptMode, packageDetails: nbExtensionApis.IPackageDetails, databaseName: string): Promise<void> {
 		let connection = await this.getCurrentConnection();

extensions/machine-learning/src/views/models/modelManagementController.ts

@@ -47,6 +47,7 @@ export class ModelManagementController extends ControllerBase {
 
 	/**
 	 * Opens the dialog for model import
+	 * @param importTable
 	 * @param parent parent if the view is opened from another view
 	 * @param controller controller
 	 * @param apiWrapper apiWrapper

extensions/machine-learning/src/views/models/modelViewBase.ts

@@ -176,7 +176,7 @@ export abstract class ModelViewBase extends ViewBase {
 
 	/**
 	 * registers local model
-	 * @param localFilePath local file path
+	 * @param models
 	 */
 	public async importLocalModel(models: ModelViewData[]): Promise<void> {
 		return await this.sendDataRequest(RegisterLocalModelEventName, models);
@@ -192,7 +192,7 @@ export abstract class ModelViewBase extends ViewBase {
 
 	/**
 	 * download azure model
-	 * @param args azure resource
+	 * @param resource azure resource
 	 */
 	public async downloadAzureModel(resource: AzureModelResource | undefined): Promise<string> {
 		return await this.sendDataRequest(DownloadAzureModelEventName, resource);
@@ -207,7 +207,7 @@ export abstract class ModelViewBase extends ViewBase {
 
 	/**
 	 * registers azure model
-	 * @param args azure resource
+	 * @param models
 	 */
 	public async importAzureModel(models: ModelViewData[]): Promise<void> {
 		return await this.sendDataRequest(RegisterAzureModelEventName, models);
@@ -229,7 +229,9 @@ export abstract class ModelViewBase extends ViewBase {
 
 	/**
 	 * registers azure model
-	 * @param args azure resource
+	 * @param model
+	 * @param filePath
+	 * @param params
 	 */
 	public async generatePredictScript(model: ImportedModel | undefined, filePath: string | undefined, params: PredictParameters | undefined): Promise<void> {
 		const args: PredictModelEventArgs = Object.assign({}, params, {

extensions/machine-learning/src/views/models/modelsDetailsTableComponent.ts

@@ -111,7 +111,6 @@ export class ModelsDetailsTableComponent extends ModelViewBase implements IDataC
 
 	/**
 	 * Load data in the component
-	 * @param workspaceResource Azure workspace
 	 */
 	public async loadData(): Promise<void> {
 

extensions/machine-learning/src/views/models/prediction/columnsTable.ts

@@ -158,7 +158,8 @@ export class ColumnsTable extends ModelViewBase implements IDataComponent<Predic
 
 	/**
 	 * Load data in the component
-	 * @param workspaceResource Azure workspace
+	 * @param modelParameters
+	 * @param table
 	 */
 	public async loadInputs(modelParameters: ModelParameters | undefined, table: DatabaseTable): Promise<void> {
 		await this.onLoading();

extensions/mssql/src/dashboard/serviceEndpoints.ts

@@ -142,7 +142,7 @@ export enum Endpoint {
 
 /**
  * Gets the localized text to display for a corresponding endpoint
- * @param serviceName The endpoint name to get the display text for
+ * @param endpointName The endpoint name to get the display text for
  * @param description The backup description to use if we don't have our own
  */
 function getEndpointDisplayText(endpointName?: string, description?: string): string {

extensions/mssql/src/hdfs/fileStatus.ts

@@ -34,12 +34,17 @@ export function hdfsFileTypeToFileType(hdfsFileType: HdfsFileType | undefined):
 export class FileStatus {
 	/**
 	 *
-	 * @param owner The ACL entry object for the owner permissions
+	 * @param accessTime
+	 * @param blockSize
 	 * @param group The ACL entry object for the group permissions
-	 * @param other The ACL entry object for the other permissions
-	 * @param stickyBit The sticky bit status for the object. If true the owner/root are
-	 * the only ones who can delete the resource or its contents (if a folder)
-	 * @param aclEntries The ACL entries defined for the object
+	 * @param length
+	 * @param modificationTime
+	 * @param owner The ACL entry object for the owner permissions
+	 * @param pathSuffix
+	 * @param permission
+	 * @param replication
+	 * @param snapshotEnabled
+	 * @param type
 	 */
 	constructor(
 		/**

extensions/mssql/src/hdfs/webhdfs.ts

@@ -108,7 +108,6 @@ export class WebHDFS {
 	 * Gets status message from response
 	 *
 	 * @param response response object
-	 * @param strict If set true then RemoteException must be present in the body
 	 * @returns Error message interpreted by status code
 	 */
 	private getStatusMessage(response: request.Response): string {
@@ -211,6 +210,7 @@ export class WebHDFS {
 	 * Send a request to WebHDFS REST API
 	 *
 	 * @param method HTTP method
+	 * @param urlValue
 	 * @param opts Options for request
 	 * @returns void
 	 */
@@ -319,8 +319,10 @@ export class WebHDFS {
 	/**
 	 * Change file owner
 	 *
+	 * @param path
 	 * @param userId User name
 	 * @param groupId Group name
+	 * @param callback
 	 * @returns void
 	 */
 	public chown(path: string, userId: string, groupId: string, callback: (error: HdfsError) => void): void {
@@ -511,7 +513,7 @@ export class WebHDFS {
 	 * Set ACL for the given path. The owner, group and other fields are required - other entries are optional.
 	 * @param path The path to the file/folder to set the ACL on
 	 * @param fileType The type of file we're setting to determine if defaults should be applied. Use undefined if type is unknown
-	 * @param ownerEntry The status containing the permissions to set
+	 * @param permissionStatus The status containing the permissions to set
 	 * @param callback Callback to handle the response
 	 */
 	public setAcl(path: string, fileType: FileType | undefined, permissionStatus: PermissionStatus, callback: (error: HdfsError) => void): void {
@@ -592,7 +594,11 @@ export class WebHDFS {
 	/**
 	 * Write data to the file
 	 *
+	 * @param path
+	 * @param data
 	 * @param append If set to true then append data to the file
+	 * @param opts
+	 * @param callback
 	 */
 	public writeFile(path: string, data: string | Buffer, append: boolean, opts: object,
 		callback: (error: HdfsError) => void): fs.WriteStream {
@@ -663,8 +669,9 @@ export class WebHDFS {
 	 * Create writable stream for given path
 	 *
 	 * @fires WebHDFS#finish
-	 * @param [append] If set to true then append data to the file
-	 *
+	 * @param path
+	 * @param append If set to true then append data to the file
+	 * @param opts
 	 * @example
 	 * let hdfs = WebHDFS.createClient();
 	 *

extensions/mssql/src/objectExplorerNodeProvider/fileSources.ts

@@ -379,8 +379,7 @@ class HdfsFileSource implements IFileSource {
 	 * Sets the ACL status for given path
 	 * @param path The path to the file/folder to set the ACL on
 	 * @param fileType The type of file we're setting to determine if defaults should be applied. Use undefined if type is unknown
-	 * @param ownerEntry The status containing the permissions to set
-	 * @param aclEntries The ACL entries to set
+	 * @param permissionStatus The permissions to set
 	 */
 	public setAcl(path: string, fileType: FileType | undefined, permissionStatus: PermissionStatus): Promise<void> {
 		return new Promise((resolve, reject) => {

extensions/mssql/src/utils.ts

@@ -42,7 +42,6 @@ export function getAppDataPath() {
 /**
  * Get a file name that is not already used in the target directory
  * @param filePath source notebook file name
- * @param fileExtension file type
  */
 export function findNextUntitledEditorName(filePath: string): string {
 	const fileExtension = path.extname(filePath);

extensions/notebook/src/book/bookModel.ts

@@ -345,6 +345,7 @@ export class BookModel {
 
 	/**
 	 * Recursively parses out a section of a Jupyter Book.
+	 * @param version
 	 * @param section The input data to parse
 	 */
 	public parseJupyterSections(version: string, section: any[]): JupyterBookSection[] {

extensions/notebook/src/book/bookTocManager.ts

@@ -325,7 +325,7 @@ export class BookTocManager implements IBookTocManager {
 	 * Moves a section to a book top level or another book's section. If there's a target section we add the the targetSection directory if it has one and append it to the
 	 * notebook's path. The overwrite option is set to false to prevent any issues with duplicated file names.
 	 * @param section The section that's been moved.
-	 * @param book The target book.
+	 * @param bookItem The target book.
 	*/
 	async moveSectionFiles(section: BookTreeItem, bookItem: BookTreeItem): Promise<void> {
 		const uri = path.posix.join(path.posix.sep, path.relative(section.rootContentPath, section.book.contentPath));
@@ -369,8 +369,8 @@ export class BookTocManager implements IBookTocManager {
 	/**
 	 * Moves a file to a book top level or a book's section. If there's a target section we add the the targetSection directory if it has one and append it to the
 	 * files's path. The overwrite option is set to false to prevent any issues with duplicated file names.
-	 * @param element Notebook, Markdown File, or book's notebook that will be added to the book.
-	 * @param targetBook Book that will be modified.
+	 * @param file Notebook, Markdown File, or book's notebook that will be added to the book.
+	 * @param book Book that will be modified.
 	*/
 	async moveFile(file: BookTreeItem, book: BookTreeItem): Promise<void> {
 		const rootPath = book.rootContentPath;

extensions/notebook/src/book/bookTreeView.ts

@@ -330,7 +330,7 @@ export class BookTreeViewProvider implements vscode.TreeDataProvider<BookTreeIte
 	 * were able to successfully parse it.
 	 * @param bookPath The path to the book folder to create the model for
 	 * @param isNotebook A boolean value to know we are creating a model for a notebook or a book
-	 * @param notebookBookRoot For pinned notebooks we need to know if the notebook is part of a book or it's a standalone notebook
+	 * @param notebookDetails
 	 */
 	private async createAndAddBookModel(bookPath: string, isNotebook: boolean, notebookDetails?: IPinnedNotebook): Promise<void> {
 		if (!this.books.find(x => x.bookPath === bookPath)) {

extensions/notebook/src/intellisense/text.ts

@@ -45,8 +45,6 @@ export function jsIndexToCharIndex(jsIdx: number, text: string): number {
 /**
  * Get the diff between pure character count and JS-based count with 2 chars per surrogate pair.
  *
- * @param charIdx - The index in unicode characters
- *
  * @param text - The text in which the offset is calculated
  *
  * @returns The js-native index

extensions/resource-deployment/src/ui/modelViewUtils.ts

@@ -168,8 +168,9 @@ type AzureComponent = azdata.InputBoxComponent | azdata.DropDownComponent;
 /**
  * Creates an inputBox using the properties defined in context.fieldInfo object
  *
- * @param context - the fieldContext object for this field
- * @param inputBoxType - the type of inputBox
+ * @param root
+ * @param root.context - the fieldContext object for this field
+ * @param root.inputBoxType - the type of inputBox
  */
 function createInputBoxField({ context, inputBoxType = 'text' }: { context: FieldContext; inputBoxType?: azdata.InputBoxInputType; }) {
 	const label = createLabel(context.view, { text: context.fieldInfo.label, description: context.fieldInfo.description, required: context.fieldInfo.required, width: context.fieldInfo.labelWidth, cssStyles: context.fieldInfo.labelCSSStyles });
@@ -930,8 +931,8 @@ function processEvaluatedTextField(context: FieldContext): ReadOnlyFieldInputs {
  *
  * Only variables in the current model starting with {@see NoteBookEnvironmentVariablePrefix} are replaced.
  *
- * @param inputValue
  * @param inputComponents
+ * @param inputValue
  */
 async function substituteVariableValues(inputComponents: InputComponents, inputValue?: string): Promise<string | undefined> {
 	await Promise.all(Object.keys(inputComponents)

extensions/sql-database-projects/src/common/azureFunctionsUtils.ts

@@ -73,7 +73,7 @@ export async function setLocalAppSetting(projectFolder: string, key: string, val
 
 /**
  * Gets the Azure Functions project that contains the given file if the project is open in one of the workspace folders
- * @param filePath file that the containing project needs to be found for
+ * @param fileUri file that the containing project needs to be found for
  * @returns uri of project or undefined if project couldn't be found
  */
 export async function getAFProjectContainingFile(fileUri: vscode.Uri): Promise<vscode.Uri | undefined> {

extensions/sql-database-projects/src/controllers/projectController.ts

@@ -150,9 +150,7 @@ export class ProjectsController {
 
 	/**
 	 * Creates a new folder with the project name in the specified location, and places the new .sqlproj inside it
-	 * @param newProjName
-	 * @param folderUri
-	 * @param projectGuid
+	 * @param creationParams
 	 */
 	public async createNewProject(creationParams: NewProjectParams): Promise<string> {
 		TelemetryReporter.createActionEvent(TelemetryViews.ProjectController, TelemetryActions.createNewProject)
@@ -266,7 +264,8 @@ export class ProjectsController {
 
 	/**
 	 * Publishes a project to docker container
-	 * @param treeNode a treeItem in a project's hierarchy, to be used to obtain a Project
+	 * @param context a treeItem in a project's hierarchy, to be used to obtain a Project or the Project itself
+	 * @param deployProfile
 	 */
 	public async publishToDockerContainer(context: Project | dataworkspace.WorkspaceTreeItem, deployProfile: IDeployProfile): Promise<void> {
 		const project: Project = this.getProjectFromContext(context);
@@ -795,7 +794,7 @@ export class ProjectsController {
 
 	/**
 	 * Reloads the given project. Throws an error if given project is not a valid open project.
-	 * @param projectFileUri the uri of the project to be reloaded
+	 * @param context
 	 */
 	public async reloadProject(context: dataworkspace.WorkspaceTreeItem): Promise<void> {
 		const project = this.getProjectFromContext(context);

extensions/sql-database-projects/src/dialogs/addDatabaseReferenceQuickpick.ts

@@ -21,7 +21,6 @@ interface DbServerValues {
 
 /**
  * Create flow for adding a database reference using only VS Code-native APIs such as QuickPick
- * @param connectionInfo Optional connection info to use instead of prompting the user for a connection
  */
 export async function addDatabaseReferenceQuickpick(project: Project): Promise<AddDatabaseReferenceSettings | undefined> {
 

extensions/sql-database-projects/src/models/project.ts

@@ -740,7 +740,7 @@ export class Project implements ISqlProject {
 
 	/**
 	 * Set the target platform of the project
-	 * @param newTargetPlatform compat level of project
+	 * @param compatLevel compat level of project
 	 */
 	public async changeTargetPlatform(compatLevel: string): Promise<void> {
 		if (this.getProjectTargetVersion() !== compatLevel) {
@@ -863,8 +863,6 @@ export class Project implements ISqlProject {
 
 	/**
 	 * Adds reference to a dacpac to the project
-	 * @param uri Uri of the dacpac
-	 * @param databaseName name of the database
 	 */
 	public async addDatabaseReference(settings: IDacpacReferenceSettings): Promise<void> {
 		const databaseReferenceEntry = new DacpacReferenceProjectEntry(settings);
@@ -879,8 +877,6 @@ export class Project implements ISqlProject {
 
 	/**
 	 * Adds reference to a another project in the workspace
-	 * @param uri Uri of the dacpac
-	 * @param databaseName name of the database
 	 */
 	public async addProjectReference(settings: IProjectReferenceSettings): Promise<void> {
 		const projectReferenceEntry = new SqlProjectReferenceProjectEntry(settings);

extensions/sql-database-projects/src/projectProvider/projectProvider.ts

@@ -22,7 +22,7 @@ export class SqlDatabaseProjectProvider implements dataworkspace.IProjectProvide
 
 	/**
 	 * Gets the project tree data provider
-	 * @param projectFile The project file Uri
+	 * @param projectFilePath The project file Uri
 	 */
 	async getProjectTreeDataProvider(projectFilePath: vscode.Uri): Promise<vscode.TreeDataProvider<BaseProjectTreeItem>> {
 		const provider = new SqlDatabaseProjectTreeViewProvider();

extensions/sql-database-projects/src/tools/packageHelper.ts

@@ -38,7 +38,7 @@ export class PackageHelper {
 	/**
 	 * Runs dotnet add package to add a package reference to the specified project. If the project already has a package reference
 	 * for this package version, the project file won't get updated
-	 * @param projectPath uri of project to add package to
+	 * @param projectUri uri of project to add package to
 	 * @param packageName name of package
 	 * @param packageVersion optional version of package. If none, latest will be pulled in
 	 */
@@ -53,7 +53,7 @@ export class PackageHelper {
 
 	/**
 	 * Adds specified package to Azure Functions project the specified file is a part of
-	 * @param filePath uri of file to find the containing AF project of to add package reference to
+	 * @param fileUri uri of file to find the containing AF project of to add package reference to
 	 * @param packageName package to add reference to
 	 * @param packageVersion optional version of package. If none, latest will be pulled in
 	 */