codeCheck: edit not_used.txt only if interactive; auto-remove stuff never declared

Adjust not_used.txt files only in interactive = TRUE mode
Avoid that the interactive scripts wants to add things that were never declared to many not_used.txt -> close https://github.com/pik-piam/gms/issues/68
Improve warnings in this case
it is recommended to compare files with whitespace = 1 mode: https://github.com/pik-piam/gms/pull/92/files?w=1

Example

What happens if you add cm_NDC_version, which is a switch name but has no GAMS definition, to modules/46_carbonpriceRegi/netZero/not_used.txt in remindmodel?

In the following, irrelevant stuff shortened with [...]:

Old with interactive = FALSE. While the first warning makes sense, the three others are completely misleading.

 Running codeCheck...
[...]
 Switch Appearance check done...        (time elapsed:  70.92)
 Interface collection and check done... (time elapsed:  71.07)
 Input folder check done...             (time elapsed:  71.08)
 Description check done...              (time elapsed:  71.08)
Error in `gms::codeCheck()`:
! codeCheck returned warnings. Fix warnings to proceed!
Backtrace:
    ▆
 1. └─gms::codeCheck(strict = TRUE)
Warning messages:
1: Could not find any declaration for cm_NDC_version
2: 'cm_NDC_version' is not addressed in all realizations of module 'carbonprice'! (diffCurvPhaseIn2Lin=0, exogenous=0, expoLinear=0, exponential=0, linear=0, NDC=1, none=0, NPi=0,
temperatureNotToExceed=0) (0 = missing, 1 = in code, 2 = in not_used.txt)
3: 'cm_NDC_version' is not addressed in all realizations of module 'carbonpriceRegi'! (NDC=1, netZero=2, none=0) (0 = missing, 1 = in code, 2 = in not_used.txt)
4: 'cm_NDC_version' is not addressed in all realizations of module 'techpol'! (coalPhaseout=0, coalPhaseoutRegional=0, CombLowCandCoalPO=0, lowCarbonPush=0, NDC=1, NDCplus=1, NPi2018=1,
none=0) (0 = missing, 1 = in code, 2 = in not_used.txt)
Execution halted
make: *** [Makefile:67: check] Error 1

Old with interactive = TRUE. Asks many questions, if you accept them it adds the switch to many not_used.txt where they don't belong, and then at the end finally tells you the actual problem.

 Running codeCheck...
[...]
 Switch Appearance check done...        (time elapsed:  71.05)
In module 'carbonprice', 'cm_NDC_version' is not addressed in those 8 realizations: diffCurvPhaseIn2Lin, exogenous, expoLinear, exponential, linear, none, NPi, temperatureNotToExceed.
If you are sure that it does not need to be addressed at all you can add this to 'not_used.txt'.
Type the reason why it does not need to be addressed, or type 'n' if it actually needs to be addressed in the code.
whatever reason
In module 'carbonpriceRegi', 'cm_NDC_version' is not addressed in those 1 realizations: none.
If you are sure that it does not need to be addressed at all you can add this to 'not_used.txt'.
Type the reason why it does not need to be addressed, or type 'n' if it actually needs to be addressed in the code.
whatever reason
In module 'techpol', 'cm_NDC_version' is not addressed in those 5 realizations: coalPhaseout, coalPhaseoutRegional, CombLowCandCoalPO, lowCarbonPush, none.
If you are sure that it does not need to be addressed at all you can add this to 'not_used.txt'.
Type the reason why it does not need to be addressed, or type 'n' if it actually needs to be addressed in the code.
whatever reason
 Interface collection and check done... (time elapsed: 110.71)
 Input folder check done...             (time elapsed: 110.72)
 Description check done...              (time elapsed: 110.72)
Error in `gms::codeCheck()`:
! codeCheck returned warnings. Fix warnings to proceed!
Backtrace:
    ▆
 1. └─gms::codeCheck(strict = TRUE, interactive = TRUE)
Warning message:
Could not find any declaration for cm_NDC_version
Execution halted
make: *** [Makefile:72: check-fix] Error 1

New with interactive = FALSE: Just one straight warning.

 Running codeCheck...
[...]
 Switch Appearance check done...        (time elapsed:  73.59)
 Interface collection and check done... (time elapsed:  73.71)
 Input folder check done...             (time elapsed:  73.72)
 Description check done...              (time elapsed:  73.72)
Error in `gms::codeCheck()`:
! codeCheck returned warnings. Fix warnings to proceed!
Backtrace:
    ▆
 1. └─gms::codeCheck(strict = TRUE)
Warning message:
cm_NDC_version was never declared, but exists only in not_used.txt of carbonpriceRegi
Execution halted
make: *** [Makefile:67: check] Error 1

New with interactive = TRUE. As the case is obvious, doesn't even ask.

 Running codeCheck...
[...]
 Switch Appearance check done...        (time elapsed:  67.26)
 Cleanup not_used.txt...                (time elapsed:  67.34)
'cm_NDC_version' has been removed as interface and has been deleted from all 3 not_used.txt files of module 'carbonpriceRegi'!

 Interface collection and check done... (time elapsed:  67.46)
 Input folder check done...             (time elapsed:  67.47)
 Description check done...              (time elapsed:  67.47)
 All codeCheck tests passed!

pik-piam / gms

codeCheck: edit not_used.txt only if interactive; auto-remove stuff never declared #92

Example

Codecov Report