linguist icon indicating copy to clipboard operation
linguist copied to clipboard

Add support for Overpass QL language

Open FloEdelmann opened this issue 3 years ago • 3 comments

Language name

"Overpass QL" or "Overpass Query Language" https://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL

URL of example repository

  • https://github.com/KDE/syntax-highlighting/blob/42a061b04c507de11b0fb240808fc65a7528d946/autotests/input/highlight.overpassql
  • https://github.com/Teiron/OverpassQL.tmLanguage/tree/4429a1e84a93407cd8355178e02f96d6b1000ca3/overpass/tests

URL of syntax highlighting grammar

  • https://github.com/KDE/syntax-highlighting/blob/42a061b04c507de11b0fb240808fc65a7528d946/data/syntax/overpassql.xml
  • https://github.com/Teiron/OverpassQL.tmLanguage

Most popular extensions

  • *.overpassql
  • *.overpass

Detected language

Currently detected as plain text.

FloEdelmann avatar May 10 '22 15:05 FloEdelmann

There's only 6 .overpassql files and 26 .overpass files. That's not enough for inclusion if those are the only filenames used by this lang.

Nixinova avatar May 21 '22 09:05 Nixinova

It looks like the following file extensions are also used, but they are also used for other file types:

  • 139k *.ql files (currently detected as CodeQL), but most seem to be CodeQL files.

    At least 145 examples where it's used as Overpass QL
    • https://github.com/drolbr/Overpass-API/search?q=extension%3Aql (49 files)
    • https://github.com/ThomasG77/30DayMapChallenge/search?q=extension%3Aql (21 files)
    • https://github.com/GISdevio/OSM-Accessibility-Data/search?q=extension%3Aql (13 files)
    • https://github.com/elgaard/OpenStreetmapTools/search?q=extension%3Aql (11 files)
    • https://github.com/simboli/Cookbook-Open-Street-Map/search?q=extension%3Aql (9 files)
    • https://github.com/wodo/alpine-explorer/search?q=extension%3Aql (9 files)
    • https://github.com/jstratman/jstratman.github.io/search?q=extension%3Aql (7 files)
    • https://github.com/TestBigOrg/overpass-queries/search?q=extension%3Aql (6 files)
    • https://github.com/Devops555/ikhaat/search?q=extension%3Aql (3 files)
    • https://github.com/meyermarcel/overpass-api-examples/search?q=extension%3Aql (2 files)
    • https://github.com/openstreetmap-polska/vip/search?q=extension%3Aql (2 files)
    • https://github.com/ripsawridge/trips/search?q=extension%3Aql (2 files)
    • https://github.com/juliepanda/shortest/blob/master/main.ql (1 file)
    • https://github.com/Kacperos155/Mapa-Lini-Kolejowych/blob/master/Mapa%20lini%20kolejowych/Overpass%20data/Overpass%20query.ql (1 file)
    • https://github.com/kolesar-andras/site-download/blob/master/overpass.ql (1 file)
    • https://github.com/maksimbark/knowledge-management/blob/master/practice4/query.ql (1 file)
    • https://github.com/mapbox/wikimama/blob/master/query.ql (1 file)
    • https://github.com/MarcelloPerathoner/hikemap/blob/master/scripts/overpass.ql (1 file)
    • https://github.com/numpde/optimum/blob/main/code/data/20210610-Manhattan/manhattan.ql (1 file)
    • https://github.com/numpde/transport/blob/master/pt2pt/20191021-NYCTLC/data_preparation/data/osm/manhattan/manhattan.ql (1 file)
    • https://github.com/oaksandspokes/bikeOsmExport/blob/master/bikeInfraQuery.ql (1 file)
    • https://github.com/open-austin/atx-citysdk-js/blob/master/data/scripts/osm-parks.ql (1 file)
    • https://github.com/open-austin/austin-park-equity/blob/master/data/scripts/osm-parks.ql (1 file)
  • 104k *.osm files (currently detected as XML), but most seem to be OSM XML files.

    At least 74 examples where it's used as Overpass QL
    • https://github.com/ldodds/osm-queries/search?q=extension%3Aosm (45 files)
    • https://github.com/herver1971/AreasNaturales/tree/master/Consultas (16 files)
    • https://github.com/wireguy/SouthofMadagascarDrought/search?q=extension%3Aosm (5 files)
    • https://github.com/ldodds/overpass-doc/search?q=extension%3Aosm (2 files)
    • https://github.com/wireguy/overpass (2 files)
    • https://github.com/XuluniX/javaMaps/search?q=extension%3Aosm (2 files)
    • https://github.com/cb-cities/sf_abm/blob/master/0_network/data/sf/query.osm (1 file)
    • https://github.com/makatony/mapMapping/blob/master/query.osm (1 file)
  • 28k *.query files (currently detected as plain text), but most seem to be query files for various databases.

    At least 39 examples where it's used as Overpass QL
    • https://github.com/developmentseed/plasticwatch/search?q=extension%3Aquery (15 files)
    • https://github.com/mhuendorf/Benchmark_Instances_CLPP/search?q=extension%3Aquery (6 files)
    • https://github.com/geohacker/shaktiman/search?q=extension%3Aquery (5 files)
    • https://github.com/tylerthayn/org.tts.maps/search?q=extension%3Aquery (5 files)
    • https://github.com/straikongit/rendermap/search?q=extension%3Aquery (2 files)
    • https://github.com/taetscher/BWI/search?q=extension%3Aquery (2 files)
    • https://github.com/theednaffattack/at-api-dot-eddienaff-dot-dev/search?q=extension%3Aquery (2 files)
    • https://github.com/OffenesJena/OffeneGeodaten/blob/master/Gebiete/OpenStreetMap/overpass.query (1 file)
    • https://github.com/slowe/crossingify/blob/main/overpass.query (1 file)
  • 350 *.oql files (currently detected as plain text), but most seem to be Object Query Language files.

    At least 18 examples where it's used as Overpass QL
    • https://github.com/fgarel/install/search?q=extension%3Aoql (8 files)
    • https://github.com/pflouret/sketchbook/search?q=extension%3Aoql (5 files)
    • https://github.com/BeruNoir/Le-loups-des-chasseurs/blob/main/Requ%C3%AAtes/global.oql (1 file)
    • https://github.com/danieldreke/digitalnotes/blob/master/overpass/queries/mother-ganga.oql (1 file)
    • https://github.com/InventivetalentDev/TrashApp/blob/master/trashapp_common/src/main/res/raw/waste_basket_query.oql (1 file)
    • https://github.com/Sinar/OpenDataDay2017/blob/master/OSM-LRT-KJL/query.oql (1 file)
    • https://github.com/wvanderp/WebcamMap/blob/master/overpassQuery.oql (1 file)

