Sdílet prostřednictvím


Vývoj webového rozšíření

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Využijte rozšíření k vylepšení Azure DevOps pomocí nových webových prostředí, widgetů řídicích panelů, úloh sestavení a dalších funkcí. Rozšíření můžete vyvíjet pomocí standardních technologií, jako je HTML, JavaScript a CSS. Tento kurz vás provede vytvořením webového rozšíření pro Azure DevOps.

Tip

Prozkoumejte ukázky rozšíření a nejnovější dokumentaci k vývoji rozšíření pomocí sady Azure DevOps Extension SDK.

Požadavky

Musíte mít následující oprávnění a instalace.

  • Musíte být vlastníkem organizace. Pokud organizaci nemáte, můžete si ji zdarma vytvořit.
  • Nainstalujte Node.js.
  • Nainstalujte nástroj pro balení rozšíření (TFX). Spusťte npm install -g tfx-cli ho z příkazového řádku, který použijete k pozdějšímu zabalení rozšíření .

Vytvoření adresáře a manifestu

Přípona se skládá ze sady souborů, které obsahují požadovaný soubor manifestu. Zabalíte ho do souboru .vsix a publikujete ho na Visual Studio Marketplace.

  1. Vytvořte adresář pro uložení souborů potřebných pro vaše rozšíření:

    mkdir my-first-extension
    
  2. Z tohoto adresáře inicializujete nový manifest balíčku npm:

    npm init -y
    

    Tento soubor popisuje knihovny vyžadované vaší příponou.

  3. Nainstalujte balíček microsoft VSS Web Extension SDK a uložte ho do manifestu balíčku npm:

    npm install azure-devops-extension-sdk --save
    

    Tato sada SDK obsahuje javascriptovou knihovnu, která poskytuje rozhraní API požadovaná pro komunikaci se stránkou, do které je vaše rozšíření vložené.

  4. Vytvořte soubor manifestu přípony s názvem vss-extension.json v kořenovém adresáři rozšíření s následujícím obsahem:

    {
        "manifestVersion": 1,
        "id": "my-first-extension",
        "publisher": "",
        "version": "1.0.0",
        "name": "My First Extension",
        "description": "A sample Visual Studio Services extension",
        "public": false,
        "categories": ["Azure Repos"],
        "targets": [
            {
                "id": "Microsoft.VisualStudio.Services"
            }
        ],
        "contributions": [
            {
                "id": "my-hub",
                "type": "ms.vss-web.hub",
                "targets": [
                    "ms.vss-code-web.code-hub-group"
                ],
                "properties": {
                    "name": "My Hub",
                    "uri": "my-hub.html"
                }
            }
        ],
        "files": [
            {
                "path": "my-hub.html",
                "addressable": true
            },
            {
                "path": "node_modules/azure-devops-extension-sdk",
                "addressable": true,
                "packagePath": "lib"
            }
        ]
    }
    

    Poznámka:

    Vlastnost public určuje, jestli je rozšíření viditelné všem na Visual Studio Marketplace. Během vývoje nechte rozšíření soukromá.

  5. Vytvořte soubor s názvem my-hub.html v kořenovém adresáři rozšíření s následujícím obsahem, který je určený pro zobrazení (označované také jako centrum) přispívající do webového prostředí.

    <!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"></script>
        <script>
            window.requirejs.config({
                enforceDefine: true,
                paths: {
                    'SDK': './lib/SDK.min'
                }
            });
            window.requirejs(['SDK'], function (SDK) {
                if (typeof SDK !== 'undefined') {
                    console.log("SDK is defined. Trying to initialize...");
                    SDK.init();
                    SDK.ready().then(() => {
                        console.log("SDK is ready");
                        document.getElementById("name").innerText = SDK.getUser().displayName;
                    });
                } else {
                    console.log('SDK is not defined');
                }
            });
        </script>
        <style>
            body {
                background-color: rgb(0, 67, 117);
                color: white;
                margin: 10px;    
                font-family: "Segoe UI VSS (Regular)","-apple-system",BlinkMacSystemFont,"Segoe UI",sans-serif;
            }
        </style>
    </head>
    <body>        
        <h1>Hello, <span id="name"></span></h1>
    </body>
    </html>
    
  6. Adresář rozšíření by měl vypadat jako v následujícím příkladu.

    |-- my-hub.html
    |-- node_modules
        |-- @types
        |-- azure-devops-extension-sdk
    |-- package.json
    |-- vss-extension.json
    
Potřebujete pomoc? Publikujte dotazy do komunity vývojářů Azure DevOps Services.

Další kroky