Hogyan változtattam meg a Hemingway Editor szerkesztését - egy népszerű íróalkalmazást - és építettem egy sajátot egy thaiföldi tengerpartról

A Hemingway alkalmazást próbáltam javítani a bejegyzéseimen. Ugyanakkor megpróbáltam ötleteket találni kis projektekhez. Arra az ötletre jutottam, hogy integráljak egy Hemingway stílusú szerkesztőt egy markdown szerkesztőbe. Tehát meg kellett tudnom, hogyan működött Hemingway!

A logika megszerzése

Fogalmam sem volt, hogyan működik az alkalmazás, amikor először elindultam. Elküldhette a szöveget egy szerverre, hogy kiszámítsa az írás bonyolultságát, de arra számítottam, hogy kiszámítja az ügyféloldalt.

A fejlesztői eszközök megnyitása a Chrome-ban (Control + Shift + I vagy F12 Windows / Linuxon, Command + Option + I Mac-en) és a Forrásokhoz való navigálás adta a választ . Ott megtaláltam a keresett fájlt: hemingway3-web.js.

Ez a kód tömörített formában van, amelyet fájdalom elolvasni és megérteni. Ennek megoldása érdekében átmásoltam a fájlt a VS kódba, és megformáztam a dokumentumot ( Control + Shift + I a VS kódhoz). Ez egy 3 soros fájlt 4859 soros fájlokká változtat, minden szépen formázva.

A kódex felfedezése

Elkezdtem keresgélni az aktában mindent, ami értelmes lehet. A fájl kezdete azonnal meghívott függvény-kifejezéseket tartalmazott. Kevés fogalmam volt arról, hogy mi történik.

