makeNoticeList.py

#!/usr/bin/env python3
#
# Last modified: 2021-04-13 by RJH
#

import os
import datetime

"""
Scans all the source files to find all notices,
    sorts them,
    and then lists them in noticeList.txt.
"""

noticeList = []

for root, dirs, files in os.walk('.'):
    for name in files:
        if '/src/' in root \
        and name.endswith('.js') or name.endswith('.ts'):
            # print("file", name, os.path.join(root, name))
            with open(os.path.join(root, name), 'rt') as sourceFile:
                for n, line in enumerate(sourceFile, start=1):
                    if ('addNotice' in line or '{ priority:' in line) \
                    and 'function addNotice' not in line \
                    and 'console.log' not in line and 'userLog' not in line and 'debugLog' not in line \
                    and 'console.assert' not in line and not 'parameterAssert' in line \
                    and 'oticeEntry' not in line \
                    and 'addNotice(notice);' not in line and 'addNoticePartial(notice);' not in line \
                    and 'grammarCheckResult.error' not in line \
                    and 'MORE SIMILAR' not in line \
                    and '...' not in line:
                        strippedLine = line.strip()
                        # print("\n", os.path.join(root, name), strippedLine)
                        if strippedLine.endswith(');'): strippedLine = strippedLine[:-2]
                        if not strippedLine.startswith('//'):
                            cleanedLine = strippedLine.replace('addNoticePartial','') \
                                                .replace('addNotice6to7','') \
                                                .replace('addNoticePartial','').replace('addNotice','') \
                                                .replace('checkBookPackageResult.noticeList.push({', '') \
                                                .replace('rawCRResults.noticeList.push({', '') \
                                                .replace('ctqResult.noticeList.push({', '') \
                                                .replace('checkFileResult.noticeList.unshift({', '') \
                                                .replace('let rawCFResults = { noticeList: [{', '')
                            if cleanedLine.startswith('('): cleanedLine = cleanedLine[1:]
                            cleanedLine = cleanedLine.replace('{','').replace('}','')
                            adjustedLine = cleanedLine.replace(', ourAtString','').replace(', atString','') \
                                                .replace(', ourLocation','').replace(', ourRowLocation','') \
                                                .replace('${ourRowLocation}','') \
                                                .replace('priority:','').replace('message:','') \
                                                .replace('const notice =  ', '').replace('notice =  ', '')
                            adjustedLine = adjustedLine.strip().replace('  ',' ')
                            print("adjustedLine", adjustedLine)
                            if not adjustedLine: halt
                            noticeList.append(f"{adjustedLine}\tfrom {name} line {n:,}")
    # for name in dirs:
    #     print("dir", name, os.path.join(root, name))


def makeKey(noticeLine):
    # Gives proper sorting of 2-3 digit priority numbers
    index = 0
    string = ''
    while noticeLine[index].isdigit():
        string += noticeLine[index]
        index += 1
    if string: return int(string)
    return 99999 # Return a big number for lines not starting with digits


filename = 'noticeList.txt'
with open(filename, 'wt') as outputFile:
    print(f"\nGot {len(noticeList)} notices:")
    outputFile.write(f"Last updated {datetime.datetime.now()} by makeNoticeList.py\n")
    outputFile.write(f"Got {len(noticeList)} notices:\n")
    for notice in sorted(noticeList, reverse=True, key=makeKey):
        print(f"  {notice}")
        outputFile.write(f"  {notice}\n")
print(f"Wrote {len(noticeList)} sorted notices to {filename}.")