Skip to content
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

Clear Package Folder Before Generation #8826

Merged
merged 3 commits into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions tools/js-sdk-release-tools/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions tools/js-sdk-release-tools/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"colors": "1.4.0",
"command-line-args": "^5.1.1",
"comment-json": "^4.1.0",
"fs-extra": "^11.2.0",
"js-yaml": "^4.1.0",
"parse-ts-to-ast": "^0.1.1",
"semver": "^7.3.5",
Expand Down
40 changes: 38 additions & 2 deletions tools/js-sdk-release-tools/src/common/utils.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,31 @@
import shell from 'shelljs';
import path from 'path';
import path, { join, posix } from 'path';
import fs from 'fs';

import { SDKType } from './types'
import { logger } from "../utils/logger";
import { Project, ScriptTarget, SourceFile } from 'ts-morph';
import { replaceAll } from '@ts-common/azure-js-dev-tools';
import { readFile } from 'fs/promises';
import { parse } from 'yaml';

// ./eng/common/scripts/TypeSpec-Project-Process.ps1 script forces to use emitter '@azure-tools/typespec-ts',
// so do NOT change the emitter
const emitterName = '@azure-tools/typespec-ts';

// TODO: remove it after we generate and use options by ourselves
const messageToTspConfigSample =
'Please refer to https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml for the right schema.';

async function loadTspConfig(typeSpecDirectory: string): Promise<Exclude<any, null | undefined>> {
const configPath = join(typeSpecDirectory, 'tspconfig.yaml');
const content = await readFile(configPath, { encoding: 'utf-8' });
const config = parse(content.toString());
if (!config) {
throw new Error(`Failed to parse tspconfig.yaml in ${typeSpecDirectory}`);
}
return config;
}

export function getClassicClientParametersPath(packageRoot: string): string {
return path.join(packageRoot, 'src', 'models', 'parameters.ts');
Expand Down Expand Up @@ -73,4 +93,20 @@ export function tryReadNpmPackageChangelog(packageFolderPath: string): string {
logger.logWarn(`Failed to read NPM package's changelog "${changelogPath}": ${(err as Error)?.stack ?? err}`);
return '';
}
}
}

// generated path is in posix format
// e.g. sdk/mongocluster/arm-mongocluster
export async function getGeneratedPackageDirectory(typeSpecDirectory: string): Promise<string> {
const tspConfig = await loadTspConfig(typeSpecDirectory);
const serviceDir = tspConfig.parameters?.['service-dir']?.default;
if (!serviceDir) {
throw new Error(`Misses service-dir in parameters section of tspconfig.yaml. ${messageToTspConfigSample}`);
}
const packageDir = tspConfig.options?.[emitterName]?.['package-dir'];
if (!packageDir) {
throw new Error(`Misses package-dir in ${emitterName} options of tspconfig.yaml. ${messageToTspConfigSample}`);
}
const packageDirFromRoot = posix.join(serviceDir, packageDir);
return packageDirFromRoot;
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import {
} from '../utils/generateSampleReadmeMd';
import { updateTypeSpecProjectYamlFile } from '../utils/updateTypeSpecProjectYamlFile';
import { getRelativePackagePath } from "../utils/utils";
import { getGeneratedPackageDirectory } from "../../common/utils";
import { remove } from 'fs-extra';

export async function generateRLCInPipeline(options: {
sdkRepo: string;
Expand All @@ -38,6 +40,10 @@ export async function generateRLCInPipeline(options: {
let packagePath: string | undefined = undefined;
let relativePackagePath: string | undefined = undefined;
if (options.typespecProject) {
const typespecProject = path.join(options.swaggerRepo, options.typespecProject);
const generatedPackageDir = await getGeneratedPackageDirectory(typespecProject);
await remove(generatedPackageDir);

if (!options.skipGeneration) {
logger.logGreen(`>>>>>>>>>>>>>>>>>>> Start: "${options.typespecProject}" >>>>>>>>>>>>>>>>>>>>>>>>>`);
if(options.sdkGenerationType === "command") {
Expand Down