Replaced db project readme file with opening a doc in browser after project is created (#19543)

This commit is contained in:
Leila Lali
2022-05-27 08:24:00 -07:00
committed by GitHub
parent 1d276d90e0
commit 6b10ecd588
23 changed files with 33 additions and 105 deletions

View File

@@ -99,6 +99,7 @@ export const location = localize('location', "Location");
export const reloadProject = localize('reloadProject', "Would you like to reload your database project?");
export const learnMore = localize('learnMore', "Learn More");
export const sdkLearnMoreUrl = 'https://aka.ms/sqlprojsdk';
export const azureDevOpsLink = 'https://docs.microsoft.com/azure/azure-sql/database/local-dev-experience-overview?view=azuresql';
export function newObjectNamePrompt(objectType: string) { return localize('newObjectNamePrompt', 'New {0} name:', objectType); }
export function deleteConfirmation(toDelete: string) { return localize('deleteConfirmation', "Are you sure you want to delete {0}?", toDelete); }
export function deleteConfirmationContents(toDelete: string) { return localize('deleteConfirmationContents', "Are you sure you want to delete {0} and all of its contents?", toDelete); }

View File

@@ -8,7 +8,6 @@ import * as vscode from 'vscode';
import * as vscodeMssql from 'vscode-mssql';
import * as mssql from 'mssql';
import * as templates from '../templates/templates';
import * as projectAssets from '../projectProvider/projectAssets';
import * as path from 'path';
import { ProjectsController } from './projectController';
@@ -90,7 +89,6 @@ export default class MainController implements vscode.Disposable {
IconPathHelper.setExtensionContext(this.extensionContext);
await templates.loadTemplates(path.join(this.context.extensionPath, 'resources', 'templates'));
projectAssets.loadAssets(path.join(this.context.extensionPath, 'resources', 'projectAssets'));
}
public dispose(): void {

View File

@@ -11,7 +11,6 @@ import * as utils from '../common/utils';
import * as UUID from 'vscode-languageclient/lib/utils/uuid';
import * as templates from '../templates/templates';
import * as vscode from 'vscode';
import * as fse from 'fs-extra';
import type * as azdataType from 'azdata';
import * as dataworkspace from 'dataworkspace';
import type * as mssqlVscode from 'vscode-mssql';
@@ -47,7 +46,6 @@ import { addDatabaseReferenceQuickpick } from '../dialogs/addDatabaseReferenceQu
import { ILocalDbDeployProfile, ISqlDbDeployProfile } from '../models/deploy/deployProfile';
import { EntryType, FileProjectEntry, IDatabaseReferenceProjectEntry, SqlProjectReferenceProjectEntry } from '../models/projectEntry';
import { UpdateProjectAction, UpdateProjectDataModel } from '../models/api/updateProject';
import { targetPlatformToAssets } from '../projectProvider/projectAssets';
import { AzureSqlClient } from '../models/deploy/azureSqlClient';
const maxTableLength = 10;
@@ -200,20 +198,6 @@ export class ProjectsController {
await fs.mkdir(projectFolderPath, { recursive: true });
await fs.writeFile(newProjFilePath, newProjFileContents);
// Copy project readme
if (targetPlatformToAssets?.has(targetPlatform) && (targetPlatformToAssets?.get(targetPlatform)?.readmeFolder)) {
const readmeFolder = targetPlatformToAssets.get(targetPlatform)?.readmeFolder;
if (readmeFolder) {
const readmeFile = path.join(readmeFolder, 'README.md');
const folderExists = await utils.exists(readmeFile);
if (folderExists) {
await fs.copyFile(readmeFile, path.join(projectFolderPath, 'README.md'));
await fse.copy(path.join(readmeFolder, 'assets'), path.join(projectFolderPath, 'assets'));
}
}
}
await this.addTemplateFiles(newProjFilePath, creationParams.projectTypeId);
return newProjFilePath;

View File

@@ -1,20 +0,0 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as path from 'path';
export interface ProjectAssets {
readmeFolder?: string
}
export let targetPlatformToAssets: Map<string, ProjectAssets>;
export function loadAssets(assetsFolderPath: string) {
targetPlatformToAssets = new Map<string, ProjectAssets>([
['AzureV12', {
readmeFolder: path.join(assetsFolderPath, 'AzureV12')
}],
]);
}

View File

@@ -44,7 +44,8 @@ export class SqlDatabaseProjectProvider implements dataworkspace.IProjectProvide
defaultTargetPlatform: sqldbproj.SqlTargetPlatform.sqlAzure,
icon: IconPathHelper.azureSqlDbProject,
sdkStyleOption: true,
sdkStyleLearnMoreUrl: constants.sdkLearnMoreUrl
sdkStyleLearnMoreUrl: constants.sdkLearnMoreUrl,
learnMoreUrl: constants.azureDevOpsLink
},
{
id: constants.emptySqlDatabaseProjectTypeId,