Skip to content
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

adding placeholders for all resource strings and rule ids. #1943

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/Sarif.Multitool/Rules/RuleId.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System.Runtime.CompilerServices;
Copy link
Contributor Author

@harleenkohli harleenkohli Jun 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this came in by mistake, will remove! #Closed


namespace Microsoft.CodeAnalysis.Sarif.Multitool.Rules
{
public static class RuleId
Expand All @@ -9,17 +11,32 @@ public static class RuleId
public const string UrisMustBeValid = "SARIF1002";
public const string ExpressUriBaseIdsCorrectly = "SARIF1004";
public const string UriMustBeAbsolute = "SARIF1005";

public const string InvocationPropertiesMustBeConsistent = "SARIF1006";
public const string RegionPropertiesMustBeConsistent = "SARIF1007";
public const string PhysicalLocationPropertiesMustBeConsistent = "SARIF1008";
public const string IndexPropertiesMustBeConsistentWithArrays = "SARIF1009";
public const string RuleIdMustBeConsistent = "SARIF1010";

public const string ReferenceFinalSchema = "SARIF1011";
public const string MessageArgumentsMustBeConsistentWithRule = "SARIF1012";

public const string AuthorHighQualityMessages = "SARIF2001";
public const string AuthorHighQualityMessages = "SARIF2001"; //TODO: rename and split into multiple
public const string ProvideMessageArguments = "SARIF2002";
public const string ProvideVersionControlProvenance = "SARIF2003";
public const string OptimizeFileSize = "SARIF2004";
public const string ProvideHelpfulToolInformation = "SARIF2005";
public const string ProvideToolProperties = "SARIF2005";

public const string UrisShouldBeReachable = "SARIF2006";
public const string ExpressPathsRelativeToRepoRoot = "SARIF2007";
public const string ProvideSchema = "SARIF2008";
public const string ConsiderConventionalIdentifierValues = "SARIF2009";
public const string ProvideCodeSnippets = "SARIF2010";

public const string ProvideContextRegion = "SARIF2011";
public const string ProvideHelpUris = "SARIF2012";
public const string ProvideEmbeddedFileContent = "SARIF2013";
public const string ProvideDynamicMessageContent = "SARIF2014";
public const string EnquoteDynamicMessageContent = "SARIF2015";
}
}
217 changes: 217 additions & 0 deletions src/Sarif.Multitool/Rules/RuleResources.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

