mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-19 08:31:43 +03:00
724db487a0
- we don't need to use _.escape from lodash as we already have escapeExpression from handlebars
- it's more correct to use the escape utility from our theme engine when escaping strings _for_ our theme engine!
- Note there is a minor difference between the two:
- Lodash: &, <, >, " and '
- refs: https://lodash.com/docs/4.17.15#escape
- Handlebars: &, <, >, ", ', ` and =
- refs: https://handlebarsjs.com/api-reference/utilities.html#helper-utilities
- This could cause slightly weird behaviour in themes around ` and = characters, but as it's just convering to html entities it should be fine
57 lines
1.7 KiB
JavaScript
57 lines
1.7 KiB
JavaScript
'use strict';
|
|
// # Authors Helper
|
|
// Usage: `{{authors}}`, `{{authors separator=' - '}}`
|
|
//
|
|
// Returns a string of the authors on the post.
|
|
// By default, authors are separated by commas.
|
|
//
|
|
// Note that the standard {{#each authors}} implementation is unaffected by this helper.
|
|
const isString = require('lodash/isString');
|
|
const {SafeString, escapeExpression, templates, urlService} = require('../services/proxy');
|
|
const ghostHelperUtils = require('@tryghost/helpers').utils;
|
|
|
|
module.exports = function authors(options = {}) {
|
|
options.hash = options.hash || {};
|
|
|
|
let {
|
|
autolink,
|
|
separator = ', ',
|
|
prefix = '',
|
|
suffix = '',
|
|
limit,
|
|
visibility,
|
|
from = 1,
|
|
to
|
|
} = options.hash;
|
|
let output = '';
|
|
|
|
autolink = !(isString(autolink) && autolink === 'false');
|
|
limit = limit ? parseInt(limit, 10) : limit;
|
|
from = from ? parseInt(from, 10) : from;
|
|
to = to ? parseInt(to, 10) : to;
|
|
|
|
function createAuthorsList(authorsList) {
|
|
function processAuthor(author) {
|
|
return autolink ? templates.link({
|
|
url: urlService.getUrlByResourceId(author.id, {withSubdirectory: true}),
|
|
text: escapeExpression(author.name)
|
|
}) : escapeExpression(author.name);
|
|
}
|
|
|
|
return ghostHelperUtils.visibility.filter(authorsList, visibility, processAuthor);
|
|
}
|
|
|
|
if (this.authors && this.authors.length) {
|
|
output = createAuthorsList(this.authors);
|
|
from -= 1; // From uses 1-indexed, but array uses 0-indexed.
|
|
to = to || limit + from || output.length;
|
|
output = output.slice(from, to).join(separator);
|
|
}
|
|
|
|
if (output) {
|
|
output = prefix + output + suffix;
|
|
}
|
|
|
|
return new SafeString(output);
|
|
};
|