Skip to content

Commit

Permalink
Merge pull request sakura-editor#946 from m-tmatma/feature/CPPLINT
Browse files Browse the repository at this point in the history
CodeFactor で行われる cppcheck.py のチェックをカスタマイズする基盤を作る
  • Loading branch information
m-tmatma authored Jun 8, 2019
2 parents 93ee55a + eab211f commit 49a9893
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CPPLINT.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
set noparent
filter=-build,+build/deprecated,+build/printf_format,+build/explicit_make_pair
filter=-readability,+readability/inheritance
filter=-runtime,+runtime/memset,+runtime/threadsafe_fn,+runtime/vlog
filter=-whitespace,+whitespace/blank_line,+whitespace/empty_if_body
filter=-legal
52 changes: 52 additions & 0 deletions CPPLINT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# cpplint.py

<!-- TOC -->

- [cpplint.py](#cpplintpy)
- [CodeFactor のスタイルチェック](#codefactor-のスタイルチェック)
- [CodeFactor のデフォルトのCPPLINT.CFG](#codefactor-のデフォルトのcpplintcfg)
- [cpplint.py のインストール](#cpplintpy-のインストール)
- [cpplint.py の実行](#cpplintpy-の実行)
- [cpplint.py のインストール場所の例](#cpplintpy-のインストール場所の例)
- [参考サイト](#参考サイト)

<!-- /TOC -->


# CodeFactor のスタイルチェック

- CodeFactor では [cpplint](https://pypi.org/project/cpplint/) でチェックを行います。
- https://support.codefactor.io/i24-analysis-tools-open-source
- [cpplint](https://pypi.org/project/cpplint/) はカレントディレクトリに [CPPLINT.CFG](https://github.com/google/styleguide/blob/6271f3f473ceb3a7fef99388a3040903b1a145f1/cpplint/cpplint.py#L156-L197) というファイルを配置することでフィルタリング条件を指定できます。


# CodeFactor のデフォルトのCPPLINT.CFG

CodeFactor のデフォルトの `CPPLINT.CFG`https://github.com/codefactor-io/default-configs/blob/master/CPPLINT.cfg です。

# cpplint.py のインストール

```
pip install cpplint
```


# cpplint.py の実行


```
cd /d <sakura editor ソースのトップ>
python <path-to-cpplint>\cpplint.py --recursive sakura_core
```

## cpplint.py のインストール場所の例

`C:\Python27\Lib\site-packages\cpplint.py`

# 参考サイト

- [Analysis Tools (Open Source) at support.codefactor.io](https://support.codefactor.io/i24-analysis-tools-open-source)
- [cpplint (pip)](https://pypi.org/project/cpplint/)
- [CPPLINT.cfg](https://github.com/google/styleguide/blob/6271f3f473ceb3a7fef99388a3040903b1a145f1/cpplint/cpplint.py#L156-L197)
- [default CPPLINT.cfg at support.codefactor.io](https://github.com/codefactor-io/default-configs/blob/master/CPPLINT.cfg)
- [Visual Studioでcpplintする](https://qiita.com/odanado/items/cd364521a048c662a888)
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
- [デバッグ方法](#デバッグ方法)
- [変更履歴](#変更履歴)
- [マクロのサンプル](#マクロのサンプル)
- [静的コード解析](#静的コード解析)

<!-- /TOC -->

Expand Down Expand Up @@ -153,3 +154,10 @@ https://ci.appveyor.com/project/sakuraeditor/sakura/history

[こちら](tools/macro)でマクロのサンプルを提供してます。
もしサンプルを作ってもいいよ~という方がおられましたら PR の作成お願いします。

## 静的コード解析

- CodeFactor を利用しています。
- [cpplint.py](CPPLINT.md) で cpp のスタイルのチェックを行っています。


0 comments on commit 49a9893

Please sign in to comment.