There are also some *.txt files and files without a file extension, but I guess we can/should ignore those: Sourcegraph query

EDIT: I now keep track of all repos using *.overpassql and those where I suggested renaming in a GitHub project: https://github.com/users/FloEdelmann/projects/2/views/2

FloEdelmann avatar May 21 '22 10:05 FloEdelmann

Thanks for running the file analysis. The requirements say that each extension must be used in at least 200 repos, so this still doesn't seem enough for inclusion.

Nixinova avatar May 21 '22 21:05 Nixinova

Thanks @FloEdelmann for the request on adding Overpass QL Language support!

jerrychong25 avatar Oct 01 '22 03:10 jerrychong25

Thank @FloEdelmann for promotion of OverpassQL, I want to know whether usage in markdown's code part will help in counting repository, like this:

[out:xml][timeout:25];nwr[name="foo"];out body;>;out skel qt;

markdown_sample

LaoshuBaby avatar Oct 08 '22 18:10 LaoshuBaby

I don't know whether the languages in Markdown code blocks count towards the limit of 200 repos. But as soon as GitHub's syntax highlighting engine supports *.overpassql files, Markdown code blocks with ```overpassql should also automatically be highlighted. So it would make sense to change those, too :)

FloEdelmann avatar Oct 10 '22 07:10 FloEdelmann

I don't know whether the languages in Markdown code blocks count towards the limit of 200 repos.

No, they're not. Linguist performs no language analysis of code-blocks, since all names/aliases are unique per language. But your assumption about about ```overpassql blocks being automatically highlighted is correct. 👍

Alhadis avatar Oct 10 '22 07:10 Alhadis

There are now more than 200 repositories using the *.overpassql file extension! :tada: See https://github.com/users/FloEdelmann/projects/2/views/4

To keep the discussion clean, I've created a follow-up issue (#6311) and close this one.

FloEdelmann avatar Mar 07 '23 18:03 FloEdelmann