cpp-naming-check

Проверка соглашений об именовании в C++ на соответствие руководству по стилю Google. Используется при проверке соответствия имен соглашениям или при переименовании идентификаторов.

npx skills add https://github.com/clickhouse/pg_stat_ch --skill cpp-naming-check

C++ Naming Convention Checker

Verify names follow Google C++ Style Guide conventions.

Naming Rules Quick Check

EntityConventionPatternExamples
Fileslowercase + _ or -snake_case.ccmy_class.cc, http-parser.h
ClassesPascalCase[A-Z][a-zA-Z0-9]*MyClass, UrlParser
StructsPascalCase[A-Z][a-zA-Z0-9]*Point, HttpRequest
Type aliasesPascalCase[A-Z][a-zA-Z0-9]*DataMap, StringList
EnumsPascalCase[A-Z][a-zA-Z0-9]*ErrorCode, State
EnumeratorskPascalCasek[A-Z][a-zA-Z0-9]*kOk, kNotFound
FunctionsPascalCase[A-Z][a-zA-Z0-9]*ProcessData(), GetValue()
Accessorssnake_case[a-z][a-z0-9_]*count(), set_count()
Variablessnake_case[a-z][a-z0-9_]*table_name, num_items
Class memberssnake_case_[a-z][a-z0-9_]*_value_, data_map_
Struct memberssnake_case[a-z][a-z0-9_]*width, height
ConstantskPascalCasek[A-Z][a-zA-Z0-9]*kMaxSize, kPi
MacrosUPPER_CASE[A-Z][A-Z0-9_]*MY_MACRO, DEBUG_LOG
Namespacessnake_case[a-z][a-z0-9_]*my_project, internal
Template paramsVariesType=T, value=nT, InputIterator, N

Common Mistakes

❌ Wrong → ✅ Correct

// Classes
class myClass;        → class MyClass;
class HTTPParser;     → class HttpParser;  // Treat acronyms as words

// Variables
int TableName;        → int table_name;
int tablename;        → int table_name;    // Use underscores

// Class members
int value;            → int value_;        // Trailing underscore
int m_value;          → int value_;        // No Hungarian notation

// Functions
void process_data();  → void ProcessData();
void getValue();      → void GetValue();   // Or get_value() if accessor

// Constants
const int MAX_SIZE;   → const int kMaxSize;
const int maxSize;    → const int kMaxSize;

// Enumerators
enum { ERROR_OK };    → enum { kErrorOk };
enum { Ok };          → enum { kOk };

// Macros (must be UPPER_CASE with prefix)
#define DEBUG         → #define MYPROJECT_DEBUG

Abbreviations

  • OK: Listed in Wikipedia or universally known (i, n, id, url)
  • Capitalize as word: StartRpc() not StartRPC()
  • Don't delete letters: customer not cstmr

Check Process

  1. Identify the entity type (class, function, variable, etc.)
  2. Apply the corresponding naming rule
  3. Check for consistency with surrounding code
  4. Flag any Hungarian notation or other outdated styles

Больше skills от clickhouse

clickhouse-best-practices
clickhouse
28 правил лучших практик ClickHouse, организованных по проектированию схемы, оптимизации запросов и стратегии загрузки данных. Охватывает три критически важные области: выбор первичного ключа и типов данных (неизменяемые проектные решения), оптимизация JOIN и запросов, а также пакетная вставка с избеганием мутаций. Включает 28 правил, приоритизированных по влиянию, причем правила проектирования схемы и оптимизации запросов помечены как КРИТИЧЕСКИЕ из-за колоночного хранения ClickHouse и механики разреженных индексов. Предоставляет структурированные процедуры проверки для...
clickhouse-js-node-coding
clickhouse
Ссылка: https://clickhouse.com/docs/integrations/javascript
clickhouse-js-node-coding
clickhouse
Write idiomatic application code with the ClickHouse Node.js client (`@clickhouse/client`). Use this skill whenever a user is *building* against the Node.js…
clickhousectl-cloud-deploy
clickhouse
Используйте, когда пользователь хочет развернуть ClickHouse в облаке, перейти в продакшн, использовать ClickHouse Cloud, разместить управляемый сервис ClickHouse или мигрировать с локального…
clickstack-otel-collector
clickhouse
Используйте, когда пользователь хочет подключить коллектор OpenTelemetry к управляемому сервису ClickStack в ClickHouse Cloud, либо развернув новый локальный коллектор…
infra-clickhouse
clickhouse
Настраивает и управляет ClickHouse с помощью CLI clickhousectl — устанавливает и запускает локальный сервер ClickHouse для разработки, а также создаёт управляемые облачные инстансы ClickHouse Cloud…
infra-postgres
clickhouse
Настраивает и управляет Postgres с помощью CLI clickhousectl — запускает локальный Postgres на базе Docker для разработки, а также создаёт и управляет управляемым ClickHouse…
clickhouse-best-practices
clickhouse
ОБЯЗАТЕЛЬНО использовать при проверке схем ClickHouse, запросов или конфигураций. Содержит 31 правило, которое ОБЯЗАТЕЛЬНО нужно проверить перед предоставлением рекомендаций. Всегда читать…