Add support for calling kiota via standard npx command #6453

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

Open

garethj-msft wants to merge 32 commits into microsoft:main from garethj-msft:garethj/npxsupport

.github/workflows/build-vscode-extension.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -63,6 +63,8 @@ jobs: @@
             shell: pwsh
           - name: Install dependencies
+            env:
+              SKIP_POSTINSTALL: "true"
             run: npm install
             working-directory: vscode
@@ Expand Down Expand Up / @@ -145,6 +147,8 @@ jobs: @@
             shell: pwsh
           - name: Install dependencies
+            env:
+              SKIP_POSTINSTALL: "true"
             run: npm install
             working-directory: vscode
@@ Expand Down @@

.github/workflows/codeql-analysis.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -92,6 +92,8 @@ jobs: @@
           - name: Restore dependencies
             run: dotnet restore
           - name: Build
+            env:
+              SKIP_POSTINSTALL: "true"
             run: dotnet build --no-restore -c Release
           - name: Perform CodeQL Analysis
@@ Expand Down @@

.github/workflows/dotnet.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -16,11 +16,34 @@ jobs: @@
             uses: actions/setup-dotnet@v4
             with:
               dotnet-version: 9.x
+          - name: Setup Node.js
+            uses: actions/setup-node@v4
+            with:
+              node-version: 22.x
           - name: Restore dependencies
             run: dotnet restore kiota.sln
           - name: Check formatting
             run: dotnet format --verify-no-changes
+          - run: |
+              scripts/get-version-from-csproj.ps1 -isGHA $true -csprojPath "$PWD/src/kiota/kiota.csproj"
+            name: "Get Kiota's version-number from .csproj"
+            id: get_version
+            shell: pwsh
+          - run: |
+              $runtimeFilePath = "./vscode/packages/npm-package/runtime.json"
+              # decrease the minor version by 1 to avoid issues with binaries that are not published
+              $versionParts = "${{ steps.get_version.outputs.version }}".Split('.')
+              $versionParts[1] = [int]$versionParts[1] - 1
+              $versionParts = $versionParts -join '.'
+              $runtimeJson = Get-Content $runtimeFilePath | ConvertFrom-Json
+              $runtimeJson.kiotaVersion = $versionParts
+              $runtimeJson | ConvertTo-Json | Set-Content $runtimeFilePath
+            shell: pwsh
+            name: "Update runtime.json with Kiota's version for install unit test"
           - name: Build
+            env:
+              SKIP_POSTINSTALL: "true"
             run: dotnet build kiota.sln --no-restore
           - name: Test
             run: dotnet test kiota.sln --no-build --verbosity normal --collect:"XPlat Code Coverage"
@@ Expand All / @@ -37,7 +60,14 @@ jobs: @@
         strategy:
           fail-fast: false
           matrix:
-            os: [ubuntu-latest, macos-latest, windows-latest, windows-11-arm, ubuntu-24.04-arm]
+            os:
+              [
+                ubuntu-latest,
+                macos-latest,
+                windows-latest,
+                windows-11-arm,
+                ubuntu-24.04-arm,
+              ]
         runs-on: ${{ matrix.os }}
         steps:
           - uses: actions/checkout@v4
@@ Expand Down @@

