rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +01:00
Code Issues Actions Packages Releases Activity
0fa643a8a3
Bootstrap/grunt/bs-lessdoc-parser.js

239 lines
5.9 KiB
JavaScript
Raw Normal View History

clarify Grunt task licensing
2014-01-21 01:00:52 +01:00
/*!
* Bootstrap Grunt task for parsing Less docstrings
* http://getbootstrap.com
* Copyright 2014 Twitter, Inc.
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
*/
Use different coding style for Gruntfile Fixes #12657
2014-02-08 21:59:17 +01:00
'use strict';
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
remarkable -> markdown-it
2015-01-20 22:04:35 +01:00
var Markdown = require('markdown-it');
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
function markdown2html(markdownString) {
remarkable -> markdown-it
2015-01-20 22:04:35 +01:00
var md = new Markdown();
Replaces markdown.js with [remarkable](https://github.com/jonschlinkert/remarkable). - remarkable has 100% support for [commonmark](http://jgm.github.io/CommonMark/spec.html) - [faster](https://github.com/jonschlinkert/remarkable/tree/master/benchmark) - easier to monkeypatch. this is a goal of ours, might be useful to you at some point given the custom tokenizing/parsing you're doing for documentation.
2014-10-26 11:38:10 +01:00
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
// the slice removes the <p>...</p> wrapper output by Markdown processor
Replaces markdown.js with [remarkable](https://github.com/jonschlinkert/remarkable). - remarkable has 100% support for [commonmark](http://jgm.github.io/CommonMark/spec.html) - [faster](https://github.com/jonschlinkert/remarkable/tree/master/benchmark) - easier to monkeypatch. this is a goal of ours, might be useful to you at some point given the custom tokenizing/parsing you're doing for documentation.
2014-10-26 11:38:10 +01:00
return md.render(markdownString.trim()).slice(3, -5);
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
}
/*
Mini-language:
//== This is a normal heading, which starts a section. Sections group variables together.
//## Optional description for the heading
document subheading syntax
2014-01-13 11:37:55 +01:00
//=== This is a subheading.
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
//** Optional description for the following variable. You **can** use Markdown in descriptions to discuss `<html>` stuff.
#ffff -> #fff :smile:
2014-03-20 21:12:59 +01:00
@foo: #fff;
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
//-- This is a heading for a section whose variables shouldn't be customizable
All other lines are ignored completely.
*/
var CUSTOMIZABLE_HEADING = /^[/]{2}={2}(.*)$/;
var UNCUSTOMIZABLE_HEADING = /^[/]{2}-{2}(.*)$/;
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
var SUBSECTION_HEADING = /^[/]{2}={3}(.*)$/;
Tweak parser to ignore empty Less section docstrings; fixes #14878
2014-10-27 21:50:45 +01:00
var SECTION_DOCSTRING = /^[/]{2}#{2}(.+)$/;
var VAR_ASSIGNMENT = /^(@[a-zA-Z0-9_-]+):[ ]*([^ ;][^;]*);[ ]*$/;
var VAR_DOCSTRING = /^[/]{2}[*]{2}(.+)$/;
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
function Section(heading, customizable) {
this.heading = heading.trim();
this.id = this.heading.replace(/\s+/g, '-').toLowerCase();
this.customizable = customizable;
this.docstring = null;
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
this.subsections = [];
}
Section.prototype.addSubSection = function (subsection) {
this.subsections.push(subsection);
add missing semicolon
2014-01-14 23:25:25 +01:00
};
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
function SubSection(heading) {
this.heading = heading.trim();
this.id = this.heading.replace(/\s+/g, '-').toLowerCase();
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
this.variables = [];
}
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
SubSection.prototype.addVar = function (variable) {
this.variables.push(variable);
};
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
function VarDocstring(markdownString) {
this.html = markdown2html(markdownString);
}
function SectionDocstring(markdownString) {
this.html = markdown2html(markdownString);
}
function Variable(name, defaultValue) {
this.name = name;
this.defaultValue = defaultValue;
this.docstring = null;
}
function Tokenizer(fileContent) {
this._lines = fileContent.split('\n');
this._next = undefined;
}
Tokenizer.prototype.unshift = function (token) {
if (this._next !== undefined) {
throw new Error('Attempted to unshift twice!');
}
this._next = token;
};
Tokenizer.prototype._shift = function () {
// returning null signals EOF
// returning undefined means the line was ignored
if (this._next !== undefined) {
var result = this._next;
this._next = undefined;
return result;
}
if (this._lines.length <= 0) {
return null;
}
var line = this._lines.shift();
var match = null;
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
match = SUBSECTION_HEADING.exec(line);
if (match !== null) {
return new SubSection(match[1]);
}
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
match = CUSTOMIZABLE_HEADING.exec(line);
if (match !== null) {
return new Section(match[1], true);
}
match = UNCUSTOMIZABLE_HEADING.exec(line);
if (match !== null) {
return new Section(match[1], false);
}
match = SECTION_DOCSTRING.exec(line);
if (match !== null) {
return new SectionDocstring(match[1]);
}
match = VAR_DOCSTRING.exec(line);
if (match !== null) {
return new VarDocstring(match[1]);
}
var commentStart = line.lastIndexOf('//');
var varLine = (commentStart === -1) ? line : line.slice(0, commentStart);
match = VAR_ASSIGNMENT.exec(varLine);
if (match !== null) {
return new Variable(match[1], match[2]);
}
return undefined;
};
Tokenizer.prototype.shift = function () {
while (true) {
var result = this._shift();
if (result === undefined) {
continue;
}
return result;
}
};
function Parser(fileContent) {
this._tokenizer = new Tokenizer(fileContent);
}
Parser.prototype.parseFile = function () {
var sections = [];
while (true) {
var section = this.parseSection();
if (section === null) {
if (this._tokenizer.shift() !== null) {
throw new Error('Unexpected unparsed section of file remains!');
}
return sections;
}
sections.push(section);
}
};
Parser.prototype.parseSection = function () {
var section = this._tokenizer.shift();
if (section === null) {
return null;
}
if (!(section instanceof Section)) {
throw new Error('Expected section heading; got: ' + JSON.stringify(section));
}
var docstring = this._tokenizer.shift();
if (docstring instanceof SectionDocstring) {
section.docstring = docstring;
}
else {
this._tokenizer.unshift(docstring);
}
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
this.parseSubSections(section);
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
return section;
};
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
Parser.prototype.parseSubSections = function (section) {
while (true) {
var subsection = this.parseSubSection();
if (subsection === null) {
if (section.subsections.length === 0) {
// Presume an implicit initial subsection
subsection = new SubSection('');
this.parseVars(subsection);
}
else {
break;
}
}
section.addSubSection(subsection);
}
if (section.subsections.length === 1 && !(section.subsections[0].heading) && section.subsections[0].variables.length === 0) {
// Ignore lone empty implicit subsection
section.subsections = [];
}
};
Parser.prototype.parseSubSection = function () {
var subsection = this._tokenizer.shift();
if (subsection instanceof SubSection) {
this.parseVars(subsection);
return subsection;
}
this._tokenizer.unshift(subsection);
return null;
};
Parser.prototype.parseVars = function (subsection) {
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
while (true) {
var variable = this.parseVar();
if (variable === null) {
return;
}
add support for '//===' for <h3>s in bs-lessdoc
2014-01-08 06:43:12 +01:00
subsection.addVar(variable);
Use JS & Jade to generate the customizer variables form HTML from variables.less; fixes #11095 also updates variables file organization (courtesy @mdo)
2013-10-18 04:52:16 +02:00
}
};
Parser.prototype.parseVar = function () {
var docstring = this._tokenizer.shift();
if (!(docstring instanceof VarDocstring)) {
this._tokenizer.unshift(docstring);
docstring = null;
}
var variable = this._tokenizer.shift();
if (variable instanceof Variable) {
variable.docstring = docstring;
return variable;
}
this._tokenizer.unshift(variable);
return null;
};
module.exports = Parser;
Reference in New Issue Copy Permalink