mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
631c6925d4
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 Big changes: * Uses template strings where appropriate * Config and argument parsing is unified and there is no such thing as formatterOptions anymore. All user-passed options go through mergeConfig. * The node API surface changed (again): `buildSync` is removed, building operations return Promises. * Now using Flow for internal type annotations. More changes: * Remove buildSync command * feat(inference): Partially implement object shorthand support * Refs #649 * Use Flow annotations to enforce types * Keep flow but switch to comment syntax * Clarify types * More flow improvements * Turn server into class * LinkerStack becomes class too * Fix comment description type * Run flow on lint * Many more flow fixes * More intense flow refactoring * Simplify inference steps * Update inference tests, flow errors down to 1 * Continue refining types * Fix more flow issues * Use 'use strict' everywhere * Make 'ast' property configurable * Fix many tests * Fix more tests * Fix more tests * Fix augments * Test Markdown meta support * Improve test coverage * Switch back from for of to for for speed
66 lines
1.9 KiB
JavaScript
66 lines
1.9 KiB
JavaScript
/* @flow */
|
|
'use strict';
|
|
|
|
|
|
/**
|
|
* Create a tokenizer method for Remark, our Markdown processor,
|
|
* that is able to parse JSDoc inline tokens
|
|
*
|
|
* @private
|
|
* @param {string} type the destination type of the parsed objects
|
|
* @param {RegExp} regex regular expression for extracting content
|
|
* from text
|
|
* @returns {Function} tokenizer
|
|
*/
|
|
function makeTokenizer(type, regex) {
|
|
var tokenizer = function (eat, value) {
|
|
var match = regex.exec(value);
|
|
|
|
if (!match) {
|
|
return;
|
|
}
|
|
|
|
return eat(match[0])({
|
|
type,
|
|
url: match[1],
|
|
title: null,
|
|
jsdoc: true,
|
|
children: [{
|
|
type: 'text',
|
|
value: match[2] || match[1]
|
|
}]
|
|
});
|
|
};
|
|
|
|
tokenizer.notInLink = true;
|
|
tokenizer.locator = function (value, fromIndex) {
|
|
return value.indexOf('{@' + type, fromIndex);
|
|
};
|
|
|
|
return tokenizer;
|
|
}
|
|
|
|
var tokenizeLink = makeTokenizer('link', /^\{@link\s+(.+?)(?:[\s|](.*?))?\}/);
|
|
var tokenizeTutorial = makeTokenizer('tutorial', /^\{@tutorial\s+(.+?)(?:[\s|](.*?))?\}/);
|
|
|
|
/**
|
|
* A remark plugin that installs
|
|
* [tokenizers](https://github.com/wooorm/remark/blob/master/doc/remarkplugin.3.md#function-tokenizereat-value-silent)
|
|
* and [locators](https://github.com/wooorm/remark/blob/master/doc/remarkplugin.3.md#function-locatorvalue-fromindex)
|
|
* for JSDoc inline `{@link}` and `{@tutorial}` tags.
|
|
*
|
|
* This does not handle the `[text]({@link url})` and `[text]({@tutorial url})` forms of these tags.
|
|
* That's a JSDoc misfeature; just use regular markdown syntax instead: `[text](url)`.
|
|
*
|
|
* @param {Object} processor - remark instance
|
|
* @returns {undefined}
|
|
*/
|
|
module.exports = function (processor/*: Object*/) {
|
|
var proto = processor.Parser.prototype;
|
|
proto.inlineTokenizers.tokenizeLink = tokenizeLink;
|
|
proto.inlineTokenizers.tokenizeTutorial = tokenizeTutorial;
|
|
var methods = proto.inlineMethods;
|
|
methods.splice(methods.indexOf('inlineText'), 0,
|
|
'tokenizeLink', 'tokenizeTutorial');
|
|
};
|