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

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

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í. Tento kurz vás provede vytvořením a zabalením jednoduchého webového rozšíření.

Spropitné

Kompletní referenční informace najdete v úložišti azure-devops-extension-sample .

Požadavky

Kategorie Požadavky
Oprávnění Vlastník organizace nebo člen skupiny Správci kolekce projektů
Nástroje - Node.js (doporučuje se verze LTS)
- Nástroj pro balení rozšíření: Pro instalaci spusťte npm install -g tfx-cliTFX CLI.

Vytvoření adresáře a manifestu

Přípona je sada souborů, které obsahují požadovaný soubor manifestu. Zabalte příponu do souboru .vsix a publikujte ho na Visual Studio Marketplace.

  1. Vytvořte adresář pro rozšíření:

    mkdir my-first-extension && cd my-first-extension

  2. Inicializace manifestu balíčku npm:

    npm init -y

  3. Nainstalujte sadu SDK rozšíření Azure DevOps:

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

    Tato sada SDK poskytuje rozhraní API pro komunikaci s rámcem hostitele Azure DevOps.

  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 Azure DevOps 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"
        }
    ]
}

    Důležité

    publisher Nastavte pole na ID vydavatele Marketplace. Vlastnost public určuje, jestli je rozšíření viditelné všem na Webu 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. Tato stránka HTML je zobrazením (výchozí bod) zahrnuté do webového prostředí Azure DevOps.

    <!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) {
            SDK.init();
            SDK.ready().then(function () {
                document.getElementById("name").innerText = SDK.getUser().displayName;
            });
        });
    </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>

    Poznámka:

    V tomto příkladu se k načtení sady SDK používá RequireJS, která funguje bez kroku sestavení. V případě produkčních rozšíření použijte k zajištění lepšího výkonu balíček, například webpack, s importy modulů ES (import * as SDK from "azure-devops-extension-sdk"). Podívejte se na ukázku rozšíření pro nastavení založené na webovém balíčku.

  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 pomoct? Publikujte dotazy do komunity vývojářů Azure DevOps Services.

Další krok

Zabalte a publikujte své rozšíření

Související obsah

  • Last updated on