Text analysis and assessment library in JavaScript. This library can generate interesting metrics about a text and assess these metrics to give you an assessment which can be used to improve the text.
npm install axyseoText analysis and assessment library in JavaScript. This library can generate interesting metrics about a text and assess these metrics to give you an assessment which can be used to improve the text.
!Screenshot of the assessment of the given text
Also included is a preview of the Google search results which can be assessed using the library.
yoastseo package can be found here.You can install YoastSEO.js using npm:
``bash`
npm install yoastseo
Or using yarn:
`bash`
yarn add yoastseo
You can either use YoastSEO.js using the web worker API or use the internal components directly.
Because a web worker must be a separate script in the browser you first need to create a script for inside the web worker:
`js
import { AnalysisWebWorker } from "yoastseo";
const worker = new AnalysisWebWorker( self );
worker.register();
`
Then in a different script you have the following code:
`js
import { AnalysisWorkerWrapper, createWorker, Paper } from "yoastseo";
// url needs to be the full URL to the script for the browser to know where to load the worker script from.
// This should be the script created by the previous code-snippet.
const url = "https://my-site-url.com/path-to-webworker-script.js"
const worker = new AnalysisWorkerWrapper( createWorker( url ) );
worker.initialize( {
locale: "en_US",
contentAnalysisActive: true,
keywordAnalysisActive: true,
logLevel: "ERROR",
} ).then( () => {
// The worker has been configured, we can now analyze a Paper.
const paper = new Paper( "Text to analyze", {
keyword: "analyze",
} );
return worker.analyze( paper );
} ).then( ( results ) => {
console.log( 'Analysis results:' );
console.log( results );
} ).catch( ( error ) => {
console.error( 'An error occured while analyzing the text:' );
console.error( error );
} );
`
If you want to have a more bare-bones API, or are in an environment without access to Web Worker you can use the internal objects:
`js
import { AbstractResearcher, Paper } from "yoastseo";
const paper = new Paper( "Text to analyze", {
keyword: "analyze",
} );
const researcher = new AbstractResearcher( paper );
console.log( researcher.getResearch( "wordCountInText" ) );
`
Note: This is currently a synchronous API, but will become an asynchronous API in the future.
English, German, Dutch, French, Spanish, Italian, Portuguese, Russian, Polish, Swedish, Hungarian, Indonesian, Arabic,
Hebrew, Farsi, Turkish, Norwegian, Czech, Slovak, Greek, Japanese
| Language | Transition words | Flesch reading ease | Passive voice | Sentence beginnings | Sentence length1 |
|------------ |------------------ |--------------------- |--------------- |--------------------- |----------------------------- |
| English | ✅ | ✅ | ✅ | ✅ | ✅ |
| German | ✅ | ✅ | ✅ | ✅ | ✅ |
| Dutch | ✅ | ✅ | ✅ | ✅ | ✅ |
| French | ✅ | ✅ | ✅ | ✅ | ✅ |
| Spanish | ✅ | ✅ | ✅ | ✅ | ✅ |
| Italian | ✅ | ✅ | ✅ | ✅ | ✅ |
| Portuguese | ✅ | ✅ | ✅ | ✅ | ✅ |
| Russian | ✅ | ✅ | ✅ | ✅ | ✅ |
| Catalan | ✅ | ❌3 | ❌3 | ❌3 | ❌3 |
| Polish | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Swedish | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Hungarian | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Indonesian | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Arabic | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Hebrew | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Farsi | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Turkish | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Norwegian | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Czech | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Slovak | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Greek | ✅ | ❌2 | ✅ | ✅ | ✅ |
| Japanese | ✅ | ❌2 | ❌4 | ✅ | ✅ |
1 This means the default upper limit of 20 words has been verified for this language, or the upper limit has been changed.
2 There is no existing Flesch reading ease formula for these languages.
3 This means that the functionality for this assessment is currently not available for these languages.
4 The Passive voice check for Japanese is not implemented since the structure is the same as the potential form and can additionally be used for an honorific purpose. Identifying whether a verb is in its passive, honorific or potential form is problematic without contextual information.
The following readability assessments are available for all languages:
- sentence length (with a default upper limit of 20 words, see1 above )
- paragraph length
- subheading distribution
- text presence
The inclusive language analysis is currently available in English.
Please see CHANGELOG for more information what has changed recently.
`bash`
npm test
Or using yarn:
`bash`
yarn test
Generate coverage using the --coverage flag.
To test your code style:
`bash`
yarn lint
In the YoastSEO.js directory, run:
`bash`
npm link
Or using yarn:
`bash`
yarn link
Then, in the project directory where you want to test the package, assuming you have a complete development version, run:
`bash`
npm link yoastseo
Or using yarn:
`bash`
yarn link yoastseo
If you want to unlink, simply do:
`bash`
npm unlink yoastseo
Or using yarn:
`bash``
yarn unlink yoastseo
Please see CONTRIBUTING for details.
If you discover any security related issues, please email security [at] yoast.com instead of using the issue tracker.
- Team Yoast
- All Contributors
We follow the GPL. Please see License file for more information.