!function(e) { function t(r) { if (n[r]) return n[r].exports; var o = n[r] = { exports: {}, id: r, loaded: !1 }; ...

Ez körülbelül 200 sorig folytatódott, mire úgy döntöttem, hogy valószínűleg elolvastam a kódot az oldal futtatásához (React?). Addig kezdtem átnézni a kód többi részét, amíg nem találtam valamit, amit meg tudtam érteni. (Elég sokat hiányoltam, amit később megtalálhattam a függvényhívások megkeresésével és a funkciódefiníció megnézésével).

Az első bit, amit megértettem, egészen a 3496-os sorig volt!

getTokens: function(e) { var t = this.getAdverbs(e), n = this.getQualifiers(e), r = this.getPassiveVoices(e), o = this.getComplexWords(e); return [].concat(t, n, r, o).sort(function(e, t) { return e.startIndex - t.startIndex }) }

Meglepő módon mindezeket a funkciókat pontosan alább definiálták. Most már tudtam, hogy az alkalmazás hogyan határozza meg a határozószókat, a jelölőket, a passzív hangot és az összetett szavakat. Néhány közülük nagyon egyszerű. Az alkalmazás ellenőrzi az egyes szavakat a minősítők, összetett szavak és passzív hangmondatok listájával. this.getAdverbs szűri a szavakat aszerint, hogy végződnek-e „ly” betűvel, majd ellenőrzi, hogy szerepelnek-e a „ly” végződésű, nem határozószóval rendelkező szavak listájában.

A következő hasznos kód a szavak vagy mondatok kiemelésének megvalósítása volt. Ebben a kódban van egy sor:

e.highlight.hardSentences += h

A „hardSentences” valami, amit megértettem, valami értelme volt. Ezután rákerestem a fájlra, hardSentencesés 13 találatot kaptam. Ez egy olyan vonalhoz vezet, amely kiszámítja az olvashatósági statisztikákat:

n.stats.readability === i.default.readability.hard && (e.hardSentences += 1), n.stats.readability === i.default.readability.veryHard && (e.veryHardSentences += 1)

Most már tudtam, hogy volt egy readabilityparaméter mindkét statsés i.default. A fájlban keresve 40 találatot kaptam. Az egyik ilyen egyezés egy getReadabilityStylefunkció volt, ahol osztályozzák az írásodat.

Három szint van: normál, kemény és nagyon kemény.

t = e.words; n = e.readingLevel; return t = 10 && n = 14 ? i.default.readability.veryHard : i.default.readability.normal;

A „Normal” kifejezés kevesebb, mint 14 szó, a „kemény” 10–14 szó, a „nagyon kemény” pedig több, mint 14 szó.

Most megtalálja az olvasási szint kiszámítását.

Itt töltöttem egy ideig, hogy megpróbáljam megtalálni az olvasási szint kiszámításának fogalmát. 4 sort találtam a getReadabilityStylefüggvény felett .

e = letters in paragraph; t = words in paragraph; n = sentences in paragraph; getReadingLevel: function(e, t, n) { if (0 === t 0 === n) return 0; var r = Math.round(4.71 * (e / t) + 0.5 * (t / n) - 21.43); return r <= 0 ? 0 : r; }

Ez azt jelenti, hogy a pontszáma 4,71 * átlagos szóhossz + 0,5 * átlagos mondathossz -21,43. Ez az. Hemingway így osztályozza az egyes mondatokat.

Egyéb érdekes dolgokat találtam

  • A kiemeléshez fűzött kommentár (az írásával kapcsolatos információk a jobb oldalon) nagy kapcsoló nyilatkozat. A háromkomponensű állítások a válasz megváltoztatására szolgálnak az Ön írása alapján.
  • A besorolás 16-ra emelkedik, mielőtt besorolják „posztgraduális” szintre.

Mit fogok csinálni ezzel

Azt tervezem, hogy elkészítek egy alapoldalt, és alkalmazom, amit a Hemingway alkalmazás dekonstrukciójából tanultam. Semmi fantázia, inkább gyakorlat valamilyen logika megvalósításához. Korábban már készítettem egy Markdown előnézetet, így megpróbálhatok egy írás alkalmazást is létrehozni a kiemelő és pontozó rendszerrel.

Saját Hemingway alkalmazás létrehozása

Miután rájöttem a Hemingway alkalmazás működésére, akkor úgy döntöttem, hogy a tanultakat megvalósítom egy sokkal egyszerűbb verzió elkészítéséhez.

Meg akartam győződni arról, hogy megtartom-e az alapjaimat, inkább a logikára összpontosítva, mint a stílusra. Úgy döntöttem, hogy egy egyszerű szövegdoboz beviteli mezővel megyek.

Kihívások

1. Hogyan biztosíthatom a teljesítményt. A teljes dokumentum újbóli szkennelése minden gombnyomásra számítási szempontból nagyon költséges lehet. Ez UX blokkolást eredményezhet, ami nyilvánvalóan nem az, amit szeretnénk.

2. Hogyan lehet felosztani a szöveget bekezdésekre, mondatokra és szavakra a kiemeléshez.

Lehetséges megoldások

  • Csak a megváltozott bekezdéseket olvassa újra. Tegye ezt úgy, hogy megszámolja a bekezdések számát, és összehasonlítja azt a változás előtti dokumentummal. Ezzel megkeresheti a megváltozott bekezdést vagy az új bekezdést, és csak azt olvassa be.
  • Van egy gomb a dokumentum beolvasásához. Ez jelentősen csökkenti a beolvasási funkció hívásait.

2. Használja azt, amit Hemingway-től tanultam - minden bekezdés a

és minden kiemelést igénylő mondatot vagy szót belefoglalunk a szükséges osztályba.

Az alkalmazás kiépítése

Nemrégiben sok cikket olvastam egy minimálisan életképes termék (MVP) felépítéséről, ezért úgy döntöttem, hogy ugyanezt a kis projektet fogom vezetni. Ez azt jelentette, hogy minden egyszerű marad. Úgy döntöttem, hogy bemeneti dobozzal, egy gomb beolvasására és egy kimeneti területre megyek.

This was all very easy to set up in my index.html file.

 Fake Hemingway 

Fake Hemingway

Test Me

Now to start on the interesting part. Now to get the Javascript working.

The first thing to do was to render the text from the text box into the output area. This involves finding the input text and setting the output’s inner html to that text.

function format() { let inputArea = document.getElementById(“text-area”); let text = inputArea.value; let outputArea = document.getElementById(“output”); outputArea.innerHTML = text; }

Next is getting the text split into paragraphs. This is accomplished by splitting the text by ‘\n’ and putting each of these into a

tag. To do this we can map over the array of paragraphs, putting them in between

tags. Using template strings makes doing this very easy.

let paragraphs = text.split(“\n”); let inParagraphs = paragraphs.map(paragraph => `

${paragraph}

`); outputArea.innerHTML = inParagraphs.join(“ “);

Whilst I was working though that, I was becoming annoyed having to copy and paste the test text into the text box. To solve this, I implemented an Immediately Invoked Function Expression (IIFE) to populate the text box when the web page renders.

(function start() { let inputArea = document.getElementById(“text-area”); let text = `The app highlights lengthy, …. compose something new.`; inputArea.value = text; })();

Now the text box was pre-populated with the test text whenever you load or refresh the web page. Much simpler.

Highlighting

Now that I was rendering the text well and I was testing on a consistent text, I had to work on the highlighting. The first type of highlighting I decided to tackle was the hard and very hard sentence highlighting.

The first stage of this is to loop over every paragraph and split them into an array of sentences. I did this using a `split()` function, splitting on every full stop with a space after it.

let sentences = paragraph.split(‘. ’);

From Heminway I knew that I needed to calculate the number of words and level of each of the sentences. The level of the sentence is dependant on the average length of words and the average words per sentence. Here is how I calculated the number of words and the total words per sentence.

let words = sentence.split(“ “).length; let letters = sentence.split(“ “).join(“”).length;

Using these numbers, I could use the equation that I found in the Hemingway app.

let level = Math.round(4.71 * (letters / words) + 0.5 * words / sentences — 21.43);

With the level and number of words for each of the sentences, set their difficulty level.

if (words = 10 && level < 14) { return `${sentence}`; } else if (level >= 14) { return `${sentence}`; } else { return sentence; }

This code says that if a sentence is longer than 14 words and has a level of 10 to 14 then its hard, if its longer than 14 words and has a level of 14 or up then its very hard. I used template strings again but include a class in the span tags. This is how I’m going to define the highlighting.

The CSS file is really simple; it just has each of the classes (adverb, passive, hardSentence) and sets their background colour. I took the exact colours from the Hemingway app.

Once the sentences have been returned, I join them all together to make each of the paragraphs.

At this point, I realised that there were a few problems in my code.

  • There were no full stops. When I split the paragraphs into sentences, I had removed all of the full stops.
  • The numbers of letters in the sentence included the commas, dashes, colons and semi-colons.

My first solution was very primitive but it worked. I used split(‘symbol’) and join(‘’) to remove the punctuation and then appended ‘.’ onto the end. Whist it worked, I searched for a better solution. Although I don’t have much experience using regex, I knew that it would be the best solution. After some Googling I found a much more elegant solution.

let cleanSentence = sent.replace(/[^a-z0–9. ]/gi, “”) + “.”;

With this done, I had a partially working product.

The next thing I decided to tackle was the adverbs. To find an adverb, Hemingway just finds words that end in ‘ly’ and then checks that it isn’t on a list of non-adverb ‘ly’ words. It would be bad if ‘apply’ or ‘Italy’ were tagged as adverbs.

To find these words, I took the sentences and split them into an arary of words. I mapped over this array and used an IF statement.

if(word.match(/ly$/) &&, !lyWords[word] ){ return `${word}`; } else { return word };

Whist this worked most of the time, I found a few exceptions. If a word was followed by a punctuation mark then it didn’t match ending with ‘ly’. For example, “The crocodile glided elegantly; it’s prey unaware” would have the word ‘elegantly;’ in the array. To solve this I reused the .replace(/^a-z0-9. ]/gi,””) functionality to clean each of the words.

Another exception was if the word was capitalised, which was easily solved by calling toLowerCase()on the string.

Now I had a result that worked with adverbs and highlighting individual words. I then implemented a very similar method for complex and qualifying words. That was when I realised that I was no longer just looking for individual words, I was looking for phrases. I had to change my approach from checking if each word was in the list to seeing if the sentence contained each of the phrases.

To do this I used the .indexOf() function on the sentences. If there was an index of the word or phrase, I inserted an opening span tag at that index and then the closing span tag after the key length.

let qualifiers = getQualifyingWords(); let wordList = Object.keys(qualifiers); wordList.forEach(key => { let index = sentence.toLowerCase().indexOf(key); if (index >= 0) { sentence = sentence.slice(0, index) + ‘’ + sentence.slice(index, index + key.length) + “” + sentence.slice(index + key.length); } });

With that working, it’s starting to look more and more like the Hemingway editor.

The last piece of the highlighting puzzle to implement was the passive voice. Hemingway used a 30 line function to find all of the passive phrases. I chose to use most of the logic that Hemingway implemented, but order the process differently. They looked to find any words that were in a list (is, are, was, were, be, been, being) and then checked whether the next word ended in ‘ed’.

I looped though each of the words in a sentence and checked if they ended in ‘ed’. For every ‘ed’ word I found, I checked whether the previous word was in the list of pre-words. This seemed much simpler, but may be less performant.

With that working I had an app that highlighted everything I wanted. This is my MVP.

Then I hit a problem

As I was writing this post I realised that there were two huge bugs in my code.

// from getQualifier and getComplex let index = sentence.toLowerCase().indexOf(key); // from getPassive let index = words.indexOf(match);

These will only ever find the first instance of the key or match. Here is an example of the results this code will produce.

‘Perhaps’ and ‘been marked’ should have been highlighted twice each but they aren’t.

To fix the bug in getQualifier and getComplex, I decided to use recursion. I created a findAndSpan function which uses .indexOf() to find the first instance of the word or phrase. It splits the sentence into 3 parts: before the phrase, the phrase, after the phrase. The recursion works by passing the ‘after the phrase’ string back into the function. This will continue until there are no more instances of the phrase, where the string will just be passed back.

function findAndSpan(sentence, string, type) { let index = sentence.toLowerCase().indexOf(key); if (index >= 0) { sentence = sentence.slice(0, index) + `` + sentence.slice(index, index + key.length) + "" + findAndSpan( sentence.slice(index + key.length), key, type); } return sentence; }

Something very similar had to be done for the passive voice. The recursion was in an almost identical pattern, passing the leftover array items instead of the leftover string. The result of the recursion call was spread into an array that was then returned. Now the app can deal with repeated adverbs, qualifiers, complex phrases and passive voice uses.

Statistics Counter

The last thing that I wanted to get working was the nice line of boxes informing you on how many adverbs or complex words you’d used.

To store the data I created an object with keys for each of the parameters I wanted to count. I started by having this variable as a global variable but knew I would have to change that later.

Now I had to populate the values. This was done by incrementing the value every time it was found.

data.sentences += sentence.length or data.adverbs += 1

The values needed to be reset every time the scan was run to make sure that values didn’t continuously increase.

With the values I needed, I had to get them rendering on the screen. I altered the structure of the html file so that the input box and output area were in a div on the left, leaving a right div for the counters. These counters are empty divs with an appropriate id and class as well as a ‘counter’ class.

With these divs, I used document.querySelector to set the inner html for each of the counters using the data that had been collected. With a little bit of styling of the ‘counter’ class, the web app was complete. Try it out here or look at my code here.