ScanModuleTids (open)

Returns the list of tids in a module

Syntax

LOADLIB "mod::system/lib/validation.whlib";

RECORD FUNCTION ScanModuleTids(RECORD validationconfig, STRING module)

Parameters

RECORD validationconfig

Validation configuration for the specified module

BOOLEAN documentation

Whether to validate documentation

STRING ARRAY eslintmasks

List of masks for files to validate with eslint

RECORD ARRAY excludemasks

List of masks for files to exclude from validation

BOOLEAN futuremodule

Contains TRUE when this module isn't allowed to run on this webhare installation

STRING futuremodulewhy

Explains why the module isn't allowed to run on this webhare installation

BOOLEAN nomissingtids

Whether to fail validation when any tids are missing

BOOLEAN nowarnings

Whether to fail validation when any warnings are found (does not necessarily include warnings added since 2024)

BOOLEAN perfectcompile

Whether to fail validation when any harescript file has a warning

STRING module

Module to scan

Return value

RECORD

List of tids and warnings

RECORD ARRAY tids

List of tids

STRING tids.attrname

Attribute where this tid was defined

INTEGER tids.col

Column number for this message

INTEGER tids.line

Line number for this message

STRING tids.resourcename

Resource where this tid was defined

STRING tids.tid

Tid

RECORD ARRAY warnings

List of warnings

INTEGER warnings.col

Column number for this message

INTEGER warnings.line

Line number for this message

STRING warnings.message

Message

RECORD warnings.metadata

metadata (only when source != "unknown")

STRING warnings.resourcename

Resource name for this message

STRING warnings.source

Source for this message