Skip to content
This repository has been archived by the owner on Oct 4, 2022. It is now read-only.

Latest commit

 

History

History
1147 lines (885 loc) · 56.5 KB

CHANGELOG.md

File metadata and controls

1147 lines (885 loc) · 56.5 KB

Change Log

All notable changes to this project will be documented in this file. Releases without a changelog entry contain only minor changes that are irrelevant for users of this library. We will follow Semantic Versioning from version 2 and onwards.

1.89.0 January 25th, 2021

Enhancements

  • Adds Turkish stemmer.
  • Adds function words for Turkish.
  • Adds the consecutive sentences beginnings assessment for Turkish.
  • Adds the sentence length assessment for Turkish.
  • Implements the passive voice assessment for Turkish.
  • Implements the transition words assessment for Turkish.

1.88.0 January 12th, 2021

Enhancements

  • Adds function words for Norwegian.
  • Adds Norwegian stemmer.

1.87.0 December 14th, 2020

Enhancements

  • Implements the Hungarian passive voice.
  • Implements Hungarian stemmer.
  • Edits typos and add more transition words for Hungarian.
  • Adds function words for Hungarian.
  • Adds the sentence beginning assessment and specs for Hungarian.
  • Adds specs for the sentence length assessment in Hungarian.

1.86.0 November 30th, 2020

Enhancements

  • Adds prefixes وبال, مست, تنن, است, نست, ولل, كال, فال, بال, وال, لن, سن, ست, ات, وس, فل, فب, فس, لل, ول, وب, ال to the list of ignored prefixes for Arabic. When the Arabic keyphrase is preceded by one of these prefixes, the basic keyphrase forms will also be created.

Bugfixes

  • Fixes a bug where links that contain line terminators (\n, \r, \u2028 or \u2029) would not be detected as a link.

1.85.0 November 16th, 2020

Enhancements

  • Implements Hebrew stemmer.
  • Implements the transition words assessment for Hebrew.
  • Adds Hebrew papers and specs to check the assessments functionality for Hebrew.
  • Adds the consecutive sentences assessment for Hebrew.
  • Adds Sentence length assessment for Hebrew.
  • Adds passive voice assessment for Hebrew, including a check, a number of specs and a list of Hebrew verb roots, both in their original and (for some) modified version.
  • Adds the words 'annoyed', 'depressed', 'disappointed', and 'upset' to the list of English non-passives.
  • Adds Swedish, Indonesian, Arabic, Hebrew, and Farsi to the list of languages with function words, to which a different scoring system applies for the keyphraseDistribution assessment.

1.84.0 October 26th, 2020

Enhancements

  • Expands list of exceptions for Indonesian words that look like passive voice forms but are not and adds a rule that checks for those exceptions.

Bugfixes

  • Adds various quotation marks to wordBoundaries and removePunctuation.

1.83.0 October 13th, 2020

Enhancements

  • Creates basic keyphrase forms for Farsi when they have the following affixes: prefix ن, and suffixes مان, شان, تان, ش, ت, م, ی and their variations such as ‌اش, ‌ات, یی, یم, یت, یش, ‌ای, ‌ام.
  • Adds function words for Farsi and edits a typo in the Arabic function words file.

1.82.0 September 14th, 2020

Enhancements

  • Adds the following words to the list that's used for the English transition word assessment: 'note that', 'not only', 'initially', 'as opposed to'.
  • Improves word tokenization when words are followed by specific Arabic or Urdu punctuation marks.
  • Adds passive voice assessment for Arabic, including a check, and a list of Arabic passive verbs with long vowel in their root.
  • Adds the consecutive sentences assessment for Arabic.
  • Implements the transition words assessment for Arabic.
  • Adds the prefixes س and أ to the list of ignored prefixes for Arabic. When the Arabic keyphrase is preceded by س and أ, the basic keyphrase forms will also be created.
  • Adds and refactors an external stemmer for Arabic.

Bugfixes

  • Fixes the URL of the assessment image in the readme. Props to Güven Atbakan.

Other

  • Sets the threshold for words to be recognized as prominent words from 4 to 2, in case a language has no morphology support. This increases the chance that different word forms are saved, leading to better internal linking suggestions for these languages.

1.81.0 August 31st, 2020

Enhancements

  • Adds more Polish function words.
  • Adds word form functionality for Polish.
  • Makes feedback string in the keyphrase in subheadings assessment more explicit.
  • Improves keyphrase recognition for Hebrew.
  • Adds function words for Hebrew.

Bugfixes

  • Fixes a bug where closing parentheses would always be regarded as sentence endings in RTL languages.
  • Fixes a bug where closing parentheses would always be regarded as sentence endings when followed by an upper-case letter.

1.80.0 August 17th, 2020

Enhancements

  • Makes it possible to tokenize sentences in languages that are written right-to-left (e.g., Hebrew, Arabic, Farsi and Urdu).
  • Improves keyphrase recognition for Arabic.
  • Adds function words for Arabic and Hebrew.
  • Adds Sentence beginning assessment for Indonesian.
  • Adds Transition words assessment for Indonesian.
  • Adds Passive voice assessment for Indonesian.
  • Adds Flesch reading ease assessment for Portuguese.
  • Adds passive voice assessment for Portuguese.
  • Fixes inconsistency in feedback strings that are produced by the Keyphrase in SEO Title assessment.

1.79.0 August 3rd, 2020

Enhancements

  • Adds some irregular plural forms of Italian words to function words and morphologyData file, including specs and a function to call the exception list.
  • Adds a check for whether the word belongs to stemming exceptions to the Russian stemmer.
  • Adds an exception check for irregular Italian diminutives to the Italian stemmer.
  • Adds a check for exception lists of full forms and words with multiple stems to the Russian stemmer.
  • Adds specs for irregular verbs for the Italian full forms exception list.
  • Adds check for French verbs on -ions before stemming the verb suffix -ons and does not stem -ons if the word ends on -ions (for these words, the suffix is most likely -s, not -ons).
  • Adds Indonesian function words.
  • Changes the getProminentWordsForInternalLinking research so that it only runs for texts over 400 words or texts over 300 words with a title and/or a metadescription specified.
  • Changes the output of the research so that it not only returns the list of prominent words but also information about the presence of metadescription and title, as well as the length of text. This information is later used to return a customized message to the user, within the internal linking suggestions container.

