Giter VIP home page Giter VIP logo

cc's Introduction

cc

Code style linter for C++ source files used in Node.js native addons.

Follows the Google C++ Style Guide.

As standard, semistandard and xo are to your JavaScript source files, cc is to your C++ source files.

Using from the command line

npx cc

Adding to a native module as a development dependency

npm install cc --save-dev

Add cpplint to the test script of your project's package.json file.

The following example uses xo for linting JavaScript, cpplint for linting C++ and ava for unit tests.

{
  "name": "awesome-native-package",
  "scripts": {
    "test": "xo && cpplint && ava"
  },
  "devDependencies": {
    "ava": "^2.4.0",
    "cc": "^3.0.0",
    "xo": "^0.25.3"
  }
}

Defaults

"cc": {
  "linelength": "80",
  "files": [
    "**/*.cc",
    "**/*.h"
  ],
  "ignore": [
    "node_modules/**",
    "vendor/**"
  ],
  "filter": []
}

Files listed in .gitignore or contained within any "dot" directories (e.g. .git) are also ignored.

Example

Allow a line length of 120 characters and ignore all include checks:

{
  "name": "awesome-native-package",
  "scripts": {
    "test": "cpplint"
  },
  "devDependencies": {
    "cc": "^3.0.0"
  },
  "cc": {
    "linelength": "120",
    "filter": [
      "build/include"
    ]
  }
}

Thanks

Licence

Copyright 2017, 2019, 2020 Lovell Fuller.

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.

cc's People

Contributors

lovell avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

cc's Issues

CC is the name of a compiler...

{
  "bin": { "cc": "..." }
}

You realize that cc is the standard link name for the system's C compiler, right? You're going to cause a ton of conflicts when installing this package.

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.