axyseo 2.0.0-alpha.0.0.19 → 2.0.0-alpha.0.0.2

package/.browserslistrc

@@ -0,0 +1 @@
+extends @yoast/browserslist-config

package/.gitattributes

@@ -0,0 +1 @@
+text eol=lf

package/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+	presets: [ "@babel/preset-env", "@babel/preset-react" ],
+};

package/eslint.config.mjs

@@ -0,0 +1,119 @@
+import globals from "globals";
+import yoastConfig from "eslint-config-yoast";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+	{ ignores: [ "build", "vendor", "examples" ] },
+	...yoastConfig,
+	{
+		languageOptions: {
+			ecmaVersion: "latest",
+			globals: {
+				...globals.browser,
+			},
+		},
+		rules: {
+			// Account for webpack externals and potentially unbuilt packages in the monorepo setup.
+			"import/no-unresolved": [
+				"error",
+				{
+					ignore: [
+						// Ignore @yoast packages from this workspace, or we have to build the code before linting.
+						// Because `main` in `package.json` points to the `build/index.js`, which is not present before building.
+						// As we are dealing with our source, not the actual NPM download, due to the monorepo setup.
+						"^@yoast/(ui-library|style-guide|components|helpers|search-metadata-previews|social-metadata-forms|replacement-variable-editor|analysis-report|feature-flag|related-keyphrase-suggestions)$",
+						"yoastseo",
+						// Ignore imports from premium-configuration, which might not be available in all environments.
+						"premium-configuration/data/morphologyData",
+					],
+				},
+			],
+
+			// Deviate from the Yoast config to prohibit dangling commas in functions.
+			"stylistic/comma-dangle": [
+				"error",
+				{
+					functions: "never",
+					arrays: "always-multiline",
+					objects: "always-multiline",
+					imports: "always-multiline",
+					exports: "always-multiline",
+				},
+			],
+
+			// Deviate from the Yoast config to ignore RegExp literals.
+			"stylistic/max-len": [
+				"error",
+				{
+					code: 150,
+					tabWidth: 4,
+					ignoreComments: true,
+					ignoreStrings: true,
+					ignoreRegExpLiterals: true,
+				},
+			],
+
+			// Deviate from the Yoast config to allow existing violations. New occurrences are still disallowed.
+			"no-useless-backreference": "warn",
+			"no-prototype-builtins": "warn",
+
+			// Deviate from the Yoast config to allow default imports that share the name of a named export.
+			// We sometimes export a value as both a named export and a default export.
+			"import/no-named-as-default": "off",
+
+			// Deviate from the Yoast config to allow for not using the error that is caught.
+			"no-unused-vars": [ "error", { caughtErrors: "none" } ],
+		},
+	},
+	{
+		files: [ "src/languageProcessing/**" ],
+		settings: {
+			"import/core-modules": [ "yoastseo" ],
+		},
+	},
+	{
+		// Enable node globals for the singleton script, as it is the only file that accounts for a Node environment as a fallback.
+		files: [ "src/helpers/shortlinker/singleton.js" ],
+		languageOptions: {
+			globals: {
+				...globals.node,
+			},
+		},
+	},
+	{
+		// Enable worker globals for worker scripts.
+		files: [ "src/worker/**" ],
+		languageOptions: {
+			globals: {
+				...globals.worker,
+			},
+		},
+	},
+	{
+		// Enable browser globals for the createWorker script, which is not a worker itself.
+		files: [ "src/worker/createWorker.js" ],
+		languageOptions: {
+			globals: {
+				...globals.browser,
+			},
+		},
+	},
+	{
+		files: [ "spec/**" ],
+		rules: {
+			"max-statements": "off",
+			// Deviate from the Yoast config to allow access properties from the default export that share a name with a named export.
+			// We sometimes export a value as both a named export and a default export that represents all the named exports as a single object.
+			// We exclusively do this in test, so we can keep this rule enabled in src.
+			"import/no-named-as-default-member": "off",
+		},
+	},
+	{
+		files: [ "Gruntfile.js", "grunt/**", "babel.config.js", "premium-configuration/**" ],
+		languageOptions: {
+			globals: {
+				...globals.node,
+			},
+		},
+	},
+];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "axyseo",
-  "version": "2.0.0-alpha.0.0.19",
-  "main": "build/index.js",
+  "version": "2.0.0-alpha.0.0.2",
+  "main": "src/index.js",
   "scripts": {
     "build": "yarn clean && yarn build:js && yarn build:types",
     "build:js": "babel src --copy-files --source-maps --out-dir build",
@@ -9,17 +9,12 @@
     "clean": "rm -rf build",
     "lint": "eslint src spec --max-warnings 10"
   },
