Mitä yhteiskäyttöinen koodin muokkaus tarkoittaa?

Yhteiskäyttöisen koodin muokkauksen ansiosta useat kehittäjät voivat työskennellä saman koodin parissa samanaikaisesti omissa selaimissaan. Se sopii pariohjelmointiin, haastatteluihin, opettamiseen ja koodinpätkän virheiden selvittämiseen yhdessä ilman yhteisen IDE:n käyttöönottoa tai tiedostojen siirtelyä.

Jotta kaikilla olisi sama versio koodista, muutokset lähetetään pieninä muokkauksina kokonaisten tiedostojen sijaan, ja yksi palvelin päättää, missä järjestyksessä ne otetaan käyttöön. Samanaikaisesti tehdyt muokkaukset sovitetaan yhteen, jotta molemmat säilyvät.

Työkalun kuvaus

Tämä työkalu on yhteiskäyttöinen TypeScript-editori, jossa on syntaksin korostus. Avaa se ja lähetä linkki muille: kaikki huoneessa muokkaavat samaa koodia reaaliajassa, näkevät toistensa kohdistimet ja voivat tarkistaa tai muotoilla koodin kaikkien puolesta yhdellä napsautuksella.

Tarkistus käy syntaksin läpi Babel-jäsentimellä ja sen TypeScript-laajennuksella, joten tyyppimääritykset, rajapinnat, geneeriset tyypit ja enumit tunnistetaan. Muotoilussa käytetään Prettierin TypeScript-jäsennintä. Muotoiltu koodi korvaa vain muuttuneet rivit, joten muiden sillä välin tekemät kirjoitukset pysyvät paikoillaan.

Ominaisuudet

  • Reaaliaikainen muokkaus – kaikkien tekemät muutokset näkyvät heti, ja samanaikaiset kirjoitukset yhdistetään
  • Kohdistimet ja valinnat – näet, missä kukin on, sekä hänen nimensä vieressä näkyvän värin
  • Tarkista – tarkistaa TypeScript-syntaksin ja näyttää ensimmäisen virheen rivin ja sarakkeen
  • Muotoile – muotoilee huoneessa kaikkien koodin uudelleen Prettierillä
  • Kopioi ja lataa – säilytä kopio koodista .ts-tiedostona

Näin se toimii

Kun sivu avataan, se luo huoneen synkronointipalvelimelle ja lisää sen linkin osoiteriville. Kaikki linkin avaavat liittyvät samaan huoneeseen ja näkevät saman dokumentin.

Jokainen muutos lähetetään palvelimelle pienenä kuvauksena siitä, mitä muuttui – mitkä merkit lisättiin tai poistettiin ja mistä – koko tekstin sijaan. Palvelin asettaa kaikkien tekemät muutokset samaan järjestykseen, siirtää vanhempaan versioon perustuvan muutoksen aiemmin tehtyjen muutosten jälkeiseen kohtaan ja välittää tuloksen kaikille muille. Oma kirjoituksesi näkyy heti, ja muiden tekemät muutokset yhdistetään siihen, joten kenenkään kirjoitus ei katoa, kun kaksi henkilöä muokkaa koodia samanaikaisesti.

Dokumenttia säilytetään palvelimen muistissa vain niin kauan kuin huone on avoinna. Jos lataat sivun uudelleen, pääset takaisin huoneeseen ja näet tekstin sellaisena kuin se oli. Kun kaikki ovat poistuneet, huone ja sen teksti katoavat.

Rajoitukset

  • Huoneessa voi olla enintään 20 henkilöä, ja siinä voi olla enintään 100 000 merkkiä.
  • Huoneen sulkeuduttua mitään ei tallenneta. Lataa teksti ennen kuin viimeinen henkilö poistuu.
  • Hyvin nopeat tai suuret muutokset, kuten koko dokumentin liittäminen monta kertaa peräkkäin, hylätään, ja editori lataa huoneen tekstin uudelleen.
  • Jos huonelinkki avataan toisessa yhteiskäyttöisessä editorissa (esimerkiksi SQL-huone JavaScript-editorissa), näkyviin tulee ilmoitus ”Huonetta ei löydy”: kukin huone kuuluu yhdelle kielelle.
  • Tarkistus käsittelee vain syntaksia, ei tyyppejä: myös koodi, joka ei kääntyisi tyyppivirheen vuoksi, läpäisee tarkistuksen. JSX:ää (.tsx) ei tueta.