Change exception type/message when project item does not exist #391
Conversation
|
Tests passed for netcoreapp2.0 and netcoreapp3.1, but I am not able to run the tests for net5.0 yet. |
| @@ -108,7 +108,7 @@ public virtual async Task<RazorCodeDocument> CreateCodeDocumentAsync(RazorLightP | |||
|
|
|||
| if (!projectItem.Exists) | |||
| { | |||
| throw new InvalidOperationException($"Project can not find template with key {projectItem.Key}"); | |||
| throw new InvalidOperationException($"RazorLightProjectItem with key {projectItem.Key} must exist"); | |||
There was a problem hiding this comment.
Use $"nameof(RazorLightProjectItem) of type {projectItem.GetType().FullName} with key {projectItem.Key} does not exist."
My rationale being that it would help when people ask for help to know exactly what type of RazorLightProjectItem they passed in.
There was a problem hiding this comment.
I've made the requested changes. I also added two additional tests since the new exception messages require that projectItem is not null.
| @@ -71,7 +71,7 @@ public async Task<IGeneratedRazorTemplate> GenerateCodeAsync(RazorLightProjectIt | |||
|
|
|||
| if (!projectItem.Exists) | |||
| { | |||
| throw new TemplateNotFoundException($"Project can not find template with key {projectItem.Key}"); | |||
| throw new InvalidOperationException($"RazorLightProjectItem with key {projectItem.Key} must exist"); | |||
There was a problem hiding this comment.
Use $"nameof(RazorLightProjectItem) of type {projectItem.GetType().FullName} with key {projectItem.Key} does not exist."
My rationale being that it would help when people ask for help to know exactly what type of RazorLightProjectItem they passed in.
There was a problem hiding this comment.
I've made the requested changes. I also added two additional tests since the new exception messages require that projectItem is not null.
|
Thanks. I will try to push this out tonight. |
Change exception type/message when project item does not exist
This is related to the discussion in #378
RazorSourceGenerator.GenerateCodeAsync(RazorLightProjectItem projectItem)andRazorSourceGenerator.CreateCodeDocumentAsync(RazorLightProjectItem projectItem)both accept aRazorLightProjectItemwith the precondition that the.Existsproperty is true. Previously, when this precondition was not met,GenerateCodeAsyncthrew aTemplateNotFoundExceptionwhileCreateCodeDoucmentAsyncthrew aInvalidOperationException. The exception language and type (inGenerateCodeAsync) made it sound like these methods are trying to "look up" a template, when in reality they are only checking theExistsproperty on the project item. These changes clarify the behavior of these methods and make the exception type consistent.