-  "files": [
-    "build/"
-  ],
   "dependencies": {
-    "@shopify/polaris": "^13.9.1",
     "@shopify/polaris-icons": "^8.2.0",
     "htmlparser2": "^3.9.2",
     "lodash": "^4.17.21",
     "loglevel": "^1.8.1",
     "parse5": "^7.1.2",
-    "react": "18.2.0",
     "tiny-segmenter": "^0.2.0",
     "tokenizer2": "^2.0.1"
   },
@@ -29,16 +24,10 @@
     "@babel/preset-env": "^7.26.0",
     "@babel/preset-react": "^7.26.3",
     "@yoast/browserslist-config": "^1.2.3",
-    "babel-plugin-module-resolver": "^5.0.2",
     "blob-polyfill": "^7.0.20220408",
     "console.table": "^0.10.0",
     "eslint": "^9.16.0",
-    "prettier": "^1.18.2",
     "eslint-config-yoast": "^6.0.0",
-    "eslint-config-google": "^0.14.0",
-    "eslint-config-prettier": "^6.2.0",
-    "eslint-plugin-prettier": "^3.1.0",
-    "eslint-plugin-react": "^7.16.0",
     "globals": "^15.12.0",
     "grunt": "^1.6.1",
     "grunt-shell": "^4.0.0",

package/src/bundledPlugins/index.js

@@ -0,0 +1,5 @@
+import usedKeywords from "./previouslyUsedKeywords";
+
+export {
+	usedKeywords,
+};

package/src/bundledPlugins/previouslyUsedKeywords.js

