Skip to content

Commit 0b29e5a

Browse files
AArnottAArnott
authored
Merge pull request #644 from dotnet/IsNull
Apply `is null` pattern and analyzer
2 parents 0d49d20 + 9ead478 commit 0b29e5a

32 files changed

+88
-80
lines changed

‎.editorconfig

+6
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,9 @@ csharp_new_line_before_catch = true
7979
csharp_new_line_before_finally = true
8080
csharp_new_line_before_members_in_object_initializers = true
8181
csharp_new_line_before_members_in_anonymous_types = true
82+
83+
# CSIsNull001: Use `is null` for null checks
84+
dotnet_diagnostic.CSIsNull001.severity = warning
85+
86+
# CSIsNull002: Use `is object` for non-null checks
87+
dotnet_diagnostic.CSIsNull002.severity = warning

‎src/Directory.Build.props

+5-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@
2424
<LibGit2SharpNativeVersion>2.0.312</LibGit2SharpNativeVersion>
2525
</PropertyGroup>
2626
<ItemGroup>
27-
<PackageReference Include="Microsoft.Net.Compilers.Toolset" Version="3.8.0-5.final" PrivateAssets="all" />
27+
<PackageReference Include="Microsoft.Net.Compilers.Toolset" Version="3.11.0" PrivateAssets="all" />
2828
<PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" PrivateAssets="All" />
2929
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
30+
<PackageReference Include="CSharpIsNullAnalyzer" Version="0.1.288-beta">
31+
<PrivateAssets>all</PrivateAssets>
32+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
33+
</PackageReference>
3034
</ItemGroup>
3135
<ItemGroup>
3236
<None Include="$(MSBuildThisFileDirectory)..\3rdPartyNotices.txt" Pack="true" PackagePath="" />

‎src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ public async Task GetBuildVersion_In_Git_But_Head_Lacks_VersionFile()
219219
var repo = new Repository(this.RepoPath); // do not assign Repo property to avoid commits being generated later
220220
repo.Commit("empty", this.Signer, this.Signer, new CommitOptions { AllowEmptyCommit = true });
221221
this.WriteVersionFile("3.4");
222-
Assumes.True(repo.Index[VersionFile.JsonFileName] == null);
222+
Assumes.True(repo.Index[VersionFile.JsonFileName] is null);
223223
var buildResult = await this.BuildAsync();
224224
Assert.Equal("3.4.0." + this.GetVersion().Revision, buildResult.BuildVersion);
225225
Assert.Equal("3.4.0+" + repo.Head.Tip.Id.Sha.Substring(0, VersionOptions.DefaultGitCommitIdShortFixedLength), buildResult.AssemblyInformationalVersion);

‎src/NerdBank.GitVersioning.Tests/ManagedGit/DeltaStreamReaderTests.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public void ReadStreamTest()
8989

9090
DeltaInstruction? current;
9191

92-
while ((current = DeltaStreamReader.Read(stream)) != null)
92+
while ((current = DeltaStreamReader.Read(stream)) is not null)
9393
{
9494
instructions.Add(current.Value);
9595
}
@@ -139,7 +139,7 @@ public void ReadStreamTest_Memory()
139139

140140
DeltaInstruction? current;
141141

142-
while ((current = DeltaStreamReader.Read(ref memory)) != null)
142+
while ((current = DeltaStreamReader.Read(ref memory)) is not null)
143143
{
144144
instructions.Add(current.Value);
145145
}

‎src/NerdBank.GitVersioning.Tests/ReleaseManagerTests.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ public void PrepareRelease_Master(
320320

321321
// prepare release
322322
var releaseManager = new ReleaseManager();
323-
releaseManager.PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion == null ? null : Version.Parse(nextVersion)), parameterVersionIncrement);
323+
releaseManager.PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion is null ? null : Version.Parse(nextVersion)), parameterVersionIncrement);
324324

