113 lines
3.5 KiB
TypeScript
113 lines
3.5 KiB
TypeScript
import { LocDir } from "github-linguist";
|
|
|
|
import { Language } from "./languages";
|
|
import { Logger } from "./logging";
|
|
import { assertNever } from "./util";
|
|
|
|
// Language IDs used by codeql when specifying its metrics.
|
|
export type IdPrefix = "cpp" | "cs" | "go" | "java" | "js" | "py" | "rb";
|
|
|
|
// Map from linguist language names to language prefixes used in the action and codeql
|
|
const linguistToMetrics: Record<string, Language> = {
|
|
c: Language.cpp,
|
|
"c++": Language.cpp,
|
|
"c#": Language.csharp,
|
|
go: Language.go,
|
|
java: Language.java,
|
|
javascript: Language.javascript,
|
|
python: Language.python,
|
|
ruby: Language.ruby,
|
|
typescript: Language.javascript,
|
|
};
|
|
|
|
const nameToLinguist = Object.entries(linguistToMetrics).reduce(
|
|
(obj, [key, name]) => {
|
|
if (!obj[name]) {
|
|
obj[name] = [];
|
|
}
|
|
obj[name].push(key);
|
|
return obj;
|
|
},
|
|
{} as Record<Language, string[]>
|
|
);
|
|
|
|
export function getIdPrefix(language: Language): IdPrefix {
|
|
switch (language) {
|
|
case Language.cpp:
|
|
return "cpp";
|
|
case Language.csharp:
|
|
return "cs";
|
|
case Language.go:
|
|
return "go";
|
|
case Language.java:
|
|
return "java";
|
|
case Language.javascript:
|
|
return "js";
|
|
case Language.python:
|
|
return "py";
|
|
case Language.ruby:
|
|
return "rb";
|
|
|
|
default:
|
|
assertNever(language);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Count the lines of code of the specified language using the include
|
|
* and exclude glob paths.
|
|
*
|
|
* @param cwd the root directory to start the count from
|
|
* @param include glob patterns to include in the search for relevant files
|
|
* @param exclude glob patterns to exclude in the search for relevant files
|
|
* @param dbLanguages list of languages to include in the results
|
|
* @param logger object to log results
|
|
*/
|
|
export async function countLoc(
|
|
cwd: string,
|
|
include: string[],
|
|
exclude: string[],
|
|
dbLanguages: Language[],
|
|
logger: Logger
|
|
): Promise<Partial<Record<Language, number>>> {
|
|
const result = await new LocDir({
|
|
cwd,
|
|
include: Array.isArray(include) && include.length > 0 ? include : ["**"],
|
|
exclude,
|
|
analysisLanguages: dbLanguages.flatMap((lang) => nameToLinguist[lang]),
|
|
}).loadInfo();
|
|
|
|
// The analysis counts LoC in all languages. We need to
|
|
// extract the languages we care about. Also, note that
|
|
// the analysis uses slightly different names for language.
|
|
const lineCounts = Object.entries(result.languages).reduce(
|
|
(obj, [language, { code }]) => {
|
|
const metricsLanguage = linguistToMetrics[language];
|
|
if (metricsLanguage && dbLanguages.includes(metricsLanguage)) {
|
|
obj[metricsLanguage] = code + (obj[metricsLanguage] || 0);
|
|
}
|
|
return obj;
|
|
},
|
|
{} as Record<Language, number>
|
|
);
|
|
|
|
if (Object.keys(lineCounts).length) {
|
|
logger.debug("Lines of code count:");
|
|
for (const [language, count] of Object.entries(lineCounts)) {
|
|
logger.debug(` ${language}: ${count}`);
|
|
}
|
|
} else {
|
|
logger.info(
|
|
"Could not determine the total number of lines of code in this repository. " +
|
|
"Because of this, it will not be possible to compare the number of lines " +
|
|
"of code analyzed by code scanning with the total number of lines of " +
|
|
"code in the repository. This will not affect the results produced by code " +
|
|
"scanning. If you have any questions, you can raise an issue at " +
|
|
"https://github.com/github/codeql-action/issues. Please include a link " +
|
|
"to the repository if public, or otherwise information about the code scanning " +
|
|
"workflow you are using."
|
|
);
|
|
}
|
|
|
|
return lineCounts;
|
|
}
|