nodejs/node

Cpplint produces false positives for FastApiOptions

Open

#45,761 opened on Dec 6, 2022

View on GitHub
 (9 comments) (0 reactions) (0 assignees)JavaScript (35,535 forks)batch import
c++good first issuepython

Repository metrics

Stars
 (117,218 stars)
PR merge metrics
 (Avg merge 13d 4h) (233 merged PRs in 30d)

Description

Following line is a perfectly fine declaration for v8 fast API.

using CFunctionCallbackWithInput =
    void (*)(v8::Local<v8::Value> receiver,
             const v8::FastOneByteString& source,
             const v8::FastApiTypedArray<uint8_t>& destination,
             const v8::FastApiTypedArray<uint32_t>& result,
             v8::FastApiCallbackOptions& options);

But it produces the following error

Running C++ linter...
src/node_encoding.cc:101:  Is this a non-const reference? If so, make const or use a pointer: FastApiCallbackOptions& options  [runtime/references] [2]
Done processing src/node_encoding.cc
src/node_external_reference.h:20:  Is this a non-const reference? If so, make const or use a pointer: v8::FastApiCallbackOptions& options  [runtime/references] [2]
Done processing src/node_external_reference.h
Total errors found: 2
make: *** [tools/.cpplintstamp] Error 1

Contributor guide

Research direction
Examine the cpplint configuration file to see if the `runtime/references` rule can be suppressed for FastApiCallbackOptions. Alternatively, check if a comment can be added to bypass the lint warning.
Tech stack
cpp
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++ basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75