[template] Migrate template projects to use snippets extraction

sdk/template/template-dpg/README.md

@@ -81,8 +81,8 @@ Create several code examples for how someone would use your library to accomplis
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```
@@ -101,7 +101,5 @@ If you'd like to contribute to this library, please read the [contributing guide
 
 - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
 
-
-
 [azure_cli]: https://learn.microsoft.com/cli/azure
 [azure_sub]: https://azure.microsoft.com/free/

sdk/template/template-dpg/package.json

@@ -87,7 +87,7 @@
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser",
     "unit-test:node": "dev-tool run test:vitest",
-    "update-snippets": "echo skipped"
+    "update-snippets": "dev-tool run update-snippets"
   },
   "files": [
     "dist/",
@@ -118,23 +118,24 @@
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@types/node": "^18.0.0",
-    "@vitest/browser": "^3.0.3",
-    "@vitest/coverage-istanbul": "^3.0.3",
+    "@vitest/browser": "^3.0.6",
+    "@vitest/coverage-istanbul": "^3.0.6",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
-    "playwright": "^1.49.0",
+    "playwright": "^1.50.1",
     "typescript": "~5.7.2",
-    "vitest": "^3.0.3"
+    "vitest": "^3.0.6"
   },
   "dependencies": {
     "@azure-rest/core-client": "^2.3.1",
     "@azure/core-auth": "^1.9.0",
-    "@azure/core-rest-pipeline": "^1.18.0",
+    "@azure/core-rest-pipeline": "^1.19.0",
     "@azure/core-util": "^1.11.0",
     "@azure/logger": "^1.1.4",
     "tslib": "^2.8.1"
   },
   "tshy": {
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts",
@@ -149,8 +150,8 @@
       "browser",
       "react-native"
     ],
-    "selfLink": false,
-    "project": "./tsconfig.src.json"
+    "selfLink": false
   },
-  "browser": "./dist/browser/index.js"
+  "browser": "./dist/browser/index.js",
+  "react-native": "./dist/react-native/index.js"
 }

sdk/template/template-dpg/samples-dev/createWidget.ts

@@ -9,15 +9,13 @@
  * @azsdk-weight 100
  */
 
-import * as dotenv from "dotenv";
+import "dotenv/config";
 import { WidgetServiceClient } from "@azure/template-dpg";
 
 // Load the .env file if it exists
-dotenv.config();
-
 const endpoint = process.env.WIDGET_SERVICE_ENDPOINT || "https://tsp-widgets.azurewebsites.net";
 
-async function main() {
+async function main(): Promise<void> {
   const client = new WidgetServiceClient(endpoint);
 
   // Create a new widget

sdk/template/template-dpg/test/public/widgetService.spec.ts

@@ -71,10 +71,8 @@ describe("WidgetServiceClient", () => {
   describe("Widgets CRUD", () => {
     it("should create a widget", async () => {
       const widget = await client.createWidget(10, "red");
-      // eslint-disable-next-line no-unused-expressions
-      expect(widget).to.exist;
-      // eslint-disable-next-line no-unused-expressions
-      expect(widget.id).to.exist;
+      expect(widget).toBeDefined();
+      expect(widget.id).toBeDefined();
       expect(widget.color).to.equal("red");
       expect(widget.weight).to.equal(10);
     });
@@ -88,8 +86,7 @@ describe("WidgetServiceClient", () => {
     it("should update a widget", async () => {
       const widget = await client.createWidget(10, "red");
       const updatedWidget = await client.updateWidget(widget.id, { weight: 20 });
-      // eslint-disable-next-line no-unused-expressions
-      expect(updatedWidget).to.exist;
+      expect(updatedWidget).toBeDefined();
       expect(updatedWidget.id).to.equal(widget.id);
       expect(updatedWidget.color).to.equal("red");
       expect(updatedWidget.weight).to.equal(20);

sdk/template/template-dpg/test/snippets.spec.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { setLogLevel } from "@azure/logger";
+import { describe, it } from "vitest";
+
+describe("snippets", () => {
+  it("SetLogLevel", async () => {
+    setLogLevel("info");
+  });
+});

sdk/template/template-dpg/tsconfig.json

@@ -1,7 +1,13 @@
 {
   "references": [
-    { "path": "./tsconfig.src.json" },
-    { "path": "./tsconfig.samples.json" },
-    { "path": "./tsconfig.test.json" }
+    {
+      "path": "./tsconfig.src.json"
+    },
+    {
+      "path": "./tsconfig.samples.json"
+    },
+    {
+      "path": "./tsconfig.test.json"
+    }
   ]
 }

sdk/template/template-dpg/vitest.browser.config.ts

@@ -9,8 +9,8 @@ export default mergeConfig(
   defineConfig({
     test: {
       include: ["dist-test/browser/test/**/*.spec.js"],
-      hookTimeout: 500000,
-      testTimeout: 500000,
+      testTimeout: 1200000,
+      hookTimeout: 1200000,
     },
   }),
 );

sdk/template/template-dpg/vitest.config.ts

@@ -8,8 +8,8 @@ export default mergeConfig(
   viteConfig,
   defineConfig({
     test: {
-      hookTimeout: 500000,
-      testTimeout: 500000,
+      testTimeout: 1200000,
+      hookTimeout: 1200000,
     },
   }),
 );

sdk/template/template-dpg/vitest.esm.config.ts

@@ -5,7 +5,4 @@ import { mergeConfig } from "vitest/config";
 import vitestConfig from "./vitest.config.ts";
 import vitestEsmConfig from "../../../vitest.esm.shared.config.ts";
 
-export default mergeConfig(
-  vitestConfig,
-  vitestEsmConfig
-);
+export default mergeConfig(vitestConfig, vitestEsmConfig);

sdk/template/template/README.md

@@ -75,7 +75,7 @@ Create a section for each top-level service concept you want to explain.
 
 Create several code examples for how someone would use your library to accomplish a common task with the service.
 
-```ts snippet:new_configurationclient
+```ts snippet:ReadmeSampleCreateClient
 import { ConfigurationClient } from "@azure/template";
 import { DefaultAzureCredential } from "@azure/identity";
 
@@ -91,7 +91,7 @@ const client = new ConfigurationClient(
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```ts snippet:setloglevel
+```ts snippet:SetLogLevel
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("verbose");
@@ -111,7 +111,5 @@ If you'd like to contribute to this library, please read the [contributing guide
 
 - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
 
-
-
 [azure_cli]: https://learn.microsoft.com/cli/azure
 [azure_sub]: https://azure.microsoft.com/free/

sdk/template/template/api-extractor.json

@@ -11,7 +11,7 @@
   "dtsRollup": {
     "enabled": true,
     "untrimmedFilePath": "",
-    "publicTrimmedFilePath": "./dist/template.d.ts"
+    "publicTrimmedFilePath": "dist/template.d.ts"
   },
   "messages": {
     "tsdocMessageReporting": {

sdk/template/template/package.json

@@ -53,9 +53,9 @@
     "test:browser": "npm run clean && npm run integration-test:browser",
     "test:node": "npm run clean && npm run build:test && npm run integration-test:node",
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
-    "unit-test:browser": "npm run integration-test:browser",
-    "unit-test:node": "npm run integration-test:node",
-    "update-snippets": "dev-tool run build-package && dev-tool run update-snippets"
+    "unit-test:browser": "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser",
+    "unit-test:node": "dev-tool run test:vitest",
+    "update-snippets": "dev-tool run update-snippets"
   },
   "files": [
     "dist/",
@@ -80,32 +80,33 @@
   "sideEffects": false,
   "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
   "dependencies": {
-    "@azure/core-auth": "^1.3.0",
-    "@azure/core-client": "^1.4.0",
+    "@azure/core-auth": "^1.9.0",
+    "@azure/core-client": "^1.9.2",
     "@azure/core-lro": "^2.7.0",
-    "@azure/core-rest-pipeline": "^1.4.0",
-    "@azure/core-tracing": "^1.0.0",
-    "@azure/logger": "^1.0.0",
-    "tslib": "^2.6.2"
+    "@azure/core-rest-pipeline": "^1.19.0",
+    "@azure/core-tracing": "^1.2.0",
+    "@azure/logger": "^1.1.4",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@azure-tools/test-credential": "^2.0.0",
-    "@azure-tools/test-recorder": "^4.0.0",
+    "@azure-tools/test-recorder": "^4.1.0",
     "@azure-tools/test-utils-vitest": "^1.0.0",
     "@azure-tools/vite-plugin-browser-test-map": "^1.0.0",
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
-    "@azure/identity": "^4.5.0",
+    "@azure/identity": "^4.7.0",
     "@types/node": "^18.0.0",
-    "@vitest/browser": "^3.0.3",
-    "@vitest/coverage-istanbul": "^3.0.3",
+    "@vitest/browser": "^3.0.6",
+    "@vitest/coverage-istanbul": "^3.0.6",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
-    "playwright": "^1.41.2",
+    "playwright": "^1.50.1",
     "typescript": "~5.7.2",
-    "vitest": "^3.0.3"
+    "vitest": "^3.0.6"
   },
   "tshy": {
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts"
@@ -118,8 +119,7 @@
       "browser",
       "react-native"
     ],
-    "selfLink": false,
-    "project": "./tsconfig.src.json"
+    "selfLink": false
   },
   "exports": {
     "./package.json": "./package.json",
@@ -143,5 +143,7 @@
     }
   },
   "type": "module",
-  "module": "./dist/esm/index.js"
+  "module": "./dist/esm/index.js",
+  "browser": "./dist/browser/index.js",
+  "react-native": "./dist/react-native/index.js"
 }

sdk/template/template/samples-dev/getConfigurationSetting.ts

@@ -9,10 +9,9 @@ import { ConfigurationClient } from "@azure/template";
 import { DefaultAzureCredential } from "@azure/identity";
 
 // Load the .env file if it exists
-import * as dotenv from "dotenv";
-dotenv.config();
+import "dotenv/config";
 
-async function main() {
+async function main(): Promise<void> {
   const endpoint = process.env.APPCONFIG_ENDPOINT || "<endpoint>";
   const key = process.env.APPCONFIG_TEST_SETTING_KEY || "<test-key>";
 

sdk/template/template/samples/v1-beta/typescript/src/getConfigurationSetting.ts

@@ -9,10 +9,9 @@ import { ConfigurationClient } from "@azure/template";
 import { DefaultAzureCredential } from "@azure/identity";
 
 // Load the .env file if it exists
-import * as dotenv from "dotenv";
-dotenv.config();
+import "dotenv/config";
 
-async function main() {
+async function main(): Promise<void> {
   const endpoint = process.env.APPCONFIG_ENDPOINT || "<endpoint>";
   const key = process.env.APPCONFIG_TEST_SETTING_KEY || "<test-key>";
 

sdk/template/template/src/configurationClient.ts

@@ -51,7 +51,7 @@ export class ConfigurationClient {
    * Creates an instance of a ConfigurationClient.
    *
    * Example usage:
-   * ```ts snippet:new_configurationclient
+   * ```ts snippet:ReadmeSampleCreateClient
    * import { ConfigurationClient } from "@azure/template";
    * import { DefaultAzureCredential } from "@azure/identity";
    *

sdk/template/template/test/public/configurationClient.spec.ts

@@ -55,7 +55,7 @@ describe("[AAD] ConfigurationClient functional tests", function () {
   // NOTE: use of "function" and not ES6 arrow-style functions with the
   // beforeEach hook is IMPORTANT due to the use of `this` in the function
   // body.
-  beforeEach(async function (context) {
+  beforeEach(async (context) => {
     // The recorder has some convenience methods, and we need to store a
     // reference to it so that we can `stop()` the recorder later in the
     // `afterEach` hook.
@@ -74,7 +74,7 @@ describe("[AAD] ConfigurationClient functional tests", function () {
   });
 
   // After each test, we need to stop the recording.
-  afterEach(async function () {
+  afterEach(async () => {
     await recorder.stop();
   });
 

sdk/template/template/test/snippets.spec.ts

@@ -7,14 +7,14 @@ import { ConfigurationClient } from "../src/index.js";
 import { describe, it } from "vitest";
 
 describe("snippets", function () {
-  it("new_configurationclient", function () {
+  it("ReadmeSampleCreateClient", () => {
     const client = new ConfigurationClient(
       process.env.ENDPOINT ?? "<app configuration endpoint>",
       new DefaultAzureCredential(),
     );
   });
 
-  it("setloglevel", () => {
+  it("SetLogLevel", () => {
     setLogLevel("verbose");
   });
 });

sdk/template/template/tsconfig.json

@@ -1,7 +1,13 @@
 {
   "references": [
-    { "path": "./tsconfig.src.json" },
-    { "path": "./tsconfig.samples.json" },
-    { "path": "./tsconfig.test.json" }
+    {
+      "path": "./tsconfig.src.json"
+    },
+    {
+      "path": "./tsconfig.samples.json"
+    },
+    {
+      "path": "./tsconfig.test.json"
+    }
   ]
 }

sdk/template/template/vitest.browser.config.ts

@@ -8,10 +8,9 @@ export default mergeConfig(
   viteConfig,
   defineConfig({
     test: {
-      include: [
-        "dist-test/browser/test/internal/**/*.spec.js",
-        "dist-test/browser/test/public/**/*.spec.js",
-      ],
+      include: ["dist-test/browser/test/**/*.spec.js"],
+      testTimeout: 1200000,
+      hookTimeout: 1200000,
     },
   }),
 );