feat!: [OSM-2918] Extract rollforward policy (#94)

BREAKING CHANGE: Removed the `extractTargetSdkFromGlobalJson` method in favour of a new one that also extracts rollForward

Author: nico-incubiq

lib/index.ts

@@ -36,12 +36,12 @@ export {
   buildDepTreeFromFiles,
   containsPackageReference,
   extractProjectSdkFromProjectFile,
+  extractSdkAndRollForwardPolicyFromGlobalJson,
   extractTargetFrameworksFromFiles,
   extractTargetFrameworksFromProjectFile,
   extractTargetFrameworksFromProjectConfig,
   extractTargetFrameworksFromProjectJson,
   extractTargetFrameworksFromProjectAssetsJson,
-  extractTargetSdkFromGlobalJson,
   extractProps,
   isSupportedByV2GraphGeneration,
   isSupportedByV3GraphGeneration,
@@ -320,14 +320,20 @@ async function extractTargetFrameworksFromProjectAssetsJson(
   return getTargetFrameworksFromProjectAssetsJson(manifestFile);
 }
 
-function extractTargetSdkFromGlobalJson(
+function extractSdkAndRollForwardPolicyFromGlobalJson(
   manifestFileContents: string,
-): string | undefined {
+): {
+  sdk?: string;
+  rollForward?: string;
+} {
   try {
     // Use a JSONC parser as that's the format of global.json, which accepts comments,
     // see https://learn.microsoft.com/en-us/dotnet/core/tools/global-json#comments-in-globaljson
     const globalJsonAsObj = jsonc.parse(manifestFileContents);
-    return globalJsonAsObj?.sdk?.version;
+    return {
+      sdk: globalJsonAsObj?.sdk?.version,
+      rollForward: globalJsonAsObj?.sdk?.rollForward,
+    };
   } catch (err: any) {
     throw new Error(
       `Extracting target framework failed with error ${err.message}`,

test/fixtures/dotnet-core-global-json/global_no_version.json

@@ -0,0 +1,5 @@
+{
+  "sdk": {
+    "rollForward": "latestMajor"
+  }
+}

test/fixtures/dotnet-core-global-json/global_with_comments.json

@@ -1,7 +1,7 @@
 {
   // This is a comment.
   "sdk": {
-    "comment": "This is a comment with a URL https://google.com",
+    "comment": "This is a JSON string with a URL https://google.com",
     "version": "7.0.100" /* This is comment 2*/
     /* This is a
     multiline comment.*/

test/lib/global-json.spec.ts

@@ -1,31 +1,46 @@
-import { extractTargetSdkFromGlobalJson } from '../../lib';
+import { extractSdkAndRollForwardPolicyFromGlobalJson } from '../../lib';
 import * as fs from 'fs';
 import * as path from 'path';
 
-describe('for global.json target SDKs', () => {
+describe('global.json parsing', () => {
   it.each([
     {
       fixturePath: path.resolve(
         `${__dirname}/../fixtures/dotnet-core-global-json`,
         'global_normal.json',
       ),
-      expected: '6.0.203',
+      expected: {
+        sdk: '6.0.203',
+        rollForward: 'latestFeature',
+      },
     },
     {
-      // Making programmers lives hard:
-      // https://learn.microsoft.com/en-us/dotnet/core/tools/global-json#comments-in-globaljson
       fixturePath: path.resolve(
         `${__dirname}/../fixtures/dotnet-core-global-json`,
         'global_with_comments.json',
       ),
-      expected: '7.0.100',
+      expected: {
+        sdk: '7.0.100',
+        rollForward: undefined,
+      },
+    },
+    {
+      fixturePath: path.resolve(
+        `${__dirname}/../fixtures/dotnet-core-global-json`,
+        'global_no_version.json',
+      ),
+      expected: {
+        sdk: undefined,
+        rollForward: 'latestMajor',
+      },
     },
   ])(
-    'should correctly parse TargetFramework with condition',
+    'should correctly parse SDK and rollForward',
     async ({ fixturePath, expected }) => {
       const globalJson = fs.readFileSync(fixturePath, 'utf-8');
 
-      const targetSdk = extractTargetSdkFromGlobalJson(globalJson);
+      const targetSdk =
+        extractSdkAndRollForwardPolicyFromGlobalJson(globalJson);
 
       expect(globalJson).toBeTruthy();
       expect(targetSdk).toEqual(expected);