verilog/analysis/default_rules.h

// Copyright 2017-2020 The Verible Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef VERIBLE_VERILOG_ANALYSIS_DEFAULT_RULES_H_
#define VERIBLE_VERILOG_ANALYSIS_DEFAULT_RULES_H_

namespace verilog {
namespace analysis {

// List of rule that are enabled by default in production
// Use --ruleset default
// clang-format off
// LINT.IfChange
constexpr const char* kDefaultRuleSet[] = {
    "invalid-system-task-function",
    "module-begin-block",
    "module-parameter",
    "module-port",
    "module-filename",
    "package-filename",
    "void-cast",
    "forbid-line-continuations",
    "generate-label",
    "generate-label-prefix",
    "always-comb",
    //"disable-statement", // temporary disabled
    "v2001-generate-begin",
    "forbidden-macro",
    "create-object-name-match",
    "packed-dimensions-range-ordering",
    "unpacked-dimensions-range-ordering",
    "no-trailing-spaces",
    "no-tabs",
    "posix-eof",
    "line-length",
    "undersized-binary-literal",
    "explicit-function-lifetime",
    "explicit-function-task-parameter-type",
    "explicit-task-lifetime",
    "explicit-parameter-storage-type",
    "plusarg-assignment",
    "macro-name-style",
    "parameter-name-style",
    "typedef-enums",
    "forbid-defparam",
    "typedef-structs-unions",
    "always-comb-blocking",
    "always-ff-non-blocking",
    "forbid-consecutive-null-statements",
    "enum-name-style",
    "struct-union-name-style",
    "case-missing-default",
    "interface-name-style",
    "positive-meaning-parameter-name",
    "constraint-name-style",
    "suggest-parentheses",
    "truncated-numeric-literal",
    // TODO(fangism): enable in production:
    // TODO(b/155128436): "uvm-macro-semicolon"
    // TODO(b/117131903): "proper-parameter-declaration",
    // TODO(b/131637160): "signal-name-style",
    // TODO(b/120784977): "numeric-format-string-style",
    // TODO: "one-module-per-file",
    // TODO: "banned-declared-name-patterns",
    // TODO: "port-name-suffix",
    // "endif-comment",
};
// LINT.ThenChange(../tools/lint/BUILD)
//   Update integration tests for rulesets.
// clang-format on
}  // namespace analysis
}  // namespace verilog

#endif  // VERIBLE_VERILOG_ANALYSIS_DEFAULT_RULES_H_