Padrão JSON inválido (JSON001)

  • Artigo
Propriedade Valor
ID da regra JSON001
Título Padrão JSON inválido
Categoria Estilo
Subcategoria N/D
Linguagens aplicáveis C#, Visual Basic
Opções Consulte a seção Opções .

Visão geral

Esta regra sinaliza locais onde uma cadeia de caracteres literal JSON não está em conformidade com a sintaxe necessária. A regra se aplica ao JSON identificado, que é determinado pela inclusão de um comentário embutido ou comentário anterior à cadeia de caracteres JSON, como //lang=json ou //lang=json,strict. O último comentário usa o modo estrito para interpretação JSON.

Essa regra é somente IDE e não é aplicável a cenários de linha de comando.

Opções

As opções especificam o comportamento que você quer que a regra imponha.

Para código reconhecido como JSON, você define as opções no Visual Studio selecionando Opções de Ferramentas>>Editor>de Texto C# | Visual Basic>Advanced. As seguintes opções estão disponíveis na seção Cadeias de caracteres JSON:

Propriedade Descrição
Colorir cadeias de caracteres JSON Especifica se as cadeias de caracteres JSON devem ser coloridas.
Relatório JSON inválido Especifica se o JSON inválido deve ser relatado.
Realce componentes relacionados sob o cursor Especifica se as Ações Rápidas
usam realce.

Exemplo

O trecho de código a seguir mostra um exemplo com JSON inválido.

// Code with violations
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3 }""";

// Fixed code
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3] }""";

// Code with violations
//lang=json,strict
var v = """
{
   "pie": true, 
   // Comments not allowed in strict mode
   "cherry": [1, 2, 3]
}
""";

// Fixed code
//lang=json
var v = """
{
   "pie": true, 
   // Comments allowed if not using strict mode
   "cherry": [1, 2, 3]
}
""";

Suprimir um aviso

Se você quiser suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem para desabilitar e, em seguida, reabilite a regra.

#pragma warning disable JSON001
// The code that's violating the rule is on this line.
#pragma warning restore JSON001

Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.

[*.{cs,vb}]
dotnet_diagnostic.JSON001.severity = none

Para obter mais informações, confira Como suprimir avisos de análise de código.

Confira também