Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: add test for error codes doc and impl #21470

Closed
wants to merge 1 commit into from

Commits on Sep 8, 2018

  1. test: add test for error codes doc and impl

    This adds several sanity checks for error codes.
    
    It scans:
     * all natives (js sources),
     * doc/api/*.md documentation
     * src/node_errors.h (errors definition from the C++ side).
    
    There is also a whitelist of manually created errors from JS side,
    currently consisting of ERR_HTTP2_ERROR and ERR_UNKNOWN_BUILTIN_MODULE.
    
    Alsom all ERR_NAPI_ codes are whitelisted, as those are created directly
    on the cpp side, without declaring them first.
    
    The performed checks:
    
      1. All errors used from JS should be defined in `internal/errors` and
         present in its .codes object. Whitelist (mentioned above) applies.
    
      2. All errors instantiated from JS without arguments should support
         0-arguments version.
    
      3. All errors mentioned in doc should defined either in JS, C++, or
         in the whitelist.
    
      4. All errors mentioned anywhere should be documented.
    
      5. Documentation of error codes should be sorted, have no repeats,
         and include exactly one entry for every error code mentioned in
         the documentation, formatted as `/\n### (ERR_[A-Z0-9_]+)\n`.
    
      6. All doc entries for error codes should have appropriate anchors.
    
    There is also a --report flag, which prints all the current issues and
    exits without asserting, for manual inspection.
    
    Individual fixes for those issues are landed in separate commits.
    
    Refs: nodejs#21421
    Refs: nodejs#21440
    Refs: nodejs#21483
    Refs: nodejs#21484
    Refs: nodejs#21485
    Refs: nodejs#21487
    PR-URL: nodejs#21470
    ChALkeR committed Sep 8, 2018
    Configuration menu
    Copy the full SHA
    8e41fd7 View commit details
    Browse the repository at this point in the history