Giter VIP home page Giter VIP logo

cncc's Introduction

Customizable Naming Convention Checker

CNCC is a customizable naming conventions checker for C++. In using the Clang frontend CNCC works directly on the language's abstract syntax tree (AST). This is quite similar to what clang-format does but way more simple and for naming conventions only.

In short, CNCC supports user-defined pattern validation based on AST nodes: you can specify patterns for variables, class names, namespace names, and so on.

Note: recent this patch introduces the concept to clang-tidy.

Example

You provide a style file containing regular expressions for validating AST nodes, such as: camel-case for class names, members should have an underscore appended, and so on.

class_decl: '^([A-Z][a-z]+)+$'
field_decl: '^[a-z]+_$'
var_decl: '^[a-z][a-z0-9]*$'
namespace: '^[a-z]?$'

CNCC then checks the AST's nodes against the provided rules, issuing warnings to stderr and returning with a appropriate status code for easy integration:

test.cc:4:11: "myNamespace" does not conform to pattern "^[a-z]?$" associated with namespace
test.cc:6:7: "myClass" does not conform to pattern "^([A-Z][a-z]+)+$" associated with class_decl
test.cc:11:9: "myMember" does not conform to pattern "^[a-z]+_$" associated with field_decl
test.cc:19:24: "myMember" does not conform to pattern "^[a-z]+_$" associated with field_decl

For all available nodes see the official libclang documentation or the Python wrapper documentation and look for CursorKind.

Requirements

  • python2
  • python-clang
  • python-yaml

Usage

For standalone files, with default compiler invocation:

cncc --style=examples/small.style examples/test.cc

CNCC defaults to reading a .cncc.style file in your home directory if no style file was given.

cncc examples/test.cc

Sometimes compilation gets more involved. Use CMake or Bear in order to create a compile_command.json compilation database. In it compiler invocation flags and arguments are stored for each file involved in the build process. This does not require you to build your program.

mkdir build
cd build
ccmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=1
cncc --style=~/.cncc.style --dbdir . ../main.cc

License

Copyright © 2015 Daniel J. Hofmann

Distributed under the MIT License (MIT).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.