72 changes: 72 additions & 0 deletions src/Sarif.Multitool/Rules/RuleResources.resx
Original file line number Diff line number Diff line change
Expand Up @@ -283,4 +283,76 @@ Many tool use similar names for 'uriBaseId' symbols. We suggest 'REPOROOT' for t
<data name="SARIF2004_OptimizeFileSize_Warning_EliminateLocationOnlyArtifacts_Text" xml:space="preserve">
<value>{0}: Placeholder_SARIF2004_OptimizeFileSize_Warning_EliminateLocationOnlyArtifacts_Text</value>
</data>
<data name="SARIF1012_MessageArgumentsMustBeConsistentWithRule_Error_MessageIdMustExist_Text" xml:space="preserve">
<value>Placeholder_SARIF1012_MessageArgumentsMustBeConsistentWithRule_Error_MessageIdMustExist_Text</value>
</data>
<data name="SARIF1012_MessageArgumentsMustBeConsistentWithRule_Error_SupplyEnoughMessageArguments_Text" xml:space="preserve">
<value>Placeholder_SARIF1012_MessageArgumentsMustBeConsistentWithRule_Error_SupplyEnoughMessageArguments_Text</value>
</data>
<data name="SARIF1012_MessageArgumentsMustBeConsistentWithRule_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF1012_MessageArgumentsMustBeConsistentWithRule_FullDescription_Text</value>
</data>
<data name="SARIF2002_ProvideMessageArguments_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2002_ProvideMessageArguments_FullDescription_Text</value>
</data>
<data name="SARIF2002_ProvideMessageArguments_Warning_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2002_ProvideMessageArguments_Warning_Default_Text</value>
</data>
<data name="SARIF2003_ProvideVersionControlProvenance_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2003_ProvideVersionControlProvenance_FullDescription_Text</value>
</data>
<data name="SARIF2003_ProvideVersionControlProvenance_Note_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2003_ProvideVersionControlProvenance_Note_Default_Text</value>
</data>
<data name="SARIF2004_OptimizeFileSize_Warning_EliminateIdOnlyRules_Text" xml:space="preserve">
<value>Placeholder_SARIF2004_OptimizeFileSize_Warning_EliminateIdOnlyRules_Text</value>
</data>
<data name="SARIF2006_UrisShouldBeReachable_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2006_UrisShouldBeReachable_FullDescription_Text</value>
</data>
<data name="SARIF2006_UrisShouldBeReachable_Warning_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2006_UrisShouldBeReachable_Warning_Default_Text</value>
</data>
<data name="SARIF2007_ExpressPathsRelativeToRepoRoot_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2007_ExpressPathsRelativeToRepoRoot_FullDescription_Text</value>
</data>
<data name="SARIF2007_ExpressPathsRelativeToRepoRoot_Warning_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2007_ExpressPathsRelativeToRepoRoot_Warning_Default_Text</value>
</data>
<data name="SARIF2010_ProvideCodeSnippets_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2010_ProvideCodeSnippets_FullDescription_Text</value>
</data>
<data name="SARIF2010_ProvideCodeSnippets_Note_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2010_ProvideCodeSnippets_Note_Default_Text</value>
</data>
<data name="SARIF2011_ProvideContextRegion_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2011_ProvideContextRegion_FullDescription_Text</value>
</data>
<data name="SARIF2011_ProvideContextRegion_Note_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2011_ProvideContextRegion_Note_Default_Text</value>
</data>
<data name="SARIF2012_ProvideHelpUris_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2012_ProvideHelpUris_FullDescription_Text</value>
</data>
<data name="SARIF2012_ProvideHelpUris_Note_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2012_ProvideHelpUris_Note_Default_Text</value>
</data>
<data name="SARIF2013_ProvideEmbeddedFileContent_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2013_ProvideEmbeddedFileContent_FullDescription_Text</value>
</data>
<data name="SARIF2013_ProvideEmbeddedFileContent_Note_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2013_ProvideEmbeddedFileContent_Note_Default_Text</value>
</data>
<data name="SARIF2014_ProvideDynamicMessageContent_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2014_ProvideDynamicMessageContent_FullDescription_Text</value>
</data>
<data name="SARIF2014_ProvideDynamicMessageContent_Note_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2014_ProvideDynamicMessageContent_Note_Default_Text</value>
</data>
<data name="SARIF2015_EnquoteDynamicMessageContent_FullDescription_Text" xml:space="preserve">
<value>Placeholder_SARIF2015_EnquoteDynamicMessageContent_FullDescription_Text</value>
</data>
<data name="SARIF2015_EnquoteDynamicMessageContent_Note_Default_Text" xml:space="preserve">
<value>Placeholder_SARIF2015_EnquoteDynamicMessageContent_Note_Default_Text</value>
</data>
</root>
4 changes: 2 additions & 2 deletions src/Sarif.Multitool/Rules/SARIF2005.ProvideToolProperties.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@

namespace Microsoft.CodeAnalysis.Sarif.Multitool.Rules
{
public class ProvideHelpfulToolInformation : SarifValidationSkimmerBase
public class ProvideToolProperties : SarifValidationSkimmerBase
{
/// <summary>
/// SARIF2005
/// </summary>
public override string Id => RuleId.ProvideHelpfulToolInformation;
public override string Id => RuleId.ProvideToolProperties;

/// <summary>
/// Provide information that makes it easy to identify the name and version of your tool.
Expand Down
Loading