check_license: accept Triple Slash Directive

run-tests.sh checks that Licenses are OK for some files.
This scripts fails when JS files use a Triple Slash Directive.
This commit change this.

* Improves check_license method to include Triple-Slash directives for
.js files (Cf.
https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html)
* Avoids checking screenshots directory in Cypress
* Adds a triple slash directive on 2 JS files (from Cypress).

Co-Authored-by: Olivier DOSSMANN <[email protected]>

Author: blankoworld

check_license_config.yml

@@ -36,6 +36,7 @@ directories:
     js:
       - tests/e2e/cypress/cypress/support
       - tests/e2e/cypress/cypress/plugins
+      - tests/e2e/cypress/cypress/screenshots
       - tests/e2e/cypress/node_modules
     d.ts:
       - tests/e2e/cypress/cypress/support

rero_ils/modules/cli.py

@@ -26,6 +26,7 @@
 import logging
 import multiprocessing
 import os
+import re
 import shutil
 import sys
 import traceback
@@ -448,6 +449,12 @@ def test_file(file_name, extensions, extension, license_lines,
         # No error found
         return 0
 
+    def is_slash_directive(file, line):
+        is_js_file = file.name.split('.')[-1] == 'js'
+        if is_js_file and re.search(triple_slash, line):
+            return True
+        return False
+
     def test_license(file, extension, license_lines, verbose):
         """Test the license in file."""
         lines_with_errors = []
@@ -456,7 +463,10 @@ def test_license(file, extension, license_lines, verbose):
         linemaxnbr = len(lines)
         prefix = extension.get('prefix')
         line, linenbr = get_line(lines, linenbr, prefix)
-        while lines[linenbr-1].startswith('#!'):
+        # Get over Shebang lines or Triple-Slash Directives (for Javascript
+        # files)
+        while lines[linenbr-1].startswith('#!') or \
+                is_slash_directive(file, lines[linenbr-1]):
             # get over Shebang
             line, linenbr = get_line(lines, linenbr, prefix)
         if extension.get('top'):
@@ -512,6 +522,9 @@ def test_license(file, extension, license_lines, verbose):
         )
     files_list = list(set(files_list) - set(exclude_list))
 
+    # set regexp expression for Triple-Slash directives
+    triple_slash = r'^/// <reference \w*=\"\w*\" />$'
+
     license_lines = config['license_text'].split('\n')
     tot_error_cnt = 0
     for file_name in files_list:

tests/e2e/cypress/.gitignore

@@ -0,0 +1 @@
+cypress/screenshots

tests/e2e/cypress/cypress/integration/circulation/checkout-checkin.spec.js

@@ -1,3 +1,4 @@
+/// <reference types="Cypress" />
 /*
 
 RERO ILS

tests/e2e/cypress/cypress/support/commands.js

@@ -1,3 +1,4 @@
+/// <reference types="Cypress" />
 // ***********************************************
 // This example commands.js shows you how to
 // create various custom commands and overwrite