JavaScript: Make file types customisable in AutoBuild. #998
Conversation
… for `AutoBuild`.
Every once in a while we encounter projects using some custom file extension for files that we could in principle extract, but since the extractor doesn't know about the extension the files are skipped. To handle this, the legacy extractor has a `--file-type` option that one can use to specify a file type to use for all files in that particular extraction. So far, `AutoBuild` has nothing of the sort. This PR proposes to introduce an environment variable `LGTM_INDEX_FILETYPES` to allow a similar customisation. In the fullness of time, this variable would be set through `lgtm.yml` in the usual way, but for now it is undocumented and for internal use only. Specifically, `LGTM_INDEX_FILETYPES` is a newline-separated list of ".extension:filetype" pairs, specifying that files with the given `.extension` should be extracted as type `filetype`, where `filetype` is one of `js`, `html`, `json`, `typescript` or `yaml`. For example, `.jsm:js` causes all `.jsm` files to be extracted as JavaScript. This can also be used to override default file types: for example, by specifying `.js:typescript` all JavaScript files will be extracted as TypeScript.
|
I'll do a brief evaluation, so WIP for now. |
|
A test on All of this is expected, so I think this is good to go. I've opened #1003 to fix the language test failure, which seems unrelated to this PR. |
|
@asger-semmle, do you want me to rebase (and hence trigger a re-run of the tests)? The only language test failure is from the problem fixed in #1003, and the pr checks complain about tabs-vs-spaces which I'm going to address by auto-formatting the extractor Any Day Now. |
2 participants
Every once in a while we encounter projects using some custom file extension for files that we could in principle extract, but since the extractor doesn't know about the extension the files are skipped.
To handle this, the legacy extractor has a
--file-typeoption that one can use to specify a file type to use for all files in that particular extraction. So far,AutoBuildhas nothing of the sort.This PR proposes to introduce an environment variable
LGTM_INDEX_FILETYPESto allow a similar customisation. In the fullness of time, this variable would be set throughlgtm.ymlin the usual way, but for now it is undocumented and for internal use only.Specifically,
LGTM_INDEX_FILETYPESis a newline-separated list of ".extension:filetype" pairs, specifying that files with the given.extensionshould be extracted as typefiletype, wherefiletypeis one ofjs,html,json,typescriptoryaml.For example,
.jsm:jscauses all.jsmfiles to be extracted as JavaScript.This can also be used to override default file types: for example, by specifying
.js:typescriptall JavaScript files will be extracted as TypeScript.