Added JSDoc (#1782)
This commit is contained in:
Michael Schmidt
GitHub
parent
a375872875
commit
4ff555bea1
|
|
@ -0,0 +1,66 @@
|
|||
{
|
||||
"plugins": [
|
||||
"plugins/markdown",
|
||||
"./gulpfile.js/docs.js"
|
||||
],
|
||||
"opts": {
|
||||
"destination": "./docs",
|
||||
"encoding": "utf8",
|
||||
"template": "./node_modules/docdash",
|
||||
"access": [
|
||||
"public",
|
||||
"protected"
|
||||
]
|
||||
},
|
||||
"recurseDepth": 10,
|
||||
"source": {
|
||||
"includePattern": "\\.js$",
|
||||
"excludePattern": "\\.min\\.js$"
|
||||
},
|
||||
"tags": {
|
||||
"allowUnknownTags": true,
|
||||
"dictionaries": [
|
||||
"jsdoc",
|
||||
"closure"
|
||||
]
|
||||
},
|
||||
"templates": {
|
||||
"cleverLinks": true,
|
||||
"monospaceLinks": true,
|
||||
"default": {
|
||||
"includeDate": false
|
||||
}
|
||||
},
|
||||
"docdash": {
|
||||
"static": true,
|
||||
"sort": true,
|
||||
"search": true,
|
||||
"collapse": false,
|
||||
"wrap": false,
|
||||
"typedefs": true,
|
||||
"private": false,
|
||||
"scripts": [
|
||||
"styles/overwrites.css"
|
||||
],
|
||||
"openGraph": {
|
||||
"title": "Prism generated API documentation",
|
||||
"type": "website",
|
||||
"image": "/logo.svg",
|
||||
"site_name": "Prism",
|
||||
"url": "https://prismjs.com"
|
||||
},
|
||||
"menu": {
|
||||
"PrismJS": {
|
||||
"href": "https://prismjs.com",
|
||||
"class": "menu-item",
|
||||
"id": "website_link"
|
||||
},
|
||||
"GitHub": {
|
||||
"href": "https://github.com/PrismJS/prism",
|
||||
"target": "_blank",
|
||||
"class": "menu-item",
|
||||
"id": "github_link"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
/// <reference lib="WebWorker"/>
|
||||
|
||||
var _self = (typeof window !== 'undefined')
|
||||
? window // if in browser
|
||||
: (
|
||||
|
|
@ -8,10 +10,12 @@ var _self = (typeof window !== 'undefined')
|
|||
|
||||
/**
|
||||
* Prism: Lightweight, robust, elegant syntax highlighting
|
||||
* MIT license http://www.opensource.org/licenses/mit-license.php/
|
||||
* @author Lea Verou http://lea.verou.me
|
||||
*
|
||||
* @license MIT <https://opensource.org/licenses/MIT>
|
||||
* @author Lea Verou <https://lea.verou.me>
|
||||
* @namespace
|
||||
* @public
|
||||
*/
|
||||
|
||||
var Prism = (function (_self){
|
||||
|
||||
// Private helper vars
|
||||
|
|
@ -20,8 +24,39 @@ var uniqueId = 0;
|
|||
|
||||
|
||||
var _ = {
|
||||
/**
|
||||
* By default, Prism will attempt to highlight all code elements (by calling {@link Prism.highlightAll}) on the
|
||||
* current page after the page finished loading. This might be a problem if e.g. you wanted to asynchronously load
|
||||
* additional languages or plugins yourself.
|
||||
*
|
||||
* By setting this value to `true`, Prism will not automatically highlight all code elements on the page.
|
||||
*
|
||||
* You obviously have to change this value before the automatic highlighting started. To do this, you can add an
|
||||
* empty Prism object into the global scope before loading the Prism script like this:
|
||||
*
|
||||
* ```js
|
||||
* window.Prism = window.Prism || {};
|
||||
* Prism.manual = true;
|
||||
* // add a new <script> to load Prism's script
|
||||
* ```
|
||||
*
|
||||
* @default false
|
||||
* @type {boolean}
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
manual: _self.Prism && _self.Prism.manual,
|
||||
disableWorkerMessageHandler: _self.Prism && _self.Prism.disableWorkerMessageHandler,
|
||||
|
||||
/**
|
||||
* A namespace for utility methods.
|
||||
*
|
||||
* All function in this namespace that are not explicitly marked as _public_ are for __internal use only__ and may
|
||||
* change or disappear at any time.
|
||||
*
|
||||
* @namespace
|
||||
* @memberof Prism
|
||||
*/
|
||||
util: {
|
||||
encode: function encode(tokens) {
|
||||
if (tokens instanceof Token) {
|
||||
|
|
@ -33,10 +68,32 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns the name of the type of the given value.
|
||||
*
|
||||
* @param {any} o
|
||||
* @returns {string}
|
||||
* @example
|
||||
* type(null) === 'Null'
|
||||
* type(undefined) === 'Undefined'
|
||||
* type(123) === 'Number'
|
||||
* type('foo') === 'String'
|
||||
* type(true) === 'Boolean'
|
||||
* type([1, 2]) === 'Array'
|
||||
* type({}) === 'Object'
|
||||
* type(String) === 'Function'
|
||||
* type(/abc+/) === 'RegExp'
|
||||
*/
|
||||
type: function (o) {
|
||||
return Object.prototype.toString.call(o).slice(8, -1);
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns a unique number for the given object. Later calls will still return the same number.
|
||||
*
|
||||
* @param {Object} obj
|
||||
* @returns {number}
|
||||
*/
|
||||
objId: function (obj) {
|
||||
if (!obj['__id']) {
|
||||
Object.defineProperty(obj, '__id', { value: ++uniqueId });
|
||||
|
|
@ -44,18 +101,27 @@ var _ = {
|
|||
return obj['__id'];
|
||||
},
|
||||
|
||||
// Deep clone a language definition (e.g. to extend it)
|
||||
/**
|
||||
* Creates a deep clone of the given object.
|
||||
*
|
||||
* The main intended use of this function is to clone language definitions.
|
||||
*
|
||||
* @param {T} o
|
||||
* @param {Record<number, any>} [visited]
|
||||
* @returns {T}
|
||||
* @template T
|
||||
*/
|
||||
clone: function deepClone(o, visited) {
|
||||
var clone, id, type = _.util.type(o);
|
||||
visited = visited || {};
|
||||
|
||||
switch (type) {
|
||||
var clone, id;
|
||||
switch (_.util.type(o)) {
|
||||
case 'Object':
|
||||
id = _.util.objId(o);
|
||||
if (visited[id]) {
|
||||
return visited[id];
|
||||
}
|
||||
clone = {};
|
||||
clone = /** @type {Record<string, any>} */ ({});
|
||||
visited[id] = clone;
|
||||
|
||||
for (var key in o) {
|
||||
|
|
@ -64,7 +130,7 @@ var _ = {
|
|||
}
|
||||
}
|
||||
|
||||
return clone;
|
||||
return /** @type {any} */ (clone);
|
||||
|
||||
case 'Array':
|
||||
id = _.util.objId(o);
|
||||
|
|
@ -74,11 +140,11 @@ var _ = {
|
|||
clone = [];
|
||||
visited[id] = clone;
|
||||
|
||||
o.forEach(function (v, i) {
|
||||
(/** @type {Array} */(/** @type {any} */(o))).forEach(function (v, i) {
|
||||
clone[i] = deepClone(v, visited);
|
||||
});
|
||||
|
||||
return clone;
|
||||
return /** @type {any} */ (clone);
|
||||
|
||||
default:
|
||||
return o;
|
||||
|
|
@ -114,8 +180,8 @@ var _ = {
|
|||
if (typeof document === 'undefined') {
|
||||
return null;
|
||||
}
|
||||
if ('currentScript' in document) {
|
||||
return document.currentScript;
|
||||
if ('currentScript' in document && 1 < 2 /* hack to trip TS' flow analysis */) {
|
||||
return /** @type {any} */ (document.currentScript);
|
||||
}
|
||||
|
||||
// IE11 workaround
|
||||
|
|
@ -181,7 +247,42 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* This namespace contains all currently loaded languages and the some helper functions to create and modify languages.
|
||||
*
|
||||
* @namespace
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
languages: {
|
||||
/**
|
||||
* Creates a deep copy of the language with the given id and appends the given tokens.
|
||||
*
|
||||
* If a token in `redef` also appears in the copied language, then the existing token in the copied language
|
||||
* will be overwritten at its original position.
|
||||
*
|
||||
* ## Best practices
|
||||
*
|
||||
* Since the position of overwriting tokens (token in `redef` that overwrite tokens in the copied language)
|
||||
* doesn't matter, they can technically be in any order. However, this can be confusing to others that trying to
|
||||
* understand the language definition because, normally, the order of tokens matters in Prism grammars.
|
||||
*
|
||||
* Therefore, it is encouraged to order overwriting tokens according to the positions of the overwritten tokens.
|
||||
* Furthermore, all non-overwriting tokens should be placed after the overwriting ones.
|
||||
*
|
||||
* @param {string} id The id of the language to extend. This has to be a key in `Prism.languages`.
|
||||
* @param {Grammar} redef The new tokens to append.
|
||||
* @returns {Grammar} The new language created.
|
||||
* @public
|
||||
* @example
|
||||
* Prism.languages['css-with-colors'] = Prism.languages.extend('css', {
|
||||
* // Prism.languages.css already has a 'comment' token, so this token will overwrite CSS' 'comment' token
|
||||
* // at its original position
|
||||
* 'comment': { ... },
|
||||
* // CSS doesn't have a 'color' token, so this token will be appended
|
||||
* 'color': /\b(?:red|green|blue)\b/
|
||||
* });
|
||||
*/
|
||||
extend: function (id, redef) {
|
||||
var lang = _.util.clone(_.languages[id]);
|
||||
|
||||
|
|
@ -193,17 +294,84 @@ var _ = {
|
|||
},
|
||||
|
||||
/**
|
||||
* Insert a token before another token in a language literal
|
||||
* As this needs to recreate the object (we cannot actually insert before keys in object literals),
|
||||
* we cannot just provide an object, we need an object and a key.
|
||||
* @param inside The key (or language id) of the parent
|
||||
* @param before The key to insert before.
|
||||
* @param insert Object with the key/value pairs to insert
|
||||
* @param root The object that contains `inside`. If equal to Prism.languages, it can be omitted.
|
||||
* Inserts tokens _before_ another token in a language definition or any other grammar.
|
||||
*
|
||||
* ## Usage
|
||||
*
|
||||
* This helper method makes it easy to modify existing languages. For example, the CSS language definition
|
||||
* not only defines CSS highlighting for CSS documents, but also needs to define highlighting for CSS embedded
|
||||
* in HTML through `<style>` elements. To do this, it needs to modify `Prism.languages.markup` and add the
|
||||
* appropriate tokens. However, `Prism.languages.markup` is a regular JavaScript object literal, so if you do
|
||||
* this:
|
||||
*
|
||||
* ```js
|
||||
* Prism.languages.markup.style = {
|
||||
* // token
|
||||
* };
|
||||
* ```
|
||||
*
|
||||
* then the `style` token will be added (and processed) at the end. `insertBefore` allows you to insert tokens
|
||||
* before existing tokens. For the CSS example above, you would use it like this:
|
||||
*
|
||||
* ```js
|
||||
* Prism.languages.insertBefore('markup', 'cdata', {
|
||||
* 'style': {
|
||||
* // token
|
||||
* }
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* ## Special cases
|
||||
*
|
||||
* If the grammars of `inside` and `insert` have tokens with the same name, the tokens in `inside`'s grammar
|
||||
* will be ignored.
|
||||
*
|
||||
* This behavior can be used to insert tokens after `before`:
|
||||
*
|
||||
* ```js
|
||||
* Prism.languages.insertBefore('markup', 'comment', {
|
||||
* 'comment': Prism.languages.markup.comment,
|
||||
* // tokens after 'comment'
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* ## Limitations
|
||||
*
|
||||
* The main problem `insertBefore` has to solve is iteration order. Since ES2015, the iteration order for object
|
||||
* properties is guaranteed to be the insertion order (except for integer keys) but some browsers behave
|
||||
* differently when keys are deleted and re-inserted. So `insertBefore` can't be implemented by temporarily
|
||||
* deleting properties which is necessary to insert at arbitrary positions.
|
||||
*
|
||||
* To solve this problem, `insertBefore` doesn't actually insert the given tokens into the target object.
|
||||
* Instead, it will create a new object and replace all references to the target object with the new one. This
|
||||
* can be done without temporarily deleting properties, so the iteration order is well-defined.
|
||||
*
|
||||
* However, only references that can be reached from `Prism.languages` or `insert` will be replaced. I.e. if
|
||||
* you hold the target object in a variable, then the value of the variable will not change.
|
||||
*
|
||||
* ```js
|
||||
* var oldMarkup = Prism.languages.markup;
|
||||
* var newMarkup = Prism.languages.insertBefore('markup', 'comment', { ... });
|
||||
*
|
||||
* assert(oldMarkup !== Prism.languages.markup);
|
||||
* assert(newMarkup === Prism.languages.markup);
|
||||
* ```
|
||||
*
|
||||
* @param {string} inside The property of `root` (e.g. a language id in `Prism.languages`) that contains the
|
||||
* object to be modified.
|
||||
* @param {string} before The key to insert before.
|
||||
* @param {Grammar} insert An object containing the key-value pairs to be inserted.
|
||||
* @param {Object<string, any>} [root] The object containing `inside`, i.e. the object that contains the
|
||||
* object to be modified.
|
||||
*
|
||||
* Defaults to `Prism.languages`.
|
||||
* @returns {Grammar} The new grammar object.
|
||||
* @public
|
||||
*/
|
||||
insertBefore: function (inside, before, insert, root) {
|
||||
root = root || _.languages;
|
||||
root = root || /** @type {any} */ (_.languages);
|
||||
var grammar = root[inside];
|
||||
/** @type {Grammar} */
|
||||
var ret = {};
|
||||
|
||||
for (var token in grammar) {
|
||||
|
|
@ -262,12 +430,39 @@ var _ = {
|
|||
}
|
||||
}
|
||||
},
|
||||
|
||||
plugins: {},
|
||||
|
||||
/**
|
||||
* This is the most high-level function in Prism’s API.
|
||||
* It fetches all the elements that have a `.language-xxxx` class and then calls {@link Prism.highlightElement} on
|
||||
* each one of them.
|
||||
*
|
||||
* This is equivalent to `Prism.highlightAllUnder(document, async, callback)`.
|
||||
*
|
||||
* @param {boolean} [async=false] Same as in {@link Prism.highlightAllUnder}.
|
||||
* @param {HighlightCallback} [callback] Same as in {@link Prism.highlightAllUnder}.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
highlightAll: function(async, callback) {
|
||||
_.highlightAllUnder(document, async, callback);
|
||||
},
|
||||
|
||||
/**
|
||||
* Fetches all the descendants of `container` that have a `.language-xxxx` class and then calls
|
||||
* {@link Prism.highlightElement} on each one of them.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `before-highlightall`
|
||||
* 2. All hooks of {@link Prism.highlightElement} for each element.
|
||||
*
|
||||
* @param {ParentNode} container The root element, whose descendants that have a `.language-xxxx` class will be highlighted.
|
||||
* @param {boolean} [async=false] Whether each element is to be highlighted asynchronously using Web Workers.
|
||||
* @param {HighlightCallback} [callback] An optional callback to be invoked on each element after its highlighting is done.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
highlightAllUnder: function(container, async, callback) {
|
||||
var env = {
|
||||
callback: callback,
|
||||
|
|
@ -286,6 +481,31 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Highlights the code inside a single element.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `before-sanity-check`
|
||||
* 2. `before-highlight`
|
||||
* 3. All hooks of {@link Prism.highlight}. These hooks will only be run by the current worker if `async` is `true`.
|
||||
* 4. `before-insert`
|
||||
* 5. `after-highlight`
|
||||
* 6. `complete`
|
||||
*
|
||||
* @param {Element} element The element containing the code.
|
||||
* It must have a class of `language-xxxx` to be processed, where `xxxx` is a valid language identifier.
|
||||
* @param {boolean} [async=false] Whether the element is to be highlighted asynchronously using Web Workers
|
||||
* to improve performance and avoid blocking the UI when highlighting very large chunks of code. This option is
|
||||
* [disabled by default](https://prismjs.com/faq.html#why-is-asynchronous-highlighting-disabled-by-default).
|
||||
*
|
||||
* Note: All language definitions required to highlight the code must be included in the main `prism.js` file for
|
||||
* asynchronous highlighting to work. You can build your own bundle on the
|
||||
* [Download page](https://prismjs.com/download.html).
|
||||
* @param {HighlightCallback} [callback] An optional callback to be invoked after the highlighting is done.
|
||||
* Mostly useful when `async` is `true`, since in that case, the highlighting is done asynchronously.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
highlightElement: function(element, async, callback) {
|
||||
// Find language
|
||||
var language = _.util.getLanguage(element);
|
||||
|
|
@ -295,7 +515,7 @@ var _ = {
|
|||
element.className = element.className.replace(lang, '').replace(/\s+/g, ' ') + ' language-' + language;
|
||||
|
||||
// Set language on the parent, for styling
|
||||
var parent = element.parentNode;
|
||||
var parent = element.parentElement;
|
||||
if (parent && parent.nodeName.toLowerCase() === 'pre') {
|
||||
parent.className = parent.className.replace(lang, '').replace(/\s+/g, ' ') + ' language-' + language;
|
||||
}
|
||||
|
|
@ -354,6 +574,26 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Low-level function, only use if you know what you’re doing. It accepts a string of text as input
|
||||
* and the language definitions to use, and returns a string with the HTML produced.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `before-tokenize`
|
||||
* 2. `after-tokenize`
|
||||
* 3. `wrap`: On each {@link Token}.
|
||||
*
|
||||
* @param {string} text A string with the code to be highlighted.
|
||||
* @param {Grammar} grammar An object containing the tokens to use.
|
||||
*
|
||||
* Usually a language definition like `Prism.languages.markup`.
|
||||
* @param {string} language The name of the language definition passed to `grammar`.
|
||||
* @returns {string} The highlighted HTML.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
* @example
|
||||
* Prism.highlight('var foo = true;', Prism.languages.javascript, 'javascript');
|
||||
*/
|
||||
highlight: function (text, grammar, language) {
|
||||
var env = {
|
||||
code: text,
|
||||
|
|
@ -366,6 +606,30 @@ var _ = {
|
|||
return Token.stringify(_.util.encode(env.tokens), env.language);
|
||||
},
|
||||
|
||||
/**
|
||||
* This is the heart of Prism, and the most low-level function you can use. It accepts a string of text as input
|
||||
* and the language definitions to use, and returns an array with the tokenized code.
|
||||
*
|
||||
* When the language definition includes nested tokens, the function is called recursively on each of these tokens.
|
||||
*
|
||||
* This method could be useful in other contexts as well, as a very crude parser.
|
||||
*
|
||||
* @param {string} text A string with the code to be highlighted.
|
||||
* @param {Grammar} grammar An object containing the tokens to use.
|
||||
*
|
||||
* Usually a language definition like `Prism.languages.markup`.
|
||||
* @returns {TokenStream} An array of strings and tokens, a token stream.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
* @example
|
||||
* let code = `var foo = 0;`;
|
||||
* let tokens = Prism.tokenize(code, Prism.languages.javascript);
|
||||
* tokens.forEach(token => {
|
||||
* if (token instanceof Prism.Token && token.type === 'number') {
|
||||
* console.log(`Found numeric literal: ${token.content}`);
|
||||
* }
|
||||
* });
|
||||
*/
|
||||
tokenize: function(text, grammar) {
|
||||
var rest = grammar.rest;
|
||||
if (rest) {
|
||||
|
|
@ -384,9 +648,26 @@ var _ = {
|
|||
return toArray(tokenList);
|
||||
},
|
||||
|
||||
/**
|
||||
* @namespace
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
hooks: {
|
||||
all: {},
|
||||
|
||||
/**
|
||||
* Adds the given callback to the list of callbacks for the given hook.
|
||||
*
|
||||
* The callback will be invoked when the hook it is registered for is run.
|
||||
* Hooks are usually directly run by a highlight function but you can also run hooks yourself.
|
||||
*
|
||||
* One callback function can be registered to multiple hooks and the same hook multiple times.
|
||||
*
|
||||
* @param {string} name The name of the hook.
|
||||
* @param {HookCallback} callback The callback function which is given environment variables.
|
||||
* @public
|
||||
*/
|
||||
add: function (name, callback) {
|
||||
var hooks = _.hooks.all;
|
||||
|
||||
|
|
@ -395,6 +676,15 @@ var _ = {
|
|||
hooks[name].push(callback);
|
||||
},
|
||||
|
||||
/**
|
||||
* Runs a hook invoking all registered callbacks with the given environment variables.
|
||||
*
|
||||
* Callbacks will be invoked synchronously and in the order in which they were registered.
|
||||
*
|
||||
* @param {string} name The name of the hook.
|
||||
* @param {Object<string, any>} env The environment variables of the hook passed to all callbacks registered.
|
||||
* @public
|
||||
*/
|
||||
run: function (name, env) {
|
||||
var callbacks = _.hooks.all[name];
|
||||
|
||||
|
|
@ -410,18 +700,86 @@ var _ = {
|
|||
|
||||
Token: Token
|
||||
};
|
||||
|
||||
_self.Prism = _;
|
||||
|
||||
|
||||
// Typescript note:
|
||||
// The following can be used to import the Token type in JSDoc:
|
||||
//
|
||||
// @typedef {InstanceType<import("./prism-core")["Token"]>} Token
|
||||
|
||||
/**
|
||||
* Creates a new token.
|
||||
*
|
||||
* @param {string} type See {@link Token#type type}
|
||||
* @param {string | TokenStream} content See {@link Token#content content}
|
||||
* @param {string|string[]} [alias] The alias(es) of the token.
|
||||
* @param {string} [matchedStr=""] A copy of the full string this token was created from.
|
||||
* @param {boolean} [greedy=false] Whether the pattern that created this token is greedy or not. Will be removed soon.
|
||||
* @class
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
function Token(type, content, alias, matchedStr, greedy) {
|
||||
/**
|
||||
* The type of the token.
|
||||
*
|
||||
* This is usually the key of a pattern in a {@link Grammar}.
|
||||
*
|
||||
* @type {string}
|
||||
* @see GrammarToken
|
||||
* @public
|
||||
*/
|
||||
this.type = type;
|
||||
/**
|
||||
* The strings or tokens contained by this token.
|
||||
*
|
||||
* This will be a token stream if the pattern matched also defined an `inside` grammar.
|
||||
*
|
||||
* @type {string | TokenStream}
|
||||
* @public
|
||||
*/
|
||||
this.content = content;
|
||||
/**
|
||||
* The alias(es) of the token.
|
||||
*
|
||||
* @type {string|string[]}
|
||||
* @see GrammarToken
|
||||
* @public
|
||||
*/
|
||||
this.alias = alias;
|
||||
// Copy of the full string this token was created from
|
||||
this.length = (matchedStr || '').length|0;
|
||||
this.length = (matchedStr || "").length|0;
|
||||
this.greedy = !!greedy;
|
||||
}
|
||||
|
||||
/**
|
||||
* A token stream is an array of strings and {@link Token Token} objects.
|
||||
*
|
||||
* Token streams have to fulfill a few properties that are assumed by most functions (mostly internal ones) that process
|
||||
* them.
|
||||
*
|
||||
* 1. No adjacent strings.
|
||||
* 2. No empty strings.
|
||||
*
|
||||
* The only exception here is the token stream that only contains the empty string and nothing else.
|
||||
*
|
||||
* @typedef {Array<string | Token>} TokenStream
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* Converts the given token or token stream to an HTML representation.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `wrap`: On each {@link Token}.
|
||||
*
|
||||
* @param {string | Token | TokenStream} o The token or token stream to be converted.
|
||||
* @param {string} language The name of current language.
|
||||
* @returns {string} The HTML representation of the token or token stream.
|
||||
* @memberof Token
|
||||
* @static
|
||||
*/
|
||||
Token.stringify = function stringify(o, language) {
|
||||
if (typeof o == 'string') {
|
||||
return o;
|
||||
|
|
@ -470,6 +828,7 @@ Token.stringify = function stringify(o, language) {
|
|||
* @param {number} startPos
|
||||
* @param {boolean} [oneshot=false]
|
||||
* @param {string} [target]
|
||||
* @private
|
||||
*/
|
||||
function matchGrammar(text, tokenList, grammar, startNode, startPos, oneshot, target) {
|
||||
for (var token in grammar) {
|
||||
|
|
@ -616,10 +975,12 @@ function matchGrammar(text, tokenList, grammar, startNode, startPos, oneshot, ta
|
|||
* @property {LinkedListNode<T> | null} prev The previous node.
|
||||
* @property {LinkedListNode<T> | null} next The next node.
|
||||
* @template T
|
||||
* @private
|
||||
*/
|
||||
|
||||
/**
|
||||
* @template T
|
||||
* @private
|
||||
*/
|
||||
function LinkedList() {
|
||||
/** @type {LinkedListNode<T>} */
|
||||
|
|
@ -710,7 +1071,7 @@ if (!_self.document) {
|
|||
return _;
|
||||
}
|
||||
|
||||
//Get current script and highlight
|
||||
// Get current script and highlight
|
||||
var script = _.util.currentScript();
|
||||
|
||||
if (script) {
|
||||
|
|
@ -758,3 +1119,52 @@ if (typeof module !== 'undefined' && module.exports) {
|
|||
if (typeof global !== 'undefined') {
|
||||
global.Prism = Prism;
|
||||
}
|
||||
|
||||
// some additional documentation/types
|
||||
|
||||
/**
|
||||
* The expansion of a simple `RegExp` literal to support additional properties.
|
||||
*
|
||||
* @typedef GrammarToken
|
||||
* @property {RegExp} pattern The regular expression of the token.
|
||||
* @property {boolean} [lookbehind=false] If `true`, then the first capturing group of `pattern` will (effectively)
|
||||
* behave as a lookbehind group meaning that the captured text will not be part of the matched text of the new token.
|
||||
* @property {boolean} [greedy=false] Whether the token is greedy.
|
||||
* @property {string|string[]} [alias] An optional alias or list of aliases.
|
||||
* @property {Grammar} [inside] The nested grammar of this token.
|
||||
*
|
||||
* The `inside` grammar will be used to tokenize the text value of each token of this kind.
|
||||
*
|
||||
* This can be used to make nested and even recursive language definitions.
|
||||
*
|
||||
* Note: This can cause infinite recursion. Be careful when you embed different languages or even the same language into
|
||||
* each another.
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef Grammar
|
||||
* @type {Object<string, RegExp | GrammarToken | Array<RegExp | GrammarToken>>}
|
||||
* @property {Grammar} [rest] An optional grammar object that will be appended to this grammar.
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* A function which will invoked after an element was successfully highlighted.
|
||||
*
|
||||
* @callback HighlightCallback
|
||||
* @param {Element} element The element successfully highlighted.
|
||||
* @returns {void}
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* @callback HookCallback
|
||||
* @param {Object<string, any>} env The environment variables of the hook.
|
||||
* @returns {void}
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,494 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
|
||||
<meta charset="utf-8">
|
||||
<title>hooks - Documentation</title>
|
||||
|
||||
|
||||
<meta property="og:title" content="Prism generated API documentation"/>
|
||||
<meta property="og:type" content="website"/>
|
||||
<meta property="og:image" content="/logo.svg"/>
|
||||
<meta property="og:site_name" content="Prism"/>
|
||||
<meta property="og:url" content="https://prismjs.com"/>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
||||
<script src="scripts/nav.js" defer></script>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="icon" type="image/png" href="/favicon.png"/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav >
|
||||
|
||||
<input type="text" id="nav-search" placeholder="Search" />
|
||||
|
||||
<h2><a href="index.html">Home</a></h2><h2><a href="https://prismjs.com" class="menu-item" id="website_link" >PrismJS</a></h2><h2><a href="https://github.com/PrismJS/prism" target="_blank" class="menu-item" id="github_link" >GitHub</a></h2><h3>Classes</h3><ul><li><a href="Token.html">Token</a></li></ul><h3>Namespaces</h3><ul><li><a href="Prism.html">Prism</a><ul class='members'><li data-type='member'><a href="Prism.html#.manual">manual</a></li></ul><ul class='methods'><li data-type='method'><a href="Prism.html#.highlight">highlight</a></li><li data-type='method'><a href="Prism.html#.highlightAll">highlightAll</a></li><li data-type='method'><a href="Prism.html#.highlightAllUnder">highlightAllUnder</a></li><li data-type='method'><a href="Prism.html#.highlightElement">highlightElement</a></li><li data-type='method'><a href="Prism.html#.tokenize">tokenize</a></li></ul></li><li><a href="Prism.hooks.html">hooks</a><ul class='methods'><li data-type='method'><a href="Prism.hooks.html#.add">add</a></li><li data-type='method'><a href="Prism.hooks.html#.run">run</a></li></ul></li><li><a href="Prism.languages.html">languages</a><ul class='methods'><li data-type='method'><a href="Prism.languages.html#.extend">extend</a></li><li data-type='method'><a href="Prism.languages.html#.insertBefore">insertBefore</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#Grammar">Grammar</a></li><li><a href="global.html#GrammarToken">GrammarToken</a></li><li><a href="global.html#HighlightCallback">HighlightCallback</a></li><li><a href="global.html#HookCallback">HookCallback</a></li><li><a href="global.html#TokenStream">TokenStream</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">hooks</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
<h2>
|
||||
<span class="ancestors"><a href="Prism.html">Prism</a>.</span>
|
||||
|
||||
hooks
|
||||
</h2>
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line656">line 656</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Methods</h3>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id=".add"><span class="type-signature">(static) </span>add<span class="signature">(name, callback)</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line671">line 671</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>Adds the given callback to the list of callbacks for the given hook.</p>
|
||||
<p>The callback will be invoked when the hook it is registered for is run.
|
||||
Hooks are usually directly run by a highlight function but you can also run hooks yourself.</p>
|
||||
<p>One callback function can be registered to multiple hooks and the same hook multiple times.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>name</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The name of the hook.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>callback</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><a href="global.html#HookCallback">HookCallback</a></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The callback function which is given environment variables.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id=".run"><span class="type-signature">(static) </span>run<span class="signature">(name, env)</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line688">line 688</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>Runs a hook invoking all registered callbacks with the given environment variables.</p>
|
||||
<p>Callbacks will be invoked synchronously and in the order in which they were registered.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>name</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The name of the hook.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>env</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Object.<string, any></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The environment variables of the hook passed to all callbacks registered.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/polyfill.js"></script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
|
||||
<script src="scripts/search.js" defer></script>
|
||||
|
||||
|
||||
|
||||
<link type="text/css" rel="stylesheet" href="styles/overwrites.css">
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,683 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
|
||||
<meta charset="utf-8">
|
||||
<title>languages - Documentation</title>
|
||||
|
||||
|
||||
<meta property="og:title" content="Prism generated API documentation"/>
|
||||
<meta property="og:type" content="website"/>
|
||||
<meta property="og:image" content="/logo.svg"/>
|
||||
<meta property="og:site_name" content="Prism"/>
|
||||
<meta property="og:url" content="https://prismjs.com"/>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
||||
<script src="scripts/nav.js" defer></script>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="icon" type="image/png" href="/favicon.png"/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav >
|
||||
|
||||
<input type="text" id="nav-search" placeholder="Search" />
|
||||
|
||||
<h2><a href="index.html">Home</a></h2><h2><a href="https://prismjs.com" class="menu-item" id="website_link" >PrismJS</a></h2><h2><a href="https://github.com/PrismJS/prism" target="_blank" class="menu-item" id="github_link" >GitHub</a></h2><h3>Classes</h3><ul><li><a href="Token.html">Token</a></li></ul><h3>Namespaces</h3><ul><li><a href="Prism.html">Prism</a><ul class='members'><li data-type='member'><a href="Prism.html#.manual">manual</a></li></ul><ul class='methods'><li data-type='method'><a href="Prism.html#.highlight">highlight</a></li><li data-type='method'><a href="Prism.html#.highlightAll">highlightAll</a></li><li data-type='method'><a href="Prism.html#.highlightAllUnder">highlightAllUnder</a></li><li data-type='method'><a href="Prism.html#.highlightElement">highlightElement</a></li><li data-type='method'><a href="Prism.html#.tokenize">tokenize</a></li></ul></li><li><a href="Prism.hooks.html">hooks</a><ul class='methods'><li data-type='method'><a href="Prism.hooks.html#.add">add</a></li><li data-type='method'><a href="Prism.hooks.html#.run">run</a></li></ul></li><li><a href="Prism.languages.html">languages</a><ul class='methods'><li data-type='method'><a href="Prism.languages.html#.extend">extend</a></li><li data-type='method'><a href="Prism.languages.html#.insertBefore">insertBefore</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#Grammar">Grammar</a></li><li><a href="global.html#GrammarToken">GrammarToken</a></li><li><a href="global.html#HighlightCallback">HighlightCallback</a></li><li><a href="global.html#HookCallback">HookCallback</a></li><li><a href="global.html#TokenStream">TokenStream</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">languages</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
<h2>
|
||||
<span class="ancestors"><a href="Prism.html">Prism</a>.</span>
|
||||
|
||||
languages
|
||||
</h2>
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line257">line 257</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext"><p>This namespace contains all currently loaded languages and the some helper functions to create and modify languages.</p></div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Methods</h3>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id=".extend"><span class="type-signature">(static) </span>extend<span class="signature">(id, redef)</span><span class="type-signature"> → {<a href="global.html#Grammar">Grammar</a>}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line286">line 286</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>Creates a deep copy of the language with the given id and appends the given tokens.</p>
|
||||
<p>If a token in <code>redef</code> also appears in the copied language, then the existing token in the copied language
|
||||
will be overwritten at its original position.</p>
|
||||
<h2>Best practices</h2>
|
||||
<p>Since the position of overwriting tokens (token in <code>redef</code> that overwrite tokens in the copied language)
|
||||
doesn't matter, they can technically be in any order. However, this can be confusing to others that trying to
|
||||
understand the language definition because, normally, the order of tokens matters in Prism grammars.</p>
|
||||
<p>Therefore, it is encouraged to order overwriting tokens according to the positions of the overwritten tokens.
|
||||
Furthermore, all non-overwriting tokens should be placed after the overwriting ones.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Example</h5>
|
||||
|
||||
<pre class="prettyprint"><code>Prism.languages['css-with-colors'] = Prism.languages.extend('css', {
|
||||
// Prism.languages.css already has a 'comment' token, so this token will overwrite CSS' 'comment' token
|
||||
// at its original position
|
||||
'comment': { ... },
|
||||
// CSS doesn't have a 'color' token, so this token will be appended
|
||||
'color': /\b(?:red|green|blue)\b/
|
||||
});</code></pre>
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>id</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The id of the language to extend. This has to be a key in <code>Prism.languages</code>.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>redef</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><a href="global.html#Grammar">Grammar</a></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The new tokens to append.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
<p>The new language created.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl class="param-type">
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type"><a href="global.html#Grammar">Grammar</a></span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id=".insertBefore"><span class="type-signature">(static) </span>insertBefore<span class="signature">(inside, before, insert, root<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="global.html#Grammar">Grammar</a>}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line371">line 371</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>Inserts tokens <em>before</em> another token in a language definition or any other grammar.</p>
|
||||
<h2>Usage</h2>
|
||||
<p>This helper method makes it easy to modify existing languages. For example, the CSS language definition
|
||||
not only defines CSS highlighting for CSS documents, but also needs to define highlighting for CSS embedded
|
||||
in HTML through <code><style></code> elements. To do this, it needs to modify <code>Prism.languages.markup</code> and add the
|
||||
appropriate tokens. However, <code>Prism.languages.markup</code> is a regular JavaScript object literal, so if you do
|
||||
this:</p>
|
||||
<pre class="prettyprint source lang-js"><code>Prism.languages.markup.style = {
|
||||
// token
|
||||
};
|
||||
</code></pre>
|
||||
<p>then the <code>style</code> token will be added (and processed) at the end. <code>insertBefore</code> allows you to insert tokens
|
||||
before existing tokens. For the CSS example above, you would use it like this:</p>
|
||||
<pre class="prettyprint source lang-js"><code>Prism.languages.insertBefore('markup', 'cdata', {
|
||||
'style': {
|
||||
// token
|
||||
}
|
||||
});
|
||||
</code></pre>
|
||||
<h2>Special cases</h2>
|
||||
<p>If the grammars of <code>inside</code> and <code>insert</code> have tokens with the same name, the tokens in <code>inside</code>'s grammar
|
||||
will be ignored.</p>
|
||||
<p>This behavior can be used to insert tokens after <code>before</code>:</p>
|
||||
<pre class="prettyprint source lang-js"><code>Prism.languages.insertBefore('markup', 'comment', {
|
||||
'comment': Prism.languages.markup.comment,
|
||||
// tokens after 'comment'
|
||||
});
|
||||
</code></pre>
|
||||
<h2>Limitations</h2>
|
||||
<p>The main problem <code>insertBefore</code> has to solve is iteration order. Since ES2015, the iteration order for object
|
||||
properties is guaranteed to be the insertion order (except for integer keys) but some browsers behave
|
||||
differently when keys are deleted and re-inserted. So <code>insertBefore</code> can't be implemented by temporarily
|
||||
deleting properties which is necessary to insert at arbitrary positions.</p>
|
||||
<p>To solve this problem, <code>insertBefore</code> doesn't actually insert the given tokens into the target object.
|
||||
Instead, it will create a new object and replace all references to the target object with the new one. This
|
||||
can be done without temporarily deleting properties, so the iteration order is well-defined.</p>
|
||||
<p>However, only references that can be reached from <code>Prism.languages</code> or <code>insert</code> will be replaced. I.e. if
|
||||
you hold the target object in a variable, then the value of the variable will not change.</p>
|
||||
<pre class="prettyprint source lang-js"><code>var oldMarkup = Prism.languages.markup;
|
||||
var newMarkup = Prism.languages.insertBefore('markup', 'comment', { ... });
|
||||
|
||||
assert(oldMarkup !== Prism.languages.markup);
|
||||
assert(newMarkup === Prism.languages.markup);
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
<th>Attributes</th>
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>inside</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The property of <code>root</code> (e.g. a language id in <code>Prism.languages</code>) that contains the
|
||||
object to be modified.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>before</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The key to insert before.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>insert</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><a href="global.html#Grammar">Grammar</a></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>An object containing the key-value pairs to be inserted.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>root</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Object.<string, any></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The object containing <code>inside</code>, i.e. the object that contains the
|
||||
object to be modified.</p>
|
||||
<p>Defaults to <code>Prism.languages</code>.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
<p>The new grammar object.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl class="param-type">
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type"><a href="global.html#Grammar">Grammar</a></span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/polyfill.js"></script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
|
||||
<script src="scripts/search.js" defer></script>
|
||||
|
||||
|
||||
|
||||
<link type="text/css" rel="stylesheet" href="styles/overwrites.css">
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,670 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
|
||||
<meta charset="utf-8">
|
||||
<title>Token - Documentation</title>
|
||||
|
||||
|
||||
<meta property="og:title" content="Prism generated API documentation"/>
|
||||
<meta property="og:type" content="website"/>
|
||||
<meta property="og:image" content="/logo.svg"/>
|
||||
<meta property="og:site_name" content="Prism"/>
|
||||
<meta property="og:url" content="https://prismjs.com"/>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
||||
<script src="scripts/nav.js" defer></script>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="icon" type="image/png" href="/favicon.png"/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav >
|
||||
|
||||
<input type="text" id="nav-search" placeholder="Search" />
|
||||
|
||||
<h2><a href="index.html">Home</a></h2><h2><a href="https://prismjs.com" class="menu-item" id="website_link" >PrismJS</a></h2><h2><a href="https://github.com/PrismJS/prism" target="_blank" class="menu-item" id="github_link" >GitHub</a></h2><h3>Classes</h3><ul><li><a href="Token.html">Token</a></li></ul><h3>Namespaces</h3><ul><li><a href="Prism.html">Prism</a><ul class='members'><li data-type='member'><a href="Prism.html#.manual">manual</a></li></ul><ul class='methods'><li data-type='method'><a href="Prism.html#.highlight">highlight</a></li><li data-type='method'><a href="Prism.html#.highlightAll">highlightAll</a></li><li data-type='method'><a href="Prism.html#.highlightAllUnder">highlightAllUnder</a></li><li data-type='method'><a href="Prism.html#.highlightElement">highlightElement</a></li><li data-type='method'><a href="Prism.html#.tokenize">tokenize</a></li></ul></li><li><a href="Prism.hooks.html">hooks</a><ul class='methods'><li data-type='method'><a href="Prism.hooks.html#.add">add</a></li><li data-type='method'><a href="Prism.hooks.html#.run">run</a></li></ul></li><li><a href="Prism.languages.html">languages</a><ul class='methods'><li data-type='method'><a href="Prism.languages.html#.extend">extend</a></li><li data-type='method'><a href="Prism.languages.html#.insertBefore">insertBefore</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#Grammar">Grammar</a></li><li><a href="global.html#GrammarToken">GrammarToken</a></li><li><a href="global.html#HighlightCallback">HighlightCallback</a></li><li><a href="global.html#HookCallback">HookCallback</a></li><li><a href="global.html#TokenStream">TokenStream</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Token</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
<h2>
|
||||
Token
|
||||
</h2>
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="Token"><span class="type-signature"></span>new Token<span class="signature">(type, content, alias<span class="signature-attributes">opt</span>, matchedStr<span class="signature-attributes">opt</span>, greedy<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line723">line 723</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>Creates a new token.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
<th>Attributes</th>
|
||||
|
||||
|
||||
|
||||
<th>Default</th>
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>type</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>See <a href="Token.html#type"><code>type</code></a></p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>content</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
|
||||
|
||||
<span class="param-type"><a href="global.html#TokenStream">TokenStream</a></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>See <a href="Token.html#content"><code>content</code></a></p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>alias</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
|
||||
|
||||
<span class="param-type">Array.<string></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The alias(es) of the token.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>matchedStr</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
<code>""</code>
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>A copy of the full string this token was created from.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>greedy</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">boolean</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
<code>false</code>
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>Whether the pattern that created this token is greedy or not. Will be removed soon.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Members</h3>
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="alias"><span class="type-signature"></span>alias<span class="type-signature"> :string|Array.<string></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line750">line 750</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-see">See:</dt>
|
||||
<dd class="tag-see">
|
||||
<ul>
|
||||
<li><a href="global.html#GrammarToken">GrammarToken</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>The alias(es) of the token.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h5>Type:</h5>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
|
||||
|
||||
<span class="param-type">Array.<string></span>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="content"><span class="type-signature"></span>content<span class="type-signature"> :string|<a href="global.html#TokenStream">TokenStream</a></span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line742">line 742</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>The strings or tokens contained by this token.</p>
|
||||
<p>This will be a token stream if the pattern matched also defined an <code>inside</code> grammar.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h5>Type:</h5>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
|
||||
|
||||
<span class="param-type"><a href="global.html#TokenStream">TokenStream</a></span>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line733">line 733</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-see">See:</dt>
|
||||
<dd class="tag-see">
|
||||
<ul>
|
||||
<li><a href="global.html#GrammarToken">GrammarToken</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>The type of the token.</p>
|
||||
<p>This is usually the key of a pattern in a <a href="global.html#Grammar"><code>Grammar</code></a>.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h5>Type:</h5>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/polyfill.js"></script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
|
||||
<script src="scripts/search.js" defer></script>
|
||||
|
||||
|
||||
|
||||
<link type="text/css" rel="stylesheet" href="styles/overwrites.css">
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,965 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
|
||||
<meta charset="utf-8">
|
||||
<title>Global - Documentation</title>
|
||||
|
||||
|
||||
<meta property="og:title" content="Prism generated API documentation"/>
|
||||
<meta property="og:type" content="website"/>
|
||||
<meta property="og:image" content="/logo.svg"/>
|
||||
<meta property="og:site_name" content="Prism"/>
|
||||
<meta property="og:url" content="https://prismjs.com"/>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
||||
<script src="scripts/nav.js" defer></script>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="icon" type="image/png" href="/favicon.png"/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav >
|
||||
|
||||
<input type="text" id="nav-search" placeholder="Search" />
|
||||
|
||||
<h2><a href="index.html">Home</a></h2><h2><a href="https://prismjs.com" class="menu-item" id="website_link" >PrismJS</a></h2><h2><a href="https://github.com/PrismJS/prism" target="_blank" class="menu-item" id="github_link" >GitHub</a></h2><h3>Classes</h3><ul><li><a href="Token.html">Token</a></li></ul><h3>Namespaces</h3><ul><li><a href="Prism.html">Prism</a><ul class='members'><li data-type='member'><a href="Prism.html#.manual">manual</a></li></ul><ul class='methods'><li data-type='method'><a href="Prism.html#.highlight">highlight</a></li><li data-type='method'><a href="Prism.html#.highlightAll">highlightAll</a></li><li data-type='method'><a href="Prism.html#.highlightAllUnder">highlightAllUnder</a></li><li data-type='method'><a href="Prism.html#.highlightElement">highlightElement</a></li><li data-type='method'><a href="Prism.html#.tokenize">tokenize</a></li></ul></li><li><a href="Prism.hooks.html">hooks</a><ul class='methods'><li data-type='method'><a href="Prism.hooks.html#.add">add</a></li><li data-type='method'><a href="Prism.hooks.html#.run">run</a></li></ul></li><li><a href="Prism.languages.html">languages</a><ul class='methods'><li data-type='method'><a href="Prism.languages.html#.extend">extend</a></li><li data-type='method'><a href="Prism.languages.html#.insertBefore">insertBefore</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#Grammar">Grammar</a></li><li><a href="global.html#GrammarToken">GrammarToken</a></li><li><a href="global.html#HighlightCallback">HighlightCallback</a></li><li><a href="global.html#HookCallback">HookCallback</a></li><li><a href="global.html#TokenStream">TokenStream</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Global</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
<h2>
|
||||
|
||||
</h2>
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Type Definitions</h3>
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="Grammar">Grammar</h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line1146">line 1146</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<h5 class="subsection-title">Properties:</h5>
|
||||
|
||||
|
||||
|
||||
<table class="props">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
<th>Attributes</th>
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>rest</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><a href="global.html#Grammar">Grammar</a></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>An optional grammar object that will be appended to this grammar.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Type:</h5>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<span class="param-type">Object.<string, (RegExp|<a href="global.html#GrammarToken">GrammarToken</a>|Array.<(RegExp|<a href="global.html#GrammarToken">GrammarToken</a>)>)></span>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="GrammarToken">GrammarToken</h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line1125">line 1125</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<h5 class="subsection-title">Properties:</h5>
|
||||
|
||||
|
||||
|
||||
<table class="props">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
<th>Attributes</th>
|
||||
|
||||
|
||||
|
||||
<th>Default</th>
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>pattern</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">RegExp</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The regular expression of the token.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>lookbehind</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">boolean</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
<code>false</code>
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>If <code>true</code>, then the first capturing group of <code>pattern</code> will (effectively)
|
||||
behave as a lookbehind group meaning that the captured text will not be part of the matched text of the new token.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>greedy</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">boolean</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
<code>false</code>
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>Whether the token is greedy.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>alias</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
|
||||
|
||||
<span class="param-type">Array.<string></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>An optional alias or list of aliases.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>inside</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><a href="global.html#Grammar">Grammar</a></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The nested grammar of this token.</p>
|
||||
<p>The <code>inside</code> grammar will be used to tokenize the text value of each token of this kind.</p>
|
||||
<p>This can be used to make nested and even recursive language definitions.</p>
|
||||
<p>Note: This can cause infinite recursion. Be careful when you embed different languages or even the same language into
|
||||
each another.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>The expansion of a simple <code>RegExp</code> literal to support additional properties.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="HighlightCallback"><span class="type-signature"></span>HighlightCallback<span class="signature">(element)</span><span class="type-signature"> → {void}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line1154">line 1154</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>A function which will invoked after an element was successfully highlighted.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>element</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Element</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The element successfully highlighted.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="param-type">
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">void</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="HookCallback"><span class="type-signature"></span>HookCallback<span class="signature">(env)</span><span class="type-signature"> → {void}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line1164">line 1164</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>env</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Object.<string, any></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The environment variables of the hook.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="param-type">
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">void</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="TokenStream">TokenStream</h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line755">line 755</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description usertext">
|
||||
<p>A token stream is an array of strings and <a href="Token.html"><code>Token</code></a> objects.</p>
|
||||
<p>Token streams have to fulfill a few properties that are assumed by most functions (mostly internal ones) that process
|
||||
them.</p>
|
||||
<ol>
|
||||
<li>
|
||||
<p>No adjacent strings.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>No empty strings.</p>
|
||||
<p>The only exception here is the token stream that only contains the empty string and nothing else.</p>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h5>Type:</h5>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<span class="param-type">Array.<(string|<a href="Token.html">Token</a>)></span>
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/polyfill.js"></script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
|
||||
<script src="scripts/search.js" defer></script>
|
||||
|
||||
|
||||
|
||||
<link type="text/css" rel="stylesheet" href="styles/overwrites.css">
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,107 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
|
||||
<meta charset="utf-8">
|
||||
<title>Home - Documentation</title>
|
||||
|
||||
|
||||
<meta property="og:title" content="Prism generated API documentation"/>
|
||||
<meta property="og:type" content="website"/>
|
||||
<meta property="og:image" content="/logo.svg"/>
|
||||
<meta property="og:site_name" content="Prism"/>
|
||||
<meta property="og:url" content="https://prismjs.com"/>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
||||
<script src="scripts/nav.js" defer></script>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="icon" type="image/png" href="/favicon.png"/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav >
|
||||
|
||||
<input type="text" id="nav-search" placeholder="Search" />
|
||||
|
||||
<h2><a href="index.html">Home</a></h2><h2><a href="https://prismjs.com" class="menu-item" id="website_link" >PrismJS</a></h2><h2><a href="https://github.com/PrismJS/prism" target="_blank" class="menu-item" id="github_link" >GitHub</a></h2><h3>Classes</h3><ul><li><a href="Token.html">Token</a></li></ul><h3>Namespaces</h3><ul><li><a href="Prism.html">Prism</a><ul class='members'><li data-type='member'><a href="Prism.html#.manual">manual</a></li></ul><ul class='methods'><li data-type='method'><a href="Prism.html#.highlight">highlight</a></li><li data-type='method'><a href="Prism.html#.highlightAll">highlightAll</a></li><li data-type='method'><a href="Prism.html#.highlightAllUnder">highlightAllUnder</a></li><li data-type='method'><a href="Prism.html#.highlightElement">highlightElement</a></li><li data-type='method'><a href="Prism.html#.tokenize">tokenize</a></li></ul></li><li><a href="Prism.hooks.html">hooks</a><ul class='methods'><li data-type='method'><a href="Prism.hooks.html#.add">add</a></li><li data-type='method'><a href="Prism.hooks.html#.run">run</a></li></ul></li><li><a href="Prism.languages.html">languages</a><ul class='methods'><li data-type='method'><a href="Prism.languages.html#.extend">extend</a></li><li data-type='method'><a href="Prism.languages.html#.insertBefore">insertBefore</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#Grammar">Grammar</a></li><li><a href="global.html#GrammarToken">GrammarToken</a></li><li><a href="global.html#HighlightCallback">HighlightCallback</a></li><li><a href="global.html#HookCallback">HookCallback</a></li><li><a href="global.html#TokenStream">TokenStream</a></li></ul>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="readme usertext">
|
||||
<article><h1><a href="https://prismjs.com/">Prism</a></h1>
|
||||
<p><a href="https://travis-ci.org/PrismJS/prism"><img src="https://travis-ci.org/PrismJS/prism.svg?branch=master" alt="Build Status"></a>
|
||||
<a href="https://www.npmjs.com/package/prismjs"><img src="https://img.shields.io/npm/dw/prismjs.svg" alt="npm"></a></p>
|
||||
<p>Prism is a lightweight, robust, elegant syntax highlighting library. It's a spin-off project from <a href="https://dabblet.com/">Dabblet</a>.</p>
|
||||
<p>You can learn more on <a href="https://prismjs.com/">prismjs.com</a>.</p>
|
||||
<p><a href="https://lea.verou.me/2012/07/introducing-prism-an-awesome-new-syntax-highlighter/#more-1841">Why another syntax highlighter?</a></p>
|
||||
<p><a href="https://github.com/PrismJS/prism-themes">More themes for Prism!</a></p>
|
||||
<h2>Contribute to Prism!</h2>
|
||||
<p>Prism depends on community contributions to expand and cover a wider array of use cases. If you like it, considering giving back by sending a pull request. Here are a few tips:</p>
|
||||
<ul>
|
||||
<li>Read the <a href="https://prismjs.com/extending.html">documentation</a>. Prism was designed to be extensible.</li>
|
||||
<li>Do not edit <code>prism.js</code>, it’s just the version of Prism used by the Prism website and is built automatically. Limit your changes to the unminified files in the <code>components/</code> folder. <code>prism.js</code> and all minified files are also generated automatically by our build system.</li>
|
||||
<li>The build system uses <a href="https://github.com/gulpjs/gulp">gulp</a> to minify the files and build <code>prism.js</code>. With all of Prism's dependencies installed, you just need to run the command <code>npm run build</code>.</li>
|
||||
<li>Please follow the code conventions used in the files already. For example, I use <a href="http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/">tabs for indentation and spaces for alignment</a>. Opening braces are on the same line, closing braces on their own line regardless of construct. There is a space before the opening brace. etc etc.</li>
|
||||
<li>Please try to err towards more smaller PRs rather than few huge PRs. If a PR includes changes I want to merge and changes I don't, handling it becomes difficult.</li>
|
||||
<li>My time is very limited these days, so it might take a long time to review longer PRs (short ones are usually merged very quickly), especially those modifying the Prism Core. This doesn't mean your PR is rejected.</li>
|
||||
<li>If you contribute a new language definition, you will be responsible for handling bug reports about that language definition.</li>
|
||||
<li>If you <a href="https://prismjs.com/extending.html#creating-a-new-language-definition">add a new language definition</a> or plugin, you need to add it to <code>components.json</code> as well and rebuild Prism by running <code>npm run build</code>, so that it becomes available to the download build page. For new languages, please also add a few <a href="https://prismjs.com/test-suite.html">tests</a> and an example in the <code>examples/</code> folder.</li>
|
||||
<li>Go to <a href="https://github.com/PrismJS/prism-themes">prism-themes</a> if you want to add a new theme.</li>
|
||||
</ul>
|
||||
<p>Thank you so much for contributing!!</p>
|
||||
<h2>Translations</h2>
|
||||
<ul>
|
||||
<li><a href="https://www.awesomes.cn/repo/PrismJS/prism"><img src="http://awesomes.oss-cn-beijing.aliyuncs.com/readme.png" alt="中文说明"></a></li>
|
||||
</ul></article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/polyfill.js"></script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
|
||||
<script src="scripts/search.js" defer></script>
|
||||
|
||||
|
||||
|
||||
<link type="text/css" rel="stylesheet" href="styles/overwrites.css">
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,20 @@
|
|||
function hideAllButCurrent(){
|
||||
//by default all submenut items are hidden
|
||||
//but we need to rehide them for search
|
||||
document.querySelectorAll("nav > ul > li > ul li").forEach(function(parent) {
|
||||
parent.style.display = "none";
|
||||
});
|
||||
|
||||
//only current page (if it exists) should be opened
|
||||
var file = window.location.pathname.split("/").pop().replace(/\.html/, '');
|
||||
document.querySelectorAll("nav > ul > li > a").forEach(function(parent) {
|
||||
var href = parent.attributes.href.value.replace(/\.html/, '');
|
||||
if (file === href) {
|
||||
parent.parentNode.querySelectorAll("ul li").forEach(function(elem) {
|
||||
elem.style.display = "block";
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
hideAllButCurrent();
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
/*global document */
|
||||
(function() {
|
||||
var source = document.getElementsByClassName('prettyprint source linenums');
|
||||
var i = 0;
|
||||
var lineNumber = 0;
|
||||
var lineId;
|
||||
var lines;
|
||||
var totalLines;
|
||||
var anchorHash;
|
||||
|
||||
if (source && source[0]) {
|
||||
anchorHash = document.location.hash.substring(1);
|
||||
lines = source[0].getElementsByTagName('li');
|
||||
totalLines = lines.length;
|
||||
|
||||
for (; i < totalLines; i++) {
|
||||
lineNumber++;
|
||||
lineId = 'line' + lineNumber;
|
||||
lines[i].id = lineId;
|
||||
if (lineId === anchorHash) {
|
||||
lines[i].className += ' selected';
|
||||
}
|
||||
}
|
||||
}
|
||||
})();
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
function scrollToNavItem() {
|
||||
var path = window.location.href.split('/').pop().replace(/\.html/, '');
|
||||
document.querySelectorAll('nav a').forEach(function(link) {
|
||||
var href = link.attributes.href.value.replace(/\.html/, '');
|
||||
if (path === href) {
|
||||
link.scrollIntoView({block: 'center'});
|
||||
return;
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
scrollToNavItem();
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
//IE Fix, src: https://www.reddit.com/r/programminghorror/comments/6abmcr/nodelist_lacks_foreach_in_internet_explorer/
|
||||
if (typeof(NodeList.prototype.forEach)!==typeof(alert)){
|
||||
NodeList.prototype.forEach=Array.prototype.forEach;
|
||||
}
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
|
||||
/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
|
||||
(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
|
||||
[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c<i;++c){var j=f[c];if(/\\[bdsw]/i.test(j))a.push(j);else{var j=m(j),d;c+2<i&&"-"===f[c+1]?(d=m(f[c+2]),c+=2):d=j;b.push([j,d]);d<65||j>122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;c<b.length;++c)i=b[c],i[0]<=j[1]+1?j[1]=Math.max(j[1],i[1]):f.push(j=i);b=["["];o&&b.push("^");b.push.apply(b,a);for(c=0;c<
|
||||
f.length;++c)i=f[c],b.push(e(i[0])),i[1]>i[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c<b;++c){var j=f[c];j==="("?++i:"\\"===j.charAt(0)&&(j=+j.substring(1))&&j<=i&&(d[j]=-1)}for(c=1;c<d.length;++c)-1===d[c]&&(d[c]=++t);for(i=c=0;c<b;++c)j=f[c],j==="("?(++i,d[i]===void 0&&(f[c]="(?:")):"\\"===j.charAt(0)&&
|
||||
(j=+j.substring(1))&&j<=i&&(f[c]="\\"+d[i]);for(i=c=0;c<b;++c)"^"===f[c]&&"^"!==f[c+1]&&(f[c]="");if(a.ignoreCase&&s)for(c=0;c<b;++c)j=f[c],a=j.charAt(0),j.length>=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p<d;++p){var g=a[p];if(g.ignoreCase)l=!0;else if(/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){s=!0;l=!1;break}}for(var r=
|
||||
{b:8,t:9,n:10,v:11,f:12,r:13},n=[],p=0,d=a.length;p<d;++p){g=a[p];if(g.global||g.multiline)throw Error(""+g);n.push("(?:"+y(g)+")")}return RegExp(n.join("|"),l?"gi":"g")}function M(a){function m(a){switch(a.nodeType){case 1:if(e.test(a.className))break;for(var g=a.firstChild;g;g=g.nextSibling)m(g);g=a.nodeName;if("BR"===g||"LI"===g)h[s]="\n",t[s<<1]=y++,t[s++<<1|1]=a;break;case 3:case 4:g=a.nodeValue,g.length&&(g=p?g.replace(/\r\n?/g,"\n"):g.replace(/[\t\n\r ]+/g," "),h[s]=g,t[s<<1]=y,y+=g.length,
|
||||
t[s++<<1|1]=a)}}var e=/(?:^|\s)nocode(?:\s|$)/,h=[],y=0,t=[],s=0,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=document.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);m(a);return{a:h.join("").replace(/\n$/,""),c:t}}function B(a,m,e,h){m&&(a={a:m,d:a},e(a),h.push.apply(h,a.e))}function x(a,m){function e(a){for(var l=a.d,p=[l,"pln"],d=0,g=a.a.match(y)||[],r={},n=0,z=g.length;n<z;++n){var f=g[n],b=r[f],o=void 0,c;if(typeof b===
|
||||
"string")c=!1;else{var i=h[f.charAt(0)];if(i)o=f.match(i[1]),b=i[0];else{for(c=0;c<t;++c)if(i=m[c],o=f.match(i[1])){b=i[0];break}o||(b="pln")}if((c=b.length>=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
|
||||
l=[],p={},d=0,g=e.length;d<g;++d){var r=e[d],n=r[3];if(n)for(var k=n.length;--k>=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
|
||||
q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
|
||||
q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
|
||||
"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
|
||||
a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
|
||||
for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g<d.length;++g)e(d[g]);m===(m|0)&&d[0].setAttribute("value",
|
||||
m);var r=s.createElement("OL");r.className="linenums";for(var n=Math.max(0,m-1|0)||0,g=0,z=d.length;g<z;++g)l=d[g],l.className="L"+(g+n)%10,l.firstChild||l.appendChild(s.createTextNode("\xa0")),r.appendChild(l);a.appendChild(r)}function k(a,m){for(var e=m.length;--e>=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*</.test(m)?"default-markup":"default-code";return A[a]}function E(a){var m=
|
||||
a.g;try{var e=M(a.h),h=e.a;a.a=h;a.c=e.c;a.d=0;C(m,h)(a);var k=/\bMSIE\b/.test(navigator.userAgent),m=/\n/g,t=a.a,s=t.length,e=0,l=a.c,p=l.length,h=0,d=a.e,g=d.length,a=0;d[g]=s;var r,n;for(n=r=0;n<g;)d[n]!==d[n+2]?(d[r++]=d[n++],d[r++]=d[n++]):n+=2;g=r;for(n=r=0;n<g;){for(var z=d[n],f=d[n+1],b=n+2;b+2<=g&&d[b+1]===f;)b+=2;d[r++]=z;d[r++]=f;n=b}for(d.length=r;h<p;){var o=l[h+2]||s,c=d[a+2]||s,b=Math.min(o,c),i=l[h+1],j;if(i.nodeType!==1&&(j=t.substring(e,b))){k&&(j=j.replace(m,"\r"));i.nodeValue=
|
||||
j;var u=i.ownerDocument,v=u.createElement("SPAN");v.className=d[a+1];var x=i.parentNode;x.replaceChild(v,i);v.appendChild(i);e<o&&(l[h+1]=i=u.createTextNode(t.substring(b,o)),x.insertBefore(i,v.nextSibling))}e=b;e>=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
|
||||
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
|
||||
H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
|
||||
J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
|
||||
I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
|
||||
["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
|
||||
/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
|
||||
["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
|
||||
hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p<h.length&&l.now()<e;p++){var n=h[p],k=n.className;if(k.indexOf("prettyprint")>=0){var k=k.match(g),f,b;if(b=
|
||||
!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p<h.length?setTimeout(m,
|
||||
250):a&&a()}for(var e=[document.getElementsByTagName("pre"),document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],h=[],k=0;k<e.length;++k)for(var t=0,s=e[k].length;t<s;++t)h.push(e[k][t]);var e=q,l=Date;l.now||(l={now:function(){return+new Date}});var p=0,d,g=/\blang(?:uage)?-([\w.]+)(?!\S)/;m()};window.PR={createSimpleLexer:x,registerLangHandler:k,sourceDecorator:u,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",
|
||||
PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ"}})();
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
|
||||
var searchAttr = 'data-search-mode';
|
||||
function contains(a,m){
|
||||
return (a.textContent || a.innerText || "").toUpperCase().indexOf(m) !== -1;
|
||||
};
|
||||
|
||||
//on search
|
||||
document.getElementById("nav-search").addEventListener("keyup", function(event) {
|
||||
var search = this.value.toUpperCase();
|
||||
|
||||
if (!search) {
|
||||
//no search, show all results
|
||||
document.documentElement.removeAttribute(searchAttr);
|
||||
|
||||
document.querySelectorAll("nav > ul > li:not(.level-hide)").forEach(function(elem) {
|
||||
elem.style.display = "block";
|
||||
});
|
||||
|
||||
if (typeof hideAllButCurrent === "function"){
|
||||
//let's do what ever collapse wants to do
|
||||
hideAllButCurrent();
|
||||
} else {
|
||||
//menu by default should be opened
|
||||
document.querySelectorAll("nav > ul > li > ul li").forEach(function(elem) {
|
||||
elem.style.display = "block";
|
||||
});
|
||||
}
|
||||
} else {
|
||||
//we are searching
|
||||
document.documentElement.setAttribute(searchAttr, '');
|
||||
|
||||
//show all parents
|
||||
document.querySelectorAll("nav > ul > li").forEach(function(elem) {
|
||||
elem.style.display = "block";
|
||||
});
|
||||
//hide all results
|
||||
document.querySelectorAll("nav > ul > li > ul li").forEach(function(elem) {
|
||||
elem.style.display = "none";
|
||||
});
|
||||
//show results matching filter
|
||||
document.querySelectorAll("nav > ul > li > ul a").forEach(function(elem) {
|
||||
if (!contains(elem.parentNode, search)) {
|
||||
return;
|
||||
}
|
||||
elem.parentNode.style.display = "block";
|
||||
});
|
||||
//hide parents without children
|
||||
document.querySelectorAll("nav > ul > li").forEach(function(parent) {
|
||||
var countSearchA = 0;
|
||||
parent.querySelectorAll("a").forEach(function(elem) {
|
||||
if (contains(elem, search)) {
|
||||
countSearchA++;
|
||||
}
|
||||
});
|
||||
|
||||
var countUl = 0;
|
||||
var countUlVisible = 0;
|
||||
parent.querySelectorAll("ul").forEach(function(ulP) {
|
||||
// count all elements that match the search
|
||||
if (contains(ulP, search)) {
|
||||
countUl++;
|
||||
}
|
||||
|
||||
// count all visible elements
|
||||
var children = ulP.children
|
||||
for (i=0; i<children.length; i++) {
|
||||
var elem = children[i];
|
||||
if (elem.style.display != "none") {
|
||||
countUlVisible++;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
if (countSearchA == 0 && countUl === 0){
|
||||
//has no child at all and does not contain text
|
||||
parent.style.display = "none";
|
||||
} else if(countSearchA == 0 && countUlVisible == 0){
|
||||
//has no visible child and does not contain text
|
||||
parent.style.display = "none";
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
|
|
@ -0,0 +1,765 @@
|
|||
* {
|
||||
box-sizing: border-box
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
body {
|
||||
color: #4d4e53;
|
||||
background-color: white;
|
||||
margin: 0 auto;
|
||||
padding: 0 20px;
|
||||
font-family: 'Helvetica Neue', Helvetica, sans-serif;
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
a,
|
||||
a:active {
|
||||
color: #606;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
article a {
|
||||
border-bottom: 1px solid #ddd;
|
||||
}
|
||||
|
||||
article a:hover, article a:active {
|
||||
border-bottom-color: #222;
|
||||
}
|
||||
|
||||
article .description a {
|
||||
word-break: break-word;
|
||||
}
|
||||
|
||||
p, ul, ol, blockquote {
|
||||
margin-bottom: 1em;
|
||||
line-height: 160%;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-family: 'Montserrat', sans-serif;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
color: #000;
|
||||
font-weight: 400;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-weight: 300;
|
||||
font-size: 48px;
|
||||
margin: 1em 0 .5em;
|
||||
}
|
||||
|
||||
h1.page-title {
|
||||
font-size: 48px;
|
||||
margin: 1em 30px;
|
||||
line-height: 100%;
|
||||
word-wrap: break-word;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 24px;
|
||||
margin: 1.5em 0 .3em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 24px;
|
||||
margin: 1.2em 0 .3em;
|
||||
}
|
||||
|
||||
h4 {
|
||||
font-size: 18px;
|
||||
margin: 1em 0 .2em;
|
||||
color: #4d4e53;
|
||||
}
|
||||
|
||||
h4.name {
|
||||
color: #fff;
|
||||
background: #6d426d;
|
||||
box-shadow: 0 .25em .5em #d3d3d3;
|
||||
border-top: 1px solid #d3d3d3;
|
||||
border-bottom: 1px solid #d3d3d3;
|
||||
margin: 1.5em 0 0.5em;
|
||||
padding: .75em 0 .75em 10px;
|
||||
}
|
||||
|
||||
h4.name a {
|
||||
color: #fc83ff;
|
||||
}
|
||||
|
||||
h4.name a:hover {
|
||||
border-bottom-color: #fc83ff;
|
||||
}
|
||||
|
||||
h5, .container-overview .subsection-title {
|
||||
font-size: 120%;
|
||||
letter-spacing: -0.01em;
|
||||
margin: 8px 0 3px 0;
|
||||
}
|
||||
|
||||
h6 {
|
||||
font-size: 100%;
|
||||
letter-spacing: -0.01em;
|
||||
margin: 6px 0 3px 0;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.usertext h1 {
|
||||
font-family: "Source Sans Pro";
|
||||
font-size: 24px;
|
||||
margin: 2.5em 0 1em;
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
.usertext h2 {
|
||||
font-family: "Source Sans Pro";
|
||||
font-size: 18px;
|
||||
margin: 2em 0 0.5em;
|
||||
font-weight: 400;
|
||||
|
||||
}
|
||||
|
||||
.usertext h3 {
|
||||
font-family: "Source Sans Pro";
|
||||
font-size: 15px;
|
||||
margin: 1.5em 0 0;
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
.usertext h4 {
|
||||
font-family: "Source Sans Pro";
|
||||
font-size: 14px;
|
||||
margin: 0 0 0;
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
.usertext h5 {
|
||||
font-size: 12px;
|
||||
margin: 1em 0 0;
|
||||
font-weight: normal;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
.usertext h6 {
|
||||
font-size: 11px;
|
||||
margin: 1em 0 0;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
|
||||
tt, code, kbd, samp {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
background: #f4f4f4;
|
||||
padding: 1px 5px;
|
||||
}
|
||||
|
||||
.class-description {
|
||||
font-size: 130%;
|
||||
line-height: 140%;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.class-description:empty {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
#main {
|
||||
float: right;
|
||||
width: calc(100% - 240px);
|
||||
}
|
||||
|
||||
header {
|
||||
display: block
|
||||
}
|
||||
|
||||
section {
|
||||
display: block;
|
||||
background-color: #fff;
|
||||
padding: 0 0 0 30px;
|
||||
}
|
||||
|
||||
.variation {
|
||||
display: none
|
||||
}
|
||||
|
||||
.signature-attributes {
|
||||
font-size: 60%;
|
||||
color: #eee;
|
||||
font-style: italic;
|
||||
font-weight: lighter;
|
||||
}
|
||||
|
||||
nav {
|
||||
float: left;
|
||||
display: block;
|
||||
width: 250px;
|
||||
background: #fff;
|
||||
overflow: auto;
|
||||
position: fixed;
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
nav #nav-search{
|
||||
width: 210px;
|
||||
height: 30px;
|
||||
padding: 5px 10px;
|
||||
font-size: 12px;
|
||||
line-height: 1.5;
|
||||
border-radius: 3px;
|
||||
margin-right: 20px;
|
||||
margin-top: 20px;
|
||||
}
|
||||
|
||||
nav.wrap a{
|
||||
word-wrap: break-word;
|
||||
}
|
||||
|
||||
nav h3 {
|
||||
margin-top: 12px;
|
||||
font-size: 13px;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 1px;
|
||||
font-weight: 700;
|
||||
line-height: 24px;
|
||||
margin: 15px 0 10px;
|
||||
padding: 0;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
nav ul {
|
||||
font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
|
||||
font-size: 100%;
|
||||
line-height: 17px;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
nav ul a,
|
||||
nav ul a:active {
|
||||
font-family: 'Montserrat', sans-serif;
|
||||
line-height: 18px;
|
||||
padding: 0;
|
||||
display: block;
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
nav a:hover,
|
||||
nav a:active {
|
||||
color: #606;
|
||||
}
|
||||
|
||||
nav > ul {
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
nav > ul > li > a {
|
||||
color: #606;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
nav ul ul a {
|
||||
color: hsl(207, 1%, 60%);
|
||||
border-left: 1px solid hsl(207, 10%, 86%);
|
||||
}
|
||||
|
||||
nav ul ul a,
|
||||
nav ul ul a:active {
|
||||
padding-left: 20px
|
||||
}
|
||||
|
||||
nav h2 {
|
||||
font-size: 13px;
|
||||
margin: 10px 0 0 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav > h2 > a {
|
||||
margin: 10px 0 -10px;
|
||||
color: #606 !important;
|
||||
}
|
||||
|
||||
footer {
|
||||
color: hsl(0, 0%, 28%);
|
||||
margin-left: 250px;
|
||||
display: block;
|
||||
padding: 15px;
|
||||
font-style: italic;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
.ancestors {
|
||||
color: #999
|
||||
}
|
||||
|
||||
.ancestors a {
|
||||
color: #999 !important;
|
||||
}
|
||||
|
||||
.clear {
|
||||
clear: both
|
||||
}
|
||||
|
||||
.important {
|
||||
font-weight: bold;
|
||||
color: #950B02;
|
||||
}
|
||||
|
||||
.yes-def {
|
||||
text-indent: -1000px
|
||||
}
|
||||
|
||||
.type-signature {
|
||||
color: #CA79CA
|
||||
}
|
||||
|
||||
.type-signature:last-child {
|
||||
color: #eee;
|
||||
}
|
||||
|
||||
.name, .signature {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace
|
||||
}
|
||||
|
||||
.signature {
|
||||
color: #fc83ff;
|
||||
}
|
||||
|
||||
.details {
|
||||
margin-top: 6px;
|
||||
border-left: 2px solid #DDD;
|
||||
line-height: 20px;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
.details dt {
|
||||
width: auto;
|
||||
float: left;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
.details dd {
|
||||
margin-left: 70px;
|
||||
margin-top: 6px;
|
||||
margin-bottom: 6px;
|
||||
}
|
||||
|
||||
.details ul {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
.details ul {
|
||||
list-style-type: none
|
||||
}
|
||||
|
||||
.details pre.prettyprint {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
.details .object-value {
|
||||
padding-top: 0
|
||||
}
|
||||
|
||||
.description {
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.code-caption {
|
||||
font-style: italic;
|
||||
font-size: 107%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.prettyprint {
|
||||
font-size: 14px;
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
.prettyprint.source {
|
||||
width: inherit;
|
||||
line-height: 18px;
|
||||
display: block;
|
||||
background-color: #0d152a;
|
||||
color: #aeaeae;
|
||||
}
|
||||
|
||||
.prettyprint code {
|
||||
line-height: 18px;
|
||||
display: block;
|
||||
background-color: #0d152a;
|
||||
color: #4D4E53;
|
||||
}
|
||||
|
||||
.prettyprint > code {
|
||||
padding: 15px;
|
||||
}
|
||||
|
||||
.prettyprint .linenums code {
|
||||
padding: 0 15px
|
||||
}
|
||||
|
||||
.prettyprint .linenums li:first-of-type code {
|
||||
padding-top: 15px
|
||||
}
|
||||
|
||||
.prettyprint code span.line {
|
||||
display: inline-block
|
||||
}
|
||||
|
||||
.prettyprint.linenums {
|
||||
padding-left: 70px;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
.prettyprint.linenums ol {
|
||||
padding-left: 0
|
||||
}
|
||||
|
||||
.prettyprint.linenums li {
|
||||
border-left: 3px #34446B solid;
|
||||
}
|
||||
|
||||
.prettyprint.linenums li.selected, .prettyprint.linenums li.selected * {
|
||||
background-color: #34446B;
|
||||
}
|
||||
|
||||
.prettyprint.linenums li * {
|
||||
-webkit-user-select: text;
|
||||
-moz-user-select: text;
|
||||
-ms-user-select: text;
|
||||
user-select: text;
|
||||
}
|
||||
|
||||
.prettyprint.linenums li code:empty:after {
|
||||
content:"";
|
||||
display:inline-block;
|
||||
width:0px;
|
||||
}
|
||||
|
||||
table {
|
||||
border-spacing: 0;
|
||||
border: 1px solid #ddd;
|
||||
border-collapse: collapse;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px rgba(0,0,0,0.1);
|
||||
width: 100%;
|
||||
font-size: 14px;
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
td, th {
|
||||
margin: 0px;
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
padding: 10px;
|
||||
display: table-cell;
|
||||
}
|
||||
|
||||
thead tr, thead tr {
|
||||
background-color: #fff;
|
||||
font-weight: bold;
|
||||
border-bottom: 1px solid #ddd;
|
||||
}
|
||||
|
||||
.params .type {
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.params code {
|
||||
white-space: pre;
|
||||
}
|
||||
|
||||
.params td, .params .name, .props .name, .name code {
|
||||
color: #4D4E53;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.params td {
|
||||
border-top: 1px solid #eee
|
||||
}
|
||||
|
||||
.params td.description > p:first-child, .props td.description > p:first-child {
|
||||
margin-top: 0;
|
||||
padding-top: 0;
|
||||
}
|
||||
|
||||
.params td.description > p:last-child, .props td.description > p:last-child {
|
||||
margin-bottom: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
span.param-type, .params td .param-type, .param-type dd {
|
||||
color: #606;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace
|
||||
}
|
||||
|
||||
.param-type dt, .param-type dd {
|
||||
display: inline-block
|
||||
}
|
||||
|
||||
.param-type {
|
||||
margin: 14px 0;
|
||||
}
|
||||
|
||||
.disabled {
|
||||
color: #454545
|
||||
}
|
||||
|
||||
/* navicon button */
|
||||
.navicon-button {
|
||||
display: none;
|
||||
position: relative;
|
||||
padding: 2.0625rem 1.5rem;
|
||||
transition: 0.25s;
|
||||
cursor: pointer;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
user-select: none;
|
||||
opacity: .8;
|
||||
}
|
||||
.navicon-button .navicon:before, .navicon-button .navicon:after {
|
||||
transition: 0.25s;
|
||||
}
|
||||
.navicon-button:hover {
|
||||
transition: 0.5s;
|
||||
opacity: 1;
|
||||
}
|
||||
.navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after {
|
||||
transition: 0.25s;
|
||||
}
|
||||
.navicon-button:hover .navicon:before {
|
||||
top: .825rem;
|
||||
}
|
||||
.navicon-button:hover .navicon:after {
|
||||
top: -.825rem;
|
||||
}
|
||||
|
||||
/* navicon */
|
||||
.navicon {
|
||||
position: relative;
|
||||
width: 2.5em;
|
||||
height: .3125rem;
|
||||
background: #000;
|
||||
transition: 0.3s;
|
||||
border-radius: 2.5rem;
|
||||
}
|
||||
.navicon:before, .navicon:after {
|
||||
display: block;
|
||||
content: "";
|
||||
height: .3125rem;
|
||||
width: 2.5rem;
|
||||
background: #000;
|
||||
position: absolute;
|
||||
z-index: -1;
|
||||
transition: 0.3s 0.25s;
|
||||
border-radius: 1rem;
|
||||
}
|
||||
.navicon:before {
|
||||
top: .625rem;
|
||||
}
|
||||
.navicon:after {
|
||||
top: -.625rem;
|
||||
}
|
||||
|
||||
/* open */
|
||||
.nav-trigger:checked + label:not(.steps) .navicon:before,
|
||||
.nav-trigger:checked + label:not(.steps) .navicon:after {
|
||||
top: 0 !important;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label .navicon:before,
|
||||
.nav-trigger:checked + label .navicon:after {
|
||||
transition: 0.5s;
|
||||
}
|
||||
|
||||
/* Minus */
|
||||
.nav-trigger:checked + label {
|
||||
-webkit-transform: scale(0.75);
|
||||
transform: scale(0.75);
|
||||
}
|
||||
|
||||
/* × and + */
|
||||
.nav-trigger:checked + label.plus .navicon,
|
||||
.nav-trigger:checked + label.x .navicon {
|
||||
background: transparent;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus .navicon:before,
|
||||
.nav-trigger:checked + label.x .navicon:before {
|
||||
-webkit-transform: rotate(-45deg);
|
||||
transform: rotate(-45deg);
|
||||
background: #FFF;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus .navicon:after,
|
||||
.nav-trigger:checked + label.x .navicon:after {
|
||||
-webkit-transform: rotate(45deg);
|
||||
transform: rotate(45deg);
|
||||
background: #FFF;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus {
|
||||
-webkit-transform: scale(0.75) rotate(45deg);
|
||||
transform: scale(0.75) rotate(45deg);
|
||||
}
|
||||
|
||||
.nav-trigger:checked ~ nav {
|
||||
left: 0 !important;
|
||||
}
|
||||
|
||||
.nav-trigger:checked ~ .overlay {
|
||||
display: block;
|
||||
}
|
||||
|
||||
.nav-trigger {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
clip: rect(0, 0, 0, 0);
|
||||
}
|
||||
|
||||
.overlay {
|
||||
display: none;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
background: hsla(0, 0%, 0%, 0.5);
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
/* nav level */
|
||||
.level-hide {
|
||||
display: none;
|
||||
}
|
||||
html[data-search-mode] .level-hide {
|
||||
display: block;
|
||||
}
|
||||
|
||||
|
||||
@media only screen and (max-width: 680px) {
|
||||
body {
|
||||
overflow-x: hidden;
|
||||
}
|
||||
|
||||
nav {
|
||||
background: #FFF;
|
||||
width: 250px;
|
||||
height: 100%;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
left: -250px;
|
||||
z-index: 3;
|
||||
padding: 0 10px;
|
||||
transition: left 0.2s;
|
||||
}
|
||||
|
||||
.navicon-button {
|
||||
display: inline-block;
|
||||
position: fixed;
|
||||
top: 1.5em;
|
||||
right: 0;
|
||||
z-index: 2;
|
||||
}
|
||||
|
||||
#main {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
#main h1.page-title {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
#main section {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
footer {
|
||||
margin-left: 0;
|
||||
}
|
||||
}
|
||||
|
||||
/** Add a '#' to static members */
|
||||
[data-type="member"] a::before {
|
||||
content: '#';
|
||||
display: inline-block;
|
||||
margin-left: -14px;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
#disqus_thread{
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Montserrat';
|
||||
font-style: normal;
|
||||
font-weight: 400;
|
||||
src: url('../fonts/Montserrat/Montserrat-Regular.eot'); /* IE9 Compat Modes */
|
||||
src: url('../fonts/Montserrat/Montserrat-Regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
|
||||
url('../fonts/Montserrat/Montserrat-Regular.woff2') format('woff2'), /* Super Modern Browsers */
|
||||
url('../fonts/Montserrat/Montserrat-Regular.woff') format('woff'), /* Pretty Modern Browsers */
|
||||
url('../fonts/Montserrat/Montserrat-Regular.ttf') format('truetype'); /* Safari, Android, iOS */
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Montserrat';
|
||||
font-style: normal;
|
||||
font-weight: 700;
|
||||
src: url('../fonts/Montserrat/Montserrat-Bold.eot'); /* IE9 Compat Modes */
|
||||
src: url('../fonts/Montserrat/Montserrat-Bold.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
|
||||
url('../fonts/Montserrat/Montserrat-Bold.woff2') format('woff2'), /* Super Modern Browsers */
|
||||
url('../fonts/Montserrat/Montserrat-Bold.woff') format('woff'), /* Pretty Modern Browsers */
|
||||
url('../fonts/Montserrat/Montserrat-Bold.ttf') format('truetype'); /* Safari, Android, iOS */
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Source Sans Pro';
|
||||
src: url('../fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot');
|
||||
src: url('../fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot?#iefix') format('embedded-opentype'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2') format('woff2'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff') format('woff'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf') format('truetype'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg#source_sans_proregular') format('svg');
|
||||
font-weight: 400;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Source Sans Pro';
|
||||
src: url('../fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot');
|
||||
src: url('../fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot?#iefix') format('embedded-opentype'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2') format('woff2'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff') format('woff'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf') format('truetype'),
|
||||
url('../fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg#source_sans_prolight') format('svg');
|
||||
font-weight: 300;
|
||||
font-style: normal;
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
/*
|
||||
* This file contains specific fixes and changes from some parts of the theme.
|
||||
*
|
||||
* This file is part of Prims and not of the theme!
|
||||
*/
|
||||
|
||||
pre.prettyprint > ol.linenums {
|
||||
/* I don't know why but this fixes the extra little scroll bar some code block have. */
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.description > *:not(pre) {
|
||||
/*
|
||||
* Text will span across the whole width of the page by default.
|
||||
* This makes is really hard to read, so this will put a max width to the elements (except code block) of all
|
||||
* description blocks, so text breaks after some width.
|
||||
*/
|
||||
max-width: 60em;
|
||||
}
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
.pln {
|
||||
color: #ddd;
|
||||
}
|
||||
|
||||
/* string content */
|
||||
.str {
|
||||
color: #61ce3c;
|
||||
}
|
||||
|
||||
/* a keyword */
|
||||
.kwd {
|
||||
color: #fbde2d;
|
||||
}
|
||||
|
||||
/* a comment */
|
||||
.com {
|
||||
color: #aeaeae;
|
||||
}
|
||||
|
||||
/* a type name */
|
||||
.typ {
|
||||
color: #8da6ce;
|
||||
}
|
||||
|
||||
/* a literal value */
|
||||
.lit {
|
||||
color: #fbde2d;
|
||||
}
|
||||
|
||||
/* punctuation */
|
||||
.pun {
|
||||
color: #ddd;
|
||||
}
|
||||
|
||||
/* lisp open bracket */
|
||||
.opn {
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
/* lisp close bracket */
|
||||
.clo {
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
/* a markup tag name */
|
||||
.tag {
|
||||
color: #8da6ce;
|
||||
}
|
||||
|
||||
/* a markup attribute name */
|
||||
.atn {
|
||||
color: #fbde2d;
|
||||
}
|
||||
|
||||
/* a markup attribute value */
|
||||
.atv {
|
||||
color: #ddd;
|
||||
}
|
||||
|
||||
/* a declaration */
|
||||
.dec {
|
||||
color: #EF5050;
|
||||
}
|
||||
|
||||
/* a variable name */
|
||||
.var {
|
||||
color: #c82829;
|
||||
}
|
||||
|
||||
/* a function name */
|
||||
.fun {
|
||||
color: #4271ae;
|
||||
}
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
131
extending.html
131
extending.html
|
|
@ -93,42 +93,9 @@ ol.indent {
|
|||
'tokenname': [ /regex0/, /regex1/, { pattern: /regex2/ } ]
|
||||
...</code></pre>
|
||||
|
||||
<section>
|
||||
<h1><code>Prism.languages.insertBefore(inside, before, insert<span class="optional" title="Default value: Prism.languages">, root</span>)</code></h1>
|
||||
<h2 id="helper-functions">Helper functions</h2>
|
||||
|
||||
<p>This is a helper method to ease modifying existing languages. For example, the CSS language definition not only defines CSS highlighting for CSS documents,
|
||||
but also needs to define highlighting for CSS embedded in HTML through <code class="language-markup"><style></code> elements. To do this, it needs to modify
|
||||
<code>Prism.languages.markup</code> and add the appropriate tokens. However, <code>Prism.languages.markup</code>
|
||||
is a regular JavaScript object literal, so if you do this:</p>
|
||||
|
||||
<pre><code >Prism.languages.markup.style = {
|
||||
/* tokens */
|
||||
};</code></pre>
|
||||
|
||||
<p>then the <code>style</code> token will be added (and processed) at the end. <code>Prism.languages.insertBefore</code> allows you to insert
|
||||
tokens <em>before</em> existing tokens. For the CSS example above, you would use it like this:</p>
|
||||
|
||||
<pre><code>Prism.languages.insertBefore('markup', 'cdata', {
|
||||
'style': {
|
||||
/* tokens */
|
||||
}
|
||||
});</code></pre>
|
||||
|
||||
<h2>Parameters</h2>
|
||||
<dl>
|
||||
<dt>inside</dt>
|
||||
<dd>The property of <code>root</code> that contains the object to be modified.</dd>
|
||||
|
||||
<dt>before</dt>
|
||||
<dd>Key to insert before (String)</dd>
|
||||
|
||||
<dt>insert</dt>
|
||||
<dd>An object containing the key-value pairs to be inserted</dd>
|
||||
|
||||
<dt>root</dt>
|
||||
<dd>The root object, i.e. the object that contains the object that will be modified. Optional, default value is <code>Prism.languages</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<p>Prism also provides some useful function for creating and modifying language definitions. <a href="docs/Prism.languages.html#.insertBefore"><code>Prism.languages.insertBefore</code></a> can be used to modify existing languages definitions. <a href="docs/Prism.languages.html#.extend"><code>Prism.languages.extend</code></a> is useful for when your language is very similar to another existing language.</p>
|
||||
</section>
|
||||
|
||||
<section id="creating-a-new-language-definition" class="language-none">
|
||||
|
|
@ -397,99 +364,7 @@ loader.load(id => {
|
|||
<section id="api">
|
||||
<h1>API documentation</h1>
|
||||
|
||||
<section id="highlight-all">
|
||||
<h1><code>Prism.highlightAll(async, callback)</code></h1>
|
||||
<p>This is the most high-level function in Prism’s API. It fetches all the elements that have a <code>.language-xxxx</code> class
|
||||
and then calls <code>Prism.highlightElement()</code> on each one of them.</p>
|
||||
|
||||
<h2>Parameters</h2>
|
||||
<dl>
|
||||
<dt>async</dt>
|
||||
<dd>
|
||||
Whether to use Web Workers to improve performance and avoid blocking the UI when highlighting very large
|
||||
chunks of code. False by default
|
||||
(<a href="faq.html#why-is-asynchronous-highlighting-disabled-by-default">why?</a>).<br />
|
||||
Note: All language definitions required to highlight the code must be included in the main <code>prism.js</code>
|
||||
file for the async highlighting to work. You can build your own bundle on the <a href="download.html">Download page</a>.
|
||||
</dd>
|
||||
|
||||
<dt>callback</dt>
|
||||
<dd>
|
||||
An optional callback to be invoked after the highlighting is done. Mostly useful when <code>async</code>
|
||||
is true, since in that case, the highlighting is done asynchronously.
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
<section id="highlight-all-under">
|
||||
<h1><code>Prism.highlightAllUnder(element, async, callback)</code></h1>
|
||||
<p>Fetches all the descendants of <code>element</code> that have a <code>.language-xxxx</code> class
|
||||
and then calls <code>Prism.highlightElement()</code> on each one of them.</p>
|
||||
|
||||
<h2>Parameters</h2>
|
||||
<dl>
|
||||
<dt>element</dt>
|
||||
<dd>The root element, whose descendants that have a <code>.language-xxxx</code> class will be highlighted.</dd>
|
||||
|
||||
<dt>async</dt>
|
||||
<dd>Same as in <a href="#highlight-all"><code>Prism.highlightAll()</code></a></dd>
|
||||
|
||||
<dt>callback</dt>
|
||||
<dd>Same as in <a href="#highlight-all"><code>Prism.highlightAll()</code></a></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
<section id="highlight-element">
|
||||
<h1><code>Prism.highlightElement(element, async, callback)</code></h1>
|
||||
<p>Highlights the code inside a single element.</p>
|
||||
|
||||
<h2>Parameters</h2>
|
||||
<dl>
|
||||
<dt>element</dt>
|
||||
<dd>The element containing the code. It must have a class of <code>language-xxxx</code> to be processed, where <code>xxxx</code> is a valid language identifier.</dd>
|
||||
|
||||
<dt>async</dt>
|
||||
<dd>Same as in <a href="#highlight-all"><code>Prism.highlightAll()</code></a></dd>
|
||||
<dt>callback</dt>
|
||||
<dd>Same as in <a href="#highlight-all"><code>Prism.highlightAll()</code></a></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
<section id="highlight">
|
||||
<h1><code>Prism.highlight(text, grammar, language)</code></h1>
|
||||
<p>Low-level function, only use if you know what you’re doing.
|
||||
It accepts a string of text as input, the language definitions to use, and the name of the language, and returns a string with the HTML produced.</p>
|
||||
|
||||
<h2>Parameters</h2>
|
||||
<dl>
|
||||
<dt>text</dt>
|
||||
<dd>A string with the code to be highlighted.</dd>
|
||||
<dt>grammar</dt>
|
||||
<dd>An object containing the tokens to use. Usually a language definition like <code>Prism.languages.markup</code></dd>
|
||||
<dt>language</dt>
|
||||
<dd>The name of the language definition passed to <code>grammar</code>. E.g. <code>markup</code> or <code>javascript</code></dd>
|
||||
</dl>
|
||||
|
||||
<h2>Returns</h2>
|
||||
<p>The highlighted HTML</p>
|
||||
</section>
|
||||
|
||||
<section id="tokenize">
|
||||
<h1><code>Prism.tokenize(text, grammar)</code></h1>
|
||||
<p>This is the heart of Prism, and the most low-level function you can use. It accepts a string of text as input and the language definitions to use, and returns an array with the tokenized code.
|
||||
When the language definition includes nested tokens, the function is called recursively on each of these tokens. This method could be useful in other contexts as well, as a very crude parser.</p>
|
||||
|
||||
<h2>Parameters</h2>
|
||||
<dl>
|
||||
<dt>text</dt>
|
||||
<dd>A string with the code to be highlighted.</dd>
|
||||
<dt>grammar</dt>
|
||||
<dd>An object containing the tokens to use. Usually a language definition like <code>Prism.languages.markup</code></dd>
|
||||
</dl>
|
||||
|
||||
<h2>Returns</h2>
|
||||
<p>An array of strings, tokens (class <code>Prism.Token</code>) and other arrays.</p>
|
||||
</section>
|
||||
<p>All public and stable parts of <a href="docs/">Prism's API are documented here</a>.</p>
|
||||
</section>
|
||||
|
||||
<footer data-src="templates/footer.html" data-type="text/html"></footer>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,62 @@
|
|||
"use strict";
|
||||
|
||||
const { src, dest, series } = require('gulp');
|
||||
const replace = require('gulp-replace');
|
||||
const jsdoc = require('gulp-jsdoc3');
|
||||
const pump = require('pump');
|
||||
const del = require('del');
|
||||
|
||||
const jsDoc = {
|
||||
config: '../.jsdoc.json',
|
||||
readme: 'README.md',
|
||||
files: ['components/prism-core.js'],
|
||||
junk: ['docs/fonts/Source-Sans-Pro', 'docs/**/Apache-License-2.0.txt']
|
||||
};
|
||||
|
||||
|
||||
function docsClean() {
|
||||
return del([
|
||||
// everything in the docs folder
|
||||
'docs/**/*',
|
||||
// except for our CSS overwrites
|
||||
'!docs/styles',
|
||||
'!docs/styles/overwrites.css',
|
||||
]);
|
||||
}
|
||||
|
||||
function docsCreate(cb) {
|
||||
var config = require(jsDoc.config);
|
||||
var files = [jsDoc.readme].concat(jsDoc.files);
|
||||
src(files, { read: false }).pipe(jsdoc(config, cb));
|
||||
}
|
||||
|
||||
function docsAddFavicon(cb) {
|
||||
return pump([
|
||||
src('docs/*.html'),
|
||||
replace(
|
||||
/\s*<\/head>/,
|
||||
'\n <link rel="icon" type="image/png" href="/favicon.png"/>$&'
|
||||
),
|
||||
dest('docs/')
|
||||
], cb);
|
||||
}
|
||||
|
||||
function docsRemoveExcessFiles() {
|
||||
return del(jsDoc.junk);
|
||||
}
|
||||
|
||||
const docs = series(docsClean, docsCreate, docsRemoveExcessFiles, docsAddFavicon);
|
||||
|
||||
module.exports = {
|
||||
docs,
|
||||
handlers: {
|
||||
jsdocCommentFound(comment) {
|
||||
// This is a hack.
|
||||
// JSDoc doesn't support TS' type import syntax (e.g. `@type {import("./my-file.js").Type}`) and throws an
|
||||
// error if used. So we just replace the "function" with some literal that JSDoc will interpret as a
|
||||
// namespace. Not pretty but it works.
|
||||
comment.comment = comment.comment
|
||||
.replace(/\bimport\s*\(\s*(?:"(?:[^"\r\n\\]|\\.)*"|'(?:[^'\r\n\\]|\\.)*')\s*\)/g, '__dyn_import__')
|
||||
}
|
||||
}
|
||||
};
|
||||
|
|
@ -13,6 +13,7 @@ const fs = require('fs');
|
|||
|
||||
const paths = require('./paths');
|
||||
const { changes, linkify } = require('./changelog');
|
||||
const { docs } = require('./docs');
|
||||
|
||||
|
||||
const componentsPromise = new Promise((resolve, reject) => {
|
||||
|
|
@ -202,7 +203,7 @@ async function languagePlugins() {
|
|||
}
|
||||
}));
|
||||
|
||||
const rejectedTasks = taskResults.filter(/** @return {r is {status: 'rejected', reason: any}} */ r => r.status === 'rejected');
|
||||
const rejectedTasks = taskResults.filter(/** @returns {r is {status: 'rejected', reason: any}} */ r => r.status === 'rejected');
|
||||
if (rejectedTasks.length > 0) {
|
||||
throw rejectedTasks.map(r => r.reason);
|
||||
}
|
||||
|
|
@ -214,7 +215,7 @@ const plugins = series(languagePlugins, minifyPlugins);
|
|||
|
||||
module.exports = {
|
||||
watch: watchComponentsAndPlugins,
|
||||
default: parallel(components, plugins, componentsJsonToJs, build),
|
||||
default: series(parallel(components, plugins, componentsJsonToJs, build), docs),
|
||||
linkify,
|
||||
changes
|
||||
};
|
||||
|
|
|
|||
|
|
@ -4,6 +4,41 @@
|
|||
"lockfileVersion": 1,
|
||||
"requires": true,
|
||||
"dependencies": {
|
||||
"@babel/parser": {
|
||||
"version": "7.10.3",
|
||||
"resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.10.3.tgz",
|
||||
"integrity": "sha512-oJtNJCMFdIMwXGmx+KxuaD7i3b8uS7TTFYW/FNG2BT8m+fmGHoiPYoH0Pe3gya07WuFmM5FCDIr1x0irkD/hyA==",
|
||||
"dev": true
|
||||
},
|
||||
"@types/events": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/@types/events/-/events-3.0.0.tgz",
|
||||
"integrity": "sha512-EaObqwIvayI5a8dCzhFrjKzVwKLxjoG9T6Ppd5CEo07LRKfQ8Yokw54r5+Wq7FaBQ+yXRvQAYPrHwya1/UFt9g==",
|
||||
"dev": true
|
||||
},
|
||||
"@types/glob": {
|
||||
"version": "7.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.1.1.tgz",
|
||||
"integrity": "sha512-1Bh06cbWJUHMC97acuD6UMG29nMt0Aqz1vF3guLfG+kHHJhy3AyohZFFxYk2f7Q1SQIrNwvncxAE0N/9s70F2w==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@types/events": "*",
|
||||
"@types/minimatch": "*",
|
||||
"@types/node": "*"
|
||||
}
|
||||
},
|
||||
"@types/minimatch": {
|
||||
"version": "3.0.3",
|
||||
"resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.3.tgz",
|
||||
"integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==",
|
||||
"dev": true
|
||||
},
|
||||
"@types/node": {
|
||||
"version": "12.0.2",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-12.0.2.tgz",
|
||||
"integrity": "sha512-5tabW/i+9mhrfEOUcLDu2xBPsHJ+X5Orqy9FKpale3SjDA17j5AEpYq5vfy3oAeAHGcvANRCO3NV3d2D6q3NiA==",
|
||||
"dev": true
|
||||
},
|
||||
"abab": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/abab/-/abab-2.0.0.tgz",
|
||||
|
|
@ -225,6 +260,21 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"array-union": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/array-union/-/array-union-1.0.2.tgz",
|
||||
"integrity": "sha1-mjRBDk9OPaI96jdb5b5w8kd47Dk=",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"array-uniq": "^1.0.1"
|
||||
}
|
||||
},
|
||||
"array-uniq": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/array-uniq/-/array-uniq-1.0.3.tgz",
|
||||
"integrity": "sha1-r2rId6Jcx/dOBYiUdThY39sk/bY=",
|
||||
"dev": true
|
||||
},
|
||||
"array-unique": {
|
||||
"version": "0.3.2",
|
||||
"resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz",
|
||||
|
|
@ -402,6 +452,15 @@
|
|||
"tweetnacl": "^0.14.3"
|
||||
}
|
||||
},
|
||||
"beeper": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/beeper/-/beeper-2.0.0.tgz",
|
||||
"integrity": "sha512-+ShExQEewPvKdTUOtCAJmkUAgEyNF0QqgiAhPRE5xLvoFkIPt8xuHKaz1gMLzSMS73beHWs9gbRBngdH61nVWw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"delay": "^4.1.0"
|
||||
}
|
||||
},
|
||||
"binary-extensions": {
|
||||
"version": "1.13.1",
|
||||
"resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-1.13.1.tgz",
|
||||
|
|
@ -424,6 +483,12 @@
|
|||
"file-uri-to-path": "1.0.0"
|
||||
}
|
||||
},
|
||||
"bluebird": {
|
||||
"version": "3.7.2",
|
||||
"resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz",
|
||||
"integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==",
|
||||
"dev": true
|
||||
},
|
||||
"brace-expansion": {
|
||||
"version": "1.1.11",
|
||||
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
|
||||
|
|
@ -516,6 +581,15 @@
|
|||
"integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=",
|
||||
"dev": true
|
||||
},
|
||||
"catharsis": {
|
||||
"version": "0.8.11",
|
||||
"resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.8.11.tgz",
|
||||
"integrity": "sha512-a+xUyMV7hD1BrDQA/3iPV7oc+6W26BgVJO05PGEoatMyIuPScQKsde6i3YorWX1qs+AZjnJ18NqdKoCtKiNh1g==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"lodash": "^4.17.14"
|
||||
}
|
||||
},
|
||||
"chai": {
|
||||
"version": "4.2.0",
|
||||
"resolved": "https://registry.npmjs.org/chai/-/chai-4.2.0.tgz",
|
||||
|
|
@ -970,6 +1044,35 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"del": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/del/-/del-4.1.1.tgz",
|
||||
"integrity": "sha512-QwGuEUouP2kVwQenAsOof5Fv8K9t3D8Ca8NxcXKrIpEHjTXK5J2nXLdP+ALI1cgv8wj7KuwBhTwBkOZSJKM5XQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@types/glob": "^7.1.1",
|
||||
"globby": "^6.1.0",
|
||||
"is-path-cwd": "^2.0.0",
|
||||
"is-path-in-cwd": "^2.0.0",
|
||||
"p-map": "^2.0.0",
|
||||
"pify": "^4.0.1",
|
||||
"rimraf": "^2.6.3"
|
||||
},
|
||||
"dependencies": {
|
||||
"pify": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz",
|
||||
"integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==",
|
||||
"dev": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"delay": {
|
||||
"version": "4.3.0",
|
||||
"resolved": "https://registry.npmjs.org/delay/-/delay-4.3.0.tgz",
|
||||
"integrity": "sha512-Lwaf3zVFDMBop1yDuFZ19F9WyGcZcGacsbdlZtWjQmM50tOcMntm1njF/Nb/Vjij3KaSvCF+sEYGKrrjObu2NA==",
|
||||
"dev": true
|
||||
},
|
||||
"delayed-stream": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
|
||||
|
|
@ -994,6 +1097,12 @@
|
|||
"integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==",
|
||||
"dev": true
|
||||
},
|
||||
"docdash": {
|
||||
"version": "1.2.0",
|
||||
"resolved": "https://registry.npmjs.org/docdash/-/docdash-1.2.0.tgz",
|
||||
"integrity": "sha512-IYZbgYthPTspgqYeciRJNPhSwL51yer7HAwDXhF5p+H7mTDbPvY3PCk/QDjNxdPCpWkaJVFC4t7iCNB/t9E5Kw==",
|
||||
"dev": true
|
||||
},
|
||||
"dom-serializer": {
|
||||
"version": "0.2.2",
|
||||
"resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-0.2.2.tgz",
|
||||
|
|
@ -2272,6 +2381,19 @@
|
|||
"which": "^1.2.14"
|
||||
}
|
||||
},
|
||||
"globby": {
|
||||
"version": "6.1.0",
|
||||
"resolved": "https://registry.npmjs.org/globby/-/globby-6.1.0.tgz",
|
||||
"integrity": "sha1-9abXDoOV4hyFj7BInWTfAkJNUGw=",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"array-union": "^1.0.1",
|
||||
"glob": "^7.0.3",
|
||||
"object-assign": "^4.0.1",
|
||||
"pify": "^2.0.0",
|
||||
"pinkie-promise": "^2.0.0"
|
||||
}
|
||||
},
|
||||
"glogg": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/glogg/-/glogg-1.0.2.tgz",
|
||||
|
|
@ -2386,6 +2508,45 @@
|
|||
"through2": "^2.0.0"
|
||||
}
|
||||
},
|
||||
"gulp-jsdoc3": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/gulp-jsdoc3/-/gulp-jsdoc3-3.0.0.tgz",
|
||||
"integrity": "sha512-rE2jAwCPA8XFi9g4V3Z3LPhZNjxuMTIYQVMjdqZAQpRfJITLVaUK3xfmiiNTMc7j+fT7pL8Q5yj7ZPRdwCJWNg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-colors": "^4.1.1",
|
||||
"beeper": "^2.0.0",
|
||||
"debug": "^4.1.1",
|
||||
"fancy-log": "^1.3.3",
|
||||
"ink-docstrap": "^1.3.2",
|
||||
"jsdoc": "^3.6.3",
|
||||
"map-stream": "0.0.7",
|
||||
"tmp": "0.1.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"ansi-colors": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz",
|
||||
"integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==",
|
||||
"dev": true
|
||||
},
|
||||
"debug": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz",
|
||||
"integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ms": "^2.1.1"
|
||||
}
|
||||
},
|
||||
"ms": {
|
||||
"version": "2.1.2",
|
||||
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
|
||||
"integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==",
|
||||
"dev": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"gulp-rename": {
|
||||
"version": "1.4.0",
|
||||
"resolved": "https://registry.npmjs.org/gulp-rename/-/gulp-rename-1.4.0.tgz",
|
||||
|
|
@ -2592,6 +2753,16 @@
|
|||
"integrity": "sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==",
|
||||
"dev": true
|
||||
},
|
||||
"ink-docstrap": {
|
||||
"version": "1.3.2",
|
||||
"resolved": "https://registry.npmjs.org/ink-docstrap/-/ink-docstrap-1.3.2.tgz",
|
||||
"integrity": "sha512-STx5orGQU1gfrkoI/fMU7lX6CSP7LBGO10gXNgOZhwKhUqbtNjCkYSewJtNnLmWP1tAGN6oyEpG1HFPw5vpa5Q==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"moment": "^2.14.1",
|
||||
"sanitize-html": "^1.13.0"
|
||||
}
|
||||
},
|
||||
"interpret": {
|
||||
"version": "1.2.0",
|
||||
"resolved": "https://registry.npmjs.org/interpret/-/interpret-1.2.0.tgz",
|
||||
|
|
@ -2762,6 +2933,30 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"is-path-cwd": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/is-path-cwd/-/is-path-cwd-2.1.0.tgz",
|
||||
"integrity": "sha512-Sc5j3/YnM8tDeyCsVeKlm/0p95075DyLmDEIkSgQ7mXkrOX+uTCtmQFm0CYzVyJwcCCmO3k8qfJt17SxQwB5Zw==",
|
||||
"dev": true
|
||||
},
|
||||
"is-path-in-cwd": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/is-path-in-cwd/-/is-path-in-cwd-2.1.0.tgz",
|
||||
"integrity": "sha512-rNocXHgipO+rvnP6dk3zI20RpOtrAM/kzbB258Uw5BWr3TpXi861yzjo16Dn4hUox07iw5AyeMLHWsujkjzvRQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"is-path-inside": "^2.1.0"
|
||||
}
|
||||
},
|
||||
"is-path-inside": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-2.1.0.tgz",
|
||||
"integrity": "sha512-wiyhTzfDWsvwAW53OBWF5zuvaOGlZ6PwYxAbPVDhpm+gM09xKQGjBq/8uYN12aDvMxnAnq3dxTyoSoRNmg5YFg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"path-is-inside": "^1.0.2"
|
||||
}
|
||||
},
|
||||
"is-plain-object": {
|
||||
"version": "2.0.4",
|
||||
"resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz",
|
||||
|
|
@ -2890,12 +3085,63 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"js2xmlparser": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.1.tgz",
|
||||
"integrity": "sha512-KrPTolcw6RocpYjdC7pL7v62e55q7qOMHvLX1UCLc5AAS8qeJ6nukarEJAF2KL2PZxlbGueEbINqZR2bDe/gUw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"xmlcreate": "^2.0.3"
|
||||
}
|
||||
},
|
||||
"jsbn": {
|
||||
"version": "0.1.1",
|
||||
"resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz",
|
||||
"integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=",
|
||||
"dev": true
|
||||
},
|
||||
"jsdoc": {
|
||||
"version": "3.6.4",
|
||||
"resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.4.tgz",
|
||||
"integrity": "sha512-3G9d37VHv7MFdheviDCjUfQoIjdv4TC5zTTf5G9VODLtOnVS6La1eoYBDlbWfsRT3/Xo+j2MIqki2EV12BZfwA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@babel/parser": "^7.9.4",
|
||||
"bluebird": "^3.7.2",
|
||||
"catharsis": "^0.8.11",
|
||||
"escape-string-regexp": "^2.0.0",
|
||||
"js2xmlparser": "^4.0.1",
|
||||
"klaw": "^3.0.0",
|
||||
"markdown-it": "^10.0.0",
|
||||
"markdown-it-anchor": "^5.2.7",
|
||||
"marked": "^0.8.2",
|
||||
"mkdirp": "^1.0.4",
|
||||
"requizzle": "^0.2.3",
|
||||
"strip-json-comments": "^3.1.0",
|
||||
"taffydb": "2.6.2",
|
||||
"underscore": "~1.10.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"escape-string-regexp": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz",
|
||||
"integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==",
|
||||
"dev": true
|
||||
},
|
||||
"mkdirp": {
|
||||
"version": "1.0.4",
|
||||
"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
|
||||
"integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
|
||||
"dev": true
|
||||
},
|
||||
"strip-json-comments": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.0.tgz",
|
||||
"integrity": "sha512-e6/d0eBu7gHtdCqFt0xJr642LdToM5/cN4Qb9DbHjVx1CP5RyeM+zH7pbecEmDv/lBqb0QH+6Uqq75rxFPkM0w==",
|
||||
"dev": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"jsdom": {
|
||||
"version": "13.2.0",
|
||||
"resolved": "https://registry.npmjs.org/jsdom/-/jsdom-13.2.0.tgz",
|
||||
|
|
@ -2978,6 +3224,15 @@
|
|||
"integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==",
|
||||
"dev": true
|
||||
},
|
||||
"klaw": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz",
|
||||
"integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"graceful-fs": "^4.1.9"
|
||||
}
|
||||
},
|
||||
"last-run": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/last-run/-/last-run-1.1.1.tgz",
|
||||
|
|
@ -3041,6 +3296,15 @@
|
|||
"resolve": "^1.1.7"
|
||||
}
|
||||
},
|
||||
"linkify-it": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz",
|
||||
"integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"uc.micro": "^1.0.1"
|
||||
}
|
||||
},
|
||||
"load-json-file": {
|
||||
"version": "1.1.0",
|
||||
"resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-1.1.0.tgz",
|
||||
|
|
@ -3172,6 +3436,31 @@
|
|||
"object-visit": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"markdown-it": {
|
||||
"version": "10.0.0",
|
||||
"resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz",
|
||||
"integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"argparse": "^1.0.7",
|
||||
"entities": "~2.0.0",
|
||||
"linkify-it": "^2.0.0",
|
||||
"mdurl": "^1.0.1",
|
||||
"uc.micro": "^1.0.5"
|
||||
}
|
||||
},
|
||||
"markdown-it-anchor": {
|
||||
"version": "5.3.0",
|
||||
"resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz",
|
||||
"integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==",
|
||||
"dev": true
|
||||
},
|
||||
"marked": {
|
||||
"version": "0.8.2",
|
||||
"resolved": "https://registry.npmjs.org/marked/-/marked-0.8.2.tgz",
|
||||
"integrity": "sha512-EGwzEeCcLniFX51DhTpmTom+dSA/MG/OBUDjnWtHbEnjAH180VzUeAw+oE4+Zv+CoYBWyRlYOTR0N8SO9R1PVw==",
|
||||
"dev": true
|
||||
},
|
||||
"matchdep": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/matchdep/-/matchdep-2.0.0.tgz",
|
||||
|
|
@ -3207,6 +3496,12 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"mdurl": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
|
||||
"integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=",
|
||||
"dev": true
|
||||
},
|
||||
"mem": {
|
||||
"version": "4.2.0",
|
||||
"resolved": "https://registry.npmjs.org/mem/-/mem-4.2.0.tgz",
|
||||
|
|
@ -3384,6 +3679,12 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"moment": {
|
||||
"version": "2.27.0",
|
||||
"resolved": "https://registry.npmjs.org/moment/-/moment-2.27.0.tgz",
|
||||
"integrity": "sha512-al0MUK7cpIcglMv3YF13qSgdAIqxHTO7brRtaz3DlSULbqfazqkc5kEjNrLDOM7fsjshoFIihnU8snrP7zUvhQ==",
|
||||
"dev": true
|
||||
},
|
||||
"ms": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
|
||||
|
|
@ -3701,6 +4002,12 @@
|
|||
"p-limit": "^2.0.0"
|
||||
}
|
||||
},
|
||||
"p-map": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/p-map/-/p-map-2.1.0.tgz",
|
||||
"integrity": "sha512-y3b8Kpd8OAN444hxfBbFfj1FY/RjtTd8tzYwhUqNYXx0fXx2iX4maP4Qr6qhIKbQXI02wTLAda4fYUbDagTUFw==",
|
||||
"dev": true
|
||||
},
|
||||
"p-try": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/p-try/-/p-try-2.1.0.tgz",
|
||||
|
|
@ -3772,6 +4079,12 @@
|
|||
"integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=",
|
||||
"dev": true
|
||||
},
|
||||
"path-is-inside": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz",
|
||||
"integrity": "sha1-NlQX3t5EQw0cEa9hAn+s8HS9/FM=",
|
||||
"dev": true
|
||||
},
|
||||
"path-key": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz",
|
||||
|
|
@ -3855,6 +4168,34 @@
|
|||
"integrity": "sha1-AerA/jta9xoqbAL+q7jB/vfgDqs=",
|
||||
"dev": true
|
||||
},
|
||||
"postcss": {
|
||||
"version": "7.0.32",
|
||||
"resolved": "https://registry.npmjs.org/postcss/-/postcss-7.0.32.tgz",
|
||||
"integrity": "sha512-03eXong5NLnNCD05xscnGKGDZ98CyzoqPSMjOe6SuoQY7Z2hIj0Ld1g/O/UQRuOle2aRtiIRDg9tDcTGAkLfKw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"chalk": "^2.4.2",
|
||||
"source-map": "^0.6.1",
|
||||
"supports-color": "^6.1.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"source-map": {
|
||||
"version": "0.6.1",
|
||||
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
|
||||
"integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
|
||||
"dev": true
|
||||
},
|
||||
"supports-color": {
|
||||
"version": "6.1.0",
|
||||
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.1.0.tgz",
|
||||
"integrity": "sha512-qe1jfm1Mg7Nq/NSh6XE24gPXROEVsWHxC1LIx//XNlD9iw7YZQGjZNjYN7xGaEG6iKdA8EtNFW6R0gjnVXp+wQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"has-flag": "^3.0.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"prelude-ls": {
|
||||
"version": "1.1.2",
|
||||
"resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz",
|
||||
|
|
@ -4149,6 +4490,15 @@
|
|||
"integrity": "sha1-l/cXtp1IeE9fUmpsWqj/3aBVpNE=",
|
||||
"dev": true
|
||||
},
|
||||
"requizzle": {
|
||||
"version": "0.2.3",
|
||||
"resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz",
|
||||
"integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"lodash": "^4.17.14"
|
||||
}
|
||||
},
|
||||
"resolve": {
|
||||
"version": "1.15.1",
|
||||
"resolved": "https://registry.npmjs.org/resolve/-/resolve-1.15.1.tgz",
|
||||
|
|
@ -4189,6 +4539,15 @@
|
|||
"integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==",
|
||||
"dev": true
|
||||
},
|
||||
"rimraf": {
|
||||
"version": "2.6.3",
|
||||
"resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz",
|
||||
"integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"glob": "^7.1.3"
|
||||
}
|
||||
},
|
||||
"safe-buffer": {
|
||||
"version": "5.1.2",
|
||||
"resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
|
||||
|
|
@ -4210,6 +4569,34 @@
|
|||
"integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==",
|
||||
"dev": true
|
||||
},
|
||||
"sanitize-html": {
|
||||
"version": "1.27.0",
|
||||
"resolved": "https://registry.npmjs.org/sanitize-html/-/sanitize-html-1.27.0.tgz",
|
||||
"integrity": "sha512-U1btucGeYVpg0GoK43jPpe/bDCV4cBOGuxzv5NBd0bOjyZdMKY0n98S/vNlO1wVwre0VCj8H3hbzE7gD2+RjKA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"chalk": "^2.4.1",
|
||||
"htmlparser2": "^4.1.0",
|
||||
"lodash": "^4.17.15",
|
||||
"postcss": "^7.0.27",
|
||||
"srcset": "^2.0.1",
|
||||
"xtend": "^4.0.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"htmlparser2": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-4.1.0.tgz",
|
||||
"integrity": "sha512-4zDq1a1zhE4gQso/c5LP1OtrhYTncXNSpvJYtWJBtXAETPlMfi3IFNjGuQbYLuVY4ZR0QMqRVvo4Pdy9KLyP8Q==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"domelementtype": "^2.0.1",
|
||||
"domhandler": "^3.0.0",
|
||||
"domutils": "^2.0.0",
|
||||
"entities": "^2.0.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"saxes": {
|
||||
"version": "3.1.9",
|
||||
"resolved": "https://registry.npmjs.org/saxes/-/saxes-3.1.9.tgz",
|
||||
|
|
@ -4501,6 +4888,12 @@
|
|||
"integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=",
|
||||
"dev": true
|
||||
},
|
||||
"srcset": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/srcset/-/srcset-2.0.1.tgz",
|
||||
"integrity": "sha512-00kZI87TdRKwt+P8jj8UZxbfp7mK2ufxcIMWvhAOZNJTRROimpHeruWrGvCZneiuVDLqdyHefVp748ECTnyUBQ==",
|
||||
"dev": true
|
||||
},
|
||||
"sshpk": {
|
||||
"version": "1.16.1",
|
||||
"resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz",
|
||||
|
|
@ -4638,6 +5031,12 @@
|
|||
"integrity": "sha1-rifbOPZgp64uHDt9G8KQgZuFGeY=",
|
||||
"dev": true
|
||||
},
|
||||
"taffydb": {
|
||||
"version": "2.6.2",
|
||||
"resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
|
||||
"integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=",
|
||||
"dev": true
|
||||
},
|
||||
"textextensions": {
|
||||
"version": "2.4.0",
|
||||
"resolved": "https://registry.npmjs.org/textextensions/-/textextensions-2.4.0.tgz",
|
||||
|
|
@ -4676,6 +5075,15 @@
|
|||
"integrity": "sha512-NB6Dk1A9xgQPMoGqC5CVXn123gWyte215ONT5Pp5a0yt4nlEoO1ZWeCwpncaekPHXO60i47ihFnZPiRPjRMq4Q==",
|
||||
"optional": true
|
||||
},
|
||||
"tmp": {
|
||||
"version": "0.1.0",
|
||||
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.1.0.tgz",
|
||||
"integrity": "sha512-J7Z2K08jbGcdA1kkQpJSqLF6T0tdQqpR2pnSUXsIchbPdTI9v3e85cLW0d6WDhwuAleOV71j2xWs8qMPfK7nKw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"rimraf": "^2.6.3"
|
||||
}
|
||||
},
|
||||
"to-absolute-glob": {
|
||||
"version": "2.0.2",
|
||||
"resolved": "https://registry.npmjs.org/to-absolute-glob/-/to-absolute-glob-2.0.2.tgz",
|
||||
|
|
@ -4798,6 +5206,12 @@
|
|||
"integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=",
|
||||
"dev": true
|
||||
},
|
||||
"uc.micro": {
|
||||
"version": "1.0.6",
|
||||
"resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz",
|
||||
"integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==",
|
||||
"dev": true
|
||||
},
|
||||
"uglify-js": {
|
||||
"version": "3.5.2",
|
||||
"resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.5.2.tgz",
|
||||
|
|
@ -4822,6 +5236,12 @@
|
|||
"integrity": "sha1-5z3T17DXxe2G+6xrCufYxqadUPo=",
|
||||
"dev": true
|
||||
},
|
||||
"underscore": {
|
||||
"version": "1.10.2",
|
||||
"resolved": "https://registry.npmjs.org/underscore/-/underscore-1.10.2.tgz",
|
||||
"integrity": "sha512-N4P+Q/BuyuEKFJ43B9gYuOj4TQUHXX+j2FqguVOpjkssLUUrnJofCcBccJSCoeturDoZU6GorDTHSvUDlSQbTg==",
|
||||
"dev": true
|
||||
},
|
||||
"undertaker": {
|
||||
"version": "1.2.1",
|
||||
"resolved": "https://registry.npmjs.org/undertaker/-/undertaker-1.2.1.tgz",
|
||||
|
|
@ -5164,6 +5584,12 @@
|
|||
"integrity": "sha512-tGkGJkN8XqCod7OT+EvGYK5Z4SfDQGD30zAa58OcnAa0RRWgzUEK72tkXhsX1FZd+rgnhRxFtmO+ihkp8LHSkw==",
|
||||
"dev": true
|
||||
},
|
||||
"xmlcreate": {
|
||||
"version": "2.0.3",
|
||||
"resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.3.tgz",
|
||||
"integrity": "sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==",
|
||||
"dev": true
|
||||
},
|
||||
"xtend": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz",
|
||||
|
|
@ -5202,9 +5628,9 @@
|
|||
"dev": true
|
||||
},
|
||||
"camelcase": {
|
||||
"version": "5.2.0",
|
||||
"resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.2.0.tgz",
|
||||
"integrity": "sha512-IXFsBS2pC+X0j0N/GE7Dm7j3bsEBp+oTpb7F50dwEVX7rf3IgwO9XatnegTsDtniKCUtEJH4fSU6Asw7uoVLfQ==",
|
||||
"version": "5.3.1",
|
||||
"resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz",
|
||||
"integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==",
|
||||
"dev": true
|
||||
},
|
||||
"cliui": {
|
||||
|
|
@ -5333,9 +5759,9 @@
|
|||
"dev": true
|
||||
},
|
||||
"yargs-parser": {
|
||||
"version": "13.0.0",
|
||||
"resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.0.0.tgz",
|
||||
"integrity": "sha512-w2LXjoL8oRdRQN+hOyppuXs+V/fVAYtpcrRxZuF7Kt/Oc+Jr2uAcVntaUTNT6w5ihoWfFDpNY8CPx1QskxZ/pw==",
|
||||
"version": "13.1.2",
|
||||
"resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz",
|
||||
"integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"camelcase": "^5.0.0",
|
||||
|
|
|
|||
|
|
@ -33,9 +33,12 @@
|
|||
},
|
||||
"devDependencies": {
|
||||
"chai": "^4.2.0",
|
||||
"del": "^4.1.1",
|
||||
"docdash": "^1.2.0",
|
||||
"gulp": "^4.0.2",
|
||||
"gulp-concat": "^2.3.4",
|
||||
"gulp-header": "^2.0.7",
|
||||
"gulp-jsdoc3": "^3.0.0",
|
||||
"gulp-rename": "^1.2.0",
|
||||
"gulp-replace": "^1.0.0",
|
||||
"gulp-uglify": "^3.0.1",
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
/**
|
||||
* The list of adapter which will be used if `data-adapter` is not specified.
|
||||
*
|
||||
* @type {Array.<{adapter: Adapter, name: string}>}
|
||||
* @type {Array<{adapter: Adapter, name: string}>}
|
||||
*/
|
||||
var adapters = [];
|
||||
|
||||
|
|
|
|||
460
prism.js
460
prism.js
|
|
@ -3,6 +3,8 @@
|
|||
Begin prism-core.js
|
||||
********************************************** */
|
||||
|
||||
/// <reference lib="WebWorker"/>
|
||||
|
||||
var _self = (typeof window !== 'undefined')
|
||||
? window // if in browser
|
||||
: (
|
||||
|
|
@ -13,10 +15,12 @@ var _self = (typeof window !== 'undefined')
|
|||
|
||||
/**
|
||||
* Prism: Lightweight, robust, elegant syntax highlighting
|
||||
* MIT license http://www.opensource.org/licenses/mit-license.php/
|
||||
* @author Lea Verou http://lea.verou.me
|
||||
*
|
||||
* @license MIT <https://opensource.org/licenses/MIT>
|
||||
* @author Lea Verou <https://lea.verou.me>
|
||||
* @namespace
|
||||
* @public
|
||||
*/
|
||||
|
||||
var Prism = (function (_self){
|
||||
|
||||
// Private helper vars
|
||||
|
|
@ -25,8 +29,39 @@ var uniqueId = 0;
|
|||
|
||||
|
||||
var _ = {
|
||||
/**
|
||||
* By default, Prism will attempt to highlight all code elements (by calling {@link Prism.highlightAll}) on the
|
||||
* current page after the page finished loading. This might be a problem if e.g. you wanted to asynchronously load
|
||||
* additional languages or plugins yourself.
|
||||
*
|
||||
* By setting this value to `true`, Prism will not automatically highlight all code elements on the page.
|
||||
*
|
||||
* You obviously have to change this value before the automatic highlighting started. To do this, you can add an
|
||||
* empty Prism object into the global scope before loading the Prism script like this:
|
||||
*
|
||||
* ```js
|
||||
* window.Prism = window.Prism || {};
|
||||
* Prism.manual = true;
|
||||
* // add a new <script> to load Prism's script
|
||||
* ```
|
||||
*
|
||||
* @default false
|
||||
* @type {boolean}
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
manual: _self.Prism && _self.Prism.manual,
|
||||
disableWorkerMessageHandler: _self.Prism && _self.Prism.disableWorkerMessageHandler,
|
||||
|
||||
/**
|
||||
* A namespace for utility methods.
|
||||
*
|
||||
* All function in this namespace that are not explicitly marked as _public_ are for __internal use only__ and may
|
||||
* change or disappear at any time.
|
||||
*
|
||||
* @namespace
|
||||
* @memberof Prism
|
||||
*/
|
||||
util: {
|
||||
encode: function encode(tokens) {
|
||||
if (tokens instanceof Token) {
|
||||
|
|
@ -38,10 +73,32 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns the name of the type of the given value.
|
||||
*
|
||||
* @param {any} o
|
||||
* @returns {string}
|
||||
* @example
|
||||
* type(null) === 'Null'
|
||||
* type(undefined) === 'Undefined'
|
||||
* type(123) === 'Number'
|
||||
* type('foo') === 'String'
|
||||
* type(true) === 'Boolean'
|
||||
* type([1, 2]) === 'Array'
|
||||
* type({}) === 'Object'
|
||||
* type(String) === 'Function'
|
||||
* type(/abc+/) === 'RegExp'
|
||||
*/
|
||||
type: function (o) {
|
||||
return Object.prototype.toString.call(o).slice(8, -1);
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns a unique number for the given object. Later calls will still return the same number.
|
||||
*
|
||||
* @param {Object} obj
|
||||
* @returns {number}
|
||||
*/
|
||||
objId: function (obj) {
|
||||
if (!obj['__id']) {
|
||||
Object.defineProperty(obj, '__id', { value: ++uniqueId });
|
||||
|
|
@ -49,18 +106,27 @@ var _ = {
|
|||
return obj['__id'];
|
||||
},
|
||||
|
||||
// Deep clone a language definition (e.g. to extend it)
|
||||
/**
|
||||
* Creates a deep clone of the given object.
|
||||
*
|
||||
* The main intended use of this function is to clone language definitions.
|
||||
*
|
||||
* @param {T} o
|
||||
* @param {Record<number, any>} [visited]
|
||||
* @returns {T}
|
||||
* @template T
|
||||
*/
|
||||
clone: function deepClone(o, visited) {
|
||||
var clone, id, type = _.util.type(o);
|
||||
visited = visited || {};
|
||||
|
||||
switch (type) {
|
||||
var clone, id;
|
||||
switch (_.util.type(o)) {
|
||||
case 'Object':
|
||||
id = _.util.objId(o);
|
||||
if (visited[id]) {
|
||||
return visited[id];
|
||||
}
|
||||
clone = {};
|
||||
clone = /** @type {Record<string, any>} */ ({});
|
||||
visited[id] = clone;
|
||||
|
||||
for (var key in o) {
|
||||
|
|
@ -69,7 +135,7 @@ var _ = {
|
|||
}
|
||||
}
|
||||
|
||||
return clone;
|
||||
return /** @type {any} */ (clone);
|
||||
|
||||
case 'Array':
|
||||
id = _.util.objId(o);
|
||||
|
|
@ -79,11 +145,11 @@ var _ = {
|
|||
clone = [];
|
||||
visited[id] = clone;
|
||||
|
||||
o.forEach(function (v, i) {
|
||||
(/** @type {Array} */(/** @type {any} */(o))).forEach(function (v, i) {
|
||||
clone[i] = deepClone(v, visited);
|
||||
});
|
||||
|
||||
return clone;
|
||||
return /** @type {any} */ (clone);
|
||||
|
||||
default:
|
||||
return o;
|
||||
|
|
@ -119,8 +185,8 @@ var _ = {
|
|||
if (typeof document === 'undefined') {
|
||||
return null;
|
||||
}
|
||||
if ('currentScript' in document) {
|
||||
return document.currentScript;
|
||||
if ('currentScript' in document && 1 < 2 /* hack to trip TS' flow analysis */) {
|
||||
return /** @type {any} */ (document.currentScript);
|
||||
}
|
||||
|
||||
// IE11 workaround
|
||||
|
|
@ -186,7 +252,42 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* This namespace contains all currently loaded languages and the some helper functions to create and modify languages.
|
||||
*
|
||||
* @namespace
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
languages: {
|
||||
/**
|
||||
* Creates a deep copy of the language with the given id and appends the given tokens.
|
||||
*
|
||||
* If a token in `redef` also appears in the copied language, then the existing token in the copied language
|
||||
* will be overwritten at its original position.
|
||||
*
|
||||
* ## Best practices
|
||||
*
|
||||
* Since the position of overwriting tokens (token in `redef` that overwrite tokens in the copied language)
|
||||
* doesn't matter, they can technically be in any order. However, this can be confusing to others that trying to
|
||||
* understand the language definition because, normally, the order of tokens matters in Prism grammars.
|
||||
*
|
||||
* Therefore, it is encouraged to order overwriting tokens according to the positions of the overwritten tokens.
|
||||
* Furthermore, all non-overwriting tokens should be placed after the overwriting ones.
|
||||
*
|
||||
* @param {string} id The id of the language to extend. This has to be a key in `Prism.languages`.
|
||||
* @param {Grammar} redef The new tokens to append.
|
||||
* @returns {Grammar} The new language created.
|
||||
* @public
|
||||
* @example
|
||||
* Prism.languages['css-with-colors'] = Prism.languages.extend('css', {
|
||||
* // Prism.languages.css already has a 'comment' token, so this token will overwrite CSS' 'comment' token
|
||||
* // at its original position
|
||||
* 'comment': { ... },
|
||||
* // CSS doesn't have a 'color' token, so this token will be appended
|
||||
* 'color': /\b(?:red|green|blue)\b/
|
||||
* });
|
||||
*/
|
||||
extend: function (id, redef) {
|
||||
var lang = _.util.clone(_.languages[id]);
|
||||
|
||||
|
|
@ -198,17 +299,84 @@ var _ = {
|
|||
},
|
||||
|
||||
/**
|
||||
* Insert a token before another token in a language literal
|
||||
* As this needs to recreate the object (we cannot actually insert before keys in object literals),
|
||||
* we cannot just provide an object, we need an object and a key.
|
||||
* @param inside The key (or language id) of the parent
|
||||
* @param before The key to insert before.
|
||||
* @param insert Object with the key/value pairs to insert
|
||||
* @param root The object that contains `inside`. If equal to Prism.languages, it can be omitted.
|
||||
* Inserts tokens _before_ another token in a language definition or any other grammar.
|
||||
*
|
||||
* ## Usage
|
||||
*
|
||||
* This helper method makes it easy to modify existing languages. For example, the CSS language definition
|
||||
* not only defines CSS highlighting for CSS documents, but also needs to define highlighting for CSS embedded
|
||||
* in HTML through `<style>` elements. To do this, it needs to modify `Prism.languages.markup` and add the
|
||||
* appropriate tokens. However, `Prism.languages.markup` is a regular JavaScript object literal, so if you do
|
||||
* this:
|
||||
*
|
||||
* ```js
|
||||
* Prism.languages.markup.style = {
|
||||
* // token
|
||||
* };
|
||||
* ```
|
||||
*
|
||||
* then the `style` token will be added (and processed) at the end. `insertBefore` allows you to insert tokens
|
||||
* before existing tokens. For the CSS example above, you would use it like this:
|
||||
*
|
||||
* ```js
|
||||
* Prism.languages.insertBefore('markup', 'cdata', {
|
||||
* 'style': {
|
||||
* // token
|
||||
* }
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* ## Special cases
|
||||
*
|
||||
* If the grammars of `inside` and `insert` have tokens with the same name, the tokens in `inside`'s grammar
|
||||
* will be ignored.
|
||||
*
|
||||
* This behavior can be used to insert tokens after `before`:
|
||||
*
|
||||
* ```js
|
||||
* Prism.languages.insertBefore('markup', 'comment', {
|
||||
* 'comment': Prism.languages.markup.comment,
|
||||
* // tokens after 'comment'
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* ## Limitations
|
||||
*
|
||||
* The main problem `insertBefore` has to solve is iteration order. Since ES2015, the iteration order for object
|
||||
* properties is guaranteed to be the insertion order (except for integer keys) but some browsers behave
|
||||
* differently when keys are deleted and re-inserted. So `insertBefore` can't be implemented by temporarily
|
||||
* deleting properties which is necessary to insert at arbitrary positions.
|
||||
*
|
||||
* To solve this problem, `insertBefore` doesn't actually insert the given tokens into the target object.
|
||||
* Instead, it will create a new object and replace all references to the target object with the new one. This
|
||||
* can be done without temporarily deleting properties, so the iteration order is well-defined.
|
||||
*
|
||||
* However, only references that can be reached from `Prism.languages` or `insert` will be replaced. I.e. if
|
||||
* you hold the target object in a variable, then the value of the variable will not change.
|
||||
*
|
||||
* ```js
|
||||
* var oldMarkup = Prism.languages.markup;
|
||||
* var newMarkup = Prism.languages.insertBefore('markup', 'comment', { ... });
|
||||
*
|
||||
* assert(oldMarkup !== Prism.languages.markup);
|
||||
* assert(newMarkup === Prism.languages.markup);
|
||||
* ```
|
||||
*
|
||||
* @param {string} inside The property of `root` (e.g. a language id in `Prism.languages`) that contains the
|
||||
* object to be modified.
|
||||
* @param {string} before The key to insert before.
|
||||
* @param {Grammar} insert An object containing the key-value pairs to be inserted.
|
||||
* @param {Object<string, any>} [root] The object containing `inside`, i.e. the object that contains the
|
||||
* object to be modified.
|
||||
*
|
||||
* Defaults to `Prism.languages`.
|
||||
* @returns {Grammar} The new grammar object.
|
||||
* @public
|
||||
*/
|
||||
insertBefore: function (inside, before, insert, root) {
|
||||
root = root || _.languages;
|
||||
root = root || /** @type {any} */ (_.languages);
|
||||
var grammar = root[inside];
|
||||
/** @type {Grammar} */
|
||||
var ret = {};
|
||||
|
||||
for (var token in grammar) {
|
||||
|
|
@ -267,12 +435,39 @@ var _ = {
|
|||
}
|
||||
}
|
||||
},
|
||||
|
||||
plugins: {},
|
||||
|
||||
/**
|
||||
* This is the most high-level function in Prism’s API.
|
||||
* It fetches all the elements that have a `.language-xxxx` class and then calls {@link Prism.highlightElement} on
|
||||
* each one of them.
|
||||
*
|
||||
* This is equivalent to `Prism.highlightAllUnder(document, async, callback)`.
|
||||
*
|
||||
* @param {boolean} [async=false] Same as in {@link Prism.highlightAllUnder}.
|
||||
* @param {HighlightCallback} [callback] Same as in {@link Prism.highlightAllUnder}.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
highlightAll: function(async, callback) {
|
||||
_.highlightAllUnder(document, async, callback);
|
||||
},
|
||||
|
||||
/**
|
||||
* Fetches all the descendants of `container` that have a `.language-xxxx` class and then calls
|
||||
* {@link Prism.highlightElement} on each one of them.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `before-highlightall`
|
||||
* 2. All hooks of {@link Prism.highlightElement} for each element.
|
||||
*
|
||||
* @param {ParentNode} container The root element, whose descendants that have a `.language-xxxx` class will be highlighted.
|
||||
* @param {boolean} [async=false] Whether each element is to be highlighted asynchronously using Web Workers.
|
||||
* @param {HighlightCallback} [callback] An optional callback to be invoked on each element after its highlighting is done.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
highlightAllUnder: function(container, async, callback) {
|
||||
var env = {
|
||||
callback: callback,
|
||||
|
|
@ -291,6 +486,31 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Highlights the code inside a single element.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `before-sanity-check`
|
||||
* 2. `before-highlight`
|
||||
* 3. All hooks of {@link Prism.highlight}. These hooks will only be run by the current worker if `async` is `true`.
|
||||
* 4. `before-insert`
|
||||
* 5. `after-highlight`
|
||||
* 6. `complete`
|
||||
*
|
||||
* @param {Element} element The element containing the code.
|
||||
* It must have a class of `language-xxxx` to be processed, where `xxxx` is a valid language identifier.
|
||||
* @param {boolean} [async=false] Whether the element is to be highlighted asynchronously using Web Workers
|
||||
* to improve performance and avoid blocking the UI when highlighting very large chunks of code. This option is
|
||||
* [disabled by default](https://prismjs.com/faq.html#why-is-asynchronous-highlighting-disabled-by-default).
|
||||
*
|
||||
* Note: All language definitions required to highlight the code must be included in the main `prism.js` file for
|
||||
* asynchronous highlighting to work. You can build your own bundle on the
|
||||
* [Download page](https://prismjs.com/download.html).
|
||||
* @param {HighlightCallback} [callback] An optional callback to be invoked after the highlighting is done.
|
||||
* Mostly useful when `async` is `true`, since in that case, the highlighting is done asynchronously.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
highlightElement: function(element, async, callback) {
|
||||
// Find language
|
||||
var language = _.util.getLanguage(element);
|
||||
|
|
@ -300,7 +520,7 @@ var _ = {
|
|||
element.className = element.className.replace(lang, '').replace(/\s+/g, ' ') + ' language-' + language;
|
||||
|
||||
// Set language on the parent, for styling
|
||||
var parent = element.parentNode;
|
||||
var parent = element.parentElement;
|
||||
if (parent && parent.nodeName.toLowerCase() === 'pre') {
|
||||
parent.className = parent.className.replace(lang, '').replace(/\s+/g, ' ') + ' language-' + language;
|
||||
}
|
||||
|
|
@ -359,6 +579,26 @@ var _ = {
|
|||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Low-level function, only use if you know what you’re doing. It accepts a string of text as input
|
||||
* and the language definitions to use, and returns a string with the HTML produced.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `before-tokenize`
|
||||
* 2. `after-tokenize`
|
||||
* 3. `wrap`: On each {@link Token}.
|
||||
*
|
||||
* @param {string} text A string with the code to be highlighted.
|
||||
* @param {Grammar} grammar An object containing the tokens to use.
|
||||
*
|
||||
* Usually a language definition like `Prism.languages.markup`.
|
||||
* @param {string} language The name of the language definition passed to `grammar`.
|
||||
* @returns {string} The highlighted HTML.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
* @example
|
||||
* Prism.highlight('var foo = true;', Prism.languages.javascript, 'javascript');
|
||||
*/
|
||||
highlight: function (text, grammar, language) {
|
||||
var env = {
|
||||
code: text,
|
||||
|
|
@ -371,6 +611,30 @@ var _ = {
|
|||
return Token.stringify(_.util.encode(env.tokens), env.language);
|
||||
},
|
||||
|
||||
/**
|
||||
* This is the heart of Prism, and the most low-level function you can use. It accepts a string of text as input
|
||||
* and the language definitions to use, and returns an array with the tokenized code.
|
||||
*
|
||||
* When the language definition includes nested tokens, the function is called recursively on each of these tokens.
|
||||
*
|
||||
* This method could be useful in other contexts as well, as a very crude parser.
|
||||
*
|
||||
* @param {string} text A string with the code to be highlighted.
|
||||
* @param {Grammar} grammar An object containing the tokens to use.
|
||||
*
|
||||
* Usually a language definition like `Prism.languages.markup`.
|
||||
* @returns {TokenStream} An array of strings and tokens, a token stream.
|
||||
* @memberof Prism
|
||||
* @public
|
||||
* @example
|
||||
* let code = `var foo = 0;`;
|
||||
* let tokens = Prism.tokenize(code, Prism.languages.javascript);
|
||||
* tokens.forEach(token => {
|
||||
* if (token instanceof Prism.Token && token.type === 'number') {
|
||||
* console.log(`Found numeric literal: ${token.content}`);
|
||||
* }
|
||||
* });
|
||||
*/
|
||||
tokenize: function(text, grammar) {
|
||||
var rest = grammar.rest;
|
||||
if (rest) {
|
||||
|
|
@ -389,9 +653,26 @@ var _ = {
|
|||
return toArray(tokenList);
|
||||
},
|
||||
|
||||
/**
|
||||
* @namespace
|
||||
* @memberof Prism
|
||||
* @public
|
||||
*/
|
||||
hooks: {
|
||||
all: {},
|
||||
|
||||
/**
|
||||
* Adds the given callback to the list of callbacks for the given hook.
|
||||
*
|
||||
* The callback will be invoked when the hook it is registered for is run.
|
||||
* Hooks are usually directly run by a highlight function but you can also run hooks yourself.
|
||||
*
|
||||
* One callback function can be registered to multiple hooks and the same hook multiple times.
|
||||
*
|
||||
* @param {string} name The name of the hook.
|
||||
* @param {HookCallback} callback The callback function which is given environment variables.
|
||||
* @public
|
||||
*/
|
||||
add: function (name, callback) {
|
||||
var hooks = _.hooks.all;
|
||||
|
||||
|
|
@ -400,6 +681,15 @@ var _ = {
|
|||
hooks[name].push(callback);
|
||||
},
|
||||
|
||||
/**
|
||||
* Runs a hook invoking all registered callbacks with the given environment variables.
|
||||
*
|
||||
* Callbacks will be invoked synchronously and in the order in which they were registered.
|
||||
*
|
||||
* @param {string} name The name of the hook.
|
||||
* @param {Object<string, any>} env The environment variables of the hook passed to all callbacks registered.
|
||||
* @public
|
||||
*/
|
||||
run: function (name, env) {
|
||||
var callbacks = _.hooks.all[name];
|
||||
|
||||
|
|
@ -415,18 +705,86 @@ var _ = {
|
|||
|
||||
Token: Token
|
||||
};
|
||||
|
||||
_self.Prism = _;
|
||||
|
||||
|
||||
// Typescript note:
|
||||
// The following can be used to import the Token type in JSDoc:
|
||||
//
|
||||
// @typedef {InstanceType<import("./prism-core")["Token"]>} Token
|
||||
|
||||
/**
|
||||
* Creates a new token.
|
||||
*
|
||||
* @param {string} type See {@link Token#type type}
|
||||
* @param {string | TokenStream} content See {@link Token#content content}
|
||||
* @param {string|string[]} [alias] The alias(es) of the token.
|
||||
* @param {string} [matchedStr=""] A copy of the full string this token was created from.
|
||||
* @param {boolean} [greedy=false] Whether the pattern that created this token is greedy or not. Will be removed soon.
|
||||
* @class
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
function Token(type, content, alias, matchedStr, greedy) {
|
||||
/**
|
||||
* The type of the token.
|
||||
*
|
||||
* This is usually the key of a pattern in a {@link Grammar}.
|
||||
*
|
||||
* @type {string}
|
||||
* @see GrammarToken
|
||||
* @public
|
||||
*/
|
||||
this.type = type;
|
||||
/**
|
||||
* The strings or tokens contained by this token.
|
||||
*
|
||||
* This will be a token stream if the pattern matched also defined an `inside` grammar.
|
||||
*
|
||||
* @type {string | TokenStream}
|
||||
* @public
|
||||
*/
|
||||
this.content = content;
|
||||
/**
|
||||
* The alias(es) of the token.
|
||||
*
|
||||
* @type {string|string[]}
|
||||
* @see GrammarToken
|
||||
* @public
|
||||
*/
|
||||
this.alias = alias;
|
||||
// Copy of the full string this token was created from
|
||||
this.length = (matchedStr || '').length|0;
|
||||
this.length = (matchedStr || "").length|0;
|
||||
this.greedy = !!greedy;
|
||||
}
|
||||
|
||||
/**
|
||||
* A token stream is an array of strings and {@link Token Token} objects.
|
||||
*
|
||||
* Token streams have to fulfill a few properties that are assumed by most functions (mostly internal ones) that process
|
||||
* them.
|
||||
*
|
||||
* 1. No adjacent strings.
|
||||
* 2. No empty strings.
|
||||
*
|
||||
* The only exception here is the token stream that only contains the empty string and nothing else.
|
||||
*
|
||||
* @typedef {Array<string | Token>} TokenStream
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* Converts the given token or token stream to an HTML representation.
|
||||
*
|
||||
* The following hooks will be run:
|
||||
* 1. `wrap`: On each {@link Token}.
|
||||
*
|
||||
* @param {string | Token | TokenStream} o The token or token stream to be converted.
|
||||
* @param {string} language The name of current language.
|
||||
* @returns {string} The HTML representation of the token or token stream.
|
||||
* @memberof Token
|
||||
* @static
|
||||
*/
|
||||
Token.stringify = function stringify(o, language) {
|
||||
if (typeof o == 'string') {
|
||||
return o;
|
||||
|
|
@ -475,6 +833,7 @@ Token.stringify = function stringify(o, language) {
|
|||
* @param {number} startPos
|
||||
* @param {boolean} [oneshot=false]
|
||||
* @param {string} [target]
|
||||
* @private
|
||||
*/
|
||||
function matchGrammar(text, tokenList, grammar, startNode, startPos, oneshot, target) {
|
||||
for (var token in grammar) {
|
||||
|
|
@ -621,10 +980,12 @@ function matchGrammar(text, tokenList, grammar, startNode, startPos, oneshot, ta
|
|||
* @property {LinkedListNode<T> | null} prev The previous node.
|
||||
* @property {LinkedListNode<T> | null} next The next node.
|
||||
* @template T
|
||||
* @private
|
||||
*/
|
||||
|
||||
/**
|
||||
* @template T
|
||||
* @private
|
||||
*/
|
||||
function LinkedList() {
|
||||
/** @type {LinkedListNode<T>} */
|
||||
|
|
@ -715,7 +1076,7 @@ if (!_self.document) {
|
|||
return _;
|
||||
}
|
||||
|
||||
//Get current script and highlight
|
||||
// Get current script and highlight
|
||||
var script = _.util.currentScript();
|
||||
|
||||
if (script) {
|
||||
|
|
@ -764,6 +1125,55 @@ if (typeof global !== 'undefined') {
|
|||
global.Prism = Prism;
|
||||
}
|
||||
|
||||
// some additional documentation/types
|
||||
|
||||
/**
|
||||
* The expansion of a simple `RegExp` literal to support additional properties.
|
||||
*
|
||||
* @typedef GrammarToken
|
||||
* @property {RegExp} pattern The regular expression of the token.
|
||||
* @property {boolean} [lookbehind=false] If `true`, then the first capturing group of `pattern` will (effectively)
|
||||
* behave as a lookbehind group meaning that the captured text will not be part of the matched text of the new token.
|
||||
* @property {boolean} [greedy=false] Whether the token is greedy.
|
||||
* @property {string|string[]} [alias] An optional alias or list of aliases.
|
||||
* @property {Grammar} [inside] The nested grammar of this token.
|
||||
*
|
||||
* The `inside` grammar will be used to tokenize the text value of each token of this kind.
|
||||
*
|
||||
* This can be used to make nested and even recursive language definitions.
|
||||
*
|
||||
* Note: This can cause infinite recursion. Be careful when you embed different languages or even the same language into
|
||||
* each another.
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef Grammar
|
||||
* @type {Object<string, RegExp | GrammarToken | Array<RegExp | GrammarToken>>}
|
||||
* @property {Grammar} [rest] An optional grammar object that will be appended to this grammar.
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* A function which will invoked after an element was successfully highlighted.
|
||||
*
|
||||
* @callback HighlightCallback
|
||||
* @param {Element} element The element successfully highlighted.
|
||||
* @returns {void}
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
/**
|
||||
* @callback HookCallback
|
||||
* @param {Object<string, any>} env The environment variables of the hook.
|
||||
* @returns {void}
|
||||
* @global
|
||||
* @public
|
||||
*/
|
||||
|
||||
|
||||
/* **********************************************
|
||||
Begin prism-markup.js
|
||||
|
|
|
|||
|
|
@ -225,7 +225,7 @@ function loadLanguage(lang) {
|
|||
* Returns all dependencies (as identifiers) of a specific language
|
||||
*
|
||||
* @param {string} lang
|
||||
* @returns {Array<string>} the list of dependencies. Empty if the language has none.
|
||||
* @returns {string[]} the list of dependencies. Empty if the language has none.
|
||||
*/
|
||||
function getDependenciesOfLanguage(lang) {
|
||||
if (!components.languages[lang] || !components.languages[lang].require) {
|
||||
|
|
|
|||
|
|
@ -161,6 +161,7 @@ module.exports = {
|
|||
*
|
||||
* @private
|
||||
* @param {string} filePath
|
||||
* @returns {{testSource: string, expectedTokenStream: Array<string[]>, comment:string?}|null}
|
||||
*/
|
||||
parseTestCaseFile(filePath) {
|
||||
const testCaseSource = fs.readFileSync(filePath, "utf8");
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ module.exports = {
|
|||
* Loads the list of all available tests
|
||||
*
|
||||
* @param {string} rootDir
|
||||
* @returns {Object.<string, string[]>}
|
||||
* @returns {Object<string, string[]>}
|
||||
*/
|
||||
loadAllTests(rootDir) {
|
||||
/** @type {Object.<string, string[]>} */
|
||||
|
|
@ -28,7 +28,7 @@ module.exports = {
|
|||
*
|
||||
* @param {string} rootDir
|
||||
* @param {string|string[]} languages
|
||||
* @returns {Object.<string, string[]>}
|
||||
* @returns {Object<string, string[]>}
|
||||
*/
|
||||
loadSomeTests(rootDir, languages) {
|
||||
/** @type {Object.<string, string[]>} */
|
||||
|
|
@ -47,7 +47,7 @@ module.exports = {
|
|||
* in the given src directory
|
||||
*
|
||||
* @param {string} src
|
||||
* @returns {Array.<string>}
|
||||
* @returns {string[]}
|
||||
*/
|
||||
getAllDirectories(src) {
|
||||
return fs.readdirSync(src).filter(file => {
|
||||
|
|
@ -61,7 +61,7 @@ module.exports = {
|
|||
*
|
||||
* @param {string} src
|
||||
* @param {string|string[]} languages
|
||||
* @returns {Array.<string>}
|
||||
* @returns {string[]}
|
||||
*/
|
||||
getSomeDirectories(src, languages) {
|
||||
return fs.readdirSync(src).filter(file => {
|
||||
|
|
@ -88,7 +88,7 @@ module.exports = {
|
|||
*
|
||||
* @private
|
||||
* @param {string} src
|
||||
* @returns {Array.<string>}
|
||||
* @returns {string[]}
|
||||
*/
|
||||
getAllFiles(src) {
|
||||
return fs.readdirSync(src)
|
||||
|
|
|
|||
Loading…
Reference in New Issue