https://github.com/lovell/cc
Code style linter for C++ source files used in Node.js native addons
https://github.com/lovell/cc
code-style cplusplus linter nodejs style-checker
Last synced: 9 months ago
JSON representation
Code style linter for C++ source files used in Node.js native addons
- Host: GitHub
- URL: https://github.com/lovell/cc
- Owner: lovell
- License: apache-2.0
- Created: 2017-02-05T14:33:29.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T16:16:04.000Z (over 2 years ago)
- Last Synced: 2024-10-17T04:55:46.502Z (about 1 year ago)
- Topics: code-style, cplusplus, linter, nodejs, style-checker
- Language: JavaScript
- Size: 165 KB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cc
Code style linter for C++ source files used in Node.js native addons.
Follows the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
As `standard`, `semistandard` and `xo` are to your JavaScript source files,
`cc` is to your C++ source files.
## Using from the command line
```sh
npx cc
```
## Adding to a native module as a development dependency
```sh
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.
```json
{
"name": "awesome-native-package",
"scripts": {
"test": "xo && cpplint && ava"
},
"devDependencies": {
"ava": "^2.4.0",
"cc": "^3.0.0",
"xo": "^0.25.3"
}
}
```
### Defaults
```json
"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:
```json
{
"name": "awesome-native-package",
"scripts": {
"test": "cpplint"
},
"devDependencies": {
"cc": "^3.0.0"
},
"cc": {
"linelength": "120",
"filter": [
"build/include"
]
}
}
```
## Thanks
* [Milosz Kordecki](https://github.com/mikomize) for use of the `cc` package name.
## 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](http://www.apache.org/licenses/LICENSE-2.0.html)
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.