npm - axyseo - Versions diffs - 2.0.0-alpha.0.0.20 → 2.0.0-alpha.0.0.4 - Mend

axyseo 2.0.0-alpha.0.0.20 → 2.0.0-alpha.0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (946) hide show

package/build/scoring/assessors/assessor.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"assessor.js","names":["_lodash","require","_AssessmentResult","_interopRequireDefault","_build","_LanguageProcessor","_missingArgument","_errors","e","__esModule","default","ScoreRating","Assessor","constructor","researcher","config","type","setResearcher","_assessments","_config","isUndefined","MissingArgument","_researcher","getAvailableAssessments","isApplicable","assessment","paper","hasOwnProperty","hasMarker","isFunction","marker","getMarks","getSpecificMarker","getPaper","_lastPaper","assess","i18n","setPaper","languageProcessor","LanguageProcessor","shortcodes","_attributes","setTree","build","assessments","results","filter","bind","map","executeAssessment","result","title","translate","id","content","good","improve","bad","getResult","setIdentifier","assessmentError","showTrace","AssessmentResult","setScore","getValidResults","isValidResult","assessmentResult","hasScore","hasText","calculateOverallScore","totalScore","reduce","total","getScore","Math","round","length","addAssessment","name","identifier","getAssessment","removeAssessment","push","toDelete","findIndex","splice","find","getApplicableAssessments","availableAssessments","availableAssessment","_default","exports"],"sources":["../../../src/scoring/assessors/assessor.js"],"sourcesContent":["// External dependencies.\nimport {filter, find, findIndex, isFunction, isUndefined, map} from 'lodash';\n\n// Internal dependencies.\nimport AssessmentResult from '../../values/AssessmentResult.js';\nimport {build} from '../../parse/build';\nimport LanguageProcessor from '../../parse/language/LanguageProcessor.js';\nimport MissingArgument from '../../errors/missingArgument.js';\nimport {showTrace} from '../../helpers/errors.js';\n\n// The maximum score of individual assessment is 9. This is why we set the \"score rating\" here to 9.\nconst ScoreRating = 9;\n\n/*\n The Assessor is a base class for all assessors.\n /\nclass Assessor {\n /\n Creates a new Assessor instance.\n * @param {Researcher}\tresearcher\tThe researcher to use.\n * @param {Object}\t\t[config]\tThe assessor config.\n /\n constructor(researcher, config) {\n this.type = 'assessor';\n this.setResearcher(researcher);\n this._assessments = [];\n\n this._config = config \|\| {};\n }\n\n /\n Checks if the researcher is defined and sets it.\n \n @param {Researcher} researcher The researcher to use in the assessor.\n \n @throws {MissingArgument} Parameter needs to be a valid researcher object.\n * @returns {void}\n /\n setResearcher(researcher) {\n if (isUndefined(researcher)) {\n throw new MissingArgument('The assessor requires a researcher.');\n }\n this._researcher = researcher;\n }\n\n /\n Gets all available assessments.\n * @returns {Assessment[]} assessment\n /\n getAvailableAssessments() {\n return this._assessments;\n }\n\n /\n Checks whether the Assessment is applicable.\n \n @param {Assessment} assessment The Assessment object that needs to be checked.\n * @param {Paper} paper The Paper object to check against.\n * @param {Researcher} [researcher] The Researcher object containing additional information.\n * @returns {boolean} Whether or not the Assessment is applicable.\n /\n isApplicable(assessment, paper, researcher) {\n if (\n assessment.hasOwnProperty('isApplicable') \|\|\n typeof assessment.isApplicable === 'function'\n ) {\n return assessment.isApplicable(paper, researcher);\n }\n\n return true;\n }\n\n /\n Determines whether an assessment has a marker.\n \n @param {Assessment} assessment The assessment to check for.\n * @returns {boolean} Whether or not the assessment has a marker.\n /\n hasMarker(assessment) {\n return (\n isFunction(this._config.marker) &&\n (assessment.hasOwnProperty('getMarks') \|\| typeof assessment.getMarks === 'function')\n );\n }\n\n /\n Returns the specific marker for this assessor.\n \n @returns {Function} The specific marker for this assessor.\n /\n getSpecificMarker() {\n return this._config.marker;\n }\n\n /\n Returns the paper that was most recently assessed.\n \n @returns {Paper} The paper that was most recently assessed.\n /\n getPaper() {\n return this._lastPaper;\n }\n\n /\n Runs the researches defined in the task list or the default researches.\n \n @param {Paper} paper The paper to run assessments on.\n * @param i18n\n * @returns {void}\n /\n assess(paper, i18n) {\n this._researcher.setPaper(paper);\n\n const languageProcessor = new LanguageProcessor(this._researcher);\n const shortcodes = paper._attributes && paper._attributes.shortcodes;\n paper.setTree(build(paper, languageProcessor, shortcodes));\n\n let assessments = this.getAvailableAssessments();\n this.results = [];\n\n assessments = filter(\n assessments,\n function(assessment) {\n return this.isApplicable(assessment, paper, this._researcher);\n }.bind(this)\n );\n\n this.results = map(assessments, assessment =>\n this.executeAssessment({\n paper,\n researcher: this._researcher,\n assessment,\n i18n\n })\n );\n this._lastPaper = paper;\n }\n\n /\n Executes an assessment and returns the AssessmentResult.\n \n @param {Paper} paper The paper to pass to the assessment.\n * @param {Researcher} researcher The researcher to pass to the assessment.\n * @param {Assessment} assessment The assessment to execute.\n * @param i18n\n * @returns {AssessmentResult} The result of the assessment.\n /\n executeAssessment({paper, researcher, assessment, i18n}) {\n let result;\n\n try {\n if (i18n) {\n assessment._config.title = i18n.translate(`Axyseo.${assessment._config.id}.title`);\n assessment._config.content = {\n good: i18n.translate(`Axyseo.${assessment._config.id}.good`),\n improve: i18n.translate(`Axyseo.${assessment._config.id}.improve`),\n bad: i18n.translate(`Axyseo.${assessment._config.id}.bad`)\n };\n }\n result = assessment.getResult({paper, researcher, config: this._config, i18n});\n result.setIdentifier(assessment._config.id);\n } catch (assessmentError) {\n showTrace(assessmentError);\n\n result = new AssessmentResult();\n\n result.setScore(-1);\n }\n return result;\n }\n\n /\n Filters out all assessment results that have no score and no text.\n \n @returns {AssessmentResult[]} The array with all the valid assessments.\n /\n getValidResults() {\n return filter(\n this.results,\n function(result) {\n return this.isValidResult(result);\n }.bind(this)\n );\n }\n\n /\n Returns if an assessmentResult is valid.\n \n @param {AssessmentResult} assessmentResult The assessmentResult to validate.\n * @returns {boolean} whether or not the result is valid.\n /\n isValidResult(assessmentResult) {\n return assessmentResult.hasScore() && assessmentResult.hasText();\n }\n\n /\n Returns the overall score. Calculates the total score by adding all scores and dividing these\n * by the number of results times the ScoreRating.\n \n @returns {number} The overall score.\n /\n calculateOverallScore() {\n const results = this.getValidResults();\n\n const totalScore = results.reduce(\n (total, assessmentResult) => total + assessmentResult.getScore(),\n 0\n );\n\n return Math.round((totalScore / (results.length ScoreRating)) * 100) \|\| 0;\n }\n\n /*\n Registers an assessment and adds it to the internal assessments object.\n \n @param {string} name The name of the assessment.\n * @param {Assessment} assessment The object containing function to run as an assessment and it's requirements.\n * @returns {boolean} Whether registering the assessment was successful.\n /\n addAssessment(name, assessment) {\n if (!assessment.hasOwnProperty('identifier')) {\n assessment.identifier = name;\n }\n // If the assessor already has the same assessment, remove it and replace it with the new assessment with the same identifier.\n if (this.getAssessment(assessment.identifier)) {\n this.removeAssessment(assessment.identifier);\n }\n\n this._assessments.push(assessment);\n return true;\n }\n\n /\n Removes a specific Assessment from the list of Assessments.\n \n @param {string} name The Assessment to remove from the list of assessments.\n * @returns {void}\n /\n removeAssessment(name) {\n const toDelete = findIndex(this._assessments, function(assessment) {\n return assessment.hasOwnProperty('identifier') && name === assessment.identifier;\n });\n\n if (-1 !== toDelete) {\n this._assessments.splice(toDelete, 1);\n }\n }\n\n /\n Returns an assessment by identifier\n \n @param {string} identifier The identifier of the assessment.\n * @returns {undefined\|Assessment} The object if found, otherwise undefined.\n /\n getAssessment(identifier) {\n return find(this._assessments, function(assessment) {\n return assessment.hasOwnProperty('identifier') && identifier === assessment.identifier;\n });\n }\n\n /\n Checks which of the available assessments are applicable and returns an array with applicable assessments.\n \n @returns {Assessment[]} The array with applicable assessments.\n */\n getApplicableAssessments() {\n const availableAssessments = this.getAvailableAssessments();\n return filter(\n availableAssessments,\n function(availableAssessment) {\n return this.isApplicable(availableAssessment, this.getPaper(), this._researcher);\n }.bind(this)\n );\n }\n}\n\nexport default Assessor;\n"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AAGA,IAAAC,iBAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,kBAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,gBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,OAAA,GAAAN,OAAA;AAAkD,SAAAE,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AARlD;;AAGA;;AAOA;AACA,MAAMG,WAAW,GAAG,CAAC;;AAErB;AACA;AACA;AACA,MAAMC,QAAQ,CAAC;EACb;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,EAAE;IAC9B,IAAI,CAACC,IAAI,GAAG,UAAU;IACtB,IAAI,CAACC,aAAa,CAACH,UAAU,CAAC;IAC9B,IAAI,CAACI,YAAY,GAAG,EAAE;IAEtB,IAAI,CAACC,OAAO,GAAGJ,MAAM,IAAI,CAAC,CAAC;EAC7B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEE,aAAaA,CAACH,UAAU,EAAE;IACxB,IAAI,IAAAM,mBAAW,EAACN,UAAU,CAAC,EAAE;MAC3B,MAAM,IAAIO,wBAAe,CAAC,qCAAqC,CAAC;IAClE;IACA,IAAI,CAACC,WAAW,GAAGR,UAAU;EAC/B;;EAEA;AACF;AACA;AACA;EACES,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACL,YAAY;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEM,YAAYA,CAACC,UAAU,EAAEC,KAAK,EAAEZ,UAAU,EAAE;IAC1C,IACEW,UAAU,CAACE,cAAc,CAAC,cAAc,CAAC,IACzC,OAAOF,UAAU,CAACD,YAAY,KAAK,UAAU,EAC7C;MACA,OAAOC,UAAU,CAACD,YAAY,CAACE,KAAK,EAAEZ,UAAU,CAAC;IACnD;IAEA,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEc,SAASA,CAACH,UAAU,EAAE;IACpB,OACE,IAAAI,kBAAU,EAAC,IAAI,CAACV,OAAO,CAACW,MAAM,CAAC,KAC9BL,UAAU,CAACE,cAAc,CAAC,UAAU,CAAC,IAAI,OAAOF,UAAU,CAACM,QAAQ,KAAK,UAAU,CAAC;EAExF;;EAEA;AACF;AACA;AACA;AACA;EACEC,iBAAiBA,CAAA,EAAG;IAClB,OAAO,IAAI,CAACb,OAAO,CAACW,MAAM;EAC5B;;EAEA;AACF;AACA;AACA;AACA;EACEG,QAAQA,CAAA,EAAG;IACT,OAAO,IAAI,CAACC,UAAU;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,MAAMA,CAACT,KAAK,EAAEU,IAAI,EAAE;IAClB,IAAI,CAACd,WAAW,CAACe,QAAQ,CAACX,KAAK,CAAC;IAEhC,MAAMY,iBAAiB,GAAG,IAAIC,0BAAiB,CAAC,IAAI,CAACjB,WAAW,CAAC;IACjE,MAAMkB,UAAU,GAAGd,KAAK,CAACe,WAAW,IAAIf,KAAK,CAACe,WAAW,CAACD,UAAU;IACpEd,KAAK,CAACgB,OAAO,CAAC,IAAAC,YAAK,EAACjB,KAAK,EAAEY,iBAAiB,EAAEE,UAAU,CAAC,CAAC;IAE1D,IAAII,WAAW,GAAG,IAAI,CAACrB,uBAAuB,CAAC,CAAC;IAChD,IAAI,CAACsB,OAAO,GAAG,EAAE;IAEjBD,WAAW,GAAG,IAAAE,cAAM,EAClBF,WAAW,EACX,UAASnB,UAAU,EAAE;MACnB,OAAO,IAAI,CAACD,YAAY,CAACC,UAAU,EAAEC,KAAK,EAAE,IAAI,CAACJ,WAAW,CAAC;IAC/D,CAAC,CAACyB,IAAI,CAAC,IAAI,CACb,CAAC;IAED,IAAI,CAACF,OAAO,GAAG,IAAAG,WAAG,EAACJ,WAAW,EAAEnB,UAAU,IACxC,IAAI,CAACwB,iBAAiB,CAAC;MACrBvB,KAAK;MACLZ,UAAU,EAAE,IAAI,CAACQ,WAAW;MAC5BG,UAAU;MACVW;IACF,CAAC,CACH,CAAC;IACD,IAAI,CAACF,UAAU,GAAGR,KAAK;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEuB,iBAAiBA,CAAC;IAACvB,KAAK;IAAEZ,UAAU;IAAEW,UAAU;IAAEW;EAAI,CAAC,EAAE;IACvD,IAAIc,MAAM;IAEV,IAAI;MACF,IAAId,IAAI,EAAE;QACRX,UAAU,CAACN,OAAO,CAACgC,KAAK,GAAGf,IAAI,CAACgB,SAAS,CAAC,UAAU3B,UAAU,CAACN,OAAO,CAACkC,EAAE,QAAQ,CAAC;QAClF5B,UAAU,CAACN,OAAO,CAACmC,OAAO,GAAG;UAC3BC,IAAI,EAAEnB,IAAI,CAACgB,SAAS,CAAC,UAAU3B,UAAU,CAACN,OAAO,CAACkC,EAAE,OAAO,CAAC;UAC5DG,OAAO,EAAEpB,IAAI,CAACgB,SAAS,CAAC,UAAU3B,UAAU,CAACN,OAAO,CAACkC,EAAE,UAAU,CAAC;UAClEI,GAAG,EAAErB,IAAI,CAACgB,SAAS,CAAC,UAAU3B,UAAU,CAACN,OAAO,CAACkC,EAAE,MAAM;QAC3D,CAAC;MACH;MACAH,MAAM,GAAGzB,UAAU,CAACiC,SAAS,CAAC;QAAChC,KAAK;QAAEZ,UAAU;QAAEC,MAAM,EAAE,IAAI,CAACI,OAAO;QAAEiB;MAAI,CAAC,CAAC;MAC9Ec,MAAM,CAACS,aAAa,CAAClC,UAAU,CAACN,OAAO,CAACkC,EAAE,CAAC;IAC7C,CAAC,CAAC,OAAOO,eAAe,EAAE;MACxB,IAAAC,iBAAS,EAACD,eAAe,CAAC;MAE1BV,MAAM,GAAG,IAAIY,yBAAgB,CAAC,CAAC;MAE/BZ,MAAM,CAACa,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB;IACA,OAAOb,MAAM;EACf;;EAEA;AACF;AACA;AACA;AACA;EACEc,eAAeA,CAAA,EAAG;IAChB,OAAO,IAAAlB,cAAM,EACX,IAAI,CAACD,OAAO,EACZ,UAASK,MAAM,EAAE;MACf,OAAO,IAAI,CAACe,aAAa,CAACf,MAAM,CAAC;IACnC,CAAC,CAACH,IAAI,CAAC,IAAI,CACb,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEkB,aAAaA,CAACC,gBAAgB,EAAE;IAC9B,OAAOA,gBAAgB,CAACC,QAAQ,CAAC,CAAC,IAAID,gBAAgB,CAACE,OAAO,CAAC,CAAC;EAClE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMxB,OAAO,GAAG,IAAI,CAACmB,eAAe,CAAC,CAAC;IAEtC,MAAMM,UAAU,GAAGzB,OAAO,CAAC0B,MAAM,CAC/B,CAACC,KAAK,EAAEN,gBAAgB,KAAKM,KAAK,GAAGN,gBAAgB,CAACO,QAAQ,CAAC,CAAC,EAChE,CACF,CAAC;IAED,OAAOC,IAAI,CAACC,KAAK,CAAEL,UAAU,IAAIzB,OAAO,CAAC+B,MAAM,GAAGjE,WAAW,CAAC,GAAI,GAAG,CAAC,IAAI,CAAC;EAC7E;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEkE,aAAaA,CAACC,IAAI,EAAErD,UAAU,EAAE;IAC9B,IAAI,CAACA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,EAAE;MAC5CF,UAAU,CAACsD,UAAU,GAAGD,IAAI;IAC9B;IACA;IACA,IAAI,IAAI,CAACE,aAAa,CAACvD,UAAU,CAACsD,UAAU,CAAC,EAAE;MAC7C,IAAI,CAACE,gBAAgB,CAACxD,UAAU,CAACsD,UAAU,CAAC;IAC9C;IAEA,IAAI,CAAC7D,YAAY,CAACgE,IAAI,CAACzD,UAAU,CAAC;IAClC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEwD,gBAAgBA,CAACH,IAAI,EAAE;IACrB,MAAMK,QAAQ,GAAG,IAAAC,iBAAS,EAAC,IAAI,CAAClE,YAAY,EAAE,UAASO,UAAU,EAAE;MACjE,OAAOA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,IAAImD,IAAI,KAAKrD,UAAU,CAACsD,UAAU;IAClF,CAAC,CAAC;IAEF,IAAI,CAAC,CAAC,KAAKI,QAAQ,EAAE;MACnB,IAAI,CAACjE,YAAY,CAACmE,MAAM,CAACF,QAAQ,EAAE,CAAC,CAAC;IACvC;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEH,aAAaA,CAACD,UAAU,EAAE;IACxB,OAAO,IAAAO,YAAI,EAAC,IAAI,CAACpE,YAAY,EAAE,UAASO,UAAU,EAAE;MAClD,OAAOA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,IAAIoD,UAAU,KAAKtD,UAAU,CAACsD,UAAU;IACxF,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACEQ,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,oBAAoB,GAAG,IAAI,CAACjE,uBAAuB,CAAC,CAAC;IAC3D,OAAO,IAAAuB,cAAM,EACX0C,oBAAoB,EACpB,UAASC,mBAAmB,EAAE;MAC5B,OAAO,IAAI,CAACjE,YAAY,CAACiE,mBAAmB,EAAE,IAAI,CAACxD,QAAQ,CAAC,CAAC,EAAE,IAAI,CAACX,WAAW,CAAC;IAClF,CAAC,CAACyB,IAAI,CAAC,IAAI,CACb,CAAC;EACH;AACF;AAAC,IAAA2C,QAAA,GAAAC,OAAA,CAAAjF,OAAA,GAEcE,QAAQ","ignoreList":[]}
1	+ {"version":3,"file":"assessor.js","names":["_lodash","require","_AssessmentResult","_interopRequireDefault","_build","_LanguageProcessor","_missingArgument","_errors","e","__esModule","default","ScoreRating","Assessor","constructor","researcher","options","type","setResearcher","_assessments","_options","isUndefined","MissingArgument","_researcher","getAvailableAssessments","isApplicable","assessment","paper","hasOwnProperty","hasMarker","isFunction","marker","getMarks","getSpecificMarker","getPaper","_lastPaper","assess","i18n","setPaper","languageProcessor","LanguageProcessor","shortcodes","_attributes","setTree","build","assessments","results","filter","bind","map","executeAssessment","result","getResult","setIdentifier","identifier","assessmentError","showTrace","AssessmentResult","setScore","getValidResults","isValidResult","assessmentResult","hasScore","hasText","calculateOverallScore","totalScore","reduce","total","getScore","Math","round","length","addAssessment","name","getAssessment","removeAssessment","push","toDelete","findIndex","splice","find","getApplicableAssessments","availableAssessments","availableAssessment","_default","exports"],"sources":["../../../src/scoring/assessors/assessor.js"],"sourcesContent":["// External dependencies.\nimport {filter, find, findIndex, isFunction, isUndefined, map} from 'lodash';\n\n// Internal dependencies.\nimport AssessmentResult from '../../values/AssessmentResult.js';\nimport {build} from '../../parse/build';\nimport LanguageProcessor from '../../parse/language/LanguageProcessor.js';\nimport MissingArgument from '../../errors/missingArgument.js';\nimport {showTrace} from '../../helpers/errors.js';\n\n// The maximum score of individual assessment is 9. This is why we set the \"score rating\" here to 9.\nconst ScoreRating = 9;\n\n/*\n The Assessor is a base class for all assessors.\n /\nclass Assessor {\n /\n Creates a new Assessor instance.\n * @param {Researcher}\tresearcher\tThe researcher to use.\n * @param {Object}\t\t[options]\tThe assessor options.\n /\n constructor(researcher, options) {\n this.type = 'assessor';\n this.setResearcher(researcher);\n this._assessments = [];\n\n this._options = options \|\| {};\n }\n\n /\n Checks if the researcher is defined and sets it.\n \n @param {Researcher} researcher The researcher to use in the assessor.\n \n @throws {MissingArgument} Parameter needs to be a valid researcher object.\n * @returns {void}\n /\n setResearcher(researcher) {\n if (isUndefined(researcher)) {\n throw new MissingArgument('The assessor requires a researcher.');\n }\n this._researcher = researcher;\n }\n\n /\n Gets all available assessments.\n * @returns {Assessment[]} assessment\n /\n getAvailableAssessments() {\n return this._assessments;\n }\n\n /\n Checks whether the Assessment is applicable.\n \n @param {Assessment} assessment The Assessment object that needs to be checked.\n * @param {Paper} paper The Paper object to check against.\n * @param {Researcher} [researcher] The Researcher object containing additional information.\n * @returns {boolean} Whether or not the Assessment is applicable.\n /\n isApplicable(assessment, paper, researcher) {\n if (\n assessment.hasOwnProperty('isApplicable') \|\|\n typeof assessment.isApplicable === 'function'\n ) {\n return assessment.isApplicable(paper, researcher);\n }\n\n return true;\n }\n\n /\n Determines whether an assessment has a marker.\n \n @param {Assessment} assessment The assessment to check for.\n * @returns {boolean} Whether or not the assessment has a marker.\n /\n hasMarker(assessment) {\n return (\n isFunction(this._options.marker) &&\n (assessment.hasOwnProperty('getMarks') \|\| typeof assessment.getMarks === 'function')\n );\n }\n\n /\n Returns the specific marker for this assessor.\n \n @returns {Function} The specific marker for this assessor.\n /\n getSpecificMarker() {\n return this._options.marker;\n }\n\n /\n Returns the paper that was most recently assessed.\n \n @returns {Paper} The paper that was most recently assessed.\n /\n getPaper() {\n return this._lastPaper;\n }\n\n /\n Runs the researches defined in the task list or the default researches.\n \n @param {Paper} paper The paper to run assessments on.\n * @param i18n\n * @returns {void}\n /\n assess(paper, i18n) {\n this._researcher.setPaper(paper);\n\n const languageProcessor = new LanguageProcessor(this._researcher);\n const shortcodes = paper._attributes && paper._attributes.shortcodes;\n paper.setTree(build(paper, languageProcessor, shortcodes));\n\n let assessments = this.getAvailableAssessments();\n this.results = [];\n\n assessments = filter(\n assessments,\n function(assessment) {\n return this.isApplicable(assessment, paper, this._researcher);\n }.bind(this)\n );\n\n this.results = map(assessments, assessment =>\n this.executeAssessment({\n paper,\n researcher: this._researcher,\n assessment,\n i18n\n })\n );\n this._lastPaper = paper;\n }\n\n /\n Executes an assessment and returns the AssessmentResult.\n \n @param {Paper} paper The paper to pass to the assessment.\n * @param {Researcher} researcher The researcher to pass to the assessment.\n * @param {Assessment} assessment The assessment to execute.\n * @param i18n\n * @returns {AssessmentResult} The result of the assessment.\n /\n executeAssessment({paper, researcher, assessment, i18n}) {\n let result;\n\n try {\n result = assessment.getResult(paper, researcher, i18n);\n result.setIdentifier(assessment.identifier);\n } catch (assessmentError) {\n showTrace(assessmentError);\n\n result = new AssessmentResult();\n\n result.setScore(-1);\n }\n return result;\n }\n\n /\n Filters out all assessment results that have no score and no text.\n \n @returns {AssessmentResult[]} The array with all the valid assessments.\n /\n getValidResults() {\n return filter(\n this.results,\n function(result) {\n return this.isValidResult(result);\n }.bind(this)\n );\n }\n\n /\n Returns if an assessmentResult is valid.\n \n @param {AssessmentResult} assessmentResult The assessmentResult to validate.\n * @returns {boolean} whether or not the result is valid.\n /\n isValidResult(assessmentResult) {\n return assessmentResult.hasScore() && assessmentResult.hasText();\n }\n\n /\n Returns the overall score. Calculates the total score by adding all scores and dividing these\n * by the number of results times the ScoreRating.\n \n @returns {number} The overall score.\n /\n calculateOverallScore() {\n const results = this.getValidResults();\n\n const totalScore = results.reduce(\n (total, assessmentResult) => total + assessmentResult.getScore(),\n 0\n );\n\n return Math.round((totalScore / (results.length ScoreRating)) * 100) \|\| 0;\n }\n\n /*\n Registers an assessment and adds it to the internal assessments object.\n \n @param {string} name The name of the assessment.\n * @param {Assessment} assessment The object containing function to run as an assessment and it's requirements.\n * @returns {boolean} Whether registering the assessment was successful.\n /\n addAssessment(name, assessment) {\n if (!assessment.hasOwnProperty('identifier')) {\n assessment.identifier = name;\n }\n // If the assessor already has the same assessment, remove it and replace it with the new assessment with the same identifier.\n if (this.getAssessment(assessment.identifier)) {\n this.removeAssessment(assessment.identifier);\n }\n\n this._assessments.push(assessment);\n return true;\n }\n\n /\n Removes a specific Assessment from the list of Assessments.\n \n @param {string} name The Assessment to remove from the list of assessments.\n * @returns {void}\n /\n removeAssessment(name) {\n const toDelete = findIndex(this._assessments, function(assessment) {\n return assessment.hasOwnProperty('identifier') && name === assessment.identifier;\n });\n\n if (-1 !== toDelete) {\n this._assessments.splice(toDelete, 1);\n }\n }\n\n /\n Returns an assessment by identifier\n \n @param {string} identifier The identifier of the assessment.\n * @returns {undefined\|Assessment} The object if found, otherwise undefined.\n /\n getAssessment(identifier) {\n return find(this._assessments, function(assessment) {\n return assessment.hasOwnProperty('identifier') && identifier === assessment.identifier;\n });\n }\n\n /\n Checks which of the available assessments are applicable and returns an array with applicable assessments.\n \n @returns {Assessment[]} The array with applicable assessments.\n */\n getApplicableAssessments() {\n const availableAssessments = this.getAvailableAssessments();\n return filter(\n availableAssessments,\n function(availableAssessment) {\n return this.isApplicable(availableAssessment, this.getPaper(), this._researcher);\n }.bind(this)\n );\n }\n}\n\nexport default Assessor;\n"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AAGA,IAAAC,iBAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,kBAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,gBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,OAAA,GAAAN,OAAA;AAAkD,SAAAE,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AARlD;;AAGA;;AAOA;AACA,MAAMG,WAAW,GAAG,CAAC;;AAErB;AACA;AACA;AACA,MAAMC,QAAQ,CAAC;EACb;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,OAAO,EAAE;IAC/B,IAAI,CAACC,IAAI,GAAG,UAAU;IACtB,IAAI,CAACC,aAAa,CAACH,UAAU,CAAC;IAC9B,IAAI,CAACI,YAAY,GAAG,EAAE;IAEtB,IAAI,CAACC,QAAQ,GAAGJ,OAAO,IAAI,CAAC,CAAC;EAC/B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEE,aAAaA,CAACH,UAAU,EAAE;IACxB,IAAI,IAAAM,mBAAW,EAACN,UAAU,CAAC,EAAE;MAC3B,MAAM,IAAIO,wBAAe,CAAC,qCAAqC,CAAC;IAClE;IACA,IAAI,CAACC,WAAW,GAAGR,UAAU;EAC/B;;EAEA;AACF;AACA;AACA;EACES,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACL,YAAY;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEM,YAAYA,CAACC,UAAU,EAAEC,KAAK,EAAEZ,UAAU,EAAE;IAC1C,IACEW,UAAU,CAACE,cAAc,CAAC,cAAc,CAAC,IACzC,OAAOF,UAAU,CAACD,YAAY,KAAK,UAAU,EAC7C;MACA,OAAOC,UAAU,CAACD,YAAY,CAACE,KAAK,EAAEZ,UAAU,CAAC;IACnD;IAEA,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEc,SAASA,CAACH,UAAU,EAAE;IACpB,OACE,IAAAI,kBAAU,EAAC,IAAI,CAACV,QAAQ,CAACW,MAAM,CAAC,KAC/BL,UAAU,CAACE,cAAc,CAAC,UAAU,CAAC,IAAI,OAAOF,UAAU,CAACM,QAAQ,KAAK,UAAU,CAAC;EAExF;;EAEA;AACF;AACA;AACA;AACA;EACEC,iBAAiBA,CAAA,EAAG;IAClB,OAAO,IAAI,CAACb,QAAQ,CAACW,MAAM;EAC7B;;EAEA;AACF;AACA;AACA;AACA;EACEG,QAAQA,CAAA,EAAG;IACT,OAAO,IAAI,CAACC,UAAU;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,MAAMA,CAACT,KAAK,EAAEU,IAAI,EAAE;IAClB,IAAI,CAACd,WAAW,CAACe,QAAQ,CAACX,KAAK,CAAC;IAEhC,MAAMY,iBAAiB,GAAG,IAAIC,0BAAiB,CAAC,IAAI,CAACjB,WAAW,CAAC;IACjE,MAAMkB,UAAU,GAAGd,KAAK,CAACe,WAAW,IAAIf,KAAK,CAACe,WAAW,CAACD,UAAU;IACpEd,KAAK,CAACgB,OAAO,CAAC,IAAAC,YAAK,EAACjB,KAAK,EAAEY,iBAAiB,EAAEE,UAAU,CAAC,CAAC;IAE1D,IAAII,WAAW,GAAG,IAAI,CAACrB,uBAAuB,CAAC,CAAC;IAChD,IAAI,CAACsB,OAAO,GAAG,EAAE;IAEjBD,WAAW,GAAG,IAAAE,cAAM,EAClBF,WAAW,EACX,UAASnB,UAAU,EAAE;MACnB,OAAO,IAAI,CAACD,YAAY,CAACC,UAAU,EAAEC,KAAK,EAAE,IAAI,CAACJ,WAAW,CAAC;IAC/D,CAAC,CAACyB,IAAI,CAAC,IAAI,CACb,CAAC;IAED,IAAI,CAACF,OAAO,GAAG,IAAAG,WAAG,EAACJ,WAAW,EAAEnB,UAAU,IACxC,IAAI,CAACwB,iBAAiB,CAAC;MACrBvB,KAAK;MACLZ,UAAU,EAAE,IAAI,CAACQ,WAAW;MAC5BG,UAAU;MACVW;IACF,CAAC,CACH,CAAC;IACD,IAAI,CAACF,UAAU,GAAGR,KAAK;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEuB,iBAAiBA,CAAC;IAACvB,KAAK;IAAEZ,UAAU;IAAEW,UAAU;IAAEW;EAAI,CAAC,EAAE;IACvD,IAAIc,MAAM;IAEV,IAAI;MACFA,MAAM,GAAGzB,UAAU,CAAC0B,SAAS,CAACzB,KAAK,EAAEZ,UAAU,EAAEsB,IAAI,CAAC;MACtDc,MAAM,CAACE,aAAa,CAAC3B,UAAU,CAAC4B,UAAU,CAAC;IAC7C,CAAC,CAAC,OAAOC,eAAe,EAAE;MACxB,IAAAC,iBAAS,EAACD,eAAe,CAAC;MAE1BJ,MAAM,GAAG,IAAIM,yBAAgB,CAAC,CAAC;MAE/BN,MAAM,CAACO,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB;IACA,OAAOP,MAAM;EACf;;EAEA;AACF;AACA;AACA;AACA;EACEQ,eAAeA,CAAA,EAAG;IAChB,OAAO,IAAAZ,cAAM,EACX,IAAI,CAACD,OAAO,EACZ,UAASK,MAAM,EAAE;MACf,OAAO,IAAI,CAACS,aAAa,CAACT,MAAM,CAAC;IACnC,CAAC,CAACH,IAAI,CAAC,IAAI,CACb,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEY,aAAaA,CAACC,gBAAgB,EAAE;IAC9B,OAAOA,gBAAgB,CAACC,QAAQ,CAAC,CAAC,IAAID,gBAAgB,CAACE,OAAO,CAAC,CAAC;EAClE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMlB,OAAO,GAAG,IAAI,CAACa,eAAe,CAAC,CAAC;IAEtC,MAAMM,UAAU,GAAGnB,OAAO,CAACoB,MAAM,CAC/B,CAACC,KAAK,EAAEN,gBAAgB,KAAKM,KAAK,GAAGN,gBAAgB,CAACO,QAAQ,CAAC,CAAC,EAChE,CACF,CAAC;IAED,OAAOC,IAAI,CAACC,KAAK,CAAEL,UAAU,IAAInB,OAAO,CAACyB,MAAM,GAAG3D,WAAW,CAAC,GAAI,GAAG,CAAC,IAAI,CAAC;EAC7E;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE4D,aAAaA,CAACC,IAAI,EAAE/C,UAAU,EAAE;IAC9B,IAAI,CAACA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,EAAE;MAC5CF,UAAU,CAAC4B,UAAU,GAAGmB,IAAI;IAC9B;IACA;IACA,IAAI,IAAI,CAACC,aAAa,CAAChD,UAAU,CAAC4B,UAAU,CAAC,EAAE;MAC7C,IAAI,CAACqB,gBAAgB,CAACjD,UAAU,CAAC4B,UAAU,CAAC;IAC9C;IAEA,IAAI,CAACnC,YAAY,CAACyD,IAAI,CAAClD,UAAU,CAAC;IAClC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEiD,gBAAgBA,CAACF,IAAI,EAAE;IACrB,MAAMI,QAAQ,GAAG,IAAAC,iBAAS,EAAC,IAAI,CAAC3D,YAAY,EAAE,UAASO,UAAU,EAAE;MACjE,OAAOA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,IAAI6C,IAAI,KAAK/C,UAAU,CAAC4B,UAAU;IAClF,CAAC,CAAC;IAEF,IAAI,CAAC,CAAC,KAAKuB,QAAQ,EAAE;MACnB,IAAI,CAAC1D,YAAY,CAAC4D,MAAM,CAACF,QAAQ,EAAE,CAAC,CAAC;IACvC;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEH,aAAaA,CAACpB,UAAU,EAAE;IACxB,OAAO,IAAA0B,YAAI,EAAC,IAAI,CAAC7D,YAAY,EAAE,UAASO,UAAU,EAAE;MAClD,OAAOA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,IAAI0B,UAAU,KAAK5B,UAAU,CAAC4B,UAAU;IACxF,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACE2B,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,oBAAoB,GAAG,IAAI,CAAC1D,uBAAuB,CAAC,CAAC;IAC3D,OAAO,IAAAuB,cAAM,EACXmC,oBAAoB,EACpB,UAASC,mBAAmB,EAAE;MAC5B,OAAO,IAAI,CAAC1D,YAAY,CAAC0D,mBAAmB,EAAE,IAAI,CAACjD,QAAQ,CAAC,CAAC,EAAE,IAAI,CAACX,WAAW,CAAC;IAClF,CAAC,CAACyB,IAAI,CAAC,IAAI,CACb,CAAC;EACH;AACF;AAAC,IAAAoC,QAAA,GAAAC,OAAA,CAAA1E,OAAA,GAEcE,QAAQ","ignoreList":[]}

package/build/scoring/assessors/avadaAssessor.js CHANGED Viewed

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _index = require("./index");
+var _index = require("../../../src/scoring/assessors/index");
 var _helpers = require("../helpers");
 /**
  * The AvadaAssessor class is used for the general SEO analysis.
@@ -13,15 +13,14 @@ class AvadaAssessor {
   /**
    * Creates a new AvadaAssessor instance.
    * @param {Researcher}  researcher  The researcher to use.
-   * @param {Object}    [config]  The assessor config.
+   * @param {Object}    [options]  The assessor options.
    */
-  constructor(researcher, config) {
-    const seoAssessor = new _index.SEOAssessor(researcher, config);
-    const contentAssessor = new _index.ContentAssessor(researcher, config);
+  constructor(researcher, options) {
+    const seoAssessor = new _index.SEOAssessor(researcher, options);
+    const contentAssessor = new _index.ContentAssessor(researcher, options);
     this.seoAssessor = seoAssessor;
     this.contentAssessor = contentAssessor;
     this.researcher = researcher;
-    this.config = config;
   }
   assess(paper, i18n) {
     this.seoAssessor.assess(paper, i18n);

package/build/scoring/assessors/avadaAssessor.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"avadaAssessor.js","names":["_index","require","_helpers","AvadaAssessor","constructor","researcher","~~config~~","seoAssessor","SEOAssessor","contentAssessor","ContentAssessor","assess","paper","i18n","assessments","results","map","assessment","body","status","score","title","getResult","groupBy","getScore","groupAssessmentsByCategory","groupAssessmentsByStatus","point","forEach","maxPoint","getMaxPoint","Math","round","exports","default"],"sources":["../../../src/scoring/assessors/avadaAssessor.js"],"sourcesContent":["import {ContentAssessor, SEOAssessor} from '~~@axyseo~~/scoring/assessors/index';\nimport {getMaxPoint, groupAssessmentsByCategory, groupAssessmentsByStatus} from '../helpers';\n\n/*\n The AvadaAssessor class is used for the general SEO analysis.\n /\nexport default class AvadaAssessor {\n /\n Creates a new AvadaAssessor instance.\n * @param {Researcher} researcher The researcher to use.\n * @param {Object} [~~config~~] The assessor ~~config~~.\n /\n constructor(researcher, ~~config~~) {\n const seoAssessor = new SEOAssessor(researcher, ~~config~~);\n const contentAssessor = new ContentAssessor(researcher, ~~config~~);\n this.seoAssessor = seoAssessor;\n this.contentAssessor = contentAssessor;\n this.researcher = researcher;\n ~~this.config = config;\n~~ }\n\n assess(paper, i18n) {\n this.seoAssessor.assess(paper, i18n);\n this.contentAssessor.assess(paper, i18n);\n\n let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];\n assessments = assessments.map(assessment => ({\n ...assessment.config,\n body: assessment.body,\n status: assessment.status,\n score: assessment.score,\n title: assessment.title \|\| assessment.config.title\n }));\n this.assessments = assessments;\n }\n\n getResult(groupBy = 'category', getScore = true) {\n let assessments = [];\n switch (groupBy) {\n case 'category':\n assessments = groupAssessmentsByCategory(this.assessments);\n break;\n case 'status':\n assessments = groupAssessmentsByStatus(this.assessments);\n break;\n }\n\n return {\n assessments,\n ...(getScore ? {score: this.getScore()} : {})\n };\n }\n\n getScore() {\n let point = 0;\n\n this.assessments.forEach(assessment => {\n point += assessment.score;\n });\n\n const maxPoint = getMaxPoint(this.assessments);\n return Math.round((point 100) / maxPoint);\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;~~AAEA~~;AACA;AACA;AACe,MAAME,aAAa,CAAC;EACjC;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,~~MAAM~~,EAAE;~~IAC9B~~,MAAMC,WAAW,GAAG,IAAIC,kBAAW,CAACH,UAAU,EAAEC,~~MAAM~~,CAAC;~~IACvD~~,MAAMG,eAAe,GAAG,IAAIC,sBAAe,CAACL,UAAU,EAAEC,~~MAAM~~,CAAC;~~IAC/D~~,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACE,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACJ,UAAU,GAAGA,UAAU;~~IAC5B,IAAI,CAACC,MAAM,GAAGA,MAAM~~;~~EACtB;EAEAK~~,MAAMA,CAACC,KAAK,EAAEC,IAAI,EAAE;IAClB,IAAI,CAACN,WAAW,CAACI,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IACpC,IAAI,CAACJ,eAAe,CAACE,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IAExC,IAAIC,WAAW,GAAG,CAAC,GAAG,IAAI,CAACP,WAAW,CAACQ,OAAO,EAAE,GAAG,IAAI,CAACN,eAAe,CAACM,OAAO,CAAC;IAChFD,WAAW,GAAGA,WAAW,CAACE,GAAG,CAACC,UAAU,KAAK;MAC3C,GAAGA,UAAU,~~CAACX~~,MAAM;~~MACpBY~~,IAAI,~~EAAED~~,UAAU,~~CAACC~~,IAAI;MACrBC,MAAM,~~EAAEF~~,UAAU,~~CAACE~~,MAAM;MACzBC,KAAK,~~EAAEH~~,UAAU,~~CAACG~~,KAAK;MACvBC,KAAK,~~EAAEJ~~,UAAU,~~CAACI~~,KAAK,~~IAAIJ~~,UAAU,~~CAACX~~,MAAM,~~CAACe~~;IAC/C,CAAC,CAAC,CAAC;IACH,IAAI,~~CAACP~~,WAAW,GAAGA,WAAW;EAChC;~~EAEAQ~~,SAASA,CAACC,OAAO,GAAG,UAAU,EAAEC,QAAQ,GAAG,IAAI,EAAE;IAC/C,~~IAAIV~~,WAAW,GAAG,EAAE;IACpB,~~QAAQS~~,OAAO;MACb,KAAK,UAAU;~~QACbT~~,WAAW,GAAG,~~IAAAW~~,mCAA0B,EAAC,IAAI,~~CAACX~~,WAAW,CAAC;QAC1D;MACF,KAAK,QAAQ;QACXA,WAAW,GAAG,~~IAAAY~~,iCAAwB,EAAC,IAAI,~~CAACZ~~,WAAW,CAAC;QACxD;IACJ;IAEA,OAAO;MACLA,WAAW;MACX,~~IAAIU~~,QAAQ,GAAG;QAACJ,KAAK,EAAE,IAAI,CAACI,QAAQ,CAAC;MAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;EACH;EAEAA,QAAQA,CAAA,EAAG;IACT,IAAIG,KAAK,GAAG,CAAC;IAEb,IAAI,~~CAACb~~,WAAW,~~CAACc~~,OAAO,~~CAACX~~,UAAU,IAAI;~~MACrCU~~,KAAK,~~IAAIV~~,UAAU,~~CAACG~~,KAAK;IAC3B,CAAC,CAAC;IAEF,MAAMS,QAAQ,GAAG,IAAAC,oBAAW,EAAC,IAAI,~~CAAChB~~,WAAW,CAAC;IAC9C,~~OAAOiB~~,IAAI,CAACC,KAAK,CAAEL,KAAK,GAAG,GAAG,GAAIE,QAAQ,CAAC;EAC7C;AACF;AAACI,OAAA,CAAAC,OAAA,~~GAAA/B~~,aAAA","ignoreList":[]}
1	+ {"version":3,"file":"avadaAssessor.js","names":["_index","require","_helpers","AvadaAssessor","constructor","researcher","options","seoAssessor","SEOAssessor","contentAssessor","ContentAssessor","assess","paper","i18n","assessments","results","map","assessment","config","body","status","score","title","getResult","groupBy","getScore","groupAssessmentsByCategory","groupAssessmentsByStatus","point","forEach","maxPoint","getMaxPoint","Math","round","exports","default"],"sources":["../../../src/scoring/assessors/avadaAssessor.js"],"sourcesContent":["import {ContentAssessor, SEOAssessor} from '../../../src/scoring/assessors/index';\nimport {\n getMaxPoint,\n groupAssessmentsByCategory,\n groupAssessmentsByStatus\n} from '../helpers';\n\n/*\n The AvadaAssessor class is used for the general SEO analysis.\n /\nexport default class AvadaAssessor {\n /\n Creates a new AvadaAssessor instance.\n * @param {Researcher} researcher The researcher to use.\n * @param {Object} [options] The assessor options.\n /\n constructor(researcher, options) {\n const seoAssessor = new SEOAssessor(researcher, options);\n const contentAssessor = new ContentAssessor(researcher, options);\n this.seoAssessor = seoAssessor;\n this.contentAssessor = contentAssessor;\n this.researcher = researcher;\n }\n\n assess(paper, i18n) {\n this.seoAssessor.assess(paper, i18n);\n this.contentAssessor.assess(paper, i18n);\n\n let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];\n assessments = assessments.map(assessment => ({\n ...assessment.config,\n body: assessment.body,\n status: assessment.status,\n score: assessment.score,\n title: assessment.title \|\| assessment.config.title\n }));\n this.assessments = assessments;\n }\n\n getResult(groupBy = 'category', getScore = true) {\n let assessments = [];\n switch (groupBy) {\n case 'category':\n assessments = groupAssessmentsByCategory(this.assessments);\n break;\n case 'status':\n assessments = groupAssessmentsByStatus(this.assessments);\n break;\n }\n\n return {\n assessments,\n ...(getScore ? {score: this.getScore()} : {})\n };\n }\n\n getScore() {\n let point = 0;\n\n this.assessments.forEach(assessment => {\n point += assessment.score;\n });\n\n const maxPoint = getMaxPoint(this.assessments);\n return Math.round((point 100) / maxPoint);\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AAMA;AACA;AACA;AACe,MAAME,aAAa,CAAC;EACjC;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,OAAO,EAAE;IAC/B,MAAMC,WAAW,GAAG,IAAIC,kBAAW,CAACH,UAAU,EAAEC,OAAO,CAAC;IACxD,MAAMG,eAAe,GAAG,IAAIC,sBAAe,CAACL,UAAU,EAAEC,OAAO,CAAC;IAChE,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACE,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACJ,UAAU,GAAGA,UAAU;EAC9B;EAEAM,MAAMA,CAACC,KAAK,EAAEC,IAAI,EAAE;IAClB,IAAI,CAACN,WAAW,CAACI,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IACpC,IAAI,CAACJ,eAAe,CAACE,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IAExC,IAAIC,WAAW,GAAG,CAAC,GAAG,IAAI,CAACP,WAAW,CAACQ,OAAO,EAAE,GAAG,IAAI,CAACN,eAAe,CAACM,OAAO,CAAC;IAChFD,WAAW,GAAGA,WAAW,CAACE,GAAG,CAACC,UAAU,KAAK;MAC3C,GAAGA,UAAU,CAACC,MAAM;MACpBC,IAAI,EAAEF,UAAU,CAACE,IAAI;MACrBC,MAAM,EAAEH,UAAU,CAACG,MAAM;MACzBC,KAAK,EAAEJ,UAAU,CAACI,KAAK;MACvBC,KAAK,EAAEL,UAAU,CAACK,KAAK,IAAIL,UAAU,CAACC,MAAM,CAACI;IAC/C,CAAC,CAAC,CAAC;IACH,IAAI,CAACR,WAAW,GAAGA,WAAW;EAChC;EAEAS,SAASA,CAACC,OAAO,GAAG,UAAU,EAAEC,QAAQ,GAAG,IAAI,EAAE;IAC/C,IAAIX,WAAW,GAAG,EAAE;IACpB,QAAQU,OAAO;MACb,KAAK,UAAU;QACbV,WAAW,GAAG,IAAAY,mCAA0B,EAAC,IAAI,CAACZ,WAAW,CAAC;QAC1D;MACF,KAAK,QAAQ;QACXA,WAAW,GAAG,IAAAa,iCAAwB,EAAC,IAAI,CAACb,WAAW,CAAC;QACxD;IACJ;IAEA,OAAO;MACLA,WAAW;MACX,IAAIW,QAAQ,GAAG;QAACJ,KAAK,EAAE,IAAI,CAACI,QAAQ,CAAC;MAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;EACH;EAEAA,QAAQA,CAAA,EAAG;IACT,IAAIG,KAAK,GAAG,CAAC;IAEb,IAAI,CAACd,WAAW,CAACe,OAAO,CAACZ,UAAU,IAAI;MACrCW,KAAK,IAAIX,UAAU,CAACI,KAAK;IAC3B,CAAC,CAAC;IAEF,MAAMS,QAAQ,GAAG,IAAAC,oBAAW,EAAC,IAAI,CAACjB,WAAW,CAAC;IAC9C,OAAOkB,IAAI,CAACC,KAAK,CAAEL,KAAK,GAAG,GAAG,GAAIE,QAAQ,CAAC;EAC7C;AACF;AAACI,OAAA,CAAAC,OAAA,GAAAhC,aAAA","ignoreList":[]}

package/build/scoring/assessors/contentAssessor.js CHANGED Viewed

@@ -19,10 +19,10 @@ class ContentAssessor extends _assessor.default {
   /**
    * Creates a new ContentAssessor instance.
    * @param {Researcher}	researcher	The researcher to use.
-   * @param {Object}		[config]	The assessor config.
+   * @param {Object}		[options]	The assessor options.
    */
-  constructor(researcher, config) {
-    super(researcher, config);
+  constructor(researcher, options) {
+    super(researcher, options);
     this.type = 'contentAssessor';
     this._assessments = [new _ParagraphTooLongAssessment.default(), new _SentenceLengthInTextAssessment.default(), new _TransitionWordsAssessment.default(), new _SentenceBeginningsAssessment.default()];
   }

package/build/scoring/assessors/contentAssessor.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"contentAssessor.js","names":["_lodash","require","_assessor","_interopRequireDefault","_ParagraphTooLongAssessment","_SentenceLengthInTextAssessment","_SentenceBeginningsAssessment","_TransitionWordsAssessment","_scoreToRating","e","__esModule","default","ContentAssessor","Assessor","constructor","researcher","~~config~~","type","_assessments","ParagraphTooLong","SentenceLengthInText","TransitionWords","SentenceBeginnings","calculatePenaltyPointsFullSupport","rating","calculatePenaltyPointsPartialSupport","_allAssessmentsSupported","numberOfAssessments","length","applicableAssessments","getApplicableAssessments","calculatePenaltyPoints","results","getValidResults","penaltyPoints","map","result","scoreToRating","getScore","bind","sum","_ratePenaltyPoints","totalPenaltyPoints","calculateOverallScore","exports"],"sources":["../../../src/scoring/assessors/contentAssessor.js"],"sourcesContent":["import {map, sum} from 'lodash';\nimport Assessor from './assessor.js';\nimport ParagraphTooLong from '../assessments/readability/ParagraphTooLongAssessment.js';\nimport SentenceLengthInText from '../assessments/readability/SentenceLengthInTextAssessment.js';\nimport SentenceBeginnings from '../assessments/readability/SentenceBeginningsAssessment.js';\nimport TransitionWords from '../assessments/readability/TransitionWordsAssessment.js';\nimport scoreToRating from '../interpreters/scoreToRating.js';\n\n/*\n The ContentAssessor class is used for the readability analysis.\n /\nexport default class ContentAssessor extends Assessor {\n /\n Creates a new ContentAssessor instance.\n * @param {Researcher}\tresearcher\tThe researcher to use.\n * @param {Object}\t\t[~~config~~]\tThe assessor ~~config~~.\n /\n constructor(researcher, ~~config~~) {\n super(researcher, ~~config~~);\n this.type = 'contentAssessor';\n\n this._assessments = [\n new ParagraphTooLong(),\n new SentenceLengthInText(),\n new TransitionWords(),\n new SentenceBeginnings()\n ];\n }\n\n /\n Calculates the weighted rating for languages that have all assessments based on a given rating.\n \n @param {string} rating The rating to be weighted.\n * @returns {number} The weighted rating.\n /\n calculatePenaltyPointsFullSupport(rating) {\n switch (rating) {\n case 'bad':\n return 3;\n case 'ok':\n return 2;\n default:\n case 'good':\n return 0;\n }\n }\n\n /\n Calculates the weighted rating for languages that don't have all assessments based on a given rating.\n \n @param {string} rating The rating to be weighted.\n * @returns {number} The weighted rating.\n /\n calculatePenaltyPointsPartialSupport(rating) {\n switch (rating) {\n case 'bad':\n return 4;\n case 'ok':\n return 2;\n default:\n case 'good':\n return 0;\n }\n }\n\n /\n Determines whether a language is fully supported. If a language supports 7 content assessments,\n * it is fully supported\n \n @returns {boolean} True if fully supported.\n /\n _allAssessmentsSupported() {\n const numberOfAssessments = this._assessments.length;\n const applicableAssessments = this.getApplicableAssessments();\n return applicableAssessments.length === numberOfAssessments;\n }\n\n /\n Calculates the penalty points based on the assessment results.\n \n @returns {number} The total penalty points for the results.\n /\n calculatePenaltyPoints() {\n const results = this.getValidResults();\n\n const penaltyPoints = map(\n results,\n function(result) {\n const rating = scoreToRating(result.getScore());\n\n if (this._allAssessmentsSupported()) {\n return this.calculatePenaltyPointsFullSupport(rating);\n }\n\n return this.calculatePenaltyPointsPartialSupport(rating);\n }.bind(this)\n );\n\n return sum(penaltyPoints);\n }\n\n /\n Rates the penalty points\n \n @param {number} totalPenaltyPoints The amount of penalty points.\n * @returns {number} The score based on the amount of penalty points.\n \n @private\n /\n _ratePenaltyPoints(totalPenaltyPoints) {\n if (this.getValidResults().length === 1) {\n // If we have only 1 result, we only have a \"no content\" result\n return 30;\n }\n\n if (this._allAssessmentsSupported()) {\n // Determine the total score based on the total penalty points.\n if (totalPenaltyPoints > 6) {\n // A red indicator.\n return 30;\n }\n\n if (totalPenaltyPoints > 4) {\n // An orange indicator.\n return 60;\n }\n } else {\n if (totalPenaltyPoints > 4) {\n // A red indicator.\n return 30;\n }\n\n if (totalPenaltyPoints > 2) {\n // An orange indicator.\n return 60;\n }\n }\n // A green indicator.\n return 90;\n }\n\n /\n Calculates the overall score based on the assessment results.\n \n @returns {number} The overall score.\n */\n calculateOverallScore() {\n const results = this.getValidResults();\n\n // If you have no content, you have a red indicator.\n if (results.length === 0) {\n return 30;\n }\n\n const totalPenaltyPoints = this.calculatePenaltyPoints();\n\n return this._ratePenaltyPoints(totalPenaltyPoints);\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,SAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,2BAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,+BAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,6BAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,0BAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,cAAA,GAAAL,sBAAA,CAAAF,OAAA;AAA6D,SAAAE,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE7D;AACA;AACA;AACe,MAAMG,eAAe,SAASC,iBAAQ,CAAC;EACpD;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,~~MAAM~~,EAAE;~~IAC9B~~,KAAK,CAACD,UAAU,EAAEC,~~MAAM~~,CAAC;~~IACzB~~,IAAI,CAACC,IAAI,GAAG,iBAAiB;IAE7B,IAAI,CAACC,YAAY,GAAG,CAClB,IAAIC,mCAAgB,CAAC,CAAC,EACtB,IAAIC,uCAAoB,CAAC,CAAC,EAC1B,IAAIC,kCAAe,CAAC,CAAC,EACrB,IAAIC,qCAAkB,CAAC,CAAC,CACzB;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,iCAAiCA,CAACC,MAAM,EAAE;IACxC,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,oCAAoCA,CAACD,MAAM,EAAE;IAC3C,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEE,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,mBAAmB,GAAG,IAAI,CAACT,YAAY,CAACU,MAAM;IACpD,MAAMC,qBAAqB,GAAG,IAAI,CAACC,wBAAwB,CAAC,CAAC;IAC7D,OAAOD,qBAAqB,CAACD,MAAM,KAAKD,mBAAmB;EAC7D;;EAEA;AACF;AACA;AACA;AACA;EACEI,sBAAsBA,CAAA,EAAG;IACvB,MAAMC,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAEtC,MAAMC,aAAa,GAAG,IAAAC,WAAG,EACvBH,OAAO,EACP,UAASI,MAAM,EAAE;MACf,MAAMZ,MAAM,GAAG,IAAAa,sBAAa,EAACD,MAAM,CAACE,QAAQ,CAAC,CAAC,CAAC;MAE/C,IAAI,IAAI,CAACZ,wBAAwB,CAAC,CAAC,EAAE;QACnC,OAAO,IAAI,CAACH,iCAAiC,CAACC,MAAM,CAAC;MACvD;MAEA,OAAO,IAAI,CAACC,oCAAoC,CAACD,MAAM,CAAC;IAC1D,CAAC,CAACe,IAAI,CAAC,IAAI,CACb,CAAC;IAED,OAAO,IAAAC,WAAG,EAACN,aAAa,CAAC;EAC3B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,kBAAkBA,CAACC,kBAAkB,EAAE;IACrC,IAAI,IAAI,CAACT,eAAe,CAAC,CAAC,CAACL,MAAM,KAAK,CAAC,EAAE;MACvC;MACA,OAAO,EAAE;IACX;IAEA,IAAI,IAAI,CAACF,wBAAwB,CAAC,CAAC,EAAE;MACnC;MACA,IAAIgB,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF,CAAC,MAAM;MACL,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF;IACA;IACA,OAAO,EAAE;EACX;;EAEA;AACF;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMX,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;;IAEtC;IACA,IAAID,OAAO,CAACJ,MAAM,KAAK,CAAC,EAAE;MACxB,OAAO,EAAE;IACX;IAEA,MAAMc,kBAAkB,GAAG,IAAI,CAACX,sBAAsB,CAAC,CAAC;IAExD,OAAO,IAAI,CAACU,kBAAkB,CAACC,kBAAkB,CAAC;EACpD;AACF;AAACE,OAAA,CAAAjC,OAAA,GAAAC,eAAA","ignoreList":[]}
1	+ {"version":3,"file":"contentAssessor.js","names":["_lodash","require","_assessor","_interopRequireDefault","_ParagraphTooLongAssessment","_SentenceLengthInTextAssessment","_SentenceBeginningsAssessment","_TransitionWordsAssessment","_scoreToRating","e","__esModule","default","ContentAssessor","Assessor","constructor","researcher","options","type","_assessments","ParagraphTooLong","SentenceLengthInText","TransitionWords","SentenceBeginnings","calculatePenaltyPointsFullSupport","rating","calculatePenaltyPointsPartialSupport","_allAssessmentsSupported","numberOfAssessments","length","applicableAssessments","getApplicableAssessments","calculatePenaltyPoints","results","getValidResults","penaltyPoints","map","result","scoreToRating","getScore","bind","sum","_ratePenaltyPoints","totalPenaltyPoints","calculateOverallScore","exports"],"sources":["../../../src/scoring/assessors/contentAssessor.js"],"sourcesContent":["import {map, sum} from 'lodash';\nimport Assessor from './assessor.js';\nimport ParagraphTooLong from '../assessments/readability/ParagraphTooLongAssessment.js';\nimport SentenceLengthInText from '../assessments/readability/SentenceLengthInTextAssessment.js';\nimport SentenceBeginnings from '../assessments/readability/SentenceBeginningsAssessment.js';\nimport TransitionWords from '../assessments/readability/TransitionWordsAssessment.js';\nimport scoreToRating from '../interpreters/scoreToRating.js';\n\n/*\n The ContentAssessor class is used for the readability analysis.\n /\nexport default class ContentAssessor extends Assessor {\n /\n Creates a new ContentAssessor instance.\n * @param {Researcher}\tresearcher\tThe researcher to use.\n * @param {Object}\t\t[options]\tThe assessor options.\n /\n constructor(researcher, options) {\n super(researcher, options);\n this.type = 'contentAssessor';\n\n this._assessments = [\n new ParagraphTooLong(),\n new SentenceLengthInText(),\n new TransitionWords(),\n new SentenceBeginnings()\n ];\n }\n\n /\n Calculates the weighted rating for languages that have all assessments based on a given rating.\n \n @param {string} rating The rating to be weighted.\n * @returns {number} The weighted rating.\n /\n calculatePenaltyPointsFullSupport(rating) {\n switch (rating) {\n case 'bad':\n return 3;\n case 'ok':\n return 2;\n default:\n case 'good':\n return 0;\n }\n }\n\n /\n Calculates the weighted rating for languages that don't have all assessments based on a given rating.\n \n @param {string} rating The rating to be weighted.\n * @returns {number} The weighted rating.\n /\n calculatePenaltyPointsPartialSupport(rating) {\n switch (rating) {\n case 'bad':\n return 4;\n case 'ok':\n return 2;\n default:\n case 'good':\n return 0;\n }\n }\n\n /\n Determines whether a language is fully supported. If a language supports 7 content assessments,\n * it is fully supported\n \n @returns {boolean} True if fully supported.\n /\n _allAssessmentsSupported() {\n const numberOfAssessments = this._assessments.length;\n const applicableAssessments = this.getApplicableAssessments();\n return applicableAssessments.length === numberOfAssessments;\n }\n\n /\n Calculates the penalty points based on the assessment results.\n \n @returns {number} The total penalty points for the results.\n /\n calculatePenaltyPoints() {\n const results = this.getValidResults();\n\n const penaltyPoints = map(\n results,\n function(result) {\n const rating = scoreToRating(result.getScore());\n\n if (this._allAssessmentsSupported()) {\n return this.calculatePenaltyPointsFullSupport(rating);\n }\n\n return this.calculatePenaltyPointsPartialSupport(rating);\n }.bind(this)\n );\n\n return sum(penaltyPoints);\n }\n\n /\n Rates the penalty points\n \n @param {number} totalPenaltyPoints The amount of penalty points.\n * @returns {number} The score based on the amount of penalty points.\n \n @private\n /\n _ratePenaltyPoints(totalPenaltyPoints) {\n if (this.getValidResults().length === 1) {\n // If we have only 1 result, we only have a \"no content\" result\n return 30;\n }\n\n if (this._allAssessmentsSupported()) {\n // Determine the total score based on the total penalty points.\n if (totalPenaltyPoints > 6) {\n // A red indicator.\n return 30;\n }\n\n if (totalPenaltyPoints > 4) {\n // An orange indicator.\n return 60;\n }\n } else {\n if (totalPenaltyPoints > 4) {\n // A red indicator.\n return 30;\n }\n\n if (totalPenaltyPoints > 2) {\n // An orange indicator.\n return 60;\n }\n }\n // A green indicator.\n return 90;\n }\n\n /\n Calculates the overall score based on the assessment results.\n \n @returns {number} The overall score.\n */\n calculateOverallScore() {\n const results = this.getValidResults();\n\n // If you have no content, you have a red indicator.\n if (results.length === 0) {\n return 30;\n }\n\n const totalPenaltyPoints = this.calculatePenaltyPoints();\n\n return this._ratePenaltyPoints(totalPenaltyPoints);\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,SAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,2BAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,+BAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,6BAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,0BAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,cAAA,GAAAL,sBAAA,CAAAF,OAAA;AAA6D,SAAAE,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE7D;AACA;AACA;AACe,MAAMG,eAAe,SAASC,iBAAQ,CAAC;EACpD;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,OAAO,EAAE;IAC/B,KAAK,CAACD,UAAU,EAAEC,OAAO,CAAC;IAC1B,IAAI,CAACC,IAAI,GAAG,iBAAiB;IAE7B,IAAI,CAACC,YAAY,GAAG,CAClB,IAAIC,mCAAgB,CAAC,CAAC,EACtB,IAAIC,uCAAoB,CAAC,CAAC,EAC1B,IAAIC,kCAAe,CAAC,CAAC,EACrB,IAAIC,qCAAkB,CAAC,CAAC,CACzB;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,iCAAiCA,CAACC,MAAM,EAAE;IACxC,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,oCAAoCA,CAACD,MAAM,EAAE;IAC3C,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEE,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,mBAAmB,GAAG,IAAI,CAACT,YAAY,CAACU,MAAM;IACpD,MAAMC,qBAAqB,GAAG,IAAI,CAACC,wBAAwB,CAAC,CAAC;IAC7D,OAAOD,qBAAqB,CAACD,MAAM,KAAKD,mBAAmB;EAC7D;;EAEA;AACF;AACA;AACA;AACA;EACEI,sBAAsBA,CAAA,EAAG;IACvB,MAAMC,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAEtC,MAAMC,aAAa,GAAG,IAAAC,WAAG,EACvBH,OAAO,EACP,UAASI,MAAM,EAAE;MACf,MAAMZ,MAAM,GAAG,IAAAa,sBAAa,EAACD,MAAM,CAACE,QAAQ,CAAC,CAAC,CAAC;MAE/C,IAAI,IAAI,CAACZ,wBAAwB,CAAC,CAAC,EAAE;QACnC,OAAO,IAAI,CAACH,iCAAiC,CAACC,MAAM,CAAC;MACvD;MAEA,OAAO,IAAI,CAACC,oCAAoC,CAACD,MAAM,CAAC;IAC1D,CAAC,CAACe,IAAI,CAAC,IAAI,CACb,CAAC;IAED,OAAO,IAAAC,WAAG,EAACN,aAAa,CAAC;EAC3B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,kBAAkBA,CAACC,kBAAkB,EAAE;IACrC,IAAI,IAAI,CAACT,eAAe,CAAC,CAAC,CAACL,MAAM,KAAK,CAAC,EAAE;MACvC;MACA,OAAO,EAAE;IACX;IAEA,IAAI,IAAI,CAACF,wBAAwB,CAAC,CAAC,EAAE;MACnC;MACA,IAAIgB,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF,CAAC,MAAM;MACL,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF;IACA;IACA,OAAO,EAAE;EACX;;EAEA;AACF;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMX,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;;IAEtC;IACA,IAAID,OAAO,CAACJ,MAAM,KAAK,CAAC,EAAE;MACxB,OAAO,EAAE;IACX;IAEA,MAAMc,kBAAkB,GAAG,IAAI,CAACX,sBAAsB,CAAC,CAAC;IAExD,OAAO,IAAI,CAACU,kBAAkB,CAACC,kBAAkB,CAAC;EACpD;AACF;AAACE,OAAA,CAAAjC,OAAA,GAAAC,eAAA","ignoreList":[]}

package/build/scoring/assessors/seoAssessor.js CHANGED Viewed

@@ -32,10 +32,10 @@ class SEOAssessor extends _assessor.default {
   /**
    * Creates a new SEOAssessor instance.
    * @param {Researcher}	researcher	The researcher to use.
-   * @param {Object}		[config]	The assessor config.
+   * @param {Object}		[options]	The assessor options.
    */
-  constructor(researcher, config) {
-    super(researcher, config);
+  constructor(researcher, options) {
+    super(researcher, options);
     this.type = 'SEOAssessor';
     this._assessments = [new _MetaTitleKeywordAssessment.default(), new _TextImagesAssessment.default(), new _NumberInMetaTitleAssessment.default(), new _IntroductionKeywordAssessment.default(), new _KeyphraseLengthAssessment.default(), new _MetaDescriptionKeywordAssessment.default(), new _MetaDescriptionLengthAssessment.default(), new _SubHeadingsKeywordAssessment.default(), new _OutboundLinksAssessment.default(), new _KeywordDensityAssessment.default(), new _ImageCountAssessment.default(), new _UrlLengthAssessment.default(), new _TextLengthAssessment.default(), new _SingleTitleAssessment.default(), new _KeyphraseAssessment.default(), new _InternalLinksAssessment.default(), new _PageTitleWidthAssessment.default(), new _UrlKeywordAssessment.default(), new _SingleH1Assessment.default()];
   }

package/build/scoring/assessors/seoAssessor.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"seoAssessor.js","names":["_assessor","_interopRequireDefault","require","_IntroductionKeywordAssessment","_KeyphraseLengthAssessment","_MetaDescriptionKeywordAssessment","_MetaDescriptionLengthAssessment","_SubHeadingsKeywordAssessment","_OutboundLinksAssessment","_KeywordDensityAssessment","_InternalLinksAssessment","_UrlKeywordAssessment","_ImageCountAssessment","_TextLengthAssessment","_PageTitleWidthAssessment","_SingleH1Assessment","_KeyphraseAssessment","_SingleTitleAssessment","_UrlLengthAssessment","_NumberInMetaTitleAssessment","_TextImagesAssessment","_MetaTitleKeywordAssessment","e","__esModule","default","SEOAssessor","Assessor","constructor","researcher","~~config~~","type","_assessments","MetaTitleKeywordAssessment","TextImagesAssessment","NumberInMetaTitleAssessment","IntroductionKeywordAssessment","KeyphraseLengthAssessment","MetaDescriptionKeywordAssessment","MetaDescriptionLength","SubheadingsKeyword","OutboundLinks","KeyphraseDensityAssessment","ImageCount","UrlLengthAssessment","TextLength","SingleTitleAssessment","KeyphraseAssessment","InternalLinksAssessment","TitleWidth","SlugKeywordAssessment","SingleH1Assessment","exports"],"sources":["../../../src/scoring/assessors/seoAssessor.js"],"sourcesContent":["import Assessor from './assessor';\nimport IntroductionKeywordAssessment from '../assessments/seo/IntroductionKeywordAssessment';\nimport KeyphraseLengthAssessment from '../assessments/seo/KeyphraseLengthAssessment';\nimport MetaDescriptionKeywordAssessment from '../assessments/seo/MetaDescriptionKeywordAssessment';\nimport MetaDescriptionLength from '../assessments/seo/MetaDescriptionLengthAssessment';\nimport SubheadingsKeyword from '../assessments/seo/SubHeadingsKeywordAssessment';\nimport OutboundLinks from '../assessments/seo/OutboundLinksAssessment';\nimport KeyphraseDensityAssessment from '../assessments/seo/KeywordDensityAssessment';\nimport InternalLinksAssessment from '../assessments/seo/InternalLinksAssessment';\nimport SlugKeywordAssessment from '../assessments/seo/UrlKeywordAssessment';\nimport ImageCount from '../assessments/seo/ImageCountAssessment';\nimport TextLength from '../assessments/seo/TextLengthAssessment';\nimport TitleWidth from '../assessments/seo/PageTitleWidthAssessment';\nimport SingleH1Assessment from '../assessments/seo/SingleH1Assessment';\nimport KeyphraseAssessment from '../assessments/seo/KeyphraseAssessment';\nimport SingleTitleAssessment from '../assessments/seo/SingleTitleAssessment';\nimport UrlLengthAssessment from '../assessments/seo/UrlLengthAssessment';\nimport NumberInMetaTitleAssessment from '../assessments/seo/NumberInMetaTitleAssessment';\nimport TextImagesAssessment from '../assessments/seo/TextImagesAssessment';\nimport MetaTitleKeywordAssessment from '../assessments/seo/MetaTitleKeywordAssessment';\n\n/*\n The SEOAssessor class is used for the general SEO analysis.\n /\nexport default class SEOAssessor extends Assessor {\n /\n Creates a new SEOAssessor instance.\n * @param {Researcher}\tresearcher\tThe researcher to use.\n * @param {Object}\t\t[~~config~~]\tThe assessor ~~config~~.\n */\n constructor(researcher, ~~config~~) {\n super(researcher, ~~config~~);\n this.type = 'SEOAssessor';\n\n this._assessments = [\n new MetaTitleKeywordAssessment(),\n new TextImagesAssessment(),\n new NumberInMetaTitleAssessment(),\n new IntroductionKeywordAssessment(),\n new KeyphraseLengthAssessment(),\n new MetaDescriptionKeywordAssessment(),\n new MetaDescriptionLength(),\n new SubheadingsKeyword(),\n new OutboundLinks(),\n new KeyphraseDensityAssessment(),\n new ImageCount(),\n new UrlLengthAssessment(),\n new TextLength(),\n new SingleTitleAssessment(),\n new KeyphraseAssessment(),\n new InternalLinksAssessment(),\n new TitleWidth(),\n new SlugKeywordAssessment(),\n new SingleH1Assessment()\n ];\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,8BAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,0BAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,iCAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,gCAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,6BAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,wBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,yBAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,wBAAA,GAAAT,sBAAA,CAAAC,OAAA;AACA,IAAAS,qBAAA,GAAAV,sBAAA,CAAAC,OAAA;AACA,IAAAU,qBAAA,GAAAX,sBAAA,CAAAC,OAAA;AACA,IAAAW,qBAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,yBAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,mBAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,oBAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,sBAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,oBAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,4BAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,qBAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,2BAAA,GAAApB,sBAAA,CAAAC,OAAA;AAAuF,SAAAD,uBAAAqB,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEvF;AACA;AACA;AACe,MAAMG,WAAW,SAASC,iBAAQ,CAAC;EAChD;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,~~MAAM~~,EAAE;~~IAC9B~~,KAAK,CAACD,UAAU,EAAEC,~~MAAM~~,CAAC;~~IACzB~~,IAAI,CAACC,IAAI,GAAG,aAAa;IAEzB,IAAI,CAACC,YAAY,GAAG,CAClB,IAAIC,mCAA0B,CAAC,CAAC,EAChC,IAAIC,6BAAoB,CAAC,CAAC,EAC1B,IAAIC,oCAA2B,CAAC,CAAC,EACjC,IAAIC,sCAA6B,CAAC,CAAC,EACnC,IAAIC,kCAAyB,CAAC,CAAC,EAC/B,IAAIC,yCAAgC,CAAC,CAAC,EACtC,IAAIC,wCAAqB,CAAC,CAAC,EAC3B,IAAIC,qCAAkB,CAAC,CAAC,EACxB,IAAIC,gCAAa,CAAC,CAAC,EACnB,IAAIC,iCAA0B,CAAC,CAAC,EAChC,IAAIC,6BAAU,CAAC,CAAC,EAChB,IAAIC,4BAAmB,CAAC,CAAC,EACzB,IAAIC,6BAAU,CAAC,CAAC,EAChB,IAAIC,8BAAqB,CAAC,CAAC,EAC3B,IAAIC,4BAAmB,CAAC,CAAC,EACzB,IAAIC,gCAAuB,CAAC,CAAC,EAC7B,IAAIC,iCAAU,CAAC,CAAC,EAChB,IAAIC,6BAAqB,CAAC,CAAC,EAC3B,IAAIC,2BAAkB,CAAC,CAAC,CACzB;EACH;AACF;AAACC,OAAA,CAAA3B,OAAA,GAAAC,WAAA","ignoreList":[]}
1	+ {"version":3,"file":"seoAssessor.js","names":["_assessor","_interopRequireDefault","require","_IntroductionKeywordAssessment","_KeyphraseLengthAssessment","_MetaDescriptionKeywordAssessment","_MetaDescriptionLengthAssessment","_SubHeadingsKeywordAssessment","_OutboundLinksAssessment","_KeywordDensityAssessment","_InternalLinksAssessment","_UrlKeywordAssessment","_ImageCountAssessment","_TextLengthAssessment","_PageTitleWidthAssessment","_SingleH1Assessment","_KeyphraseAssessment","_SingleTitleAssessment","_UrlLengthAssessment","_NumberInMetaTitleAssessment","_TextImagesAssessment","_MetaTitleKeywordAssessment","e","__esModule","default","SEOAssessor","Assessor","constructor","researcher","options","type","_assessments","MetaTitleKeywordAssessment","TextImagesAssessment","NumberInMetaTitleAssessment","IntroductionKeywordAssessment","KeyphraseLengthAssessment","MetaDescriptionKeywordAssessment","MetaDescriptionLength","SubheadingsKeyword","OutboundLinks","KeyphraseDensityAssessment","ImageCount","UrlLengthAssessment","TextLength","SingleTitleAssessment","KeyphraseAssessment","InternalLinksAssessment","TitleWidth","SlugKeywordAssessment","SingleH1Assessment","exports"],"sources":["../../../src/scoring/assessors/seoAssessor.js"],"sourcesContent":["import Assessor from './assessor';\nimport IntroductionKeywordAssessment from '../assessments/seo/IntroductionKeywordAssessment';\nimport KeyphraseLengthAssessment from '../assessments/seo/KeyphraseLengthAssessment';\nimport MetaDescriptionKeywordAssessment from '../assessments/seo/MetaDescriptionKeywordAssessment';\nimport MetaDescriptionLength from '../assessments/seo/MetaDescriptionLengthAssessment';\nimport SubheadingsKeyword from '../assessments/seo/SubHeadingsKeywordAssessment';\nimport OutboundLinks from '../assessments/seo/OutboundLinksAssessment';\nimport KeyphraseDensityAssessment from '../assessments/seo/KeywordDensityAssessment';\nimport InternalLinksAssessment from '../assessments/seo/InternalLinksAssessment';\nimport SlugKeywordAssessment from '../assessments/seo/UrlKeywordAssessment';\nimport ImageCount from '../assessments/seo/ImageCountAssessment';\nimport TextLength from '../assessments/seo/TextLengthAssessment';\nimport TitleWidth from '../assessments/seo/PageTitleWidthAssessment';\nimport SingleH1Assessment from '../assessments/seo/SingleH1Assessment';\nimport KeyphraseAssessment from '../assessments/seo/KeyphraseAssessment';\nimport SingleTitleAssessment from '../assessments/seo/SingleTitleAssessment';\nimport UrlLengthAssessment from '../assessments/seo/UrlLengthAssessment';\nimport NumberInMetaTitleAssessment from '../assessments/seo/NumberInMetaTitleAssessment';\nimport TextImagesAssessment from '../assessments/seo/TextImagesAssessment';\nimport MetaTitleKeywordAssessment from '../assessments/seo/MetaTitleKeywordAssessment';\n\n/*\n The SEOAssessor class is used for the general SEO analysis.\n /\nexport default class SEOAssessor extends Assessor {\n /\n Creates a new SEOAssessor instance.\n * @param {Researcher}\tresearcher\tThe researcher to use.\n * @param {Object}\t\t[options]\tThe assessor options.\n */\n constructor(researcher, options) {\n super(researcher, options);\n this.type = 'SEOAssessor';\n\n this._assessments = [\n new MetaTitleKeywordAssessment(),\n new TextImagesAssessment(),\n new NumberInMetaTitleAssessment(),\n new IntroductionKeywordAssessment(),\n new KeyphraseLengthAssessment(),\n new MetaDescriptionKeywordAssessment(),\n new MetaDescriptionLength(),\n new SubheadingsKeyword(),\n new OutboundLinks(),\n new KeyphraseDensityAssessment(),\n new ImageCount(),\n new UrlLengthAssessment(),\n new TextLength(),\n new SingleTitleAssessment(),\n new KeyphraseAssessment(),\n new InternalLinksAssessment(),\n new TitleWidth(),\n new SlugKeywordAssessment(),\n new SingleH1Assessment()\n ];\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,8BAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,0BAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,iCAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,gCAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,6BAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,wBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,yBAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,wBAAA,GAAAT,sBAAA,CAAAC,OAAA;AACA,IAAAS,qBAAA,GAAAV,sBAAA,CAAAC,OAAA;AACA,IAAAU,qBAAA,GAAAX,sBAAA,CAAAC,OAAA;AACA,IAAAW,qBAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,yBAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,mBAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,oBAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,sBAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,oBAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,4BAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,qBAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,2BAAA,GAAApB,sBAAA,CAAAC,OAAA;AAAuF,SAAAD,uBAAAqB,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEvF;AACA;AACA;AACe,MAAMG,WAAW,SAASC,iBAAQ,CAAC;EAChD;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,OAAO,EAAE;IAC/B,KAAK,CAACD,UAAU,EAAEC,OAAO,CAAC;IAC1B,IAAI,CAACC,IAAI,GAAG,aAAa;IAEzB,IAAI,CAACC,YAAY,GAAG,CAClB,IAAIC,mCAA0B,CAAC,CAAC,EAChC,IAAIC,6BAAoB,CAAC,CAAC,EAC1B,IAAIC,oCAA2B,CAAC,CAAC,EACjC,IAAIC,sCAA6B,CAAC,CAAC,EACnC,IAAIC,kCAAyB,CAAC,CAAC,EAC/B,IAAIC,yCAAgC,CAAC,CAAC,EACtC,IAAIC,wCAAqB,CAAC,CAAC,EAC3B,IAAIC,qCAAkB,CAAC,CAAC,EACxB,IAAIC,gCAAa,CAAC,CAAC,EACnB,IAAIC,iCAA0B,CAAC,CAAC,EAChC,IAAIC,6BAAU,CAAC,CAAC,EAChB,IAAIC,4BAAmB,CAAC,CAAC,EACzB,IAAIC,6BAAU,CAAC,CAAC,EAChB,IAAIC,8BAAqB,CAAC,CAAC,EAC3B,IAAIC,4BAAmB,CAAC,CAAC,EACzB,IAAIC,gCAAuB,CAAC,CAAC,EAC7B,IAAIC,iCAAU,CAAC,CAAC,EAChB,IAAIC,6BAAqB,CAAC,CAAC,EAC3B,IAAIC,2BAAkB,CAAC,CAAC,CACzB;EACH;AACF;AAACC,OAAA,CAAA3B,OAAA,GAAAC,WAAA","ignoreList":[]}

package/build/scoring/helpers/assessments/recommendedKeywordCount.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"recommendedKeywordCount.js","names":["_getAllWordsFromTree","_interopRequireDefault","require","_keyphraseLengthFactor","e","__esModule","default","_default","paper","keyphraseLength","recommendedKeyphraseDensity","maxOrMin","customGetWords","wordCount","getText","length","getAllWordsFromTree","lengthKeyphraseFactor","keyphraseLengthFactor","recommendedKeyphraseCount","Math","ceil","floor"],"sources":["../../../../src/scoring/helpers/assessments/recommendedKeywordCount.js"],"sourcesContent":["import getAllWordsFromTree from \"~~@axyseo/~~languageProcessing/helpers/word/getAllWordsFromTree\";\nimport keyphraseLengthFactor from \"./keyphraseLengthFactor.js\";\n\n/*\n Calculates a recommended keyphrase count for a paper's text. The formula to calculate this number is based on the\n * keyphrase density formula.\n \n @param {Paper}\tpaper\t\t\t\t\t\tThe paper to analyze.\n * @param {number}\tkeyphraseLength\t\t\t\tThe length of the focus keyphrase in words.\n * @param {number}\trecommendedKeyphraseDensity\tThe recommended keyphrase density (either maximum or minimum).\n * @param {string}\tmaxOrMin\t\t\t\t\tWhether it's a maximum or minimum recommended keyphrase density.\n * @param {function} customGetWords\t\t\t\tA helper to get words from the text for languages that don't use the default approach.\n \n @returns {number} The recommended keyphrase count.\n /\nexport default function( paper, keyphraseLength, recommendedKeyphraseDensity, maxOrMin, customGetWords ) {\n\tconst wordCount = customGetWords ? customGetWords( paper.getText() ).length : getAllWordsFromTree( paper ).length;\n\n\tif ( wordCount === 0 ) {\n\t\treturn 0;\n\t}\n\n\tconst lengthKeyphraseFactor = keyphraseLengthFactor( keyphraseLength );\n\tconst recommendedKeyphraseCount = ( recommendedKeyphraseDensity wordCount ) / ( 100 * lengthKeyphraseFactor );\n\n\t/\n\t The recommended keyphrase count should always be at least 2,\n\t * regardless of the keyphrase density, the word count, or the keyphrase length.\n\t */\n\tif ( recommendedKeyphraseCount < 2 ) {\n\t\treturn 2;\n\t}\n\n\tswitch ( maxOrMin ) {\n\t\tcase \"min\":\n\t\t\t// Round up for the recommended minimum count.\n\t\t\treturn Math.ceil( recommendedKeyphraseCount );\n\t\tdefault:\n\t\tcase \"max\":\n\t\t\t// Round down for the recommended maximum count.\n\t\t\treturn Math.floor( recommendedKeyphraseCount );\n\t}\n}\n"],"mappings":";;;;;;AAAA,IAAAA,oBAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,sBAAA,GAAAF,sBAAA,CAAAC,OAAA;AAA+D,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE/D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAAAG,SAAUC,KAAK,EAAEC,eAAe,EAAEC,2BAA2B,EAAEC,QAAQ,EAAEC,cAAc,EAAG;EACxG,MAAMC,SAAS,GAAGD,cAAc,GAAGA,cAAc,CAAEJ,KAAK,CAACM,OAAO,CAAC,CAAE,CAAC,CAACC,MAAM,GAAG,IAAAC,4BAAmB,EAAER,KAAM,CAAC,CAACO,MAAM;EAEjH,IAAKF,SAAS,KAAK,CAAC,EAAG;IACtB,OAAO,CAAC;EACT;EAEA,MAAMI,qBAAqB,GAAG,IAAAC,8BAAqB,EAAET,eAAgB,CAAC;EACtE,MAAMU,yBAAyB,GAAKT,2BAA2B,GAAGG,SAAS,IAAO,GAAG,GAAGI,qBAAqB,CAAE;;EAE/G;AACD;AACA;AACA;EACC,IAAKE,yBAAyB,GAAG,CAAC,EAAG;IACpC,OAAO,CAAC;EACT;EAEA,QAASR,QAAQ;IAChB,KAAK,KAAK;MACT;MACA,OAAOS,IAAI,CAACC,IAAI,CAAEF,yBAA0B,CAAC;IAC9C;IACA,KAAK,KAAK;MACT;MACA,OAAOC,IAAI,CAACE,KAAK,CAAEH,yBAA0B,CAAC;EAChD;AACD","ignoreList":[]}
1	+ {"version":3,"file":"recommendedKeywordCount.js","names":["_getAllWordsFromTree","_interopRequireDefault","require","_keyphraseLengthFactor","e","__esModule","default","_default","paper","keyphraseLength","recommendedKeyphraseDensity","maxOrMin","customGetWords","wordCount","getText","length","getAllWordsFromTree","lengthKeyphraseFactor","keyphraseLengthFactor","recommendedKeyphraseCount","Math","ceil","floor"],"sources":["../../../../src/scoring/helpers/assessments/recommendedKeywordCount.js"],"sourcesContent":["import getAllWordsFromTree from \"../../../languageProcessing/helpers/word/getAllWordsFromTree\";\nimport keyphraseLengthFactor from \"./keyphraseLengthFactor.js\";\n\n/*\n Calculates a recommended keyphrase count for a paper's text. The formula to calculate this number is based on the\n * keyphrase density formula.\n \n @param {Paper}\tpaper\t\t\t\t\t\tThe paper to analyze.\n * @param {number}\tkeyphraseLength\t\t\t\tThe length of the focus keyphrase in words.\n * @param {number}\trecommendedKeyphraseDensity\tThe recommended keyphrase density (either maximum or minimum).\n * @param {string}\tmaxOrMin\t\t\t\t\tWhether it's a maximum or minimum recommended keyphrase density.\n * @param {function} customGetWords\t\t\t\tA helper to get words from the text for languages that don't use the default approach.\n \n @returns {number} The recommended keyphrase count.\n /\nexport default function( paper, keyphraseLength, recommendedKeyphraseDensity, maxOrMin, customGetWords ) {\n\tconst wordCount = customGetWords ? customGetWords( paper.getText() ).length : getAllWordsFromTree( paper ).length;\n\n\tif ( wordCount === 0 ) {\n\t\treturn 0;\n\t}\n\n\tconst lengthKeyphraseFactor = keyphraseLengthFactor( keyphraseLength );\n\tconst recommendedKeyphraseCount = ( recommendedKeyphraseDensity wordCount ) / ( 100 * lengthKeyphraseFactor );\n\n\t/\n\t The recommended keyphrase count should always be at least 2,\n\t * regardless of the keyphrase density, the word count, or the keyphrase length.\n\t */\n\tif ( recommendedKeyphraseCount < 2 ) {\n\t\treturn 2;\n\t}\n\n\tswitch ( maxOrMin ) {\n\t\tcase \"min\":\n\t\t\t// Round up for the recommended minimum count.\n\t\t\treturn Math.ceil( recommendedKeyphraseCount );\n\t\tdefault:\n\t\tcase \"max\":\n\t\t\t// Round down for the recommended maximum count.\n\t\t\treturn Math.floor( recommendedKeyphraseCount );\n\t}\n}\n"],"mappings":";;;;;;AAAA,IAAAA,oBAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,sBAAA,GAAAF,sBAAA,CAAAC,OAAA;AAA+D,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE/D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAAAG,SAAUC,KAAK,EAAEC,eAAe,EAAEC,2BAA2B,EAAEC,QAAQ,EAAEC,cAAc,EAAG;EACxG,MAAMC,SAAS,GAAGD,cAAc,GAAGA,cAAc,CAAEJ,KAAK,CAACM,OAAO,CAAC,CAAE,CAAC,CAACC,MAAM,GAAG,IAAAC,4BAAmB,EAAER,KAAM,CAAC,CAACO,MAAM;EAEjH,IAAKF,SAAS,KAAK,CAAC,EAAG;IACtB,OAAO,CAAC;EACT;EAEA,MAAMI,qBAAqB,GAAG,IAAAC,8BAAqB,EAAET,eAAgB,CAAC;EACtE,MAAMU,yBAAyB,GAAKT,2BAA2B,GAAGG,SAAS,IAAO,GAAG,GAAGI,qBAAqB,CAAE;;EAE/G;AACD;AACA;AACA;EACC,IAAKE,yBAAyB,GAAG,CAAC,EAAG;IACpC,OAAO,CAAC;EACT;EAEA,QAASR,QAAQ;IAChB,KAAK,KAAK;MACT;MACA,OAAOS,IAAI,CAACC,IAAI,CAAEF,yBAA0B,CAAC;IAC9C;IACA,KAAK,KAAK;MACT;MACA,OAAOC,IAAI,CAACE,KAAK,CAAEH,yBAA0B,CAAC;EAChD;AACD","ignoreList":[]}

package/eslint.config.mjs ADDED Viewed

@@ -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 CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "axyseo",
-  "version": "2.0.0-alpha.0.0.20",
-  "main": "build/index.js",
+  "version": "2.0.0-alpha.0.0.4",
+  "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 ADDED Viewed

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

package/src/bundledPlugins/previouslyUsedKeywords.js ADDED Viewed

@@ -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;
+	}
+}