Skip to content

Packages the outparamcheck check as an asset for the godel check plugin

License

Notifications You must be signed in to change notification settings

palantir/godel-okgo-asset-outparamcheck

Folders and files

NameName
Last commit message
Last commit date
Feb 7, 2025
Feb 7, 2025
Dec 6, 2024
Feb 10, 2023
Sep 10, 2024
Jan 29, 2025
Apr 26, 2021
Apr 27, 2021
Jan 20, 2022
Sep 10, 2024
Jul 29, 2020
Nov 22, 2019
Oct 21, 2023
Jun 15, 2018
Mar 6, 2018
Nov 1, 2019
Mar 6, 2018
Sep 10, 2024
Sep 10, 2024
Jan 29, 2025
Apr 27, 2021

Repository files navigation

Autorelease

godel-okgo-asset-outparamcheck

godel-okgo-asset-outparamcheck is an asset for the gödel okgo plugin. It provides the functionality of the outparamcheck check.

This check verifies that output parameters are properly passed in to functions as pointers.

Configuration

It is possible to specify functions that should be checked using output parameters using configuration. The check configuration has an out-param-fns key that stores a map from the fully qualified function name to a slice of argument indices that indicate the indices of the function parameters that should be considered output parameters.

Here is an example check.yml configuration that specifies that the second (index 1) argument of the "Load" function in the "github.com/org/repo/config" package is an output parameter:

checks:
  outparamcheck:
    config:
      out-param-fns:
        "github.com/org/repo/config.Load": [1]