Erstellen von jargons.dev [# Das Word-Editor-Skript

Erinnern Sie sich an „The Word Editor“!? Hier ist das verantwortliche Skript, das seine End-to-End-Funktionalitäten implementiert, die das Schreiben von Änderungen über die Benutzeroberfläche in das geforkte Repository eines Benutzers ermöglichen.

Der funktionale Zusammenbruch

Der durch das Skript unterstützte Word-Editor sollte zwei (2) Funktionen ausführen und dabei einige bestimmte Schritte ausführen

1. Neues Wort schreiben – im Grunde genommen, um dem Wörterbuch ein neues Wort hinzuzufügen; macht das in den folgenden Schritten...
   • Besorgen Sie sich eine bereits erstellte Word-Vorlagendatei (.md)
   • Füllen Sie den Platzhalter der Vorlage mit dem gesammelten Worttitel und Inhalt aus, um eine Word.mdx-Datei im entsprechenden Wortverzeichnis src/pages/browse zu erstellen
   • und übergeben Sie die Änderung an einen etablierten Änderungszweig/Ref im geforkten Repository des Benutzers
2. Vorhandene Wörter bearbeiten/aktualisieren – Ändern Sie vorhandene Wörter im Wörterbuch. Dies geschieht in den folgenden Schritten ...
   • Rufen Sie ein vorhandenes Wort aus dem Fork des Benutzers von jargons.dev ab (suchen Sie im Wortverzeichnis src/pages/browse)
   • Parsen Sie den Inhalt und nehmen Sie die erforderlichen Änderungen vor
   • und die Änderung an einen etablierten Änderungszweig/Ref im geforkten Repository des Benutzers übergeben

Die Aufschlüsselung inspirierte zur Entwicklung der folgenden Hilfs- und Hilfsfunktionen.

• writeNewWord – eine Funktion, die unter anderem den Worttitel und den Wortinhalt akzeptiert und dabei die authentifizierte GitHub-Instanz des Benutzers nutzt. Sie führt einen Schreibvorgang durch, d. h. das Schreiben einer neuen Datei (word.mdx) in einen Zweig von jargons.dev im Benutzerkonto in dessen Namen über den Endpunkt „PUT /repos/{owner}/{repo}/contents/{path}“.

• getExistingWord – eine Funktion, die einfach den Inhalt einer vorhandenen Word-Datei im geforkten Repository des Benutzers abruft, mit dem Ziel, ihn zur Bearbeitung zu nutzen. Dazu wird das Wort als Argument verwendet und im Pfadparameter (Beispiel src/pages/browse/${normalizeAsUrl(word)}.mdx) der Anforderung an den Endpunkt „GET /repos/{owner}“ verkettet. /{repo}/contents/{path}"; Es ist wichtig zu erwähnen, dass ich aus Verbrauchsgründen einige Anpassungen an den von diesem Helfer zurückgegebenen Daten vornehmen musste. Die Anpassungen sind wie folgt

  • Titeleigenschaft hinzugefügt: Das Response.Data-Objekt, das von der Abfrage an den Endpunkt „GET /repos/{owner}/{repo}/contents/{path}“ kommt, hat keine Titeleigenschaft (dies ist die Wort selbst);

  • Content_decoded-Eigenschaft hinzugefügt: Die Response.data.content-Eigenschaft enthält den Hauptinhalt des abgerufenen Worts, ABER er liegt im „base64“-Format vor; Deshalb dachte ich, es wäre schön, wenn die Funktion sie im verbrauchsbereiten Format bereitstellt, das sofort verwendet werden kann, ohne dass beim Verbrauch eine Konvertierung erforderlich ist. Diese habe ich mit dem folgenden Code gemacht...
    

    const { content, ...responseData } = response.data;
    
    return {
      title: word,
      content,
      content_decoded: Buffer.from(content, "base64").toString("utf-8"),
      ...responseData
    };
    

• updateExistingWord – mit einem anfänglichen Namen von editExistingWord und geändert in den aktuellen Namen in jargonsdev/jargons.dev#34 führt diese Funktion einen ähnlichen Vorgang mit writeNewWord durch, überschreibt jedoch den vorhandenen Wortinhalt in einer bestimmten Datei durch Ersetzen die Datei mit einer anderen Datei mit aktualisiertem Inhalt. Dies erfolgt auch über das Benutzerkonto in seinem Namen über den Endpunkt „PUT /repos/{owner}/{repo}/contents/{path}“.

• writeFileContent – ​​dieser Helfer hat, wie sein Name schon sagt, eine Aufgabe: Er schreibt Dateiinhalte für Wörter, die in Anfragen von writeNewWord und updateExistingWord an die GitHub-API übermittelt werden. Dazu nimmt er einen Worttitel und Inhalt (d. h. Wortdefinition) als Variable und generiert einen Inhalt aus einem Vorlagen-Avail, um darin Platzhalterinhalte zu ersetzen.

Die PR

Kunststück: „Word-Editor“-Skript implementieren #18

plapperbey veröffentlicht am 02.04.2024

Diese Pull-Anfrage implementiert das Word-Editor-Skript; Die Hauptfunktion dieses Skripts besteht darin, das Hinzufügen neuer Wörter sowie das Abrufen und Aktualisieren vorhandener Wörter zu ermöglichen, bei denen es sich um einzelne MDX-Dateien handelt, die sich im Verzeichnis src/pages/browse des Projekts befinden. Dieses Skript stellt uns alle Hilfsfunktionen zur Verfügung, die zum Ausführen dieser Vorgänge erforderlich sind.

Änderungen vorgenommen

• Die Funktion writeNewWord wurde implementiert. Diese Funktion benötigt drei Parameter, nämlich userOctokit, forkedRepoDetails und das Wort. Es nutzt die userOctokit-Instanz, um einen Schreibvorgang durchzuführen, d. h. das Schreiben einer neuen Datei (newWord.mdx) in einen Fork unseres Projekts auf dem Konto des Benutzers im Namen des Benutzers über „PUT /repos/{owner}/{repo}/“ content/{path}" Endpunkt
• Die getExistingWord-Funktion wurde implementiert. Diese Funktion hilft beim Abrufen von Daten vorhandener Wörter im Zweig unseres Projekts auf dem Benutzerkonto, indem der Endpunkt „GET /repos/{owner}/{repo}/contents/{path}“ aufgerufen wird. Es gibt ein Objekt zurück, das die folgenden Eigenschaften trägt, die uns am meisten interessieren ...
  • Titel – Titel des vorhandenen Wortes – hierbei handelt es sich tatsächlich um benutzerdefinierte angehängte Daten an die Antwortdaten des an den Endpunkt getätigten Aufrufs
  • Pfad – Pfad zur vorhandenen Word-Datei
  • sha – eindeutiger SHA des vorhandenen Wortes
• Die Funktion editExistingWord wurde implementiert. Diese Funktion benötigt drei Parameter, nämlich userOctokit, forkedRepoDetails und das Wort (enthält die Eigenschaften: Pfad, SHA, Titel und Inhalt). Es nutzt die userOctokit-Instanz, um einen Bearbeitungsvorgang durchzuführen, d. h. die vorhandene Datei in einem Fork unseres Projekts im Benutzerkonto im Namen des Benutzers über denselben „PUT /repos/{owner}/{repo}/contents/{path}“ zu aktualisieren. " Endpunkt
• Implementierte writeFileContent-Hilfsfunktion – diese Funktion hilft beim Schreiben eines Inhalts für unsere Wörterbuch-Wortdatei und generiert ihn aus einer anderen hinzugefügten Konstante in src/lib/template/word.md.js

Screencast/Screenshot

zu faul, dafür einen Screencast aufzunehmen ?, aber vertrau mir ? Die Scheiße funktioniert ?‍?

Auf GitHub ansehen

Das obige ist der detaillierte Inhalt vonErstellen von jargons.dev [# Das Word-Editor-Skript. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!