1.78.0 July 20th, 2020

Enhancements

  • Adds word form support for Portuguese.
  • Adds word form support for Indonesian.
  • Adds a check for keywords containing a dash as part of the word (e.g., buku-buku) so that they can be found in the slug.
  • Adds "кроме того" to Russian transition words.
  • Adds a check for whether the word belongs to stemming exceptions to the Russian stemmer.
  • Adds an exception check for irregular Italian diminutives to the Italian stemmer and removes scrivere, scrive, and scritto from function words.
  • Adds a check for exception lists of full forms and words with multiple stems to the Russian stemmer.
  • Adds some irregular plural forms of Italian words to function words and morphologyData file, including specs and a function to call the exception list.
  • Improves the feedback text for the keyphrase in title assessment to make clear that an exact keyphrase match is necessary.

1.77.0 June 22nd, 2020

Enhancements

  • Adds check for stemming -ons suffix in French, and for the exception list of words where only -s should be stemmed in French.
  • Adds check for nouns in Russian on ость before removing verb suffixes (including the newly added suffix ть).

1.76.0 June 8th, 2020

Enhancements

  • Adds a check for the exception list of French verbs with multiple stems and stems them by returning the indicated canonical stem.
  • Adds a stemmer for the Italian language.
  • Adds an exception check for words ending in -is/us/os where -s should not be stemmed.
  • Improves the way keyphrases containing words ending in "ent" are recognized in the text.
  • Stems French words that are considered too short to be stemmed according to the stemming rules, but that should nevertheless be stemmed.

1.75.0 May 25th, 2020

Enhancements

  • Adds a stemmer for the Russian language.
  • Adds checks for exception list with full forms and exception list of words with multiple stems to the French stemmer.
  • Checks an exception list of plurals with -x suffix and stems them correctly.
  • Transfers data from French stemmer to data file and improves stemming of words in -issement in French.

1.74.0 May 11th, 2020

Added

  • Adds French to the list of languages for which we have morphology support.
  • Adds word forms support for French in a beta version.

Changed

  • Improves the transition word assessment for Hungarian. Props to @Zsoru.
  • Improves the way diminutive nouns are stemmed.

Fixed

  • Makes sure that lists with single words don't skew the keyphrase distribution score.

1.72.0 April 9th, 2020

Added

  • Adds word-form support for Spanish.

Fixed

  • Fixes a bug where the text analysis would break if the text contains the word "Ying".

1.71.0 March 30th, 2020

Enhancements:

  • Adds word form support for Dutch.

1.66.0 January 6th, 2019

Other

  • Drops IE11 support through configuring Babel to use the preset environment with the own list of supported browsers specified.
  • Adds a way to register a custom parser for parsing a paper to a structured tree representation, ready for further analysis.
  • Adds a new attribute to the Paper: wpBlocks, to be used to send WordPress block editor data to the analysis.

1.65.1 December 11th, 2019

  • Fixes a bug where the metabox would be broken when a relative URL was configured as WP_CONTENT_URL. Props to FPCSJames.

1.63.0 November 13th, 2019

Fixed

  • Fixes a bug where the verb form landscape was not recognized in the text when the keyphrase contained the verb landscaping.

1.62.0 October 29th, 2019

Enhancements:

  • Adds a new Readability Score of 0 and "Not Available". Changes Readability for empty content from "Needs Improvement" to "Not Available". Props to emilyatmobtown

1.61.0 October 14th, 2019

Added

  • Adds the transition word assessment for Hungarian, props to 9abor

1.60.0 September 30th, 2019

No user-facing changes.

1.59.0 September 16th, 2019

No user-facing changes.

1.58.0 September 3rd, 2019

Enhancements:

  • Implements the assessment that checks whether multiple sentences begin with the same word for Portuguese, props to amesdigital.
  • Increases the recommended sentence length limit for Portuguese, props to amesdigital.

1.57.0 July 22nd, 2019

Changed

  • No user-facing changes.

1.56.0 July 8th, 2019

Changed

  • Changes the following improved internal linking functionality (which is disabled by a feature flag by default):
    • Bumps the minimum number of required word occurrences from 2 to 4 (when extracting prominent words for internal linking).

1.55.0 June 24th, 2019

Changed

  • Updated the CSS autoprefixer configuration to drop support for old Internet Explorer versions.

1.54.0 June 11th, 2019

Added

  • Adds an improved internal linking functionality behind a feature flag. For now, this new functionality is disabled by default. Specifically, the new internal linking functionality has the following improvements:
    • Changes the way prominent words are extracted for the Internal linking suggestions and Insights features. No multiple-word combinations are considered anymore, but single words only. For languages with morphological support (currently English and German) different morphological forms of words (e.g., link, linking, links, linked) are recognized and collapsed together, which improves the performance of the said features.
    • Changes the Insights functionality in the following way: no words that occurred less than 5 times in the text of the post are displayed. For languages with morphological support (for now, English and German) different word forms of the same word are collapsed based on their stem/base form (e.g., the stem of words link, linking, links, and linked is link). If the stem coincides with an actual word used in the text, it is displayed to the user in the list of Insights. If the stem does not coincide with any words used in the text, the first word form of the stem that occurred in the text will be used for display.
    • Changes the Internal linking suggestions functionality in the following way: not only the text of the post but also different meta data fields are used for analysis, i.e., title, keyphrase, synonyms, meta description, subheadings (H2 and H3 levels). One occurrence of a word in the said meta data fields is deemed more important than one occurrence of this word inside the text. Stems are further saved in the database and used for matching of prominent words between posts and the internal linking functionality.

1.52.0 May 14th, 2019

Added

  • Adds a dependency to @yoast/feature-flag.
  • Adds createRegexFromArray export to yoastseo index.js.

Fixed

  • Improves keyphrase recognition for additional irregular verbs in German (e.g., brennen, senden, kennen).

1.51.0 April 29th, 2019

Added

  • Adds functionality to specify a custom premium-configuration branch to use for tests, locally and on Travis.

Fixed

  • Adds error handling to the YoastSEO development tool, when building the tree for visualization purposes.
  • Fixes the parsing of paragraphs within headings when using the tree parser. Previously, it crashed the building of the tree.

