mapbox / mapbox/node-cpp-skel

Integrate a tool for catching missing includes

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
74
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Let's integrate a tool such as:

* https://include-what-you-use.org
* http://clang.llvm.org/extra/include-fixer.html
* https://github.com/google/styleguide/tree/gh-pages/cpplint

to catch missing includes that might not appear until Travis tries to build your code for a different OS, see https://travis-ci.org/mapbox/node-cpp-skel/builds/394326432 for example and notice how this builds for macOS but not Linux (this was due to missing `#include `).

Referencing @springmeyer's comment and tool suggestions here: https://github.com/mapbox/node-cpp-skel/pull/129#issuecomment-398533472

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare include-what-you-use, include-fixer, and cpplint, then inspect the Travis build referenced in the issue to see where a check could run. Done means the selected tool is integrated and catches missing C++ includes such as across the relevant builds.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system, ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.