mcserep
commented
3 months ago @intjftw In my view (and as discussed on the previous meetings), there are 3 type of metrics, but 2 of them are really similar, so they can be merged.
- AST node related metrics (e.g. function or class related metrics);
- File related metrics;
- Module (directory) related metrics.
File and module related metrics are basically the same, as CodeCompass identifies both of them with a file ID. I see no reason for differentiate between them, and this would only introduce code redundancy.
Thus, endpoints for querying ASTnode and File level metrics should be sufficient. (The latter including support for module metrics.)
On the other hand, we discussed the additional need for a higher abstraction level endpoint which does not receive an ASTNodeID or a FileID as an input parameter, but a file / directory path instead. Then, all file and AST node related metrics under that path should be returned. So e.g. if the path is module path, I would like to get:
- all metrics for that module;
- all metrics for the files inside that module;
- all metrics for functions, classes, etc. inside those files.
As we discussed, endpoints for module-level C++ metric types are also required. I added a new endpoint to query all available module-level metric types and all stored metrics for one module. There are no module-level metrics implemented for now, so testing is difficult. @mcserep please help me out on what else we might need, and how should I modify the endpoint if needed.