Changed

  • Improves the recognition of German keyphrases that include words with an i or e in between vowels (e.g., schrieen, schreien, speie).
  • Rewrites the SEO and readability analysis such that it uses both the original assessors as well the new tree assessors. The results of both are combined and their scores aggregated.

1.50.0 April 1st, 2019

Added

  • Adds word form recognition for German.
  • Adds more transition words for Swedish.
  • Adds visualization of the tree to the dev tool.

Changed

Fixed

  • Fixes a bug that impeded recognition of word forms for keyphrases on taxonomy pages.

1.49.0 March 11th, 2019

Added

  • The recalibrated analysis is out of its beta phase and is now the default for the SEO analysis. Thanks for testing and giving us your valuable feedback! You are awesome!

Fixed

  • Changes the text read out by a screen reader from Bad SEO score. to Needs improvement. when focused on the SEO score indicator in the menu bar and the traffic light in the snippet preview.

Changed

  • Props to Kingdutch for helping us to improve our open source content analysis library.

1.48.0 February 25th, 2019

Added

  • Improves the feedback for the assessment that checks the length of the text in cornerstone articles.

Fixed

  • Fixes a bug where a Flesch reading ease score of exactly 90 would incorrectly trigger a red bullet.

1.47.0 February 11th, 2019

Fixed

  • Fixes accidental removal of the SEO Assessor export from the index. Props Kingdutch.

1.46.0 January 21st, 2019

Added

  • Adds readability analysis for Swedish.
  • Adds prominent words for Swedish.
  • Improves keyword recognition in Swedish by filtering function words.
  • Improves the transition word assessment for German.
  • Improves the error logging when there is an error in an SEO or readability assessment.

1.45.0 January 7th, 2019

Fixed

  • Fixes a bug where special characters from certain word lists weren't correctly escaped when matched with a regex. This resulted in eggs being incorrectly matched as the transition word e.g., for example.
  • Fixes a crash when loading the createWorker module because the window was accessed in the global scope immediately.

Added

  • When the recalibration feature flag is switched on:
    • The single title assessment is added. This assessment makes sure that you don't use superfluous H1s in your text.
    • The following assessments are not used anymore:
      • The assessment checking the length or your URL.
      • The assessment checking whether your URL contains stopwords.
    • Assessments changes:
      • Keyphrase density: changes scoring schema to account for the length of the keyphrase and changes feedback strings so that we give feedback about the number of occurrences rather than a percentage.
      • Outbound links assessment: changes the scoring schema so that red bullet instead of an orange bullet is shown when you have no outbound links.
      • Image alt attributes: if there are at least 5 images, checks whether the alt tags contain the keyphrase or synoynyms in 30-70% of all images. If there are less than 5 images, 1 image with the keyphrase or synonym in the alt tag is still scored as good.
      • Keyphrase in title: function words preceding the exact match keyphrase are ignored when determining the position of the keyphrase in the title.
      • Keyphrase length: makes the scoring scheme less strict for languages that don't have function word support, so that for these languages keyphrases with 1-6 words are scored as green, 7-9 as orange, and more than 9 as red.
      • Keyphrase in subheading: only takes H2 and H3 level subheadings into account and changes the scoring schema so that 30%-75% of these subheadings need to include the keyphrase or its synonyms. In languages without function word support, a match is only counted if all the words from the keyphrase/synonym appear in the subheading.
      • Text length: on taxonomy pages, the recommended minimum text length is increased from 150 to 250 words.
  • The browser console now shows more descriptive error messages when something went wrong during analyses in the web worker.

Changed

  • Improved README Usage to detail the Web Worker API.

1.44.0 December 14th, 2018

Fixed

  • Fixes a bug where keyphrases weren't recognized in the URL when the words in the URL were separated by underscore characters instead of hyphens.
  • Fixes a bug that caused numbers to be stripped when marking a keyphrase containing a number, e.g. Yoast SEO 9.3.

Added

  • Adds relevant words from the browserified example to the dev tool.
  • Adds the option to use local morphology data in the dev tool.

Changed

  • Improves error handling in the analysis web worker by rejecting the last request instead of just throwing an error.

1.43.0 November 19th, 2018

Fixed

  • Fixes assessments failing when using a < sign in the content.
  • Fixes a bug where paragraphs were sometimes not correctly detected because paragraph tags were not automatically added in WordPress-like fashion.

Added

  • Adds toggles to use the different assessors in the webpack example (e.g., for all the different combinations for cornerstone and taxonomy pages and related keyphrase).
  • Introduce logger in the AnalysisWebWorker to replace the development console log.

Changed

  • Refactor SEO assessment file names and exports. Props Kingdutch.
  • Disables the non-functioning markers for the subheading distribution assessment.

1.42.0 November 5th, 2018

Fixed

  • Improves keyword recognition in the first paragraph on texts which start with images and captions.

Other

  • Removes non-functioning eye-markers from the link keyphrase assessment.

1.41.1 October 29th, 2018

Fixed

  • Fixes a bug where the Chrome browser tab would crash on Windows when a French or Italian text contains sentences in passive voice, props CarloCannas.
  • Fixes a bug where the Yoast SEO analysis would error if used together with the DelightfulDownloads plugin.

1.41.0 October 22nd, 2018

Added

  • Introduces two new principles for keyword recognition:
    • Makes keyphrase recognition flexible with regards to word order. This means that the keyphrase SEO WordPress plugin will be found in the sentence This is the most popular SEO plugin for WordPress. In order to use exact matches, the keyphrase can be enclosed in quotation marks.
    • When matching keyphrases for the various assessments, the analysis only targets content words and ignores function words (e.g., the or and). This functionality is available in English, German, Dutch, French, Spanish, Italian, Portuguese, Russian and Polish.
  • Implements support for word form recognition for keyphrases in English (requires Premium configuration).
  • Improves the feedback texts for all SEO and readability assessments.
  • Adds functionality to append a query string to the assessment links through the analysis worker.
  • Adds an assessment that checks whether your keyword consists only of function words.

