breck7 / truebase

TrueBase - information you can trust. Software for building computable encyclopedias.
https://truebase.treenotation.org
9 stars 0 forks source link

mixing pldb files and cancerdb "trubebase/things/" files leads to silent failures and hard to debug results. #5

Open ghost opened 1 year ago

ghost commented 1 year ago

Suppose i was using pldb and then switched over to cancer DB and accidentally copied a few trubase/things/* files over It leads to hard to debug results.

If i was not mistaken, the earlier behavior was to compile all truebase/things/* files irrespective of file extension, thankfully now it has changed to compiling only relevant files.

But an accidental rename or accidental inclusion is hard to detect. Using the search feature on pldb/CancerDB along with file system level wild card listing (ls truebase/thing/*.foo ) along with explicit checks before repo commit seems to be the only way to detect it, as the build system does not seem to warn of this issue.

A hook in npm build step of true base to address this issue would be appreciated.

breck7 commented 1 year ago

You would see it when reviewing the commit right? I generally use Sublime Merge to review my commits before posting them.

ghost commented 1 year ago

@breck7 : There are instances where i thought i would have added a file in trubase/things/ folder but it wont show up in the search results. A simple warning from trubase about files in the folder not included in the generated csv would be pretty helpful.

This after running tests and format options.

A small typo could cause an hour of delay in trying to find out why certain files dont show up.