@grnsft/if
Version:
Impact Framework
460 lines (446 loc) • 21.6 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for if-run/config/strings.ts</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../prettify.css" />
<link rel="stylesheet" href="../../base.css" />
<link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1><a href="../../index.html">All files</a> / <a href="index.html">if-run/config</a> strings.ts</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">94.11% </span>
<span class="quiet">Statements</span>
<span class='fraction'>32/34</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">75% </span>
<span class="quiet">Branches</span>
<span class='fraction'>6/8</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">93.93% </span>
<span class="quiet">Functions</span>
<span class='fraction'>31/33</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">94.11% </span>
<span class="quiet">Lines</span>
<span class='fraction'>32/34</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input oninput="onInput()" type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
<a name='L2'></a><a href='#L2'>2</a>
<a name='L3'></a><a href='#L3'>3</a>
<a name='L4'></a><a href='#L4'>4</a>
<a name='L5'></a><a href='#L5'>5</a>
<a name='L6'></a><a href='#L6'>6</a>
<a name='L7'></a><a href='#L7'>7</a>
<a name='L8'></a><a href='#L8'>8</a>
<a name='L9'></a><a href='#L9'>9</a>
<a name='L10'></a><a href='#L10'>10</a>
<a name='L11'></a><a href='#L11'>11</a>
<a name='L12'></a><a href='#L12'>12</a>
<a name='L13'></a><a href='#L13'>13</a>
<a name='L14'></a><a href='#L14'>14</a>
<a name='L15'></a><a href='#L15'>15</a>
<a name='L16'></a><a href='#L16'>16</a>
<a name='L17'></a><a href='#L17'>17</a>
<a name='L18'></a><a href='#L18'>18</a>
<a name='L19'></a><a href='#L19'>19</a>
<a name='L20'></a><a href='#L20'>20</a>
<a name='L21'></a><a href='#L21'>21</a>
<a name='L22'></a><a href='#L22'>22</a>
<a name='L23'></a><a href='#L23'>23</a>
<a name='L24'></a><a href='#L24'>24</a>
<a name='L25'></a><a href='#L25'>25</a>
<a name='L26'></a><a href='#L26'>26</a>
<a name='L27'></a><a href='#L27'>27</a>
<a name='L28'></a><a href='#L28'>28</a>
<a name='L29'></a><a href='#L29'>29</a>
<a name='L30'></a><a href='#L30'>30</a>
<a name='L31'></a><a href='#L31'>31</a>
<a name='L32'></a><a href='#L32'>32</a>
<a name='L33'></a><a href='#L33'>33</a>
<a name='L34'></a><a href='#L34'>34</a>
<a name='L35'></a><a href='#L35'>35</a>
<a name='L36'></a><a href='#L36'>36</a>
<a name='L37'></a><a href='#L37'>37</a>
<a name='L38'></a><a href='#L38'>38</a>
<a name='L39'></a><a href='#L39'>39</a>
<a name='L40'></a><a href='#L40'>40</a>
<a name='L41'></a><a href='#L41'>41</a>
<a name='L42'></a><a href='#L42'>42</a>
<a name='L43'></a><a href='#L43'>43</a>
<a name='L44'></a><a href='#L44'>44</a>
<a name='L45'></a><a href='#L45'>45</a>
<a name='L46'></a><a href='#L46'>46</a>
<a name='L47'></a><a href='#L47'>47</a>
<a name='L48'></a><a href='#L48'>48</a>
<a name='L49'></a><a href='#L49'>49</a>
<a name='L50'></a><a href='#L50'>50</a>
<a name='L51'></a><a href='#L51'>51</a>
<a name='L52'></a><a href='#L52'>52</a>
<a name='L53'></a><a href='#L53'>53</a>
<a name='L54'></a><a href='#L54'>54</a>
<a name='L55'></a><a href='#L55'>55</a>
<a name='L56'></a><a href='#L56'>56</a>
<a name='L57'></a><a href='#L57'>57</a>
<a name='L58'></a><a href='#L58'>58</a>
<a name='L59'></a><a href='#L59'>59</a>
<a name='L60'></a><a href='#L60'>60</a>
<a name='L61'></a><a href='#L61'>61</a>
<a name='L62'></a><a href='#L62'>62</a>
<a name='L63'></a><a href='#L63'>63</a>
<a name='L64'></a><a href='#L64'>64</a>
<a name='L65'></a><a href='#L65'>65</a>
<a name='L66'></a><a href='#L66'>66</a>
<a name='L67'></a><a href='#L67'>67</a>
<a name='L68'></a><a href='#L68'>68</a>
<a name='L69'></a><a href='#L69'>69</a>
<a name='L70'></a><a href='#L70'>70</a>
<a name='L71'></a><a href='#L71'>71</a>
<a name='L72'></a><a href='#L72'>72</a>
<a name='L73'></a><a href='#L73'>73</a>
<a name='L74'></a><a href='#L74'>74</a>
<a name='L75'></a><a href='#L75'>75</a>
<a name='L76'></a><a href='#L76'>76</a>
<a name='L77'></a><a href='#L77'>77</a>
<a name='L78'></a><a href='#L78'>78</a>
<a name='L79'></a><a href='#L79'>79</a>
<a name='L80'></a><a href='#L80'>80</a>
<a name='L81'></a><a href='#L81'>81</a>
<a name='L82'></a><a href='#L82'>82</a>
<a name='L83'></a><a href='#L83'>83</a>
<a name='L84'></a><a href='#L84'>84</a>
<a name='L85'></a><a href='#L85'>85</a>
<a name='L86'></a><a href='#L86'>86</a>
<a name='L87'></a><a href='#L87'>87</a>
<a name='L88'></a><a href='#L88'>88</a>
<a name='L89'></a><a href='#L89'>89</a>
<a name='L90'></a><a href='#L90'>90</a>
<a name='L91'></a><a href='#L91'>91</a>
<a name='L92'></a><a href='#L92'>92</a>
<a name='L93'></a><a href='#L93'>93</a>
<a name='L94'></a><a href='#L94'>94</a>
<a name='L95'></a><a href='#L95'>95</a>
<a name='L96'></a><a href='#L96'>96</a>
<a name='L97'></a><a href='#L97'>97</a>
<a name='L98'></a><a href='#L98'>98</a>
<a name='L99'></a><a href='#L99'>99</a>
<a name='L100'></a><a href='#L100'>100</a>
<a name='L101'></a><a href='#L101'>101</a>
<a name='L102'></a><a href='#L102'>102</a>
<a name='L103'></a><a href='#L103'>103</a>
<a name='L104'></a><a href='#L104'>104</a>
<a name='L105'></a><a href='#L105'>105</a>
<a name='L106'></a><a href='#L106'>106</a>
<a name='L107'></a><a href='#L107'>107</a>
<a name='L108'></a><a href='#L108'>108</a>
<a name='L109'></a><a href='#L109'>109</a>
<a name='L110'></a><a href='#L110'>110</a>
<a name='L111'></a><a href='#L111'>111</a>
<a name='L112'></a><a href='#L112'>112</a>
<a name='L113'></a><a href='#L113'>113</a>
<a name='L114'></a><a href='#L114'>114</a>
<a name='L115'></a><a href='#L115'>115</a>
<a name='L116'></a><a href='#L116'>116</a>
<a name='L117'></a><a href='#L117'>117</a>
<a name='L118'></a><a href='#L118'>118</a>
<a name='L119'></a><a href='#L119'>119</a>
<a name='L120'></a><a href='#L120'>120</a>
<a name='L121'></a><a href='#L121'>121</a>
<a name='L122'></a><a href='#L122'>122</a>
<a name='L123'></a><a href='#L123'>123</a>
<a name='L124'></a><a href='#L124'>124</a>
<a name='L125'></a><a href='#L125'>125</a>
<a name='L126'></a><a href='#L126'>126</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">34x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1146x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">10x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">54x</span>
<span class="cline-any cline-yes">54x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">112x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import {ManifestParameter} from '../../common/types/manifest';
export const STRINGS = {
MISSING_METHOD: "Initalization param 'method' is missing.",
MISSING_PATH: "Initalization param 'path' is missing.",
UNSUPPORTED_PLUGIN:
"Plugin interface doesn't implement 'execute' or 'metadata' methods.",
OVERRIDE_WARNING:
'\n**WARNING**: You are overriding the IF default parameters file. Please be extremely careful of unintended side-effects in your plugin pipeline!\n',
NOT_NATIVE_PLUGIN: (path: string) =>
`
You are using plugin ${path} which is not part of the Impact Framework standard library. You should do your own research to ensure the plugins are up to date and accurate. They may not be actively maintained.`,
INVALID_MODULE_PATH: (path: string, error?: any) =>
`Provided module \`${path}\` is invalid or not found. ${error ?? <span class="branch-1 cbranch-no" title="branch not covered" >''}</span>
`,
INVALID_TIME_NORMALIZATION: 'Start time or end time is missing.',
UNEXPECTED_TIME_CONFIG:
'Unexpected node-level config provided for time-sync plugin.',
INVALID_TIME_INTERVAL: 'Interval is missing.',
AVOIDING_PADDING: <span class="fstat-no" title="function not covered" >(d</span>escription: string) =>
<span class="cstat-no" title="statement not covered" > `Avoiding padding at ${description}`,</span>
AVOIDING_PADDING_BY_EDGES: (start: boolean, end: boolean) =>
`Avoiding padding at ${
start && end ? 'start and end' : start ? 'start' : <span class="branch-1 cbranch-no" title="branch not covered" >'end'</span>
}`,
INVALID_AGGREGATION_METHOD: (metric: string) =>
`Aggregation is not possible for given ${metric} since method is 'none'.`,
METRIC_MISSING: (metric: string, index: number) =>
`Aggregation metric ${metric} is not found in inputs[${index}].`,
INVALID_GROUP_BY: (type: string) => `Invalid group ${type}.`,
REJECTING_OVERRIDE: (param: ManifestParameter) =>
`Rejecting overriding of canonical parameter: ${param.name}.`,
INVALID_EXHAUST_PLUGIN: (pluginName: string) =>
`Invalid exhaust plugin: ${pluginName}.`,
UNKNOWN_PARAM: (name: string) =>
`Unknown parameter: ${name}. Using 'sum' aggregation method.`,
NOT_INITALIZED_PLUGIN: (name: string) =>
`Not initalized plugin: ${name}. Check if ${name} is in 'manifest.initalize.plugins'.`,
NO_OUTPUT: `
You have not selected an output method. To see your output data, you can choose from:
--stdout: this will print your output data to the console
--output <savepath>: this will save your output data to the given filepath (do not provide file extension)
Note that for the '--output' option you also need to define the output type in your manifest file. See https://if.greensoftware.foundation/major-concepts/manifest-file#initialize`,
UNSUPPORTED_ERROR: <span class="fstat-no" title="function not covered" >(e</span>rrorName: string) =>
<span class="cstat-no" title="statement not covered" > `UnsupportedErrorClass: plugin threw error class: ${errorName} that is not recognized by Impact Framework`,</span>
/** Debugging logs */
STARTING_IF: 'Starting IF',
EXITING_IF: 'Exiting IF',
LOADING_MANIFEST: 'Loading manifest',
VALIDATING_MANIFEST: 'Validating manifest',
CAPTURING_RUNTIME_ENVIRONMENT_DATA: 'Capturing runtime environment data',
SYNCING_PARAMETERS: 'Syncing parameters',
CHECKING_AGGREGATION_METHOD: (unitName: string) =>
`Checking aggregation method for ${unitName}`,
INITIALIZING_PLUGINS: 'Initializing plugins',
INITIALIZING_PLUGIN: (pluginName: string) => `Initializing ${pluginName}`,
LOADING_PLUGIN_FROM_PATH: (pluginName: string, path: string) =>
`Loading ${pluginName} from ${path}`,
COMPUTING_PIPELINE_FOR_NODE: (nodeName: string) =>
`Computing pipeline for \`${nodeName}\``,
MERGING_DEFAULTS_WITH_INPUT_DATA: 'Merging defaults with input data',
AGGREGATING_OUTPUTS: 'Aggregating outputs',
AGGREGATING_NODE: (nodeName: string) => `Aggregating node ${nodeName}`,
PREPARING_OUTPUT_DATA: 'Preparing output data',
EXPORTING_TO_YAML_FILE: (savepath: string) =>
`Exporting to yaml file: ${savepath}`,
EXPORTING_TO_CSV_FILE: (savepath: string) =>
`Exporting to csv file: ${savepath}`,
EXPORTING_RAW_CSV_FILE: (savepath: string) =>
`Exporting raw csv file: ${savepath}`,
/** Exhaust messages */
OUTPUT_REQUIRED:
'Output path is required, please make sure output is configured properly.',
CSV_EXPORT:
'CSV export criteria is not found in output path. Please append it after --output <path>#.',
WRITE_CSV_ERROR: (outputPath: string, error: any) =>
`Failed to write CSV file to ${outputPath}: ${error}`,
/** Plugins messages */
INVALID_NAME:
'`name` global config parameter is empty or contains all spaces',
START_LOWER_END: '`start-time` should be lower than `end-time`',
TIMESTAMP_REQUIRED: (index: number) => `required in input[${index}]`,
INVALID_DATETIME: (index: number) => `invalid datetime in input[${index}]`,
X_Y_EQUAL: 'The length of `x` and `y` should be equal',
ARRAY_LENGTH_NON_EMPTY:
'the length of the input arrays must be greater than 1',
WITHIN_THE_RANGE:
'The target x value must be within the range of the given x values',
MISSING_CSV_COLUMN: (columnName: string) =>
`There is no column with the name: ${columnName}.`,
NO_QUERY_DATA:
'One or more of the given query parameters are not found in the target CSV file column headers.',
INVALID_DATE_TYPE: (date: any) =>
`Unexpected date datatype: ${typeof date}: ${date}`,
INVALID_OBSERVATION_OVERLAP:
'Observation timestamps overlap, please check inputs.',
SCI_MISSING_FN_UNIT: (functionalUnit: string) =>
`'carbon' and ${functionalUnit} should be present in your input data.`,
MISSING_FUNCTIONAL_UNIT_CONFIG:
'`functional-unit` should be provided in your global config',
MISSING_FUNCTIONAL_UNIT_INPUT:
'`functional-unit` value is missing from input data or it is not a positive integer',
REGEX_MISMATCH: (input: any, match: string) =>
`\`${input}\` does not match the ${match} regex expression`,
SCI_EMBODIED_ERROR: (unit: string) =>
`invalid number. please provide it as \`${unit}\` to input`,
MISSING_MIN_MAX: 'Config is missing min or max value',
INVALID_MIN_MAX: (name: string) =>
`Min value should not be greater than or equal to max value of ${name}`,
FILE_FETCH_FAILED: (
filepath: string,
message: string
) => `Failed fetching the file: ${filepath}.
${message}`,
FILE_READ_FAILED: (
filepath: string,
error: string
) => `Failed reading the file: ${filepath}.
${error}`,
ZERO_DIVISION: (moduleName: string, index: number) =>
`-- SKIPPING -- DivisionByZero: you are attempting to divide by zero in ${moduleName} plugin : inputs[${index}]\n`,
MISSING_GLOBAL_CONFIG: 'Global config is not provided.',
MISSING_INPUT_DATA: (param: string) =>
`${param} is missing from the input array, or has nullish value.`,
};
</pre></td></tr></table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2024-07-05T10:11:24.039Z
</div>
<script src="../../prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="../../sorter.js"></script>
<script src="../../block-navigation.js"></script>
</body>
</html>