Skip to content

Commit 51322be

Browse files
feat(CSAF2.1): #356 add mandatory test 6.1.55 - add information about generated files to DEVELOPMENT.md
1 parent 3501890 commit 51322be

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

DEVELOPMENT.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,18 @@
22

33
## Table of Contents
44

5-
- [Code Style](#code-style)
6-
- [Formatting with prettier](#formatting-with-prettier)
7-
- [Quoting Strings](#quoting-strings)
5+
<!-- TOC -->
6+
7+
- [Developing CSAF Validator Lib](#developing-csaf-validator-lib)
8+
- [Table of Contents](#table-of-contents)
9+
- [Code Style](#code-style)
10+
- [Formatting with prettier](#formatting-with-prettier)
11+
- [Quoting Strings](#quoting-strings)
12+
- [Generated Files](#generated-files)
13+
- [License Information](#license-information)
14+
- [CWE](#cwe)
15+
16+
<!-- /TOC -->
817

918
## Code Style
1019

@@ -19,14 +28,14 @@ Strings have to be quoted in the following way:
1928

2029
- **Single quotes ''**
2130

22-
- We use `''` (single quotes) when the string has no expressions inside.
31+
- We use `''` (single quotes) when the string has no expressions inside.
2332

2433
- **Template literals (backticks)**
2534

26-
- We use ` `` ` (template literals) when there is an expression to resolve in the string, e.g. ${metricIndex}
35+
- We use ` `` ` (template literals) when there is an expression to resolve in the string, e.g. ${metricIndex}
2736

2837
- **Quotation mark in string**
29-
- We use `""` (double quotation marks) in strings to mark text in messages
38+
- We use `""` (double quotation marks) in strings to mark text in messages
3039

3140
**Examples:**
3241

@@ -49,3 +58,19 @@ message:
4958
'the ssvc id does neither match the "cve" nor it '+
5059
'matches the "text" of any item in the "ids" array',
5160
```
61+
62+
## Generated Files
63+
64+
Certain tests need to process data from different sources. This data is usually downloaded from a URL. To avoid
65+
accessing external sources during testing and to improve performance, this data is pre-processed and the result is
66+
saved.
67+
68+
### License Information
69+
70+
The script `scripts/read-spdx-and-aboutcode-licenses.js` reads the SPDX and ScanCode License DB and writes them to
71+
the file `lib/license/license_information.js`. See the comments in the script for further usage information.
72+
73+
### CWE
74+
75+
The script `scripts/cwe-importCatalogue.js` reads CWE catalogues and writes them to the file `lib/cwec.js`. See the
76+
comments in the script for further usage information.

0 commit comments

Comments
 (0)