Mitä on yhteisöllinen koodinmuokkaus?

Yhteisöllisen koodinmuokkauksen ansiosta useat kehittäjät voivat työskennellä saman koodin parissa samaan aikaan, kukin omassa selaimessaan. Se sopii pariohjelmointiin, haastatteluihin, opettamiseen ja koodinpätkän virheiden selvittämiseen yhdessä ilman jaetun kehitysympäristön käyttöönottoa tai tiedostojen lähettelyä.

Jotta kaikkien kopiot pysyvät samanlaisina, muutokset välitetään pieninä muokkauksina kokonaisten tiedostojen sijaan, ja yksi palvelin päättää niiden käyttöjärjestyksen. Samaan aikaan tehdyt muokkaukset sovitetaan yhteen, jotta molemmat säilyvät.

Työkalun kuvaus

Tämä työkalu on jaettu JavaScript-editori, jossa on syntaksin korostus. Avaa editori ja lähetä linkki: kaikki huoneessa muokkaavat samaa koodia reaaliajassa, näkevät toistensa kohdistimet ja voivat tarkistaa tai muotoilla koodin kaikille yhdellä napsautuksella.

Tarkistus varmistaa syntaksin Babel-jäsentimellä (mukana ovat ES-moduulit ja JSX). Muotoilussa käytetään Prettieriä, ja muotoiltu koodi korvaa vain muuttuneet rivit, joten muiden sillä välin kirjoittama teksti pysyy paikallaan.

Ominaisuudet

  • Reaaliaikainen muokkaus – kaikkien tekemät muutokset näkyvät heti, ja samaan aikaan kirjoitetut muutokset yhdistetään
  • Kohdistimet ja valinnat – näet, missä kukin on, sekä kunkin henkilön nimen vieressä näkyvän värin
  • Tarkista – tarkistaa JavaScript-syntaksin ja näyttää ensimmäisen virheen rivin ja sarakkeen
  • Muotoile – muotoilee huoneessa olevan koodin uudelleen Prettierillä kaikkien puolesta
  • Kopioi ja lataa – tallenna koodista kopio .js-tiedostona

Näin se toimii

Kun sivu avataan, se luo synkronointipalvelimelle huoneen 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 yhteen järjestykseen, siirtää vanhemman version pohjalta tehdyn muutoksen myöhemmin kuin aiemmin saapuneet muutokset ja välittää tuloksen kaikille muille. Oma kirjoituksesi näkyy heti, ja muiden tekemät muutokset yhdistetään sen ympärille, joten kenenkään kirjoittama teksti ei katoa, kun kaksi henkilöä muokkaa samaan aikaan.

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

Rajoitukset

  • Huoneessa voi olla enintään 20 henkilöä ja 100 000 merkkiä.
  • Mitään ei tallenneta huoneen sulkeuduttua. 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 avaat huonelinkin toisessa yhteisöllisessä editorissa (esimerkiksi SQL-huoneen JavaScript-editorissa), näet ilmoituksen ”Huonetta ei löydy”: jokainen huone kuuluu yhdelle kielelle.
  • Tarkistus kattaa vain syntaksin. Koodia ei koskaan suoriteta.