feat(updater): add .csproj file support (#95)

Author: FlorianArnould

README.md

@@ -19,6 +19,7 @@ _Having problems? Want to contribute? Join us on the [node-tooling community Sla
     - [How It Works:](#how-it-works)
     - [`bumpFiles`, `packageFiles` and `updaters`](#bumpfiles-packagefiles-and-updaters)
     - [Gradle Support (Java/Kotlin)](#gradle-support-javakotlin)
+    - [.NET Support](#net-support)
   - [Installing `commit-and-tag-version`](#installing-commit-and-tag-version)
     - [As a local `npm run` script](#as-a-local-npm-run-script)
     - [As global `bin`](#as-global-bin)
@@ -88,6 +89,13 @@ If you are using Gradle, then just point to your `build.gradle` file (or `build.
 commit-and-tag-version --packageFiles build.gradle --bumpFiles build.gradle
 ```
 
+### .NET Support
+
+If you are using .NET with `.csproj` files.
+This is going to read and update only the `<Version>` tag in the file.
+```sh
+commit-and-tag-version --packageFiles <YOUR-PROJECT-NAME>.csproj --bumpFiles <YOUR-PROJECT-NAME>.csproj
+```
 
 ## Installing `commit-and-tag-version`
 

lib/updaters/index.js

@@ -3,7 +3,8 @@ const JSON_BUMP_FILES = require('../../defaults').bumpFiles
 const updatersByType = {
   json: require('./types/json'),
   'plain-text': require('./types/plain-text'),
-  gradle: require('./types/gradle')
+  gradle: require('./types/gradle'),
+  csproj: require('./types/csproj')
 }
 const PLAIN_TEXT_BUMP_FILES = ['VERSION.txt', 'version.txt']
 
@@ -25,6 +26,9 @@ function getUpdaterByFilename (filename) {
   if (/build.gradle/.test(filename)) {
     return getUpdaterByType('gradle')
   }
+  if (filename.endsWith('.csproj')) {
+    return getUpdaterByType('csproj')
+  }
   throw Error(
     `Unsupported file (${filename}) provided for bumping.\n Please specify the updater \`type\` or use a custom \`updater\`.`
   )

lib/updaters/types/csproj.js

@@ -0,0 +1,13 @@
+const versionRegex = /<Version>(.*)<\/Version>/
+
+module.exports.readVersion = function (contents) {
+  const matches = versionRegex.exec(contents)
+  if (matches === null || matches.length !== 2) {
+    throw new Error('Failed to read the Version field in your csproj file - is it present?')
+  }
+  return matches[1]
+}
+
+module.exports.writeVersion = function (contents, version) {
+  return contents.replace(versionRegex, `<Version>${version}</Version>`)
+}

test/core.spec.js

@@ -769,6 +769,22 @@ describe('commit-and-tag-version', function () {
     fs.readFileSync('build.gradle.kts', 'utf-8').should.equal(expected)
   })
 
+  it('bumps version in .NET `Project.csproj` file', async function () {
+    const expected = fs.readFileSync('./test/mocks/Project-6.4.0.csproj', 'utf-8')
+    const filename = 'Project.csproj'
+    mock({
+      bump: 'minor',
+      fs: {
+        [filename]: fs.readFileSync('./test/mocks/Project-6.3.1.csproj')
+      }
+    })
+    await exec({
+      packageFiles: [{ filename, type: 'csproj' }],
+      bumpFiles: [{ filename, type: 'csproj' }]
+    })
+    fs.readFileSync(filename, 'utf-8').should.equal(expected)
+  })
+
   it('bumps version # in npm-shrinkwrap.json', async function () {
     mock({
       bump: 'minor',

test/mocks/Project-6.3.1.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+    <PropertyGroup>
+        <TargetFramework>net7.0</TargetFramework>
+        <Nullable>enable</Nullable>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Version>6.3.1</Version>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="7.0.10"/>
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="7.0.10"/>
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="7.0.10"/>
+        <PackageReference Include="Microsoft.Identity.Web" Version="1.16.0"/>
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0"/>
+    </ItemGroup>
+
+</Project>

test/mocks/Project-6.4.0.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+    <PropertyGroup>
+        <TargetFramework>net7.0</TargetFramework>
+        <Nullable>enable</Nullable>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Version>6.4.0</Version>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="7.0.10"/>
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="7.0.10"/>
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="7.0.10"/>
+        <PackageReference Include="Microsoft.Identity.Web" Version="1.16.0"/>
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0"/>
+    </ItemGroup>
+
+</Project>