Changed

  • The analysis of the following assessments incorporates the new keyword recognition principles:
    • Image alt attributes: checks whether there’s at least one image with an alt tag that contains words from the keyphrase. An exact match isn’t required anymore.
    • Keyphrase in introduction: checks whether words from the keyphrase are matched within one sentence in the introduction or, if not, whether they are present in the first paragraph at all. An exact match isn’t required anymore.
    • Keyphrase in title: still checks whether an exact match of the keyphrase is found in (the beginning of) the title, but now also recommends improvement if all words from the keyphrase are found in the title.
    • Keyphrase length: has new boundaries to check whether the keyphrase is not too long. For languages that have support for function word stripping (see above), only content words are taken into account.
    • Keyphrase in meta description: checks how often all words from the keyphrase are matched within the meta description.
    • Keyphrase in subheading: checks whether at least one subheading contains more than half of the words from the keyphrase. An exact match isn’t required anymore.
    • Keyphrase in slug: checks whether a sufficient number of words from the keyphrase is used in the slug. The number of words required depends on the length of the keyphrase.
    • Keyphrase density: checks whether there are enough keyphrase matches; a match is defined as a sentence that contains all words from the keyphrase. The upper boundary for a good score is higher when word form recognition is available, since in that case the analysis is able to pick up more matches.
    • Link focus keyphrase: the assessment that checks whether you’re using your keyphrase to link to a different article doesn't require an exact match anymore.
    • Keyphrase distribution uses an improved algorithm that checks whether the keyphrase is evenly distributed throughout the text.
  • The following assessments will also count synonym matches as keyphrase matches:
    • Image alt attributes
    • Keyphrase in introduction
    • Keyphrase in meta description
    • Keyphrase in subheading
    • Keyphrase distribution
  • Deprecates the assessment that checks if stopwords are used within the keyphrase.
  • The analysis for related keyphrases only shows assessments relevant for the specific keyphrase. It omits assessments that are non-keyphrase-related and assessments that should only be applied to the focus keyphrase.

Fixed

  • Fixes a bug where the keyword would not be found in the slug when containing punctuation, for example the keyphrase apples & pears in the slug apples-pears.

1.40.0 September 24th, 2018

Bugs:

  • Fixes a bug that caused keywords beginning with the Turkish characters İ / i and I / ı not to be recognized when changing that character from lowercase to uppercase and vice versa.

Enhancements:

  • Exposes word boundaries for use in other libraries or applications.

Changed:

  • Drops TypeScript support.
  • Changes all usage of lodash to lodash-es.
  • index.js has been rewritten to use ES6 Module import and export logic, instead of Node's require logic.

1.39.3 September 19th, 2018

Bugs:

  • Fixes a bug that would cause a browser crash in Chrome and Opera on Windows when the site language was Polish and the readability analysis was switched on.

1.39.2 September 6th, 2018

Bugs:

  • Fixes a bug where the readability analysis would not show the correct scores for cornerstone content.
  • Fixes a bug where switching off the SEO analysis would stop the readability analysis from loading.

1.39.1 September 5th, 2018

  • Fixes a bug where our JavaScript memory usage would increase indefinitely. This could result in a browser crash after a long enough period.

1.39 August 28th, 2018

Enhancements

  • Adds readability analysis for Polish.
  • Adds prominent words for Polish.

1.38.4 September 5th, 2018

Bugs:

  • Fixes a bug where our JavaScript memory usage would increase indefinitely. This could result in a browser crash after a long enough period.

1.38.3 August 24th, 2018

Bugs:

  • Fixes an issue where the worker communication wouldn't work when the script was minified.

1.38.2 August 24th, 2018

Bugs:

  • Fixes an issue where we would show bad results for an empty Paper.

Enhancements:

  • Automatically parse and serialize all value objects send to and from the worker. This means Paper objects can be passed to the analysis wrapper.
  • Add a method to the worker that can run any arbitrary research, runResearch.
  • Add a priority system to the Scheduler, this means extensions run before the analysis to make sure they are loaded.
  • Adds support for related keywords.

1.38.1 August 21st, 2018

  • Improves web worker functionality.

1.38.0 August 21st, 2018

  • Adds basic web worker functionality.

1.37.0 August 13th, 2018

  • Updates the font size of the snippet title measure element to correctly mimic Google's desktop snippet title.
  • Deprecates the switch assessor.

1.36.1 August 6th, 2018

Changed

  • Increased the debounce delay in the App to make sure the refresh is triggered less often.

1.36.0 July 24th, 2018

Added

  • Adds a link to a relevant article about re-using keywords to the feedback of the assessment that checks if the keyword was used previously.
  • Exposes all assessments and more as a public API.
  • Adds the passive voice assessment for Dutch.

Changed

  • Improves the order in which assessments are triggered. The keyword in the title is only checked once there's a title, the keyword in the introduction is only checked once there's a text, and the keyword in the meta description is only checked once there's a meta description.