325325
// check if a branch was created
326326
Assert.Contains(this.LibGit2Repository.Branches, branch => branch.FriendlyName == expectedBranchName);
@@ -394,7 +394,7 @@ public void PrepareRelease_MasterWithVersionDecrement(string initialVersion, str
394394
// running PrepareRelease should result in an error
395395
// because we're trying to add a prerelease tag to a version without prerelease tag
396396
this.AssertError(
397-
() => new ReleaseManager().PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion == null ? null : Version.Parse(nextVersion))),
397+
() => new ReleaseManager().PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion is null ? null : Version.Parse(nextVersion))),
398398
ReleasePreparationError.VersionDecrement);
399399
}
400400

‎src/NerdBank.GitVersioning.Tests/RepoTestBase.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ protected void AddCommits(int count = 1)
143143

144144
protected Commit? WriteVersionTxtFile(string version = "1.2", string prerelease = "", string? relativeDirectory = null)
145145
{
146-
if (relativeDirectory == null)
146+
if (relativeDirectory is null)
147147
{
148148
relativeDirectory = string.Empty;
149149
}
@@ -163,7 +163,7 @@ protected void AddCommits(int count = 1)
163163
{
164164
Requires.NotNull(versionData, nameof(versionData));
165165

166-
if (relativeDirectory == null)
166+
if (relativeDirectory is null)
167167
{
168168
relativeDirectory = string.Empty;
169169
}
@@ -197,7 +197,7 @@ protected void AddCommits(int count = 1)
197197
if (Path.GetExtension(relativeFilePath) == ".json")
198198
{
199199
string txtFilePath = relativeFilePath.Substring(0, relativeFilePath.Length - 4) + "txt";
200-
if (!File.Exists(Path.Combine(this.RepoPath, txtFilePath)) && this.LibGit2Repository.Index[txtFilePath] != null)
200+
if (!File.Exists(Path.Combine(this.RepoPath, txtFilePath)) && this.LibGit2Repository.Index[txtFilePath] is not null)
201201
{
202202
this.LibGit2Repository.Index.Remove(txtFilePath);
203203
}

‎src/NerdBank.GitVersioning.Tests/TestUtilities.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ internal static void ExtractEmbeddedResource(string resourcePath, string extract
5454

5555
using (var stream = GetEmbeddedResource(resourcePath))
5656
{
57-
Requires.Argument(stream != null, nameof(resourcePath), "Resource not found.");
57+
Requires.Argument(stream is not null, nameof(resourcePath), "Resource not found.");
5858
using (var extractedFile = File.OpenWrite(extractedFilePath))
5959
{
6060
stream.CopyTo(extractedFile);

‎src/NerdBank.GitVersioning.Tests/VersionFileTests.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ public void SetVersion_WritesSimplestFile(string version, string assemblyVersion
140140
var versionOptions = new VersionOptions
141141
{
142142
Version = SemanticVersion.Parse(version),
143-
AssemblyVersion = assemblyVersion != null || precision != null ? new VersionOptions.AssemblyVersionOptions(assemblyVersion != null ? new Version(assemblyVersion) : null, precision) : null,
143+
AssemblyVersion = assemblyVersion is not null || precision is not null ? new VersionOptions.AssemblyVersionOptions(assemblyVersion is not null ? new Version(assemblyVersion) : null, precision) : null,
144144
VersionHeightOffset = versionHeightOffset,
145145
Inherit = inherit,
146146
};

‎src/NerdBank.GitVersioning/AssemblyVersionOptionsConverter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
5151
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
5252
{
5353
var data = value as VersionOptions.AssemblyVersionOptions;
54-
if (data != null)
54+
if (data is not null)
5555
{
5656
if (data.PrecisionOrDefault == VersionOptions.DefaultVersionPrecision && !this.includeDefaults)
5757
{

‎src/NerdBank.GitVersioning/CloudBuildServices/GitLab.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
internal class GitLab : ICloudBuild
1515
{
1616
public string BuildingBranch =>
17-
Environment.GetEnvironmentVariable("CI_COMMIT_TAG") == null ?
17+
Environment.GetEnvironmentVariable("CI_COMMIT_TAG") is null ?
1818
$"refs/heads/{Environment.GetEnvironmentVariable("CI_COMMIT_REF_NAME")}" : null;
1919

2020
public string BuildingRef => this.BuildingBranch ?? this.BuildingTag;
2121

2222
public string BuildingTag =>
23-
Environment.GetEnvironmentVariable("CI_COMMIT_TAG") != null ?
23+
Environment.GetEnvironmentVariable("CI_COMMIT_TAG") is not null ?
2424
$"refs/tags/{Environment.GetEnvironmentVariable("CI_COMMIT_TAG")}" : null;
2525

2626
public string GitCommitId => Environment.GetEnvironmentVariable("CI_COMMIT_SHA");

‎src/NerdBank.GitVersioning/CloudBuildServices/TeamCity.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ internal class TeamCity : ICloudBuild
1919

2020
public string GitCommitId => Environment.GetEnvironmentVariable("BUILD_VCS_NUMBER");
2121

22-
public bool IsApplicable => this.GitCommitId != null;
22+
public bool IsApplicable => this.GitCommitId is not null;
2323

2424
public bool IsPullRequest => false;
2525

‎src/NerdBank.GitVersioning/FilterPathJsonConverter.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
2222
throw new NotSupportedException();
2323
}
2424

25-
if (this.repoRelativeBaseDirectory == null)
25+
if (this.repoRelativeBaseDirectory is null)
2626
{
2727
throw new ArgumentNullException(nameof(this.repoRelativeBaseDirectory), $"Base directory must not be null to be able to deserialize filter paths. Ensure that one was passed to {nameof(VersionOptions.GetJsonSettings)}, and that the version.json file is being written to a Git repository.");
2828
}
@@ -37,7 +37,7 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
3737
throw new NotSupportedException();
3838
}
3939

40-
if (this.repoRelativeBaseDirectory == null)
40+
if (this.repoRelativeBaseDirectory is null)
4141
{
4242
throw new ArgumentNullException(nameof(this.repoRelativeBaseDirectory), $"Base directory must not be null to be able to serialize filter paths. Ensure that one was passed to {nameof(VersionOptions.GetJsonSettings)}, and that the version.json file is being written to a Git repository.");
4343
}

‎src/NerdBank.GitVersioning/LibGit2/LibGit2GitExtensions.cs

+8-8
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ internal static int GetVersionHeight(LibGit2Context context, Version? baseVersio
6060
var tracker = new GitWalkTracker(context);
6161

6262
var versionOptions = tracker.GetVersion(context.Commit);
63-
if (versionOptions == null)
63+
if (versionOptions is null)
6464
{
6565
return 0;
6666
}
6767

6868
var baseSemVer =
69-
baseVersion != null ? SemanticVersion.Parse(baseVersion.ToString()) :
69+
baseVersion is not null ? SemanticVersion.Parse(baseVersion.ToString()) :
7070
versionOptions.Version ?? SemVer0;
7171

7272
var versionHeightPosition = versionOptions.VersionHeightPosition;
@@ -174,7 +174,7 @@ public static IEnumerable<Commit> GetCommitsFromVersion(LibGit2Context context,
174174
var tracker = new GitWalkTracker(context);
175175
var possibleCommits = from commit in GetCommitsReachableFromRefs(context.Repository)
176176
let commitVersionOptions = tracker.GetVersion(commit)
177-
where commitVersionOptions != null
177+
where commitVersionOptions is not null
178178
where !IsCommitIdMismatch(version, commitVersionOptions, commit)
179179
where !IsVersionHeightMismatch(version, commitVersionOptions, commit, tracker)
180180
select commit;
@@ -221,7 +221,7 @@ private static bool CommitMatchesVersion(this Commit commit, SemanticVersion exp
221221

222222
var commitVersionData = tracker.GetVersion(commit);
223223
var semVerFromFile = commitVersionData?.Version;
224-
if (semVerFromFile == null)
224+
if (semVerFromFile is null)
225225
{
226226
return false;
227227
}
@@ -250,7 +250,7 @@ private static bool CommitMatchesVersion(this Commit commit, Version expectedVer
250250

251251
var commitVersionData = tracker.GetVersion(commit);
252252
var semVerFromFile = commitVersionData?.Version;
253-
if (semVerFromFile == null)
253+
if (semVerFromFile is null)
254254
{
255255
return false;
256256
}
@@ -422,7 +422,7 @@ bool ContainsRelevantChanges(IEnumerable<TreeEntryChanges> changes) =>
422422

423423
int height = 1;
424424

425-
if (includePaths != null)
425+
if (includePaths is not null)
426426
{
427427
// If there are no include paths, or any of the include
428428
// paths refer to the root of the repository, then do not
@@ -527,8 +527,8 @@ internal static Version GetIdAsVersionHelper(this Commit? commit, VersionOptions
527527

528528
// Don't use the ?? coalescing operator here because the position property getters themselves can return null, which should NOT be overridden with our default.
529529
// The default value is only appropriate if versionOptions itself is null.
530-
var versionHeightPosition = versionOptions != null ? versionOptions.VersionHeightPosition : SemanticVersion.Position.Build;
531-
var commitIdPosition = versionOptions != null ? versionOptions.GitCommitIdPosition : SemanticVersion.Position.Revision;
530+
var versionHeightPosition = versionOptions is not null ? versionOptions.VersionHeightPosition : SemanticVersion.Position.Build;
531+
var commitIdPosition = versionOptions is not null ? versionOptions.GitCommitIdPosition : SemanticVersion.Position.Revision;
532532

533533
// The compiler (due to WinPE header requirements) only allows 16-bit version components,
534534
// and forbids 0xffff as a value.

‎src/NerdBank.GitVersioning/Managed/ManagedGitContext.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ internal override int CalculateVersionHeight(VersionOptions? committedVersion, V
9494
{
9595
var workingCopyVersion = workingVersion?.Version?.Version;
9696

97-
if (workingCopyVersion == null || !workingCopyVersion.Equals(headCommitVersion))
97+
if (workingCopyVersion is null || !workingCopyVersion.Equals(headCommitVersion))
9898
{
9999
// The working copy has changed the major.minor version.
100100
// So by definition the version height is 0, since no commit represents it yet.
@@ -153,8 +153,8 @@ private Version GetIdAsVersionHelper(VersionOptions? versionOptions, int version
153153

154154
// Don't use the ?? coalescing operator here because the position property getters themselves can return null, which should NOT be overridden with our default.
155155
// The default value is only appropriate if versionOptions itself is null.
156-
var versionHeightPosition = versionOptions != null ? versionOptions.VersionHeightPosition : SemanticVersion.Position.Build;
157-
var commitIdPosition = versionOptions != null ? versionOptions.GitCommitIdPosition : SemanticVersion.Position.Revision;
156+
var versionHeightPosition = versionOptions is not null ? versionOptions.VersionHeightPosition : SemanticVersion.Position.Build;
157+
var commitIdPosition = versionOptions is not null ? versionOptions.GitCommitIdPosition : SemanticVersion.Position.Revision;
158158

159159
// The compiler (due to WinPE header requirements) only allows 16-bit version components,
160160
// and forbids 0xffff as a value.

‎src/NerdBank.GitVersioning/Managed/ManagedGitExtensions.cs

+6-6
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ internal static int GetVersionHeight(ManagedGitContext context, Version? baseVer
3535
var tracker = new GitWalkTracker(context);
3636

3737
var versionOptions = tracker.GetVersion(context.Commit.Value);
38-
if (versionOptions == null)
38+
if (versionOptions is null)
3939
{
4040
return 0;
4141
}
4242

4343
var baseSemVer =
44-
baseVersion != null ? SemanticVersion.Parse(baseVersion.ToString()) :
44+
baseVersion is not null ? SemanticVersion.Parse(baseVersion.ToString()) :
4545
versionOptions.Version ?? SemVer0;
4646

4747
var versionHeightPosition = versionOptions.VersionHeightPosition;
@@ -69,7 +69,7 @@ private static bool CommitMatchesVersion(GitCommit commit, SemanticVersion expec
6969

7070
var commitVersionData = tracker.GetVersion(commit);
7171
var semVerFromFile = commitVersionData?.Version;
72-
if (commitVersionData == null || semVerFromFile == null)
72+
if (commitVersionData is null || semVerFromFile is null)
7373
{
7474
return false;
7575
}
@@ -167,7 +167,7 @@ bool TryCalculateHeight(GitCommit commit)
167167

168168
int height = 1;
169169

170-
if (pathFilters != null)
170+
if (pathFilters is not null)
171171
{
172172
var relevantCommit = true;
173173

@@ -250,7 +250,7 @@ private static bool IsRelevantCommit(GitRepository repository, GitTree tree, Git
250250
isRelevant = IsRelevantCommit(
251251
repository,
252252
repository.GetTree(entry.Sha),
253-
parentEntry == null ? GitTree.Empty : repository.GetTree(parentEntry.Sha),
253+
parentEntry is null ? GitTree.Empty : repository.GetTree(parentEntry.Sha),
254254
$"{fullPath}/",
255255
filters);
256256
}
@@ -262,7 +262,7 @@ private static bool IsRelevantCommit(GitRepository repository, GitTree tree, Git
262262
}
263263
}
264264

265-
if (parentEntry != null)
265+
if (parentEntry is not null)
266266
{
267267
parent.Children.Remove(child.Key);
268268
}

‎src/NerdBank.GitVersioning/ManagedGit/GitCommitReader.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public static class GitCommitReader
3838
/// </returns>
3939
public static GitCommit Read(Stream stream, GitObjectId sha, bool readAuthor = false)
4040
{
41-
if (stream == null)
41+
if (stream is null)
4242
{
4343
throw new ArgumentNullException(nameof(stream));
4444
}

‎src/NerdBank.GitVersioning/ManagedGit/GitObjectId.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public override bool Equals(object? obj)
174174
/// </summary>
175175
public override string ToString()
176176
{
177-
if (this.sha == null)
177+
if (this.sha is null)
178178
{
179179
this.sha = this.CreateString(0, 20);
180180
}

‎src/NerdBank.GitVersioning/ManagedGit/GitPack.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ public bool TryGetObject(GitObjectId objectId, string objectType, out Stream? va
146146
{
147147
var offset = this.GetOffset(objectId);
148148

149-
if (offset == null)
149+
if (offset is null)
150150
{
151151
value = null;
152152
return false;
@@ -268,7 +268,7 @@ public void Dispose()
268268
var indexReader = this.indexReader.Value;
269269
var offset = indexReader.GetOffset(objectId);
270270

271-
if (offset != null)
271+
if (offset is not null)
272272
{
273273
this.offsets.Add(objectId, offset.Value);
274274
}

‎src/NerdBank.GitVersioning/ManagedGit/GitPackDeltafiedStream.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -169,15 +169,15 @@ protected override void Dispose(bool disposing)
169169

170170
private bool TryGetInstruction(out DeltaInstruction instruction)
171171
{
172-
if (this.current != null && this.offset < this.current.Value.Size)
172+
if (this.current is not null && this.offset < this.current.Value.Size)
173173
{
174174
instruction = this.current.Value;
175175
return true;
176176
}
177177

178178
this.current = DeltaStreamReader.Read(this.deltaStream);
179179

180-
if (this.current == null)
180+
if (this.current is null)
181181
{
182182
instruction = default;
183183
return false;

‎src/NerdBank.GitVersioning/ManagedGit/GitPackIndexMappedReader.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public unsafe class GitPackIndexMappedReader : GitPackIndexReader
3232
/// </param>
3333
public GitPackIndexMappedReader(FileStream stream)
3434
{
35-
if (stream == null)
35+
if (stream is null)
3636
{
3737
throw new ArgumentNullException(nameof(stream));
3838
}

‎src/NerdBank.GitVersioning/ManagedGit/GitPackReader.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ internal static class GitPackReader
1313

1414
public static Stream GetObject(GitPack pack, Stream stream, long offset, string objectType, GitPackObjectType packObjectType)
1515
{
16-
if (pack == null)
16+
if (pack is null)
1717
{
1818
throw new ArgumentNullException(nameof(pack));
1919
}
2020

21-
if (stream == null)
21+
if (stream is null)
2222
{
2323
throw new ArgumentNullException(nameof(stream));
2424
}

0 commit comments

Comments
 (0)