Så fungerar Keykit
Så fungerar Keykit
Keykit kopplar din översättningskatalog direkt till koden som använder den. Lägg till ett vanligt översättningsanrop, låt Keykit upptäcka nyckeln och hantera hela översättningslivscykeln utan att manuellt hålla ett andra register synkroniserat.
Källdriven lokalisering
Ett enda översättningsanrop räcker för att introducera en nyckel.
Med ett traditionellt arbetsflöde måste utvecklare ofta tänka på både koden och översättningssystemet. Keykit betraktar användningen i applikationen som den viktiga signalen. När en ny statisk översättningsnyckel dyker upp i din kodbas kan Keykit upptäcka den och automatiskt föra in den i projektet.
import { useKeykit } from '@keykithq/sdk/react';
function CreateProjectButton() {
const { translate } = useKeykit();
return <Button>{translate('projects.actions.create', 'Create')}</Button>;
}Keykit ser nyckeln som används av applikationen och lägger till den i översättningsflödet. Det finns inget separat steg för att först registrera nyckeln i en instrumentpanel.
Från källkod till alla stödda språk
Keykit håller översättningsarbetsflödet centrerat kring produktkoden istället för att tvinga utvecklare att underhålla synkroniseringsinfrastruktur kring den.
1. Använd nyckeln
Skriv ett vanligt översättningsanrop där texten hör hemma. Använd en stabil och statiskt analyserbar nyckel som beskriver produktkonceptet.
2. Keykit upptäcker det
Keykit skannar den anslutna källan och känner igen nya översättningsnycklar som används av applikationen.
3. Saknade översättningar skapas
Nya lokaliseringsvärden kan genereras automatiskt, granskas och redigeras i Keykit-projektet.
4. Din applikation får översättningarna
Använd Keykits live- eller statisk leveransmodell beroende på hur du vill att översättningarna ska nå applikationen.
Välj din leveransmodell
Hämta översättningar i realtid eller behåll dem som statiska resurser i applikationen
Keykit stöder två leveransmodeller så att team kan välja mellan färskhet vid körningstid och kontroll vid byggtid. Ställ in delivery: "live" eller delivery: "static" i projektkonfigurationen.
Live-leverans
Ladda översättningar från Keykit vid körning så att uppdaterat innehåll kan bli tillgängligt utan att manuellt underhålla genererade lokalfiler. Användbart när du vill att översättningsändringar ska rullas ut oberoende av applikationsbyggen.
Statisk leverans
Behåll översättningarna som statiska resurser i din applikation och använd Keykit CLI pull workflow för att populera dem. Användbart när översättningar bör versionshanteras, paketeras och distribueras med applikationen.
npx @keykithq/cli pull
Automatisk livscykelspårning
Att ta bort UI bör också rensa upp dess översättningsskuld.
Översättningssystem är bra på att samla på sig nycklar och mycket sämre på att berätta när de nycklarna slutade vara relevanta. Keykit ser försvinnandet från källan som användbar information.
Keykit känner inte igen nyckeln längre.
Istället för att omedelbart ta bort översättningen kan Keykit markera den som inte längre upptäckt eller föråldrad så att teamet kan granska den på ett säkert sätt.
Oanvänt betyder inte alltid att det är säkert att ta bort.
En nyckel kan försvinna från ett frontend medan en annan applikation, en backendtjänst eller en äldre utplacerad version fortfarande är beroende av den. Därför skiljer Keykit på upptäckt och borttagning.
En annan källa kan fortfarande använda den
En webbapp kan sluta använda en nyckel medan en administrationsapplikation eller en backendtjänst fortfarande refererar till den.
En återställning kan fortfarande behöva det.
Omedelbar borttagning förvandlar en vanlig refaktorering till en potentiellt bakåtinkompatibel åtgärd för äldre utplacerad kod.
Utvecklarna har sista ordet
Keykit loggar när en nyckel försvunnit och markerar den för granskning istället för att låtsas att frånvaro alltid innebär att borttagning är säker.
Översättningsnycklar har en livscykel
Att behandla nycklar som långlivade entiteter gör lokaliseringen enklare att förstå och mycket säkrare att rensa upp.
Upptäckt
Nyckeln har upptäckts i en ansluten källa.
Aktiv
Nyckeln upptäcks för närvarande och ingår i den aktiva översättningskatalogen.
Översatt
Krävda lokaler har värden tillgängliga.
Upptäcks inte längre
En källa som tidigare hänvisade till nyckeln gör det inte längre.
Föråldrad
Nyckeln har blivit en kandidat för rensning och bör granskas.
Borttagen
Teamet har bekräftat att nyckeln inte längre behövs.
Du bör inte behöva ett separat utvecklingssystem bara för att synkronisera strängar
Lokalisering växer ofta till en samling extraktionsskript, genererade filer, uppladdningsjobb, nedladdningsjobb, integrationer med kodförråd och konventioner för rensning. Keykit är byggt kring en enklare idé: låt användningen i källan styra översättningsstatusen.
Den exakta sökvägen vid körning beror på om ditt projekt använder live- eller statisk leverans.
Hur Keykit fungerar
Ersätter Keykit mitt i18n-bibliotek?
Keykit hanterar översättningsarbetsflödet, nycklarnas livscykel och leveransen för din applikation. Körtidsrelaterade frågor som formatering, interpolering, hantering av pluralformer och lokalroutning beror fortfarande på integrationen och ramverket du använder.
Hur upptäcker Keykit översättningsnycklar?
Keykit analyserar stödda översättningsanrop i ansluten källkod och registrerar statiskt identifierbara nycklar som används av applikationen.
Tar Keykit omedelbart bort en nyckel när den försvinner?
Nej. Att den försvinner från källan är en signal, inte ett bevis på att borttagning är säker. Keykit kan markera nyckeln som inte längre upptäckt eller som föråldrad, så att den kan granskas först.
Kan jag använda Keykit i en befintlig applikation?
Ja. Befintliga översättningar kan först importeras till projektet, och därefter kan Keykit använda källupptäckt för att visa vilka nycklar som aktivt upptäcks av den anslutna applikationen.
Måste översättningar hämtas vid körtid?
Nej. Keykit stöder både live-leverans och ett statiskt arbetsflöde där CLI:n hämtar översättningsresurser in i applikationen.
Låt koden styra översättningskatalogen
Skapa översättningar när funktioner tillkommer, identifiera föråldrade nycklar när funktioner försvinner, och sluta underhålla översättningarna på två ställen.
Kom igång med Keykit