Hopp til innholdet
FrAIFlow

Solutions / Tekst & kode

Hvorfor dollartegn endrer erstatningsteksten din i JavaScript

Et søk-og-erstatt-verktøy endrer selve erstatningsteksten. Selv ved søk med en vanlig streng tolker JavaScript dollarsekvenser i erstatningsargumentet. Hvis brukeren mener bokstavelig tekst, returnerer du teksten fra en funksjon.

Én verdi, to tolkninger
Egenlaget forklaring basert på det bevarte eksemplet; ikke et skjermbilde fra et program.

Identifiser erstatningsmaler før du endrer inndataene

Tenk deg at en plassholder erstattes med en prisforklaring som inneholder $&. Brukeren forventer disse to tegnene, men den gamle plassholderen dukker opp igjen. Dette er ikke nødvendigvis et tegnkodingsproblem. Erstatningsargumentet har sitt eget lille malspråk, selv når søket er en vanlig streng og ikke et regulært uttrykk.

Start med en kopi av teksten og ett treff. Endres en dollarsekvens, bytter du erstatningsargumentet til en callback og sammenligner resultatene. Behold samme søk under sammenligningen. Hvis begge inndata endres samtidig, blir det vanskeligere å se hvilken regel som ga overraskelsen.

En offentlig rapport fra 2012 erstattet en hel streng med $' og fikk et tomt resultat. Dette tokenet betyr suffikset etter treffet. Fordi treffet tok hele strengen, fantes det ikke noe suffiks.

const input = "as";
const replacement = "$'";
input.replace("as", replacement);       // ""
input.replace("as", () => replacement); // "$'"

Den bevarte Node.js v24.19.0-testen gjenskapte begge utfallene. Andre erstatningstoken er $$ for et dollartegn, $& for selve treffet, og gruppereferanser som $1 når mønsteret har den relevante gruppen. Det finnes også former for prefiks og navngitte grupper. Ikke ethvert dollartegn er spesielt alene.

Gjør begge modusene tydelige
Egenlaget forklaring basert på det bevarte eksemplet; ikke et skjermbilde fra et program.

Bruk en callback når brukeren mener bokstavelig tekst

const draft = "Price: TOKEN. Repeat: TOKEN.";
const typedReplacement = "$& costs $$";

console.log(draft.replaceAll("TOKEN", typedReplacement));
// Price: TOKEN costs $. Repeat: TOKEN costs $.

console.log(draft.replaceAll("TOKEN", () => typedReplacement));
// Price: $& costs $$. Repeat: $& costs $$.

I det første kallet tolkes erstatningsstrengen. I det andre returnerer funksjonen brukerens bokstavelige verdi for hvert treff. Returverdien settes inn uten en ny tolkning som erstatningsmal. Det er nyttig for verktøy som lover vanlig søk-og-erstatt, der brukeren ikke bør måtte lære spesiell dollar-escaping bare for å lime inn tekst.

Ikke løs dette ved automatisk å bygge et regulært uttrykk av brukerens søk. Et søk som a.b bør vanligvis finne et bokstavelig punktum i bokstavelig modus, ikke et hvilket som helst tegn. Behold en separat, tydelig merket avansert modus hvis du også tilbyr regex-grupper og erstatningsmaler. En mal som $1 er nyttig i den modusen og bør ikke plutselig bli bokstavelig uten forklaring.

Strengerstatningen tolker dollartoken. Callbacken bevarer den innskrevne dollarteksten nøyaktig.
Egenlaget før-og-etter-forklaring av nøyaktig det syntetiske Node.js-eksemplet over. Ikke et skjermbilde fra et tekstredigeringsprogram. Åpne bildet for detaljer i full størrelse.
function replaceLiteralOnce(text, search, value) {
  return text.replace(search, () => value);
}
function replaceLiteralAll(text, search, value) {
  if (search === "") throw new Error("Search must not be empty");
  return text.replaceAll(search, () => value);
}

Disse hjelpefunksjonene forventer strenger fra programmet. Den ene erstatter første forekomst, den andre alle treff. Bare replaceLiteralAll avviser et tomt søk for å hindre innsetting mellom kodeenheter. Med et tomt søk setter replaceLiteralOnce inn erstatningsteksten i starten av strengen. Hvis produktet bevisst støtter gruppemaler, beholder du modusen og merker den tydelig i stedet for å endre betydningen i stillhet.

Forhåndsvis hele endringen i den endelige sammenhengen

Vis både original og endret tekst, særlig ved Erstatt alle. Test en erstatning med ett dollartegn, to dollartegn, et trefftoken og en tom streng. Kontroller hva som skjer uten treff. Tom erstatning er en legitim sletting. Tomt søk krever en uttrykkelig produktbeslutning fordi det kan sette inn tekst mellom posisjoner gjennom hele strengen.

Kontroller til slutt hvordan resultatet vises. Bokstavelig tekst returnert fra en erstatningscallback gjør ikke HTML trygt. En forhåndsvisning bør bruke et textarea eller textContent for ikke-betrodd tekst, slik at en innlimt tagg vises i stedet for å kjøres. Lagre eller send først når forhåndsvisningen samsvarer med brukerens hensikt, og behold en angremulighet for masseendringer.

De registrerte testene bevarte $&, $', $$ og $1 nøyaktig når de ble returnert fra callbacken. Legg tilsvarende eksempler inn i dine egne regresjonstester, inkludert gjentatte treff og tom erstatning. Behold kilden og forhåndsvis masseendringer.

Målt erstatning: Strengargumentet gir tomt resultat; funksjonen returnerer bokstavelig dollar og apostrof.
Opprinnelig forklaring er bevart.
Registrert syntetisk testresultat for hvordan dollartegn endrer erstatningstekst i JavaScript
Registrert Node.js-resultat fra strengerstatning med bokstavelig dollartekst. Dette er et bilde av registrerte testresultater, ikke programmet til den opprinnelige rapportøren. Åpne dokumentasjonsbildet i full størrelse.

Kilder og beslektet lesning