@@ -0,0 +1,192 @@
+import { __, sprintf } from "@wordpress/i18n";
+import { isUndefined } from "lodash";
+
+import MissingArgument from "../errors/missingArgument";
+import { createAnchorOpeningTag } from "../helpers";
+import AssessmentResult from "../values/AssessmentResult.js";
+
+/**
+ * The PreviouslyUsedKeyword plugin allows to check for previously used keywords.
+ */
+export default class PreviouslyUsedKeyword {
+	/**
+	 * Constructs a new PreviouslyUsedKeyword plugin.
+	 *
+	 * @param {object} app The app.
+	 * @param {object} args An arguments object.
+	 * @param {object} args.usedKeywords An object with keywords and ids where they are used.
+	 * @param {object} args.usedKeywordsPostTypes An object with the post types of the post ids from usedKeywords.
+	 * @param {string} args.searchUrl The url used to link to a search page when multiple usages of the keyword are found.
+	 * @param {string} args.postUrl The url used to link to a post when 1 usage of the keyword is found.
+	 *
+	 * @constructor
+	 */
+	constructor( app, args ) {
+		if ( isUndefined( app ) ) {
+			throw new MissingArgument( "The previously keyword plugin requires the YoastSEO app" );
+		}
+
+		if ( isUndefined( args ) ) {
+			args = {
+				usedKeywords: {},
+				usedKeywordsPostTypes: {},
+				searchUrl: "",
+				postUrl: "",
+			};
+		}
+
+		this.app = app;
+		this.usedKeywords = args.usedKeywords;
+		this.usedKeywordsPostTypes = args.usedKeywordsPostTypes;
+		this.searchUrl = args.searchUrl;
+		this.postUrl = args.postUrl;
+		this.urlTitle = createAnchorOpeningTag( "https://yoa.st/33x" );
+		this.urlCallToAction = createAnchorOpeningTag( "https://yoa.st/33y" );
+	}
+
+	/**
+	 * Registers the assessment with the assessor.
+	 *
+	 * @returns {void}
+	 */
+	registerPlugin() {
+		this.app.registerAssessment( "usedKeywords", {
+			getResult: this.assess.bind( this ),
+			/**
+			 * Checks if the paper has a keyphrase, which is a prerequisite for the assessment to run.
+			 *
+			 * @param {Paper} paper The paper.
+			 *
+			 * @returns {boolean} Whether the paper has a keyphrase.
+			 */
+			isApplicable: function( paper ) {
+				return paper.hasKeyword();
+			},
+		}, "previouslyUsedKeywords" );
+	}
+
+	/**
+	 * Updates the usedKeywords.
+	 *
+	 * @param {object} usedKeywords An object with keywords and ids where they are used.
+	 * @param {object} usedKeywordsPostTypes An object with keywords and in which post types they are used.
+	 * The post types correspond with the ids in the usedKeywords parameter.
+	 * @returns {void}
+	 */
+	updateKeywordUsage( usedKeywords, usedKeywordsPostTypes ) {
+		this.usedKeywords = usedKeywords;
+		this.usedKeywordsPostTypes = usedKeywordsPostTypes;
+	}
+
+	/**
+	 * Scores the previously used keyword assessment based on the count.
+	 *
+	 * @param {object} previouslyUsedKeywords The result of the previously used keywords research
+	 * @param {Paper} paper The paper object to research.
+	 * @returns {{text: string, score: number}} The result object with a feedback text and a score.
+	 */
+	scoreAssessment( previouslyUsedKeywords, paper ) {
+		const count = previouslyUsedKeywords.count;
+		const id = previouslyUsedKeywords.id;
+		const postTypeToDisplay = previouslyUsedKeywords.postTypeToDisplay;
+		let url;
+
+		if ( count === 0 ) {
+			return {
+				text: sprintf(
+					/* translators:
+					%1$s expands to a link to an article on yoast.com,
+					%2$s expands to an anchor end tag. */
+					__( "%1$sPreviously used keyphrase%2$s: You've not used this keyphrase before, very good.", "wordpress-seo" ),
+					this.urlTitle,
+					"</a>"
+				),
+				score: 9,
+			};
+		}
+		if ( count === 1 ) {
+			url = `<a href='${this.postUrl.replace( "{id}", id )}' target='_blank'>`;
+			return {
+				/* translators: %1$s expands to an admin link where the keyphrase is already used,
+				 %2$s expands to the anchor end tag, %3$s and %4$s expand to links on yoast.com. */
+				text: sprintf( __(
+					"%3$sPreviously used keyphrase%2$s: You've used this keyphrase %1$sonce before%2$s. %4$sDo not use your keyphrase more than once%2$s.",
+					"wordpress-seo"
+				),
+				url,
+				"</a>",
+				this.urlTitle,
+				this.urlCallToAction
+				),
+				score: 6,
+			};
+		}
+
+		if ( count > 1 ) {
+			if ( postTypeToDisplay ) {
+				url = `<a href='${this.searchUrl.replace( "{keyword}", encodeURIComponent( paper.getKeyword() ) )}&post_type=${postTypeToDisplay}' target='_blank'>`;
+			} else {
+				url = `<a href='${this.searchUrl.replace( "{keyword}", encodeURIComponent( paper.getKeyword() ) )}' target='_blank'>`;
+			}
+
+			return {
+				/* translators: %1$s expands to a link to the admin search page for the keyphrase,
+				 %2$s expands to the anchor end tag, %3$s and %4$s expand to links to yoast.com */
+				text: sprintf( __(
+					"%3$sPreviously used keyphrase%2$s: You've used this keyphrase %1$smultiple times before%2$s. %4$sDo not use your keyphrase more than once%2$s.",
+					"wordpress-seo"
+				),
+				url,
+				"</a>",
+				this.urlTitle,
+				this.urlCallToAction
+				),
+				score: 1,
+			};
+		}
+	}
+
+	/**
+	 * Researches the previously used keywords, based on the used keywords and the keyword in the paper.
+	 *
+	 * @param {Paper} paper The paper object to research.
+	 * @returns {{id: number, count: number}} The object with the count and the id of the previously used keyword
+	 */
+	researchPreviouslyUsedKeywords( paper ) {
+		const keyword = paper.getKeyword();
+		let count = 0;
+		let postTypeToDisplay = "";
+		let id = 0;
+
+		if ( ! isUndefined( this.usedKeywords[ keyword ] ) && this.usedKeywords[ keyword ].length > 0 ) {
+			count = this.usedKeywords[ keyword ].length;
+			if ( keyword in this.usedKeywordsPostTypes ) {
+				postTypeToDisplay = this.usedKeywordsPostTypes[ keyword ][ 0 ];
+			}
+			id = this.usedKeywords[ keyword ][ 0 ];
+		}
+
+		return {
+			id: id,
+			count: count,
+			postTypeToDisplay: postTypeToDisplay,
+		};
+	}
+
+	/**
+	 * Executes the assessment that checks whether a text uses previously used keywords.
+	 *
+	 * @param {Paper} paper The Paper object to assess.
+	 * @returns {AssessmentResult} The assessment result containing both a score and a descriptive text.
+	 */
+	assess( paper ) {
+		const previouslyUsedKeywords = this.researchPreviouslyUsedKeywords( paper );
+		const previouslyUsedKeywordsResult = this.scoreAssessment( previouslyUsedKeywords, paper );
+
+		const assessmentResult = new AssessmentResult();
+		assessmentResult.setScore( previouslyUsedKeywordsResult.score );
+		assessmentResult.setText( previouslyUsedKeywordsResult.text );
+
+		return assessmentResult;
+	}
+}

