Skip to content

[JS] Update doc because the dpg modular has already been set as the default #38892

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.

Sign up for GitHub

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[JS] Update doc because the dpg modular has already been set as the default #38892

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b8eb259
update doc
v-jiaodi Nov 20, 2025
a12c8da
update tsv validation
v-jiaodi Nov 20, 2025
a5c2a35
format
v-jiaodi Nov 20, 2025
9aff5fe
update
v-jiaodi Nov 20, 2025
7bc21ea
Merge branch 'main' into update-doc1120
skywing918 Nov 24, 2025
3d22976
remove ismodularlibrary true
v-jiaodi Nov 26, 2025
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
4 changes: 2 additions & 2 deletions eng/tools/typespec-validation/src/rules/sdk-tspconfig-validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/* eslint-disable */
// TODO: Enable eslint, fix errors

Expand Down Expand Up @@ -253,7 +253,7 @@
folder: string,
): SkipResult {
const isRLCClient =
config?.options?.["@azure-tools/typespec-ts"]?.["is-modular-library"] !== true;
config?.options?.["@azure-tools/typespec-ts"]?.["is-modular-library"] === false;
const shouldSkip = isManagementSdk(folder) || isRLCClient;
const result: SkipResult = {
shouldSkip: shouldSkip,
Expand All @@ -265,7 +265,7 @@

function skipForModularOrManagementPlaneInTsEmitter(config: any, folder: string): SkipResult {
const isModularClient =
config?.options?.["@azure-tools/typespec-ts"]?.["is-modular-library"] === true;
config?.options?.["@azure-tools/typespec-ts"]?.["is-modular-library"] !== false;
const shouldSkip = isManagementSdk(folder) || isModularClient;
const result: SkipResult = {
shouldSkip: shouldSkip,
Expand Down
4 changes: 4 additions & 0 deletions eng/tools/typespec-validation/test/sdk-tspconfig-validation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import { afterEach, beforeEach, describe, it, MockInstance, vi } from "vitest";

import { contosoTspConfig } from "@azure-tools/specs-shared/test/examples";
Expand Down Expand Up @@ -247,6 +247,8 @@
"{output-dir}/{service-dir}/arm-aaa-rest",
"{output-dir}/{service-dir}/aaa--rest",
[new TspConfigTsDpEmitterOutputDirSubRule()],
false,
{ "is-modular-library": false },
);

const tsDpPackageNameTestCases = createEmitterOptionTestCases(
Expand All @@ -256,6 +258,8 @@
"@azure-rest/aaa-bbb",
"@azure/aaa-bbb",
[new TspConfigTsRlcDpPackageNameMatchPatternSubRule()],
false,
{ "is-modular-library": false },
);

const tsDpModularPackageNameTestCases = createEmitterOptionTestCases(
Expand Down
1 change: 1 addition & 0 deletions specification/confidentialledger/data-plane/ConfidentialLedger/tspconfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,6 @@ options:
"name": "@azure-rest/azure-confidentialledger"
description: "Microsoft Confidential Ledger"
"flavor": "azure"
is-modular-library: false
generate-metadata: true
generate-sample-project: false
1 change: 1 addition & 0 deletions specification/confidentialledger/data-plane/ConfidentialLedgerIdentity/tspconfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,6 @@ options:
"name": "@azure-rest/azure-confidentialledger-certificate"
description: "Microsoft Confidential Ledger Certificate"
"flavor": "azure"
is-modular-library: false
generate-metadata: true
generate-sample-project: false
1 change: 0 additions & 1 deletion specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ options:
model-namespace: false
"@azure-tools/typespec-ts":
emitter-output-dir: "{output-dir}/{service-dir}/contoso-widgetmanager"
is-modular-library: true
Copy link
Member

@MaryGao MaryGao Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maririos and @mikeharder Could you help review and approve this pr?

JS has adjusted the default rule for option is-modular-library and this setting won't be necessary in our contoso project.

Copy link
Member

@mikeharder mikeharder Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the setting also be removed from our widget sample?

azure-rest-api-specs/specification/widget/data-plane/WidgetAnalytics/tspconfig.yaml

Line 31 in c3c93e9

is-modular-library: true

Also, I see a lot more hits for is-modular-library, both true and false, in existing specs in main. Why does this PR only change these 3?

Copy link
Member

@MaryGao MaryGao Nov 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know we have other samples, @v-jiaodi Could you update config to remove all is-modular-library: true?

Copy link
Member Author

@v-jiaodi v-jiaodi Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

package-details:
name: "@azure/contoso-widgetmanager"
flavor: azure
Expand Down
Loading