- 
+
+
title text
diff --git a/lib/common.js b/lib/common.js
index b2fadfe..7622dc1 100644
--- a/lib/common.js
+++ b/lib/common.js
@@ -4,51 +4,21 @@ function hasProperty(obj, key) {
return obj && Object.hasOwnProperty.call(obj, key);
}
-function stringLength(text) {
- if (typeof text !== 'string') {
- throw new Error('text is not string type.');
- }
-
- const segmentation = new Intl.Segmenter('ja', { granularity: 'grapheme' });
- return [...segmentation.segment(text)].length;
+function hasTypeOfProperty(obj, key, type) {
+ return hasProperty(obj, key) && typeof obj[key] === type;
}
-function stringSlice(text, start, end) {
- if (typeof text !== 'string') {
- throw new Error('text is not string type.');
- }
-
- const strLength = stringLength(text);
-
- let startIndex = typeof start !== 'number' || isNaN(Number(start)) ? 0 : Number(start);
- if (startIndex < 0) {
- startIndex = Math.max(startIndex + strLength, 0);
- }
-
- let endIndex = typeof end !== 'number' || isNaN(Number(end)) ? strLength : Number(end);
- if (endIndex >= strLength) {
- endIndex = strLength;
- } else if (endIndex < 0) {
- endIndex = Math.max(endIndex + strLength, 0);
- }
-
- let strings = '';
+function getObjectValueFrom(obj, key, type, defaultValue) {
+ return hasTypeOfProperty(obj, key, type) ? obj[key] || defaultValue : defaultValue;
+}
- if (startIndex >= strLength || endIndex <= startIndex) {
- return strings;
- }
- const segmentation = new Intl.Segmenter('ja', { granularity: 'grapheme' });
- [...segmentation.segment(text)]
- .forEach((value, index) => {
- if (startIndex <= index && index < endIndex) {
- strings += value.segment;
- }
- });
- return strings;
+function getValidNumber(value, defaultValue) {
+ return typeof value !== 'number' || isNaN(Number(value)) ? defaultValue : Number(value);
}
module.exports = {
hasProperty,
- stringLength,
- stringSlice,
+ hasTypeOfProperty,
+ getObjectValueFrom,
+ getValidNumber,
};
diff --git a/lib/configure.js b/lib/configure.js
index fc3c962..38ca80e 100644
--- a/lib/configure.js
+++ b/lib/configure.js
@@ -1,49 +1,64 @@
'use strict';
-const { hasProperty } = require('./common');
+const { hasTypeOfProperty, getObjectValueFrom } = require('./common');
const ANCHOR_LINK_CLASS_NAME = 'link-preview';
const DESCRIPTION_LENGTH = 140;
const DISGUISE_CRAWLER = true;
-module.exports = hexoCfg => {
- const config = {
- class_name: {
- anchor_link: ANCHOR_LINK_CLASS_NAME,
- },
+function getDefaultConfig() {
+ return {
+ class_name: { anchor_link: ANCHOR_LINK_CLASS_NAME },
description_length: DESCRIPTION_LENGTH,
disguise_crawler: DISGUISE_CRAWLER,
};
+}
- if (!hasProperty(hexoCfg, 'link_preview')) {
- return config;
- }
+function getClassNameObject(linkPreviewCfg, defaultValue) {
+ const classNameCfg = linkPreviewCfg.class_name;
- const hexoCfgLinkPreview = hexoCfg.link_preview;
+ const classNameObj = {
+ anchor_link: getAnchorLinkClassName(classNameCfg, defaultValue),
+ };
- if (hasProperty(hexoCfgLinkPreview, 'class_name')) {
- const hexoCfgLinkPreviewClassName = hexoCfgLinkPreview.class_name;
+ if (hasTypeOfProperty(classNameCfg, 'image', 'string') && classNameCfg.image !== '') {
+ classNameObj.image = classNameCfg.image;
+ }
- if (typeof hexoCfgLinkPreviewClassName === 'string') {
- config.class_name.anchor_link = hexoCfgLinkPreviewClassName || config.class_name.anchor_link;
- } else if (typeof hexoCfgLinkPreviewClassName === 'object') {
- if (hasProperty(hexoCfgLinkPreviewClassName, 'anchor_link') && typeof hexoCfgLinkPreviewClassName.anchor_link === 'string') {
- config.class_name.anchor_link = hexoCfgLinkPreviewClassName.anchor_link || config.class_name.anchor_link;
- }
+ return classNameObj;
+}
- if (hasProperty(hexoCfgLinkPreviewClassName, 'image') && hexoCfgLinkPreviewClassName.image !== '') {
- config.class_name.image = hexoCfgLinkPreviewClassName.image;
- }
- }
+function getAnchorLinkClassName(classNameCfg, defaultValue) {
+ switch (typeof classNameCfg) {
+ case 'object':
+ return getObjectValueFrom(classNameCfg, 'anchor_link', 'string', defaultValue);
+ case 'string':
+ return classNameCfg || defaultValue;
}
+ return defaultValue;
+}
- if (hasProperty(hexoCfgLinkPreview, 'description_length') && typeof hexoCfgLinkPreview.description_length === 'number') {
- config.description_length = hexoCfgLinkPreview.description_length || config.description_length;
+function getDescriptionLength(linkPreviewCfg, defaultValue) {
+ return getObjectValueFrom(linkPreviewCfg, 'description_length', 'number', defaultValue);
+}
+
+function getDisguiseCrawler(linkPreviewCfg, defaultValue) {
+ if (hasTypeOfProperty(linkPreviewCfg, 'disguise_crawler', 'boolean')) {
+ return linkPreviewCfg.disguise_crawler;
}
+ return defaultValue;
+}
- if (hasProperty(hexoCfgLinkPreview, 'disguise_crawler') && typeof hexoCfgLinkPreview.disguise_crawler === 'boolean') {
- config.disguise_crawler = hexoCfgLinkPreview.disguise_crawler;
+module.exports = hexoCfg => {
+ if (!hasTypeOfProperty(hexoCfg, 'link_preview', 'object')) {
+ return getDefaultConfig();
}
- return config;
+ const linkPreviewCfg = hexoCfg.link_preview;
+
+ return {
+ class_name: getClassNameObject(linkPreviewCfg, ANCHOR_LINK_CLASS_NAME),
+ description_length: getDescriptionLength(linkPreviewCfg, DESCRIPTION_LENGTH),
+ disguise_crawler: getDisguiseCrawler(linkPreviewCfg, DISGUISE_CRAWLER),
+ };
};
diff --git a/lib/generator.js b/lib/generator.js
index 44c855d..28f3632 100644
--- a/lib/generator.js
+++ b/lib/generator.js
@@ -19,7 +19,7 @@ module.exports = (scraper, params) => {
const desc = newHtmlDivTag('og-description', escapedDesc);
const descriptions = newHtmlDivTag('descriptions', title + desc);
const image = isImageValid
- ? newHtmlDivTag('og-image', newHtmlImgTag(imageUrl, params.generate)) : '';
+ ? newHtmlDivTag('og-image', newHtmlImgTag(imageUrl, escapedTitle, params.generate)) : '';
const content = image + descriptions;
return newHtmlAnchorTag(params.scrape.url, params.generate, content);
diff --git a/lib/htmltag.js b/lib/htmltag.js
index c749525..cec6d8d 100644
--- a/lib/htmltag.js
+++ b/lib/htmltag.js
@@ -1,7 +1,7 @@
'use strict';
const util = require('hexo-util');
-const { hasProperty } = require('./common');
+const { hasTypeOfProperty } = require('./common');
function newHtmlDivTag(className, content) {
return util.htmlTag('div', { class: className }, content, false);
@@ -13,21 +13,25 @@ function newHtmlAnchorTag(url, config, content) {
if (typeof content === 'string' && content !== '') {
tagAttrs.class = config.className.anchor_link;
return util.htmlTag('a', tagAttrs, content, false);
- } else if (hasProperty(config, 'fallbackText') && typeof config.fallbackText === 'string' && config.fallbackText !== '') {
+ }
+ if (hasTypeOfProperty(config, 'fallbackText', 'string') && config.fallbackText !== '') {
return util.htmlTag('a', tagAttrs, config.fallbackText);
}
throw new Error('failed to generate a new anchor tag.');
}
-function newHtmlImgTag(url, config) {
- const tagAttrs = { src: url };
+function newHtmlImgTag(url, alt, config) {
+ const tagAttrs = { src: url, alt: alt };
- if (hasProperty(config.className, 'image') && typeof config.className.image === 'string' && config.className.image !== '') {
+ if (hasTypeOfProperty(config.className, 'image', 'string') && config.className.image !== '') {
tagAttrs.class = config.className.image;
}
+ if (hasTypeOfProperty(config, 'loading', 'string') && ['lazy', 'eager'].includes(config.loading)) {
+ tagAttrs.loading = config.loading;
+ }
- return util.htmlTag('img', tagAttrs, '');
+ return util.htmlTag('img', tagAttrs);
}
module.exports = {
diff --git a/lib/opengraph.js b/lib/opengraph.js
index f30c7e4..4ae81f8 100644
--- a/lib/opengraph.js
+++ b/lib/opengraph.js
@@ -1,38 +1,29 @@
'use strict';
const util = require('hexo-util');
-const { hasProperty, stringLength, stringSlice } = require('./common');
+const { hasProperty, hasTypeOfProperty, getObjectValueFrom } = require('./common');
+const { stringLength, stringSlice } = require('./strings');
function getOgTitle(ogp) {
- const result = { valid: false, title: '' };
-
- if (!hasProperty(ogp, 'ogTitle')) {
- return result;
+ if (!hasTypeOfProperty(ogp, 'ogTitle', 'string')) {
+ return { valid: false, title: '' };
}
const escapedTitle = util.escapeHTML(ogp.ogTitle);
- if (typeof escapedTitle === 'string' && escapedTitle !== '') {
- result.valid = true;
- result.title = escapedTitle;
- }
- return result;
+
+ return { valid: escapedTitle !== '', title: escapedTitle };
}
function getOgDescription(ogp, maxLength) {
- const result = { valid: false, description: '' };
-
- if (!hasProperty(ogp, 'ogDescription')) {
- return result;
+ if (!hasTypeOfProperty(ogp, 'ogDescription', 'string')) {
+ return { valid: false, description: '' };
}
const escapedDescription = util.escapeHTML(ogp.ogDescription);
const descriptionText = maxLength && stringLength(escapedDescription) > maxLength
? stringSlice(escapedDescription, 0, maxLength) + '...' : escapedDescription;
- if (typeof descriptionText === 'string' && descriptionText !== '') {
- result.valid = true;
- result.description = descriptionText;
- }
- return result;
+
+ return { valid: descriptionText !== '', description: descriptionText };
}
function getOgImage(ogp, selectIndex = 0) {
@@ -41,8 +32,9 @@ function getOgImage(ogp, selectIndex = 0) {
}
const index = selectIndex >= ogp.ogImage.length ? ogp.ogImage.length - 1 : 0;
+ const imageUrl = getObjectValueFrom(ogp.ogImage[index], 'url', 'string', '');
- return { valid: true, image: ogp.ogImage[index].url };
+ return { valid: imageUrl !== '', image: imageUrl };
}
module.exports = {
diff --git a/lib/parameters.js b/lib/parameters.js
index 3857ee3..67e4e59 100644
--- a/lib/parameters.js
+++ b/lib/parameters.js
@@ -1,25 +1,34 @@
'use strict';
const urlRegex = /^(http|https):\/\//g;
-const targetKeywords = ['_self', '_blank', '_parent', '_top'];
-const relKeywords = ['external', 'nofollow', 'noopener', 'noreferrer', 'opener'];
+const targetKeywords = ['_blank', '_self', '_parent', '_top'];
+const relKeywords = ['nofollow', 'external', 'noopener', 'noreferrer', 'opener'];
+const loadingKeywords = ['lazy', 'eager'];
const CRAWLER_USER_AGENT = 'Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; Googlebot/2.1; +http://www.google.com/bot.html) Chrome/112.0.0.0 Safari/537.36';
function parseArgs(args) {
- const urls = args.filter(arg => arg.search(urlRegex) === 0);
- if (urls.length < 1) {
+ const [url, ...opts] = args;
+
+ if (typeof url !== 'string' || url.search(urlRegex) < 0) {
throw new Error('Scraping target url is not contains.');
}
- const targets = args.filter(arg => targetKeywords.includes(arg));
- const relationships = args.filter(arg => relKeywords.includes(arg));
+ const target = parseOptionalKeywordArg(opts, { argName: 'target:', index: 0 }, targetKeywords);
+ const rel = parseOptionalKeywordArg(opts, { argName: 'rel:', index: 1 }, relKeywords);
+ const loading = parseOptionalKeywordArg(opts, { argName: 'loading:', index: 2 }, loadingKeywords);
- return {
- url: urls[0],
- target: targets[0] || '_blank',
- rel: relationships[0] || 'nofollow',
- };
+ return { url, target, rel, loading };
+}
+
+function parseOptionalKeywordArg(opts, find, keywords, defaultIndex = 0) {
+ return findOptionalArgs(opts, find).filter(arg => keywords.includes(arg)).shift() || keywords[defaultIndex];
+}
+
+function findOptionalArgs(opts, find) {
+ const { argName, index } = find;
+ const args = opts.filter(arg => arg.startsWith(argName)).map(arg => arg.replace(argName, ''));
+ return args.length ? args : [opts[index]];
}
function getFetchOptions(isCrawler) {
@@ -38,12 +47,12 @@ function getFetchOptions(isCrawler) {
}
module.exports = (args, content, config) => {
- const { url, target, rel } = parseArgs(args);
+ const { url, target, rel, loading } = parseArgs(args);
const { class_name: className, description_length: descriptionLength, disguise_crawler: isCrawler } = config;
const fetchOptions = getFetchOptions(isCrawler);
return {
scrape: { url, fetchOptions },
- generate: { target, rel, descriptionLength, className, fallbackText: content },
+ generate: { target, rel, loading, descriptionLength, className, fallbackText: content },
};
};
diff --git a/lib/strings.js b/lib/strings.js
new file mode 100644
index 0000000..d70eef2
--- /dev/null
+++ b/lib/strings.js
@@ -0,0 +1,53 @@
+'use strict';
+
+const { getValidNumber } = require('./common');
+
+function getStringSegmentOf(text) {
+ const segmentation = new Intl.Segmenter('ja', { granularity: 'grapheme' });
+ return [...segmentation.segment(text)];
+}
+
+function stringLength(text) {
+ if (typeof text !== 'string') {
+ throw new Error('text is not string type.');
+ }
+
+ return getStringSegmentOf(text).length;
+}
+
+function getStartIndex(start, strLength) {
+ const startIndex = getValidNumber(start, 0);
+ return startIndex < 0 ? Math.max(startIndex + strLength, 0) : startIndex;
+}
+
+function getEndIndex(end, strLength) {
+ const endIndex = getValidNumber(end, strLength);
+ if (endIndex >= strLength) {
+ return strLength;
+ }
+ return endIndex < 0 ? Math.max(endIndex + strLength, 0) : endIndex;
+}
+
+function stringSlice(text, start, end) {
+ if (typeof text !== 'string') {
+ throw new Error('text is not string type.');
+ }
+
+ const strLength = stringLength(text);
+ const startIndex = getStartIndex(start, strLength);
+ const endIndex = getEndIndex(end, strLength);
+
+ if (startIndex >= strLength || endIndex <= startIndex) {
+ return '';
+ }
+ return getStringSegmentOf(text)
+ .map((element, index) => {
+ return startIndex <= index && index < endIndex ? element.segment : '';
+ })
+ .join('');
+}
+
+module.exports = {
+ stringLength,
+ stringSlice,
+};
diff --git a/package.json b/package.json
index 0c588d5..bb2ee8d 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "hexo-tag-ogp-link-preview",
"description": "A Hexo tag plugin for embedding link preview by OpenGraph on article.",
- "version": "1.0.0",
+ "version": "1.1.0",
"license": "MIT",
"author": "Hiroki Sugawara