package/src/config/diacritics.js

@@ -0,0 +1,106 @@
+/** @module config/diacritics */
+
+/**
+ * Returns the diacritics map
+ *
+ * @returns {array} diacritics map
+ */
+export default function() {
+	return [
+		{
+			base: "a",
+			letters: /[\u0061\u24D0\uFF41\u1E9A\u00E0\u00E1\u00E2\u1EA7\u1EA5\u1EAB\u1EA9\u00E3\u0101\u0103\u1EB1\u1EAF\u1EB5\u1EB3\u0227\u01E1\u00E4\u01DF\u1EA3\u00E5\u01FB\u01CE\u0201\u0203\u1EA1\u1EAD\u1EB7\u1E01\u0105\u2C65\u0250]/g,
+		},
+		{ base: "aa", letters: /[\uA733]/g },
+		{ base: "ae", letters: /[\u00E6\u01FD\u01E3]/g },
+		{ base: "ao", letters: /[\uA735]/g },
+		{ base: "au", letters: /[\uA737]/g },
+		{ base: "av", letters: /[\uA739\uA73B]/g },
+		{ base: "ay", letters: /[\uA73D]/g },
+		{ base: "b", letters: /[\u0062\u24D1\uFF42\u1E03\u1E05\u1E07\u0180\u0183\u0253]/g },
+		{
+			base: "c",
+			letters: /[\u0063\u24D2\uFF43\u0107\u0109\u010B\u010D\u00E7\u1E09\u0188\u023C\uA73F\u2184]/g,
+		},
+		{
+			base: "d",
+			letters: /[\u0064\u24D3\uFF44\u1E0B\u010F\u1E0D\u1E11\u1E13\u1E0F\u0111\u018C\u0256\u0257\uA77A]/g,
+		},
+		{ base: "dz", letters: /[\u01F3\u01C6]/g },
+		{
+			base: "e",
+			letters: /[\u0065\u24D4\uFF45\u00E8\u00E9\u00EA\u1EC1\u1EBF\u1EC5\u1EC3\u1EBD\u0113\u1E15\u1E17\u0115\u0117\u00EB\u1EBB\u011B\u0205\u0207\u1EB9\u1EC7\u0229\u1E1D\u0119\u1E19\u1E1B\u0247\u025B\u01DD]/g,
+		},
+		{ base: "f", letters: /[\u0066\u24D5\uFF46\u1E1F\u0192\uA77C]/g },
+		{
+			base: "g",
+			letters: /[\u0067\u24D6\uFF47\u01F5\u011D\u1E21\u011F\u0121\u01E7\u0123\u01E5\u0260\uA7A1\u1D79\uA77F]/g,
+		},
+		{
+			base: "h",
+			letters: /[\u0068\u24D7\uFF48\u0125\u1E23\u1E27\u021F\u1E25\u1E29\u1E2B\u1E96\u0127\u2C68\u2C76\u0265]/g,
+		},
+		{ base: "hv", letters: /[\u0195]/g },
+		{
+			base: "i",
+			letters: /[\u0069\u24D8\uFF49\u00EC\u00ED\u00EE\u0129\u012B\u012D\u00EF\u1E2F\u1EC9\u01D0\u0209\u020B\u1ECB\u012F\u1E2D\u0268\u0131]/g,
+		},
+		{ base: "j", letters: /[\u006A\u24D9\uFF4A\u0135\u01F0\u0249]/g },
+		{
+			base: "k",
+			letters: /[\u006B\u24DA\uFF4B\u1E31\u01E9\u1E33\u0137\u1E35\u0199\u2C6A\uA741\uA743\uA745\uA7A3]/g,
+		},
+		{
+			base: "l",
+			letters: /[\u006C\u24DB\uFF4C\u0140\u013A\u013E\u1E37\u1E39\u013C\u1E3D\u1E3B\u017F\u0142\u019A\u026B\u2C61\uA749\uA781\uA747]/g,
+		},
+		{ base: "lj", letters: /[\u01C9]/g },
+		{ base: "m", letters: /[\u006D\u24DC\uFF4D\u1E3F\u1E41\u1E43\u0271\u026F]/g },
+		{
+			base: "n",
+			letters: /[\u006E\u24DD\uFF4E\u01F9\u0144\u00F1\u1E45\u0148\u1E47\u0146\u1E4B\u1E49\u019E\u0272\u0149\uA791\uA7A5]/g,
+		},
+		{ base: "nj", letters: /[\u01CC]/g },
+		{
+			base: "o",
+			letters: /[\u006F\u24DE\uFF4F\u00F2\u00F3\u00F4\u1ED3\u1ED1\u1ED7\u1ED5\u00F5\u1E4D\u022D\u1E4F\u014D\u1E51\u1E53\u014F\u022F\u0231\u00F6\u022B\u1ECF\u0151\u01D2\u020D\u020F\u01A1\u1EDD\u1EDB\u1EE1\u1EDF\u1EE3\u1ECD\u1ED9\u01EB\u01ED\u00F8\u01FF\u0254\uA74B\uA74D\u0275]/g,
+		},
+		{ base: "oi", letters: /[\u01A3]/g },
+		{ base: "ou", letters: /[\u0223]/g },
+		{ base: "oo", letters: /[\uA74F]/g },
+		{ base: "p", letters: /[\u0070\u24DF\uFF50\u1E55\u1E57\u01A5\u1D7D\uA751\uA753\uA755]/g },
+		{ base: "q", letters: /[\u0071\u24E0\uFF51\u024B\uA757\uA759]/g },
+		{
+			base: "r",
+			letters: /[\u0072\u24E1\uFF52\u0155\u1E59\u0159\u0211\u0213\u1E5B\u1E5D\u0157\u1E5F\u024D\u027D\uA75B\uA7A7\uA783]/g,
+		},
+		{
+			base: "s",
+			letters: /[\u0073\u24E2\uFF53\u00DF\u015B\u1E65\u015D\u1E61\u0161\u1E67\u1E63\u1E69\u0219\u015F\u023F\uA7A9\uA785\u1E9B]/g,
+		},
+		{
+			base: "t",
+			letters: /[\u0074\u24E3\uFF54\u1E6B\u1E97\u0165\u1E6D\u021B\u0163\u1E71\u1E6F\u0167\u01AD\u0288\u2C66\uA787]/g,
+		},
+		{ base: "tz", letters: /[\uA729]/g },
+		{
+			base: "u",
+			letters: /[\u0075\u24E4\uFF55\u00F9\u00FA\u00FB\u0169\u1E79\u016B\u1E7B\u016D\u00FC\u01DC\u01D8\u01D6\u01DA\u1EE7\u016F\u0171\u01D4\u0215\u0217\u01B0\u1EEB\u1EE9\u1EEF\u1EED\u1EF1\u1EE5\u1E73\u0173\u1E77\u1E75\u0289]/g,
+		},
+		{ base: "v", letters: /[\u0076\u24E5\uFF56\u1E7D\u1E7F\u028B\uA75F\u028C]/g },
+		{ base: "vy", letters: /[\uA761]/g },
+		{
+			base: "w",
+			letters: /[\u0077\u24E6\uFF57\u1E81\u1E83\u0175\u1E87\u1E85\u1E98\u1E89\u2C73]/g,
+		},
+		{ base: "x", letters: /[\u0078\u24E7\uFF58\u1E8B\u1E8D]/g },
+		{
+			base: "y",
+			letters: /[\u0079\u24E8\uFF59\u1EF3\u00FD\u0177\u1EF9\u0233\u1E8F\u00FF\u1EF7\u1E99\u1EF5\u01B4\u024F\u1EFF]/g,
+		},
+		{
+			base: "z",
+			letters: /[\u007A\u24E9\uFF5A\u017A\u1E91\u017C\u017E\u1E93\u1E95\u01B6\u0225\u0240\u2C6C\uA763]/g,
+		},
+	];
+}