CHANGELOG.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ### Added
+    - Added support for calling kiota as npx command. [#6642](https://github.com/microsoft/kiota/issues/6642)
     ### Changed
     ## [1.28.0] - 2025-07-11
@@ Expand Down Expand Up @@
     ### Added
     - Initial GitHub release

kiota.sln

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,7 +1,7 @@
  
    ﻿

    Microsoft Visual Studio Solution File, Format Version 12.00

    # Visual Studio Version 16

    VisualStudioVersion = 16.0.30804.86

    # Visual Studio Version 17

    VisualStudioVersion = 17.13.35931.197

    MinimumVisualStudioVersion = 10.0.40219.1

    Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "kiota", "src\kiota\kiota.csproj", "{944FCE5E-0CFA-4018-B353-E14FA1395007}"

    EndProject

    @@ -19,6 +19,28 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{EAAC5CEA-33B
  
    EndProject

    Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "KiotaGenerated", "src\Kiota.Generated\KiotaGenerated.csproj", "{01ABDF23-60CD-4CE3-8DC7-8654C4BA1EE8}"

    EndProject

    Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kiota.NPM.IntegrationTests", "tests\Kiota.NPM.IntegrationTests\Kiota.NPM.IntegrationTests.csproj", "{51296EA6-7A4A-2A93-5060-1FBD4CB31CC5}"

    EndProject

    Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "NPMProjects", "NPMProjects", "{02EA681E-C7D8-13C7-8484-4AC65E1B71E8}"

    EndProject

    Project("{54A90642-561A-4BB1-A94E-469ADEE60C69}") = "npm-package", "vscode\packages\npm-package\npm-package.esproj", "{C6BFB632-723D-238A-EA11-44E78644612E}"

    EndProject

    Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Workflows", "Workflows", "{099BEFDC-D101-4DB6-B028-E24376B6DC50}"

    	ProjectSection(SolutionItems) = preProject

    		.github\workflows\auto-merge-dependabot.yml = .github\workflows\auto-merge-dependabot.yml

    		.github\workflows\build-vscode-extension.yml = .github\workflows\build-vscode-extension.yml

    		.github\workflows\check-translations.yml = .github\workflows\check-translations.yml

    		.github\workflows\codeql-analysis.yml = .github\workflows\codeql-analysis.yml

    		.github\workflows\codeql-required-workaround.yml = .github\workflows\codeql-required-workaround.yml

    		.github\workflows\dotnet-required-workaround.yml = .github\workflows\dotnet-required-workaround.yml

    		.github\workflows\dotnet.yml = .github\workflows\dotnet.yml

    		.github\workflows\idempotency-tests.yml = .github\workflows\idempotency-tests.yml

    		.github\workflows\integration-tests.yml = .github\workflows\integration-tests.yml

    		.github\workflows\load-tests.yml = .github\workflows\load-tests.yml

    		.github\workflows\project-auto-add.yml = .github\workflows\project-auto-add.yml

    		.github\workflows\sonarcloud.yml = .github\workflows\sonarcloud.yml

    	EndProjectSection

    EndProject

    Global

    	GlobalSection(SolutionConfigurationPlatforms) = preSolution

    		Debug|Any CPU = Debug|Any CPU

    @@ -49,15 +71,32 @@ Global
  
    		{01ABDF23-60CD-4CE3-8DC7-8654C4BA1EE8}.Debug|Any CPU.Build.0 = Debug|Any CPU

    		{01ABDF23-60CD-4CE3-8DC7-8654C4BA1EE8}.Release|Any CPU.ActiveCfg = Release|Any CPU

    		{01ABDF23-60CD-4CE3-8DC7-8654C4BA1EE8}.Release|Any CPU.Build.0 = Release|Any CPU

    		{51296EA6-7A4A-2A93-5060-1FBD4CB31CC5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU

    		{51296EA6-7A4A-2A93-5060-1FBD4CB31CC5}.Debug|Any CPU.Build.0 = Debug|Any CPU

    		{51296EA6-7A4A-2A93-5060-1FBD4CB31CC5}.Release|Any CPU.ActiveCfg = Release|Any CPU

    		{51296EA6-7A4A-2A93-5060-1FBD4CB31CC5}.Release|Any CPU.Build.0 = Release|Any CPU

    		{C6BFB632-723D-238A-EA11-44E78644612E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU

    		{C6BFB632-723D-238A-EA11-44E78644612E}.Debug|Any CPU.Build.0 = Debug|Any CPU

    		{C6BFB632-723D-238A-EA11-44E78644612E}.Debug|Any CPU.Deploy.0 = Debug|Any CPU

    		{C6BFB632-723D-238A-EA11-44E78644612E}.Release|Any CPU.ActiveCfg = Release|Any CPU

    		{C6BFB632-723D-238A-EA11-44E78644612E}.Release|Any CPU.Build.0 = Release|Any CPU

    		{C6BFB632-723D-238A-EA11-44E78644612E}.Release|Any CPU.Deploy.0 = Release|Any CPU

    	EndGlobalSection

    	GlobalSection(SolutionProperties) = preSolution

    		HideSolutionNode = FALSE

    	EndGlobalSection

    	GlobalSection(ExtensibilityGlobals) = postSolution

    		SolutionGuid = {85C3AE3B-2D83-4457-B2F9-E56D64F4E443}

    	EndGlobalSection

    	GlobalSection(NestedProjects) = preSolution

    		{944FCE5E-0CFA-4018-B353-E14FA1395007} = {EAAC5CEA-33B8-495D-9CD0-B36794B8AFE7}

    		{1F5FC53F-061A-4CED-8B53-FC5C63DBEBFF} = {EAAC5CEA-33B8-495D-9CD0-B36794B8AFE7}

    		{A2B2F620-BC5D-47EA-8B98-5A942EC9CA9A} = {2DF34BB8-B19F-4623-9E3D-9F59A14C0660}

    		{019E5612-7663-40A2-A2EA-46E39D31F0A2} = {2DF34BB8-B19F-4623-9E3D-9F59A14C0660}

    		{E4C108A5-A13F-4C3F-B32A-86210A4EC52A} = {2DF34BB8-B19F-4623-9E3D-9F59A14C0660}

    		{01ABDF23-60CD-4CE3-8DC7-8654C4BA1EE8} = {EAAC5CEA-33B8-495D-9CD0-B36794B8AFE7}

    		{51296EA6-7A4A-2A93-5060-1FBD4CB31CC5} = {2DF34BB8-B19F-4623-9E3D-9F59A14C0660}

    		{02EA681E-C7D8-13C7-8484-4AC65E1B71E8} = {EAAC5CEA-33B8-495D-9CD0-B36794B8AFE7}

    		{C6BFB632-723D-238A-EA11-44E78644612E} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}

    	EndGlobalSection

    	GlobalSection(ExtensibilityGlobals) = postSolution

    		SolutionGuid = {85C3AE3B-2D83-4457-B2F9-E56D64F4E443}

    	EndGlobalSection

    EndGlobal

tests/Kiota.NPM.IntegrationTests/.runsettings

-Original file line number
+Diff line change
@@ -0,0 +1,6 @@
+    <?xml version="1.0" encoding="utf-8" ?>
+    <RunSettings>
+        <xUnit>
+            <ShowLiveOutput>true</ShowLiveOutput>
+        </xUnit>
+    </RunSettings>

tests/Kiota.NPM.IntegrationTests/Assets/package.json

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    {
+      "name": "kiota-consumer",
+      "version": "1.0.0",
+      "description": "",
+      "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+      },
+      "author": "",
+      "license": "MIT",
+      "dependencies": {
+        "@microsoft/kiota": "file:./microsoft-kiota-1.0.0.tgz"
+      }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for calling kiota via standard npx command #6453

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Add support for calling kiota via standard npx command #6453

Are you sure you want to change the base?

Uh oh!

Add support for calling kiota via standard npx command #6453

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!