Add baseline metrics for lines of code #459
Conversation
aeisenberg
force-pushed
the
aeisenberg/add-github-linguist
branch
from
c5d6cae
to
d2b4652
Compare
aeisenberg
force-pushed
the
aeisenberg/add-linguist-data
branch
from
5c4018b
to
d6f3eb6
Compare
aeisenberg
force-pushed
the
aeisenberg/add-github-linguist
branch
from
d2b4652
to
c4a84a9
Compare
aeisenberg
force-pushed
the
aeisenberg/add-linguist-data
branch
from
d6f3eb6
to
76702a2
Compare
| @@ -145,6 +146,15 @@ export async function runQueries( | |||
| ): Promise<QueriesStatusReport> { | |||
| const statusReport: QueriesStatusReport = {}; | |||
|
|
|||
| // count the number of lines in the background | |||
| const locPromise = countLoc( | |||
There was a problem hiding this comment.
This is clever, so the promise it's only resolved when it's used but is used in potentially multiple places. Worth noting that in practice there will always be some queries to evaluate so we'll always end up using this promise. It's an error for there not to be any queries to analyse and it would have error-ed back in the init step. Up to you if you therefore want to leave this as it is or potentially simplify it.
There was a problem hiding this comment.
The main reason why I'm doing this is so that the line counting can happen in "parallel". On large projects, counting can take 10-20s and there's lots of disk IO, so it's nice to be able to run this while other things are happening.
aeisenberg
force-pushed
the
aeisenberg/add-linguist-data
branch
2 times, most recently
from
74c1aef
to
5201fb4
Compare
aeisenberg
force-pushed
the
aeisenberg/add-linguist-data
branch
from
5201fb4
to
a1e16be
Compare
aeisenberg
force-pushed
the
aeisenberg/add-linguist-data
branch
2 times, most recently
from
0ce85b6
to
674720b
Compare
There was a problem hiding this comment.
LGTM from my point of view. Probably best let @adityasharad also review the recent changes.
aeisenberg
force-pushed
the
aeisenberg/add-linguist-data
branch
from
674720b
to
28900de
Compare
This commit uses a third party library to estimate the lines of code in
a database that is to be analyzed by codeql.
The estimate uses the same includes and excludes globs for determining
which files should be counted.
The lines of code count is returned by language and injected into the
SARIF as `baseline` property in the `${language}/summary/lines-of-code`
metric.
aeisenberg
force-pushed
the
aeisenberg/add-linguist-data
branch
from
28900de
to
998f472
Compare
This commit uses a third party library to estimate the lines of code in
a database that is to be analyzed by codeql.
The estimate uses the same includes and excludes globs for determining
which files should be counted.
The lines of code count is returned by language and injected into the
SARIF as appropriate.
Currently, this PR adds the LoC data in themetricResultsproperty of the sarif in a blob like this:We haven't agreed on what this will look like, so injecting the metric may change.We've decided that the lines of code will be injected into metrics with id like this:
${language}/summary/lines-of-codeand a newbaselineproperty is added to the metric. Languages that we have a count for, but no metric, will be ignored.Merge / deployment checklist