Sketch out API design - Githubissues

sourcegraph / langur

Programming language detection library & CLI

Apache License 2.0

0 stars 0 forks source link

Sketch out API design #5

Open varungandhi-src opened 10 months ago

varungandhi-src commented 10 months ago

Some constraints we need to handle:

Language keys can be removed/renamed.
- EML key renamed to E-mail with new aliases: https://github.com/github-linguist/linguist/pull/5437
- ASP renamed to Classic ASP: https://github.com/github-linguist/linguist/pull/4924
- HTML+Django renamed to Jinja: https://github.com/github-linguist/linguist/pull/5267
- JSX removed (merged into JavaScript): https://github.com/github-linguist/linguist/pull/5133

Some things we can rely on (but should have tests for)

Unique ids are assigned to each language, and ids aren't reused later.

varungandhi-src commented 10 months ago

Some initial thoughts:

It is useful to have enums for language names + associated data to avoid errors due to stringly typed language names.
- To manage language names being removed or renamed, we need to either leverage the alias field or have some other extra file. Those enum case names will be added as "deprecated".