Fixed

  • Fixes a bug that caused keywords to be incorrectly recognized within possessive forms (e.g. Natalia in Natalia's fix).
  • Improves the recognition of keywords with special diacritics in the URL.
  • Improves keyword recognition through adding Spanish inverted exclamation and question marks to the rules that determine word boundaries.

1.35.5 July 16th, 2018

1.35.4 July 16th, 2018

Changed

  • Changes feedback in the keyword density assessment to make it more explicit that synonyms are not taken into consideration when calculating the score.

1.35.3 July 9th, 2018

Changed

  • Makes keyword distribution boundaries the same regardless of whether or not synonyms are set, enables markings also when the bullet is green, and shows a gray bullet when there are not enough keyword occurrences to calculate distribution.

1.35.2 July 5th, 2018

Changed

  • Removes the topic density assessment and uses the keyword density assessment also when synonyms are set.

1.35.1 July 4th, 2018

Fixed

  • Fixes a bug where a custom callback would not work correctly.

1.35.0 July 3rd, 2018

Added

  • Adds an assessment the checks the distribution of the focus keyword in the text.
  • Adds a topic distribution and topic density assessment to use with synonyms.
  • Adds links to relevant articles to all SEO assessments.
  • Adds Flesch Reading Ease assessment for French.
  • Adds Flesch Reading Ease assessment for Spanish.
  • Add passive voice assessment for Italian.

Fixed

  • Instances of the same keyword with different kinds of apostrophes (e.g., brain’s and brain's) are now recognized as the same in the following assessments: keyword in meta description, keyword in subheading, keyword in first paragraph, keyword in title, keyword in URL.
  • Filters out prominent word combinations ending in 's in English. Props to swekkiekekkie.

1.34.0 June 12th, 2018

Fixed

  • Fixes title width measurements by adding font styles to the hidden input field.

Changed

  • Improves the lists of French transition words, stopwords, and function words, props Laurent-1971.

1.33.1 May 25th, 2018

Fixed

  • Fixes a bug where Flesch Reading Ease translation strings were not fully translated.

1.33.0 May 23rd, 2018

Added

  • Adds Catalan transition words.
  • Added the title width to rawData in app.js to be used by the title width assessment.

Changed

  • Changed max meta description length from 320 to 156.

1.32.0 May 16th, 2018

Added

  • Adds Flesh Reading Ease for Russian.

Changed

  • Sequences of symbols which do not contain a single letter or digit are no longer considered a valid keyword.
  • Question marks and hashes are stripped from the snippet preview URL.
  • Makes the snippetPreview optional in the App. This can be enabled by putting the hasSnippetPreview argument to false.

1.31.0 April 26th, 2018

Added

  • Adds readability analysis for Russian.
  • Adds prominent words for Russian.

Changed

  • Improves SVG image accessibility.
  • Updates the language support table in the README.

Fixed

  • Fixes a bug where sentences ending in multiple sentence marks, exclamation marks or ellipses were treated as multiple sentences.

1.30.2 March 16th, 2018

Changed

  • Reverted the default view of the snippet preview to desktop.

1.30.1 March 12th, 2018

Fixed

  • Fixes a bug that broke a filter which marks Spanish and French sentences as non-passive when certain exception words occur between the auxiliary and the participle.

1.30.0 March 5th, 2018

Added

  • Adds a setter for titleWidth to the snippet preview.
  • Adds a researcher to calculate the reading time for a given paper.
  • Adds a filter to mark Spanish sentences as non-passive when certain exception words occur between the auxiliary and the participle. The list of exception words includes all forms of the copula 'estar'.
  • Adds transition words assessment for Portuguese, props amesdigital.
  • Adds prominent words for Portuguese, props amesdigital.

Changed

  • The snippet preview now shows the mobile preview by default.
  • Fixes a bug where division by zero errors in the passive voice assessment would cause NaN% to show up in the feedback.
  • Fixes a bug where multiple rel arguments prevented correct nofollow detection.
  • Slightly increased the height of the meta description box so it matches the maximum amount of characters without needing a scrollbar.
  • Improves the list of Portuguese function words.

1.29.0 January 15th, 2018

Added

  • Adds language support table to the README.
  • Adds a performance analysis tool.
  • Adds the passive voice assessment for French.
  • Adds the passive voice assessment for Spanish.

Changed

  • Simplifies the message for the SubheadingsKeywordAssessment.
  • Reduces the number of times the content analysis is refreshed on page load.
  • Fixes a bug where relative URLs were not counted as internal links in the internal link assessment.

1.28.0 December 18th, 2017

Changed

  • Includes the link to the post about using your focus keyword multiple times also to the feedback text that is shown when using a focus keyword twice.
  • Changes the anchor text of the link to the post about using your focus keyword multiple times to a more accessible one.

1.27.0 December 15th, 2017

Changed

  • The upper boundary of the meta description length has been changed from 156 to 320 characters.

1.26.0 December 13th, 2017

Changed

  • Updates the copy for the previouslyUsedKeywords assessment by referring to a new blogpost on why it might be a bad idea to use the same keyword more than once.

1.25.0 December 11th, 2017

Added

  • Adds a link to the subheadings article in the readability analysis to better explain the advantages of using subheadings in your text. #1317

1.24 November 29th, 2017

Changed

  • Changes the feedback string for a good meta description length from The length of the meta description is sufficient. to The meta description has a nice length. #1307

1.23.1 November 7th, 2017

Added

  • Adds a sentence research. #1278
  • Adds escaping of the focus keyword in the url generated by the PreviouslyUsedKeywords assessment. #1281

1.23.0 October 31st, 2017

  • Errors now give a score of -1. ScoreToRating interpreter will convert -1 to error. #1272
  • Adds Excited to exception -ed verbs for passive voice assessment. #1269
  • Adds release script to .travis.yml for publishing to npm. #1265
  • Adds a filter to exclude code tags and their enclosed content from the content analysis assessments. #1250
  • Adds a filter to exclude pre tags and their enclosed content from the content analysis assessments, props chrisboo. #1258
  • Switches testing framework to jest. #1266

1.22.0 October 3rd, 2017

  • Added typescript support.
  • Add filter for exception words between auxiliary and passive participle.
  • Fixes a bug that caused an error in the passive analysis when certain words ending in ing were followed by a parenthesis.

1.21.0: September 5th, 2017

  • Adds updatedKeywordsResults and updatedContentResults callbacks to app.js.

1.20.0: August 8th, 2017

Added

  • Adds a filter for word combinations that consist of a single one-character word.

Fixed

  • Fixes a bug where the passive voice and transition word assessments were broken when the passive voice sentence breaker or the transition word was preceded by a word containing the same string of letters.

1.19.0: July 25th, 2017

Added

  • Adds additional English transition words.
  • Adds additional French transition words, props Evoque.
  • Adds relevant words functionality for Italian.
  • Adds relevant words filters for titles such as 'Ms', 'jr' etc. for English, Dutch, German, French, Italian and Spanish.
  • Adds plural ordinal numbers relevant words filters for Spanish, Italian, and French.
  • Adds time words relevant words filters for English, Dutch, German, French and Spanish.
  • Adds more function words category relevant words filters for Spanish and Italian.

Changed

  • Improves filtering for Internal Linking Suggestions and Insights for Italian, Spanish, Dutch, French, English and German.
  • Removes all relevant word combinations containing any of the following special characters if they are not part of a word: –, —, -, ©, #, %, /, , $, €, £, *, •, |, →, ←, }, {, //, ||.

Fixed

  • Fixes a visual imperfection in the tooltip in combination with Microsoft Edge.

1.18.0: July 6th, 2017

Changed

  • Changes 'page title' to 'seo title' in the snippet preview.
  • Changes recommended maximum sentence length for Italian from 20 to 25 words, based on more in-depth research.

Added

  • Adds Flesch Reading for Italian.
  • Adds prominent words for French, props Sylvain Perret and Evoque.

1.17.2: June 7th, 2017

Fixed

  • Remove YoastSEO.js as dependency of itself.

1.17.0: June 7th, 2017

Fixed

  • Fixes a bug where assessments added with the pluggable were omitted.

1.16.0: May 23rd, 2017

Fixed

  • Fixes a typo in app.js comments, props Alexander Varwijk.
  • Fixes an incompatibility issue with includes in Internet Explorer. The browser doesn't support includes and that broke the HTMLparser.

Added

  • Adds cornerstone assessors.

1.15.1: May 9th, 2017

Fixed

  • Fixes an issue where the analysis wouldn't work on Internet Explorer.

1.15.0: May 2nd, 2017

Fixed

  • Fixes a bug where style and script elements were parsed for the prominent words.
  • Fixes a bug where the cursor pointer was in front of the metabox.

Added

  • Adds transition words for Italian.
  • Adds a new assessment for internal linking that checks for the presence of at least one internal link.

1.14.0: April 11th, 2017

Fixed

Added

  • Introduces sentence beginnings assessment for Italian.

1.13.0: March 21st, 2017

Fixed

  • Fixes a bug where the keyword density assessment would disappear when the density was 0.5%.

1.12.0: February 28th, 2017

Fixed

  • Sets the boldness of the strong tags to 700 to enforce that they are displayed strong.
  • Changes strings that link to an article to improve context.
  • Changes links to short links so we can ensure they are always up to date.

1.11.0: February 14th, 2017

Added

  • Adds prominent words for Spanish.
  • Adds getLinks to the researcher, this function retrieves the URLs of the links from the text.

Changed

  • Improves feedback text for subheading too long assessment.

1.10.0: January 31st, 2017

Added

  • Adds prominent words for Dutch.
  • Adds example for testing the prominent words analysis.
  • Adds the tooltip CSS rule from Yoast SEO to yoastSEO.js.

Changed

  • Improves the accessibility of the snippet preview toggle buttons.
  • Makes the mark buttons tooltips always visible.

Fixed

  • Fixes a bug where the measurement elements holder <div> breaks the responsive view of the media modal.

1.9.0: January 17th, 2017

Added

  • Adds mobile snippet preview.
  • Adds sentence length check for Dutch.
  • Adds sentence beginnings check for Dutch.
  • Adds transition words for Dutch.
  • Adds German prominent words.

Changed

  • Removes unused assessments; sentence length variation, subheading length, subheading presence, subheading distribution too short, paragraph too short
  • Makes the stop words check language dependant.

1.8.0: December 13th, 2016

Added

  • Adds passive voice for German.
  • Adds more transition words for French.

Changed

  • Creates value objects for sentence parts and participles.
  • Improves feedback strings for the meta description length assessment.
  • Improves matching of the keyword in the first paragraph.
  • Improves the snippet preview to match the styling of Google's snippet.

Fixed

  • Fixes a bug where keywords with periods where not highlighted in the snippet.

1.7.0: October 11th, 2016

Added

  • Adds relevant word research that returns a list of most prominent words in a given Paper.

Changed

  • Changes all target= links to consistently be target=_blank.

Fixed

  • Adds missing transition words to German transition word list.
  • Fixes a bug where empty sentences could be marked when marking the beginning of sentences.

1.6.0: September 27th, 2016

Changed

  • Improves carets used in the snippet preview to support RTL.

Fixed

  • Keywords with special characters are now matched.
  • Changes sassdash from a dev dependency to a regular dependency.

1.5.0: September 7th, 2016

Changed

  • Improves sentence beginning check by matching only alphanumeric characters.
  • Adds horizontal ellipses as sentence terminator.

Fixed

  • Improves detecting sentence endings with block ends.
  • Passive voice detects multiple uses of the same auxiliary.
  • Yoast marks are no longer placed around block level elements.
  • Prevents division by zero in transition word assessment result text.
  • Passive voice detects exceptions with the word 'rid' correctly.

Added

  • Flesch Reading for Dutch
  • Flesch Reading for German

1.4.1: August 2nd, 2016

Fixed

  • Fixes a security issue where the focus keyword would be output without escaping it first.

1.4.0: July 19th, 2016

Changed

  • Improves feedback texts of assessments.
  • Improves Russian transliteration.
  • Determine length of title based on the width in pixels instead of on number of characters.
  • Words comprised of only digits are no longer counted in the Flesch Reading assessment.
  • Improves passive voice detection by omitting HTML tags.
  • Non breaking spaces are replaced with normal spaces in word boundaries.

Fixed

  • Improved keyword density assessment by scoring on the rounded result.
  • ¿ and ¡ are now accepted as sentence beginnings.
  • Fix a bug where the text assessment would fail with exactly 300 words.
  • Fix a bug in the competing links assessment where a link to the same post would be counted as an outbound link.

Added

  • Transliterations for the following languages:
    • Breton, Chamorro, Corsican, Kashubian, Welsh, Ewe
    • Estonian, Basque, Fulah, Fijian, Arpitan, Friulian
    • Frisian, Irish, Scottish Gaelic, Galician, Guarani
    • Swiss German, Haitian Creole, Hawaiian, Croatian
    • Georgian, Greenlandic, Kinyarwanda, Luxembourgish
    • Limburgish, Lingala, Lithuanian, Malagasy, Macedonian
    • Maori, Mirandese, Occitan, Oromo, Portuguese, Romansh Vallader
    • Aromanian, Romanian, Slovak, Slovenian, Albanian
    • Klingon (in Latin characters, not KLI PlqaD script yet)
    • Hungarian, Sardinian, Silesian, Tahitian, Venetian, Walloon
  • Added assessment for consecutive sentences beginning with the same word for the following languages:
    • English, German, French, Spanish.
  • Added transition words for German, French and Spanish.

1.3.3: June 21st, 2016

Changed

  • Change the calculation of the aggregate content score to be more lenient for non-English languages.

1.3.2: June 15th, 2016

Fixed

  • Fix a bug where the transition words and passive voice assessments would display on non-English languages.

1.3.1: June 14th, 2016

Fixed

  • Fix a bug where no content would result in a green overall content score.

1.3.0: June 14th, 2016

Added

  • Assessments that assess the following properties:

    • The length of subheadings.
    • The length of text following a subheading.
    • The length of paragraphs.
    • The length of sentences.
    • The presence of transition words.
    • The presence of the passive voice.
  • Markers for certain assessments that can show the location of the feedback inside the text:

    • The length of paragraphs.
    • The length of sentences.
    • The presence of passive voice.
    • The presence of transition words.
    • The presence of links with the focus keyword as link text.
  • Transliteration for the following languages:

    • Spanish, Polish, German, Nynorsk, Bokmål, Swedish, Finnish,
    • Danish, Turkish, Latvian, Icelandic, Faroese, Czech, Russian,
    • Esperanto, Afrikaans, Catalan, Asturian, Aragonese, Aymara,
    • English, French, Italian, Dutch, Bambara.
  • Improved accessibility in the snippet preview.

  • Added a marker argument to the App that can be used to inject a marker function.

  • Added a marker argument to the Assessor that can be used to inject a marker function.

  • Added a button after all assessment results that can be marked in the text.

Changed

  • Created a contentAssessor that contains all content assessments. Some assessments have been moved from the SEO sssessor to the content assessor.
  • Gracefully fail on assessment failure. An assessment that has a fatal error now will be shown as a gray bullet and add a trace to the console.
  • Improve the way we detect sentences in the text.
  • Improve performance of the flesch reading ease.
  • Make sure the refresh of the app is always properly debounced.
  • Add identifier to all assessments and assessment results to be able to reference them later.
  • Hide progress bars from screen readers.

Fixed

  • Fix a bug where a modification on the title wasn't correctly taken into account.
  • Fix a bug where alt tags were requires in all images instead of in only one of the images.
  • Fix a bug where having subheadings without the focus keyword was worse than having no subheadings at all.
  • Fix a bug where requiring paper in index.js would fail on case-sensitive systems, props Chris Bosco.

1.2.2: May 4th, 2016

Bug

  • Fixes a bug where the alt-attribute assessment required all images to have an alt-attribute with the keyword.

1.2.1: April 21th, 2016

Bugfixes

  • Fixes a bug where one wrong translation could crash all the JavaScript.

1.2: April 20th, 2016

Backwards incompatible changes

  • Stopped loading sassdash, when importing the scss files you need to include sassdash yourself.
  • Removed all analyses in favor of researches.
  • Implement the used keywords assessment as a bundled plugin, this means that an implementation should call the plugin itself.
  • Removes js/config/scoring.js
  • Removes js/analyzer.js
  • Removes js/analyzescorer.js
  • Removes browser.js as we expect implementations to browserify themselves.
  • Removes app.registerTest in favor of app.registerAssessment.
  • Removes js/scoreFormatter.js

Features

  • Introduces several value objects to more easily work with content and results:
    • Paper to represent the text that is about to be assessed.
    • AssessmentResult to represent the result of a single assessment.
  • Implements all value judgements about content as assessments, we introduced the following assessments:
    • FleschReadingEaseAssessment
    • IntroductionKeywordAssessment
    • KeyphraseLengthAssessment
    • KeywordDensityAssessment
    • KeywordStopWordsAssessment
    • MetaDescriptionKeywordAssessment
    • MetaDescriptionLengthAssessment
    • SubheadingsKeywordAssessment
    • TaxonomyTextLengthAssessment
    • TextCompetingLinksAssessment
    • TextImagesAssessment
    • TextLengthAssessment
    • TextLinksAssessment
    • TextSubheadingsAssessment
    • TitleKeywordAssessment
    • TitleLengthAssessment
    • UrlKeywordAssessment
    • UrlLengthAssessment
    • UrlStopWordsAssessment
  • Implements all statistics about a text as researches, we introduced the following researches. All researches expect a Paper.
    • calculateFleschReading
    • countLinks
    • findKeywordInFirstParagraph
    • findKeywordInPageTitle
    • getKeywordDensity
    • getLinks
    • getLinkStatistics
    • imageAltTags
    • imageCountInText
    • keyphraseLength
    • keywordCountInUrl
    • matchKeywordInSubheadings
    • matchSubHeadings
    • metaDescriptionKeyword
    • metaDescriptionLength
    • pageTitleLength
    • stopWordsInKeyword
    • stopWordsInText
    • stopWordsInUrl
    • urlIsTooLong
    • wordCountInText
  • Introduces an Assessor that contains a number of assessments and is able to determine a total assessment.
  • Introduces an SEOAssessor that has all the assessments that are currently available.
  • Introduces an AssessorPresenter to output the results of an Assessor to the DOM.
  • Introduces a template to more easily render the assessment results.
  • Introduces an Researches that contains a number of researches and is you can retrieve a specific research from.
  • Rewrites the App to make use of the assessor setup.
  • Introduces scoreToRating to transform a score to a rating.
  • Introduces InvalidTypeError for passing invalid types to constructors or methods
  • Introduces config/presenter.js to transform a rating into a className or screenreader text.
  • Exports certain prototypes and functions in an index.js.

Enhancements

  • Improves the contrast between the background and the red circle by choosing a different color red.
  • Add a clearfix mixin.
  • Switches to ESLint in favor of JSHint, JSONLint, JSValidate and JSCS.
  • Switches to a custom grunt script to build the lodash templates, grunt-lodash is deprecated.
  • Adds an argument to stringToRegex to specify whether to replace diacritics before building the regex.
  • Massively improves test coverage.
  • Updates lodash from version 3 to version 4.
  • Pluralizes certain translations, this makes it possible to correctly translate these strings.
  • Adds a sass function for a caret point to the left.

Bugfixes

  • Removes several for..in calls that errored when build in prototypes had added methods or properties.
  • Fixes a bug where accented characters were not correctly matched in subheadings and the snippet editor.

1.1: March 1st, 2016

Backwards incompatible changes

  • Passing the title, url and meta description meant for the snippet editor is no longer taken into account. The snippet editor keeps track of these values itself.
  • callbacks.updateSnippetValues has been deprecated in favor of callback.saveSnippetData. Currently a raw event is passed to updateSnippetValues. This is undesirable because it couples the callback to the DOM. The new saveSnippetData passes the actual data that the user put in the fields.
  • The SnippetPreview object now requires an options object instead of an App object. The App object should still be passed inside the options object with the analyzerApp key.
  • Removed SnippetPreview methods:
    • setFocus
    • hideEditIcon
    • showEditIcon
    • textFeedback
    • disableEnter
  • Removed App methods:
    • bindSnippetEvents
    • bindEvent
    • createEditIcon
    • createSnippetPreviewEditIcon
    • createSnippetPreviewMeta
    • createSnippetPreviewUrl
    • createSnippetPreviewTitle
  • Deprecated App.createSnippetPreview
  • Removed StringHelper prototype.
  • Removed PreProcessor prototype.

Features

  • Completely redesign the snippet editor editing experience:
    • Remove the contenteditable fields
    • Add a decoupled form to edit the title, slug and meta description fields.
    • Add a button to clearly show how to open the snippet editor.
    • Add headings to clearly indicate which part is the snippet preview and which is the editor.
    • Add progress bars to show an indication about the length of the title and meta description.
    • Add carets before the preview and form fields to show which preview belongs to which input field.
  • Introduce modules. All non-trivial modules are moved out of analyzer.js and moved to the analyses folder as module. Where it makes sense we added a stringProcessing folder with all the string helper modules.
  • Introduces new SnippetPreview functions:
    • toggleEditor
    • closeEditor
    • openEditor
    • updateDataFromDOM
    • changedInput
    • bindEvents
    • updateProgressBars
    • validateFields
    • callRegisteredEventBinder
    • getAnalyzerData
    • refresh
    • renderTemplate
  • Introduce ScoreFormatter.getUndefinedScores to retrieve all the undefined scores from a scores array.
  • Introduce missingArgument error that is thrown when an argument is missing in the App.
  • Massively reduce the required config of the App.

Enhancements

  • Start to decouple the SnippetPreview from the scrapers and the analyzer.
  • Depend on lodash to improve the readability of our codebase and to standardize certain actions.
  • Add an option to the SnippetPreview to include a date before the meta description.
  • Add a baseURL option to the SnippetPreview to change the base URL.
  • Change the stopwords check to a grey bullet that doesn't count towards the total score.

Bugfixes

  • By default add a trailing slash to the rendered URL, add an option to the SnippetPreview to disable this behaviour.
  • Show the protocol in the snippet preview if it is HTTPS. Google has this behaviour as well.
  • Color the meta description preview gray if the user hasn't set it explicitly.

1.0: November 18th, 2015

Backwards incompatible changes

  • Removed YoastSEO.app.addToQueue method.
  • Removed YoastSEO.app.removeFromQueue method.
  • Removed YoastSEO.SnippetPreview.setFocusToEnd method.
  • Changed class name of progress bar from wpseo_msg to YoastSEO_msg. 3fa27b8
  • Changed ID of progress bar from wpseo-plugin-loading to YoastSEO-plugin-loading. 3fa27b8
  • config.sampleText.url has been removed in favor of config.sampleText.baseUrl and config.sampleText.snippetCite.
  • YoastSEO.Pluggable now needs to be instantiated with a valid YoastSEO.App object. ce32d4a
  • Removed YoastSEO.App.init method. b720553
  • Removed YoastSEO.App.loadQueue method. b720553
  • Move YoastSEO.App.queue to YoastSEO.App.rawData.queue. b720553
  • Removed YoastSEO.App.defineElements method. b720553
  • Removed YoastSEO.App.showMessage method. b720553
  • Removed YoastSEO.initialize method. b720553
  • Removed YoastSEO.getAnalyzerInput method. b596d41
  • Removed YoastSEO.runAnalyzerCallback method. b596d41
  • Removed YoastSEO.noKeywordQueue method. b596d41
  • Removed YoastSEO.InputGenerator in favor of YoastSEO.ExampleScraper, don't use this! This is only meant as an example. af05e7d
  • Removed args.snippetTitle. The snippet title will now always be rendered following args.pageTitle. 1cf3e23
  • Changed arguments of YoastSEO.ScoreFormatter 116bdfd, 9473dce and 34f7657:
    • args.pageAnalyzer removed in favor of args.scores and args.overallScore.
    • args.config.targets.output removed in favor of args.outputTarget.
    • args.config.targets.overall removed in favor of args.overallTarget.
    • Introduced args.keyword.
    • Introduced args.saveScores.

Features

  • Added YoastSEO.SnippetPreview.getUnformattedText and `YoastSEO.SnippetPreview.setUnformattedText, getter and setter for the unformatted text property. 682ec6d
  • Added fallback for meta description to the text that is analyzed. This is prioritized after the excerpt but before the sample text.
  • Added a config.snippetSuffix to include some text before the snippet title.
  • Added YoastSEO.Analyzer.addAnalysis to add an analysis on the analyzer object. ddec6b7
  • Added YoastSEO.AnalyzeScorer.addScoring to add a scoring on the scoring object. ddec6b7
  • Added YoastSEO.App.registerTest to add a new test to the analyzer. ddec6b7
  • Added YoastSEO.AnalyzerScoring.getTotalScore to retrieve the total score. 72f368a

Enhancements

  • Improved default value of the base url in the snippet preview. a1d805a
  • Improved handling of the raw snippet preview content so we the user can edit the raw string when clicking on an item in the snippet preview.
  • Improved detection of container element, now uses config.targets.output instead of a hardcoded wpseo_meta
  • config.sampleText.baseUrl is no longer required.
  • Added reference to Yoast.App instance as a parameter to bindElementEvents callback.
  • Automatically enable no keyword queue if there is no keyword. b596d41
  • Increase snippet title length from 40 to 70 characters. 0ad7c1f
  • Re-render snippet preview after each analysis. 3d080b8
  • Use input event to bind to snippet preview change instead of change. 4675a9f
  • Don't use args.overallTarget if it isn't set. 7ce7ea4

Bugfixes

  • Fixed snippet preview so only the full focus keyword is highlighted and not words that contain the focus keyword. 3655d13
  • Fixed scoring so 0-3 now mean a bad score and no-keyword is a special score. ad8a085
  • Fix scoring for title length.
  • Sanitize keyword before using it as a regex to prevent the regex from breaking. 2d95fcb
  • Style the snippet title inline-block to make the overflow hidden.
  • Style the snippet site url inline to make the overflow hidden.

1.0-beta2: September 23st, 2015

  • Fixes a bug where the slug wasn't taken into account when checking if the url contains the focus keyword.

1.0-beta: September 21st, 2015

  • Initial beta release