aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorache <ache@ache.one>2018-10-18 08:58:04 +0200
committerache <ache@ache.one>2018-10-18 08:58:04 +0200
commite8bc626cc05a860cfd2275d350fc7c7a28936c01 (patch)
tree69a19f0cc5c4a2156414877ae523e32a2c412ed5 /src
parentSupports aria attributes (diff)
Improve repo architecture to use babel
Diffstat (limited to 'src')
-rw-r--r--src/index.js226
1 files changed, 226 insertions, 0 deletions
diff --git a/src/index.js b/src/index.js
new file mode 100644
index 0000000..2bc6142
--- /dev/null
+++ b/src/index.js
@@ -0,0 +1,226 @@
+'use strict';
+
+const parseAttr = require('md-attr-parser');
+const htmlElemAttr = require('html-element-attributes');
+
+const supportedElements = ['link', 'atxHeading', 'strong', 'emphasis', 'deletion', 'code', 'setextHeading'];
+const blockElements = ['atxHeading', 'setextHeading'];
+
+// The list of DOM Event handler
+const DOMEventHandler = [
+ 'onabort', 'onautocomplete', 'onautocompleteerror',
+ 'onblur', 'oncancel', 'oncanplay',
+ 'oncanplaythrough', 'onchange', 'onclick',
+ 'onclose', 'oncontextmenu', 'oncuechange',
+ 'ondblclick', 'ondrag', 'ondragend',
+ 'ondragenter', 'ondragexit', 'ondragleave',
+ 'ondragover', 'ondragstart', 'ondrop',
+ 'ondurationchange', 'onemptied', 'onended',
+ 'onerror', 'onfocus', 'oninput',
+ 'oninvalid', 'onkeydown', 'onkeypress',
+ 'onkeyup', 'onload', 'onloadeddata',
+ 'onloadedmetadata', 'onloadstart', 'onmousedown',
+ 'onmouseenter', 'onmouseleave', 'onmousemove',
+ 'onmouseout', 'onmouseover', 'onmouseup',
+ 'onmousewheel', 'onpause', 'onplay',
+ 'onplaying', 'onprogress', 'onratechange',
+ 'onreset', 'onresize', 'onscroll',
+ 'onseeked', 'onseeking', 'onselect',
+ 'onshow', 'onsort', 'onstalled',
+ 'onsubmit', 'onsuspend', 'ontimeupdate',
+ 'ontoggle', 'onvolumechange', 'onwaiting',
+];
+
+/* Table convertion between type and HTML tagName */
+const convTypeTag = {
+ image: 'img',
+ link: 'a',
+ heading: 'h1',
+ strong: 'strong',
+ emphasis: 'em',
+ delete: 's',
+ inlineCode: 'code',
+ '*': '*',
+};
+
+/* This function is a generic function that transform
+ * the tokenize function a node type to a version that understand
+ * attributes.
+ *
+ * The tokenizer function of strong will tokenize **STRONG STRING**
+ * this function extand it to tokenize **STRONG STRING**{list=of attributes}
+ *
+ * - The prefix is '\n' for block node and '' for inline one
+ *
+ * The syntax is for atxHeading ::
+ * ## HEAD TITLE
+ * {attributes}
+ *
+ * Attributes are on the next line.
+ *
+ * - The old parser is the old function user to tokenize
+ * - The config is the configuration of this plugin
+ *
+ */
+function tokenizeGenerator(prefix, oldParser, config) {
+ function token(eat, value, silent) {
+ // This we call the old tokenize
+ const self = this;
+ let eaten = oldParser.call(self, eat, value, silent);
+
+ let index = 0;
+ let parsedAttr;
+ const {length} = value;
+
+ if (!eaten || !eaten.position) {
+ return undefined;
+ }
+
+ const type = convTypeTag[eaten.type];
+
+ index = eaten.position.end.offset - eaten.position.start.offset;
+
+ // Then we check for attributes
+ if (index + prefix.length < length && value.charAt(index + prefix.length) === '{') {
+ // If any, parse it
+ parsedAttr = parseAttr(value, index + prefix.length);
+ }
+
+ // If parsed configure the node
+ if (parsedAttr) {
+ if (config.scope && config.scope !== 'none') {
+ const filtredProp = filterAttributes(parsedAttr.prop, config, type);
+ if (filtredProp !== {}) {
+ if (eaten.data) {
+ eaten.data.hProperties = filtredProp;
+ } else {
+ eaten.data = {hProperties: filtredProp};
+ }
+ }
+ }
+ eaten = eat(prefix + parsedAttr.eaten)(eaten);
+ }
+
+ return eaten;
+ }
+ // Return the new tokenizer function
+ return token;
+}
+
+// A generic function to parse attributes
+function filterAttributes(prop, config, type) {
+ const {scope} = config;
+ const {extend} = config;
+ const {allowDangerousDOMEventHandlers} = config;
+ const specific = htmlElemAttr;
+
+ const extendTag = (extend => {
+ const t = {};
+ Object.getOwnPropertyNames(extend).forEach(p => {
+ t[convTypeTag[p]] = extend[p];
+ });
+ return t;
+ })(extend);
+
+ // Delete empty key/class/id attributes
+ Object.getOwnPropertyNames(prop).forEach(p => {
+ if (p !== 'key' && p !== 'class' && p !== 'id') {
+ prop[p] = prop[p] || '';
+ }
+ });
+
+ const isDangerous = p => DOMEventHandler.indexOf(p) >= 0;
+ const isSpecific = p => type in specific && specific[type].indexOf(p) >= 0;
+ const isGlobal = p => htmlElemAttr['*'].indexOf(p) >= 0 || p.match(/^aria-[a-z]{3,24}$/);
+
+ let inScope = _ => false;
+
+ // Function used to `or combine` two other function.
+ const orFunc = (fun, fun2) => x => fun(x) || fun2(x);
+
+ // Respect the scope configuration
+ switch (scope) {
+ case 'none': // Plugin is disabled
+ break;
+ case 'permissive':
+ case 'every':
+ if (allowDangerousDOMEventHandlers) {
+ inScope = _ => true;
+ } else {
+ inScope = x => !isDangerous(x);
+ }
+ break;
+ case 'extended':
+ default:
+ inScope = p => extendTag && type in extendTag && extendTag[type].indexOf(p) >= 0;
+ inScope = orFunc(inScope, p => '*' in extendTag && extendTag['*'].indexOf(p) >= 0);
+ // Or if it in the specific scope, fallthrough
+ case 'specific':
+ inScope = orFunc(inScope, isSpecific);
+ // Or if it in the global scope fallthrough
+ case 'global':
+ inScope = orFunc(inScope, isGlobal);
+ if (allowDangerousDOMEventHandlers) { // If allowed add dangerous attributes to global scope
+ inScope = orFunc(inScope, isDangerous);
+ }
+ }
+
+ // If an attributes isn't in the scope, delete it
+ Object.getOwnPropertyNames(prop).forEach(p => {
+ if (!inScope(p)) {
+ delete prop[p];
+ }
+ });
+
+ return prop;
+}
+
+remarkAttr.SUPPORTED_ELEMENTS = supportedElements;
+
+module.exports = remarkAttr;
+
+/* Function that is exported */
+function remarkAttr(userConfig) {
+ const parser = this.Parser;
+
+ const defaultConfig = {
+ allowDangerousDOMEventHandlers: false,
+ elements: supportedElements,
+ extend: {},
+ scope: 'extended',
+ };
+ const config = {...defaultConfig, ...userConfig};
+
+ if (!isRemarkParser(parser)) {
+ throw new Error('Missing parser to attach `remark-attr` [link] (to)');
+ }
+
+ const tokenizers = parser.prototype.inlineTokenizers;
+ const tokenizersBlock = parser.prototype.blockTokenizers;
+
+ // For each elements, replace the old tokenizer by the new one
+ config.elements.forEach(elem => {
+ if (supportedElements.indexOf(elem) >= 0) {
+ if (blockElements.indexOf(elem) >= 0) {
+ const oldElem = tokenizersBlock[elem];
+ tokenizersBlock[elem] = tokenizeGenerator('\n', oldElem, config);
+ } else {
+ const oldElem = tokenizers[elem];
+ const elemTokenize = tokenizeGenerator('', oldElem, config);
+ elemTokenize.locator = tokenizers[elem].locator;
+ tokenizers[elem] = elemTokenize;
+ }
+ }
+ });
+}
+
+function isRemarkParser(parser) {
+ return Boolean(
+ parser &&
+ parser.prototype &&
+ parser.prototype.inlineTokenizers &&
+ parser.prototype.inlineTokenizers.link &&
+ parser.prototype.inlineTokenizers.link.locator
+ );
+}
+