Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yamgent merged 1 commit into from
May 12, 2019
Merged

Revert "Add imported variables (#751)" #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 29 additions & 104 deletions src/lib/markbind/src/parser.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
* Utils
*/
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
return;
}
if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
= nunjucks.renderString(md.renderInline(variableElement.html()),
{ ...pageVariables, ...userDefinedVariables, ...includedVariables });
pageVariables[variableName] = variableValue;
if (!VARIABLE_LOOKUP[fileName]) {
VARIABLE_LOOKUP[fileName] = {};
}
VARIABLE_LOOKUP[fileName][variableName] = variableValue;
}
});
return pageVariables;
}

/**
* Extract imported page variables from a page
* @param context of the page
*/
function extractImportedVariables(context) {
if (!context.importedVariables) {
return {};
}
const importedVariables = {};
Object.entries(context.importedVariables).forEach(([src, variables]) => {
variables.forEach((variableName) => {
const actualFilePath = utils.isUrl()
? src
: path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
// eslint-disable-next-line no-console
console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
return;
}
const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
if (!importedVariables[variableName]) {
importedVariables[variableName] = variableValue;
}
});
});
return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
element.attribs = element.attribs || {};
element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

const requiresSrc = ['include', 'import'].includes(element.name);
const requiresSrc = ['include'].includes(element.name);
if (requiresSrc && _.isEmpty(element.attribs.src)) {
const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
this._onError(error);
return createErrorNode(element, error);
}
const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
const shouldProcessSrc = ['include', 'panel'].includes(element.name);
const hasSrc = _.hasIn(element.attribs, 'src');
let isUrl;
let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
}
}

if (element.name === 'include' || element.name === 'import') {
const isImport = element.name === 'import';
if (element.name === 'include') {
const isInline = _.hasIn(element.attribs, 'inline');
const isDynamic = _.hasIn(element.attribs, 'dynamic');
const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
element.name = 'markdown';
}

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

// Extract included variables from the PARENT file
const includeVariables = extractIncludeVariables(element, context.variables);

// Extract page variables from the CHILD file
const pageVariables = extractPageVariables(actualFilePath, fileContent,
const pageVariables = extractPageVariables(element.attribs.src, fileContent,
userDefinedVariables, includeVariables);

// Render inner file content
fileContent = nunjucks.renderString(fileContent,
{ ...pageVariables, ...includeVariables, ...userDefinedVariables },
{ path: actualFilePath });

// Delete variable attributes in include
Object.keys(element.attribs).forEach((attribute) => {
if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
const segmentSrc = cheerio.parseHTML(fileContent, true);
const $ = cheerio.load(segmentSrc);
const hashContent = $(includeSrc.hash).html();

if (isImport) {
const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
if (!variableContent) {
// eslint-disable-next-line no-console
console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
return createEmptyNode();
}
if (!context.importedVariables) {
// eslint-disable-next-line no-param-reassign
context.importedVariables = {};
}
if (!context.importedVariables[includeSrc.pathname]) {
// eslint-disable-next-line no-param-reassign
context.importedVariables[includeSrc.pathname] = [];
}
// eslint-disable-next-line no-param-reassign
context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
return createEmptyNode();
}

let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

if (actualContent === null) {
if (isOptional) {
// set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
true,
);
} else {
if (isImport) {
// eslint-disable-next-line no-console
console.warn(`Missing hash for import variable ${includeSrc.pathname}`
+ ` in ${element.attribs[ATTRIB_CWF]}.`);
return createEmptyNode();
}
let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
if (isIncludeSrcMd) {
if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
childContext.cwf = filePath;
childContext.source = isIncludeSrcMd ? 'md' : 'html';
childContext.callStack.push(context.cwf);
childContext.variables = { ...includeVariables };
childContext.importedVariables = {};
childContext.variables = includeVariables;

if (element.children && element.children.length > 0) {
if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
const error = new CyclicReferenceError(childContext.callStack);
this._onError(error);
return createErrorNode(element, error);
}
element.children = element.children.map((e) => {
let processedEle = cheerio.html(self._preprocess(e, childContext, config));
const importedVariables = extractImportedVariables(childContext);
userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
processedEle
= nunjucks.renderString(processedEle,
{
...pageVariables,
...importedVariables,
...includeVariables,
...userDefinedVariables,
},
{ path: actualFilePath });
return cheerio.parseHTML(processedEle)[0];
});
element.children = element.children.map(e => self._preprocess(e, childContext, config));
}
} else if ((element.name === 'panel') && hasSrc) {
if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
context.cwf = config.cwf || file; // current working file
context.mode = 'include';
context.callStack = [];
let fileData = null;

return new Promise((resolve, reject) => {
let actualFilePath = file;
if (!utils.fileExists(file)) {
const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
if (utils.fileExists(boilerplateFilePath)) {
actualFilePath = boilerplateFilePath;
}
}

const handler = new htmlparser.DomHandler((error, dom) => {
if (error) {
reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
}
return processed;
});
const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
const importedVariables = extractImportedVariables(context);
resolve(nunjucks.renderString(cheerio.html(nodes),
{ ...pageVariables, ...importedVariables, ...userDefinedVariables },
{ path: actualFilePath }));
resolve(cheerio.html(nodes));
});

const parser = new htmlparser.Parser(handler, {
xmlMode: true,
decodeEntities: true,
});

let actualFilePath = file;
if (!utils.fileExists(file)) {
const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
if (utils.fileExists(boilerplateFilePath)) {
actualFilePath = boilerplateFilePath;
}
}

// Read files
fs.readFile(actualFilePath, 'utf-8', (err, data) => {
fileData = data;
if (err) {
reject(err);
return;
}
const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
const fileContent = nunjucks.renderString(data,
{ ...pageVariables, ...userDefinedVariables },
{ path: actualFilePath });
const fileExt = utils.getExt(file);
const fileContent = data;
if (utils.isMarkdownFileExt(fileExt)) {
context.source = 'md';
parser.parseComplete(fileContent.toString());
Expand Down
14 changes: 0 additions & 14 deletions test/functional/test_site/expected/index.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
<div></div>
Page Variable Referencing Included Variable
</div>
<div>
<h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
<div></div>
Imported Variable
<h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
<div></div>
Imported Variable Referencing Global Variable
</div>
<h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
<div></div>
Imported Variable on Top Level
<h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
<p><span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
<a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
<a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
<a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
<a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
<a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
<a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
<a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
<a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down
3 changes: 0 additions & 3 deletions test/functional/test_site/expected/siteData.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
"outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
"included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
"page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
"imported-variable": "Imported Variable",
"imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
"imported-variable-on-top-level": "Imported Variable on Top Level",
"heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
"heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
"expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down
6 changes: 0 additions & 6 deletions test/functional/test_site/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
<variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down
7 changes: 0 additions & 7 deletions test/functional/test_site/testImportedVariables.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions test/functional/test_site/testImportedVariablesToImport.md
View file
Open in desktop

This file was deleted.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

May 12, 2019
 Merged


Revert "Add imported variables (#751)"
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


133 changes: 29 additions & 104 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
 * Utils
 */
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
 return;
 }
 if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 pageVariables[variableName] = variableValue;
 if (!VARIABLE_LOOKUP[fileName]) {
 VARIABLE_LOOKUP[fileName] = {};
 }
 VARIABLE_LOOKUP[fileName][variableName] = variableValue;
 }
 });
 return pageVariables;
}

/**
 * Extract imported page variables from a page
 * @param context of the page
 */
function extractImportedVariables(context) {
 if (!context.importedVariables) {
 return {};
 }
 const importedVariables = {};
 Object.entries(context.importedVariables).forEach(([src, variables]) => {
 variables.forEach((variableName) => {
 const actualFilePath = utils.isUrl()
 ? src
 : path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
 if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
 // eslint-disable-next-line no-console
 console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
 return;
 }
 const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
 if (!importedVariables[variableName]) {
 importedVariables[variableName] = variableValue;
 }
 });
 });
 return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
 return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.attribs = element.attribs || {};
 element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

 const requiresSrc = ['include', 'import'].includes(element.name);
 const requiresSrc = ['include'].includes(element.name);
 if (requiresSrc && _.isEmpty(element.attribs.src)) {
 const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
 this._onError(error);
 return createErrorNode(element, error);
 }
 const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
 const shouldProcessSrc = ['include', 'panel'].includes(element.name);
 const hasSrc = _.hasIn(element.attribs, 'src');
 let isUrl;
 let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 }
 }

 if (element.name === 'include' || element.name === 'import') {
 const isImport = element.name === 'import';
 if (element.name === 'include') {
 const isInline = _.hasIn(element.attribs, 'inline');
 const isDynamic = _.hasIn(element.attribs, 'dynamic');
 const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.name = 'markdown';
 }

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
 const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
 const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 const pageVariables = extractPageVariables(actualFilePath, fileContent,
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables },
 { path: actualFilePath });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
 if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
 const segmentSrc = cheerio.parseHTML(fileContent, true);
 const $ = cheerio.load(segmentSrc);
 const hashContent = $(includeSrc.hash).html();

 if (isImport) {
 const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
 if (!variableContent) {
 // eslint-disable-next-line no-console
 console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 if (!context.importedVariables) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables = {};
 }
 if (!context.importedVariables[includeSrc.pathname]) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname] = [];
 }
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
 return createEmptyNode();
 }

 let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

 if (actualContent === null) {
 if (isOptional) {
 // set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
 true,
 );
 } else {
 if (isImport) {
 // eslint-disable-next-line no-console
 console.warn(`Missing hash for import variable ${includeSrc.pathname}`
 + ` in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
 if (isIncludeSrcMd) {
 if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = { ...includeVariables };
 childContext.importedVariables = {};
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
 const error = new CyclicReferenceError(childContext.callStack);
 this._onError(error);
 return createErrorNode(element, error);
 }
 element.children = element.children.map((e) => {
 let processedEle = cheerio.html(self._preprocess(e, childContext, config));
 const importedVariables = extractImportedVariables(childContext);
 userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
 processedEle
 = nunjucks.renderString(processedEle,
 {
 ...pageVariables,
 ...importedVariables,
 ...includeVariables,
 ...userDefinedVariables,
 },
 { path: actualFilePath });
 return cheerio.parseHTML(processedEle)[0];
 });
 element.children = element.children.map(e => self._preprocess(e, childContext, config));
 }
 } else if ((element.name === 'panel') && hasSrc) {
 if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
 context.cwf = config.cwf || file; // current working file
 context.mode = 'include';
 context.callStack = [];
 let fileData = null;

 return new Promise((resolve, reject) => {
 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 const handler = new htmlparser.DomHandler((error, dom) => {
 if (error) {
 reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
 }
 return processed;
 });
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
 const importedVariables = extractImportedVariables(context);
 resolve(nunjucks.renderString(cheerio.html(nodes),
 { ...pageVariables, ...importedVariables, ...userDefinedVariables },
 { path: actualFilePath }));
 resolve(cheerio.html(nodes));
 });

 const parser = new htmlparser.Parser(handler, {
 xmlMode: true,
 decodeEntities: true,
 });

 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 // Read files
 fs.readFile(actualFilePath, 'utf-8', (err, data) => {
 fileData = data;
 if (err) {
 reject(err);
 return;
 }
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data,
 { ...pageVariables, ...userDefinedVariables },
 { path: actualFilePath });
 const fileExt = utils.getExt(file);
 const fileContent = data;
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
 parser.parseComplete(fileContent.toString());
Expand Down

14 changes: 0 additions & 14 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
 <div></div>
 Page Variable Referencing Included Variable
 </div>
 <div>
 <h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
 <div></div>
 Imported Variable
 <h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
 <div></div>
 Imported Variable Referencing Global Variable
 </div>
 <h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
 <div></div>
 Imported Variable on Top Level
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
 <span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down

3 changes: 0 additions & 3 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "imported-variable": "Imported Variable",
 "imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
 "imported-variable-on-top-level": "Imported Variable on Top Level",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

6 changes: 0 additions & 6 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
 <variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down

7 changes: 0 additions & 7 deletions
test/functional/test_site/testImportedVariables.md

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
test/functional/test_site/testImportedVariablesToImport.md

View file


Open in desktop


This file was deleted.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

May 12, 2019
 Merged


Revert "Add imported variables (#751)"
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


133 changes: 29 additions & 104 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
 * Utils
 */
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
 return;
 }
 if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 pageVariables[variableName] = variableValue;
 if (!VARIABLE_LOOKUP[fileName]) {
 VARIABLE_LOOKUP[fileName] = {};
 }
 VARIABLE_LOOKUP[fileName][variableName] = variableValue;
 }
 });
 return pageVariables;
}

/**
 * Extract imported page variables from a page
 * @param context of the page
 */
function extractImportedVariables(context) {
 if (!context.importedVariables) {
 return {};
 }
 const importedVariables = {};
 Object.entries(context.importedVariables).forEach(([src, variables]) => {
 variables.forEach((variableName) => {
 const actualFilePath = utils.isUrl()
 ? src
 : path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
 if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
 // eslint-disable-next-line no-console
 console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
 return;
 }
 const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
 if (!importedVariables[variableName]) {
 importedVariables[variableName] = variableValue;
 }
 });
 });
 return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
 return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.attribs = element.attribs || {};
 element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

 const requiresSrc = ['include', 'import'].includes(element.name);
 const requiresSrc = ['include'].includes(element.name);
 if (requiresSrc && _.isEmpty(element.attribs.src)) {
 const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
 this._onError(error);
 return createErrorNode(element, error);
 }
 const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
 const shouldProcessSrc = ['include', 'panel'].includes(element.name);
 const hasSrc = _.hasIn(element.attribs, 'src');
 let isUrl;
 let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 }
 }

 if (element.name === 'include' || element.name === 'import') {
 const isImport = element.name === 'import';
 if (element.name === 'include') {
 const isInline = _.hasIn(element.attribs, 'inline');
 const isDynamic = _.hasIn(element.attribs, 'dynamic');
 const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.name = 'markdown';
 }

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
 const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
 const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 const pageVariables = extractPageVariables(actualFilePath, fileContent,
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables },
 { path: actualFilePath });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
 if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
 const segmentSrc = cheerio.parseHTML(fileContent, true);
 const $ = cheerio.load(segmentSrc);
 const hashContent = $(includeSrc.hash).html();

 if (isImport) {
 const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
 if (!variableContent) {
 // eslint-disable-next-line no-console
 console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 if (!context.importedVariables) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables = {};
 }
 if (!context.importedVariables[includeSrc.pathname]) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname] = [];
 }
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
 return createEmptyNode();
 }

 let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

 if (actualContent === null) {
 if (isOptional) {
 // set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
 true,
 );
 } else {
 if (isImport) {
 // eslint-disable-next-line no-console
 console.warn(`Missing hash for import variable ${includeSrc.pathname}`
 + ` in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
 if (isIncludeSrcMd) {
 if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = { ...includeVariables };
 childContext.importedVariables = {};
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
 const error = new CyclicReferenceError(childContext.callStack);
 this._onError(error);
 return createErrorNode(element, error);
 }
 element.children = element.children.map((e) => {
 let processedEle = cheerio.html(self._preprocess(e, childContext, config));
 const importedVariables = extractImportedVariables(childContext);
 userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
 processedEle
 = nunjucks.renderString(processedEle,
 {
 ...pageVariables,
 ...importedVariables,
 ...includeVariables,
 ...userDefinedVariables,
 },
 { path: actualFilePath });
 return cheerio.parseHTML(processedEle)[0];
 });
 element.children = element.children.map(e => self._preprocess(e, childContext, config));
 }
 } else if ((element.name === 'panel') && hasSrc) {
 if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
 context.cwf = config.cwf || file; // current working file
 context.mode = 'include';
 context.callStack = [];
 let fileData = null;

 return new Promise((resolve, reject) => {
 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 const handler = new htmlparser.DomHandler((error, dom) => {
 if (error) {
 reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
 }
 return processed;
 });
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
 const importedVariables = extractImportedVariables(context);
 resolve(nunjucks.renderString(cheerio.html(nodes),
 { ...pageVariables, ...importedVariables, ...userDefinedVariables },
 { path: actualFilePath }));
 resolve(cheerio.html(nodes));
 });

 const parser = new htmlparser.Parser(handler, {
 xmlMode: true,
 decodeEntities: true,
 });

 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 // Read files
 fs.readFile(actualFilePath, 'utf-8', (err, data) => {
 fileData = data;
 if (err) {
 reject(err);
 return;
 }
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data,
 { ...pageVariables, ...userDefinedVariables },
 { path: actualFilePath });
 const fileExt = utils.getExt(file);
 const fileContent = data;
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
 parser.parseComplete(fileContent.toString());
Expand Down

14 changes: 0 additions & 14 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
 <div></div>
 Page Variable Referencing Included Variable
 </div>
 <div>
 <h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
 <div></div>
 Imported Variable
 <h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
 <div></div>
 Imported Variable Referencing Global Variable
 </div>
 <h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
 <div></div>
 Imported Variable on Top Level
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
 <span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down

3 changes: 0 additions & 3 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "imported-variable": "Imported Variable",
 "imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
 "imported-variable-on-top-level": "Imported Variable on Top Level",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

6 changes: 0 additions & 6 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
 <variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down

7 changes: 0 additions & 7 deletions
test/functional/test_site/testImportedVariables.md

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
test/functional/test_site/testImportedVariablesToImport.md

View file


Open in desktop


This file was deleted.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

May 12, 2019
 Merged


Revert "Add imported variables (#751)"
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


133 changes: 29 additions & 104 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
 * Utils
 */
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
 return;
 }
 if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 pageVariables[variableName] = variableValue;
 if (!VARIABLE_LOOKUP[fileName]) {
 VARIABLE_LOOKUP[fileName] = {};
 }
 VARIABLE_LOOKUP[fileName][variableName] = variableValue;
 }
 });
 return pageVariables;
}

/**
 * Extract imported page variables from a page
 * @param context of the page
 */
function extractImportedVariables(context) {
 if (!context.importedVariables) {
 return {};
 }
 const importedVariables = {};
 Object.entries(context.importedVariables).forEach(([src, variables]) => {
 variables.forEach((variableName) => {
 const actualFilePath = utils.isUrl()
 ? src
 : path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
 if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
 // eslint-disable-next-line no-console
 console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
 return;
 }
 const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
 if (!importedVariables[variableName]) {
 importedVariables[variableName] = variableValue;
 }
 });
 });
 return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
 return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.attribs = element.attribs || {};
 element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

 const requiresSrc = ['include', 'import'].includes(element.name);
 const requiresSrc = ['include'].includes(element.name);
 if (requiresSrc && _.isEmpty(element.attribs.src)) {
 const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
 this._onError(error);
 return createErrorNode(element, error);
 }
 const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
 const shouldProcessSrc = ['include', 'panel'].includes(element.name);
 const hasSrc = _.hasIn(element.attribs, 'src');
 let isUrl;
 let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 }
 }

 if (element.name === 'include' || element.name === 'import') {
 const isImport = element.name === 'import';
 if (element.name === 'include') {
 const isInline = _.hasIn(element.attribs, 'inline');
 const isDynamic = _.hasIn(element.attribs, 'dynamic');
 const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.name = 'markdown';
 }

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
 const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
 const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 const pageVariables = extractPageVariables(actualFilePath, fileContent,
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables },
 { path: actualFilePath });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
 if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
 const segmentSrc = cheerio.parseHTML(fileContent, true);
 const $ = cheerio.load(segmentSrc);
 const hashContent = $(includeSrc.hash).html();

 if (isImport) {
 const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
 if (!variableContent) {
 // eslint-disable-next-line no-console
 console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 if (!context.importedVariables) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables = {};
 }
 if (!context.importedVariables[includeSrc.pathname]) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname] = [];
 }
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
 return createEmptyNode();
 }

 let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

 if (actualContent === null) {
 if (isOptional) {
 // set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
 true,
 );
 } else {
 if (isImport) {
 // eslint-disable-next-line no-console
 console.warn(`Missing hash for import variable ${includeSrc.pathname}`
 + ` in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
 if (isIncludeSrcMd) {
 if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = { ...includeVariables };
 childContext.importedVariables = {};
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
 const error = new CyclicReferenceError(childContext.callStack);
 this._onError(error);
 return createErrorNode(element, error);
 }
 element.children = element.children.map((e) => {
 let processedEle = cheerio.html(self._preprocess(e, childContext, config));
 const importedVariables = extractImportedVariables(childContext);
 userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
 processedEle
 = nunjucks.renderString(processedEle,
 {
 ...pageVariables,
 ...importedVariables,
 ...includeVariables,
 ...userDefinedVariables,
 },
 { path: actualFilePath });
 return cheerio.parseHTML(processedEle)[0];
 });
 element.children = element.children.map(e => self._preprocess(e, childContext, config));
 }
 } else if ((element.name === 'panel') && hasSrc) {
 if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
 context.cwf = config.cwf || file; // current working file
 context.mode = 'include';
 context.callStack = [];
 let fileData = null;

 return new Promise((resolve, reject) => {
 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 const handler = new htmlparser.DomHandler((error, dom) => {
 if (error) {
 reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
 }
 return processed;
 });
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
 const importedVariables = extractImportedVariables(context);
 resolve(nunjucks.renderString(cheerio.html(nodes),
 { ...pageVariables, ...importedVariables, ...userDefinedVariables },
 { path: actualFilePath }));
 resolve(cheerio.html(nodes));
 });

 const parser = new htmlparser.Parser(handler, {
 xmlMode: true,
 decodeEntities: true,
 });

 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 // Read files
 fs.readFile(actualFilePath, 'utf-8', (err, data) => {
 fileData = data;
 if (err) {
 reject(err);
 return;
 }
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data,
 { ...pageVariables, ...userDefinedVariables },
 { path: actualFilePath });
 const fileExt = utils.getExt(file);
 const fileContent = data;
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
 parser.parseComplete(fileContent.toString());
Expand Down

14 changes: 0 additions & 14 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
 <div></div>
 Page Variable Referencing Included Variable
 </div>
 <div>
 <h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
 <div></div>
 Imported Variable
 <h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
 <div></div>
 Imported Variable Referencing Global Variable
 </div>
 <h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
 <div></div>
 Imported Variable on Top Level
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
 <span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down

3 changes: 0 additions & 3 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "imported-variable": "Imported Variable",
 "imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
 "imported-variable-on-top-level": "Imported Variable on Top Level",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

6 changes: 0 additions & 6 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
 <variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down

7 changes: 0 additions & 7 deletions
test/functional/test_site/testImportedVariables.md

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
test/functional/test_site/testImportedVariablesToImport.md

View file


Open in desktop


This file was deleted.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

May 12, 2019
 Merged


Revert "Add imported variables (#751)"
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


133 changes: 29 additions & 104 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
 * Utils
 */
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
 return;
 }
 if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 pageVariables[variableName] = variableValue;
 if (!VARIABLE_LOOKUP[fileName]) {
 VARIABLE_LOOKUP[fileName] = {};
 }
 VARIABLE_LOOKUP[fileName][variableName] = variableValue;
 }
 });
 return pageVariables;
}

/**
 * Extract imported page variables from a page
 * @param context of the page
 */
function extractImportedVariables(context) {
 if (!context.importedVariables) {
 return {};
 }
 const importedVariables = {};
 Object.entries(context.importedVariables).forEach(([src, variables]) => {
 variables.forEach((variableName) => {
 const actualFilePath = utils.isUrl()
 ? src
 : path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
 if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
 // eslint-disable-next-line no-console
 console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
 return;
 }
 const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
 if (!importedVariables[variableName]) {
 importedVariables[variableName] = variableValue;
 }
 });
 });
 return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
 return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.attribs = element.attribs || {};
 element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

 const requiresSrc = ['include', 'import'].includes(element.name);
 const requiresSrc = ['include'].includes(element.name);
 if (requiresSrc && _.isEmpty(element.attribs.src)) {
 const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
 this._onError(error);
 return createErrorNode(element, error);
 }
 const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
 const shouldProcessSrc = ['include', 'panel'].includes(element.name);
 const hasSrc = _.hasIn(element.attribs, 'src');
 let isUrl;
 let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 }
 }

 if (element.name === 'include' || element.name === 'import') {
 const isImport = element.name === 'import';
 if (element.name === 'include') {
 const isInline = _.hasIn(element.attribs, 'inline');
 const isDynamic = _.hasIn(element.attribs, 'dynamic');
 const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.name = 'markdown';
 }

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
 const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
 const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 const pageVariables = extractPageVariables(actualFilePath, fileContent,
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables },
 { path: actualFilePath });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
 if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
 const segmentSrc = cheerio.parseHTML(fileContent, true);
 const $ = cheerio.load(segmentSrc);
 const hashContent = $(includeSrc.hash).html();

 if (isImport) {
 const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
 if (!variableContent) {
 // eslint-disable-next-line no-console
 console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 if (!context.importedVariables) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables = {};
 }
 if (!context.importedVariables[includeSrc.pathname]) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname] = [];
 }
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
 return createEmptyNode();
 }

 let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

 if (actualContent === null) {
 if (isOptional) {
 // set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
 true,
 );
 } else {
 if (isImport) {
 // eslint-disable-next-line no-console
 console.warn(`Missing hash for import variable ${includeSrc.pathname}`
 + ` in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
 if (isIncludeSrcMd) {
 if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = { ...includeVariables };
 childContext.importedVariables = {};
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
 const error = new CyclicReferenceError(childContext.callStack);
 this._onError(error);
 return createErrorNode(element, error);
 }
 element.children = element.children.map((e) => {
 let processedEle = cheerio.html(self._preprocess(e, childContext, config));
 const importedVariables = extractImportedVariables(childContext);
 userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
 processedEle
 = nunjucks.renderString(processedEle,
 {
 ...pageVariables,
 ...importedVariables,
 ...includeVariables,
 ...userDefinedVariables,
 },
 { path: actualFilePath });
 return cheerio.parseHTML(processedEle)[0];
 });
 element.children = element.children.map(e => self._preprocess(e, childContext, config));
 }
 } else if ((element.name === 'panel') && hasSrc) {
 if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
 context.cwf = config.cwf || file; // current working file
 context.mode = 'include';
 context.callStack = [];
 let fileData = null;

 return new Promise((resolve, reject) => {
 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 const handler = new htmlparser.DomHandler((error, dom) => {
 if (error) {
 reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
 }
 return processed;
 });
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
 const importedVariables = extractImportedVariables(context);
 resolve(nunjucks.renderString(cheerio.html(nodes),
 { ...pageVariables, ...importedVariables, ...userDefinedVariables },
 { path: actualFilePath }));
 resolve(cheerio.html(nodes));
 });

 const parser = new htmlparser.Parser(handler, {
 xmlMode: true,
 decodeEntities: true,
 });

 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 // Read files
 fs.readFile(actualFilePath, 'utf-8', (err, data) => {
 fileData = data;
 if (err) {
 reject(err);
 return;
 }
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data,
 { ...pageVariables, ...userDefinedVariables },
 { path: actualFilePath });
 const fileExt = utils.getExt(file);
 const fileContent = data;
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
 parser.parseComplete(fileContent.toString());
Expand Down

14 changes: 0 additions & 14 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
 <div></div>
 Page Variable Referencing Included Variable
 </div>
 <div>
 <h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
 <div></div>
 Imported Variable
 <h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
 <div></div>
 Imported Variable Referencing Global Variable
 </div>
 <h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
 <div></div>
 Imported Variable on Top Level
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
 <span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down

3 changes: 0 additions & 3 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "imported-variable": "Imported Variable",
 "imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
 "imported-variable-on-top-level": "Imported Variable on Top Level",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

6 changes: 0 additions & 6 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
 <variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down

7 changes: 0 additions & 7 deletions
test/functional/test_site/testImportedVariables.md

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
test/functional/test_site/testImportedVariablesToImport.md

View file


Open in desktop


This file was deleted.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

May 12, 2019
 Merged


Revert "Add imported variables (#751)"
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


133 changes: 29 additions & 104 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
 * Utils
 */
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
 return;
 }
 if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 pageVariables[variableName] = variableValue;
 if (!VARIABLE_LOOKUP[fileName]) {
 VARIABLE_LOOKUP[fileName] = {};
 }
 VARIABLE_LOOKUP[fileName][variableName] = variableValue;
 }
 });
 return pageVariables;
}

/**
 * Extract imported page variables from a page
 * @param context of the page
 */
function extractImportedVariables(context) {
 if (!context.importedVariables) {
 return {};
 }
 const importedVariables = {};
 Object.entries(context.importedVariables).forEach(([src, variables]) => {
 variables.forEach((variableName) => {
 const actualFilePath = utils.isUrl()
 ? src
 : path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
 if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
 // eslint-disable-next-line no-console
 console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
 return;
 }
 const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
 if (!importedVariables[variableName]) {
 importedVariables[variableName] = variableValue;
 }
 });
 });
 return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
 return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.attribs = element.attribs || {};
 element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

 const requiresSrc = ['include', 'import'].includes(element.name);
 const requiresSrc = ['include'].includes(element.name);
 if (requiresSrc && _.isEmpty(element.attribs.src)) {
 const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
 this._onError(error);
 return createErrorNode(element, error);
 }
 const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
 const shouldProcessSrc = ['include', 'panel'].includes(element.name);
 const hasSrc = _.hasIn(element.attribs, 'src');
 let isUrl;
 let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 }
 }

 if (element.name === 'include' || element.name === 'import') {
 const isImport = element.name === 'import';
 if (element.name === 'include') {
 const isInline = _.hasIn(element.attribs, 'inline');
 const isDynamic = _.hasIn(element.attribs, 'dynamic');
 const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.name = 'markdown';
 }

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
 const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
 const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 const pageVariables = extractPageVariables(actualFilePath, fileContent,
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables },
 { path: actualFilePath });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
 if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
 const segmentSrc = cheerio.parseHTML(fileContent, true);
 const $ = cheerio.load(segmentSrc);
 const hashContent = $(includeSrc.hash).html();

 if (isImport) {
 const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
 if (!variableContent) {
 // eslint-disable-next-line no-console
 console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 if (!context.importedVariables) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables = {};
 }
 if (!context.importedVariables[includeSrc.pathname]) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname] = [];
 }
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
 return createEmptyNode();
 }

 let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

 if (actualContent === null) {
 if (isOptional) {
 // set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
 true,
 );
 } else {
 if (isImport) {
 // eslint-disable-next-line no-console
 console.warn(`Missing hash for import variable ${includeSrc.pathname}`
 + ` in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
 if (isIncludeSrcMd) {
 if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = { ...includeVariables };
 childContext.importedVariables = {};
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
 const error = new CyclicReferenceError(childContext.callStack);
 this._onError(error);
 return createErrorNode(element, error);
 }
 element.children = element.children.map((e) => {
 let processedEle = cheerio.html(self._preprocess(e, childContext, config));
 const importedVariables = extractImportedVariables(childContext);
 userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
 processedEle
 = nunjucks.renderString(processedEle,
 {
 ...pageVariables,
 ...importedVariables,
 ...includeVariables,
 ...userDefinedVariables,
 },
 { path: actualFilePath });
 return cheerio.parseHTML(processedEle)[0];
 });
 element.children = element.children.map(e => self._preprocess(e, childContext, config));
 }
 } else if ((element.name === 'panel') && hasSrc) {
 if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
 context.cwf = config.cwf || file; // current working file
 context.mode = 'include';
 context.callStack = [];
 let fileData = null;

 return new Promise((resolve, reject) => {
 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 const handler = new htmlparser.DomHandler((error, dom) => {
 if (error) {
 reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
 }
 return processed;
 });
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
 const importedVariables = extractImportedVariables(context);
 resolve(nunjucks.renderString(cheerio.html(nodes),
 { ...pageVariables, ...importedVariables, ...userDefinedVariables },
 { path: actualFilePath }));
 resolve(cheerio.html(nodes));
 });

 const parser = new htmlparser.Parser(handler, {
 xmlMode: true,
 decodeEntities: true,
 });

 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 // Read files
 fs.readFile(actualFilePath, 'utf-8', (err, data) => {
 fileData = data;
 if (err) {
 reject(err);
 return;
 }
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data,
 { ...pageVariables, ...userDefinedVariables },
 { path: actualFilePath });
 const fileExt = utils.getExt(file);
 const fileContent = data;
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
 parser.parseComplete(fileContent.toString());
Expand Down

14 changes: 0 additions & 14 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
 <div></div>
 Page Variable Referencing Included Variable
 </div>
 <div>
 <h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
 <div></div>
 Imported Variable
 <h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
 <div></div>
 Imported Variable Referencing Global Variable
 </div>
 <h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
 <div></div>
 Imported Variable on Top Level
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
 <span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down

3 changes: 0 additions & 3 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "imported-variable": "Imported Variable",
 "imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
 "imported-variable-on-top-level": "Imported Variable on Top Level",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

6 changes: 0 additions & 6 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
 <variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down

7 changes: 0 additions & 7 deletions
test/functional/test_site/testImportedVariables.md

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
test/functional/test_site/testImportedVariablesToImport.md

View file


Open in desktop


This file was deleted.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

May 12, 2019
 Merged


Revert "Add imported variables (#751)"
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


133 changes: 29 additions & 104 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
 * Utils
 */
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
 return;
 }
 if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 pageVariables[variableName] = variableValue;
 if (!VARIABLE_LOOKUP[fileName]) {
 VARIABLE_LOOKUP[fileName] = {};
 }
 VARIABLE_LOOKUP[fileName][variableName] = variableValue;
 }
 });
 return pageVariables;
}

/**
 * Extract imported page variables from a page
 * @param context of the page
 */
function extractImportedVariables(context) {
 if (!context.importedVariables) {
 return {};
 }
 const importedVariables = {};
 Object.entries(context.importedVariables).forEach(([src, variables]) => {
 variables.forEach((variableName) => {
 const actualFilePath = utils.isUrl()
 ? src
 : path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
 if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
 // eslint-disable-next-line no-console
 console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
 return;
 }
 const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
 if (!importedVariables[variableName]) {
 importedVariables[variableName] = variableValue;
 }
 });
 });
 return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
 return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.attribs = element.attribs || {};
 element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

 const requiresSrc = ['include', 'import'].includes(element.name);
 const requiresSrc = ['include'].includes(element.name);
 if (requiresSrc && _.isEmpty(element.attribs.src)) {
 const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
 this._onError(error);
 return createErrorNode(element, error);
 }
 const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
 const shouldProcessSrc = ['include', 'panel'].includes(element.name);
 const hasSrc = _.hasIn(element.attribs, 'src');
 let isUrl;
 let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 }
 }

 if (element.name === 'include' || element.name === 'import') {
 const isImport = element.name === 'import';
 if (element.name === 'include') {
 const isInline = _.hasIn(element.attribs, 'inline');
 const isDynamic = _.hasIn(element.attribs, 'dynamic');
 const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.name = 'markdown';
 }

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
 const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
 const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 const pageVariables = extractPageVariables(actualFilePath, fileContent,
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables },
 { path: actualFilePath });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
 if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
 const segmentSrc = cheerio.parseHTML(fileContent, true);
 const $ = cheerio.load(segmentSrc);
 const hashContent = $(includeSrc.hash).html();

 if (isImport) {
 const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
 if (!variableContent) {
 // eslint-disable-next-line no-console
 console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 if (!context.importedVariables) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables = {};
 }
 if (!context.importedVariables[includeSrc.pathname]) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname] = [];
 }
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
 return createEmptyNode();
 }

 let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

 if (actualContent === null) {
 if (isOptional) {
 // set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
 true,
 );
 } else {
 if (isImport) {
 // eslint-disable-next-line no-console
 console.warn(`Missing hash for import variable ${includeSrc.pathname}`
 + ` in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
 if (isIncludeSrcMd) {
 if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = { ...includeVariables };
 childContext.importedVariables = {};
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
 const error = new CyclicReferenceError(childContext.callStack);
 this._onError(error);
 return createErrorNode(element, error);
 }
 element.children = element.children.map((e) => {
 let processedEle = cheerio.html(self._preprocess(e, childContext, config));
 const importedVariables = extractImportedVariables(childContext);
 userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
 processedEle
 = nunjucks.renderString(processedEle,
 {
 ...pageVariables,
 ...importedVariables,
 ...includeVariables,
 ...userDefinedVariables,
 },
 { path: actualFilePath });
 return cheerio.parseHTML(processedEle)[0];
 });
 element.children = element.children.map(e => self._preprocess(e, childContext, config));
 }
 } else if ((element.name === 'panel') && hasSrc) {
 if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
 context.cwf = config.cwf || file; // current working file
 context.mode = 'include';
 context.callStack = [];
 let fileData = null;

 return new Promise((resolve, reject) => {
 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 const handler = new htmlparser.DomHandler((error, dom) => {
 if (error) {
 reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
 }
 return processed;
 });
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
 const importedVariables = extractImportedVariables(context);
 resolve(nunjucks.renderString(cheerio.html(nodes),
 { ...pageVariables, ...importedVariables, ...userDefinedVariables },
 { path: actualFilePath }));
 resolve(cheerio.html(nodes));
 });

 const parser = new htmlparser.Parser(handler, {
 xmlMode: true,
 decodeEntities: true,
 });

 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 // Read files
 fs.readFile(actualFilePath, 'utf-8', (err, data) => {
 fileData = data;
 if (err) {
 reject(err);
 return;
 }
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data,
 { ...pageVariables, ...userDefinedVariables },
 { path: actualFilePath });
 const fileExt = utils.getExt(file);
 const fileContent = data;
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
 parser.parseComplete(fileContent.toString());
Expand Down

14 changes: 0 additions & 14 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
 <div></div>
 Page Variable Referencing Included Variable
 </div>
 <div>
 <h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
 <div></div>
 Imported Variable
 <h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
 <div></div>
 Imported Variable Referencing Global Variable
 </div>
 <h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
 <div></div>
 Imported Variable on Top Level
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
 <span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down

3 changes: 0 additions & 3 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "imported-variable": "Imported Variable",
 "imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
 "imported-variable-on-top-level": "Imported Variable on Top Level",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

6 changes: 0 additions & 6 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
 <variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down

7 changes: 0 additions & 7 deletions
test/functional/test_site/testImportedVariables.md

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
test/functional/test_site/testImportedVariablesToImport.md

View file


Open in desktop


This file was deleted.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Revert "Add imported variables (#751)"#849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

May 12, 2019
 Merged


Revert "Add imported variables (#751)"
#849
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


133 changes: 29 additions & 104 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,6 @@ const ATTRIB_CWF = 'cwf';

const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

const VARIABLE_LOOKUP = {};

/*
 * Utils
 */
Expand DownExpand Up@@ -144,47 +142,14 @@ function extractPageVariables(fileName, data, userDefinedVariables, includedVari
 return;
 }
 if (!pageVariables[variableName]) {
const variableValue
pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 pageVariables[variableName] = variableValue;
 if (!VARIABLE_LOOKUP[fileName]) {
 VARIABLE_LOOKUP[fileName] = {};
 }
 VARIABLE_LOOKUP[fileName][variableName] = variableValue;
 }
 });
 return pageVariables;
}

/**
 * Extract imported page variables from a page
 * @param context of the page
 */
function extractImportedVariables(context) {
 if (!context.importedVariables) {
 return {};
 }
 const importedVariables = {};
 Object.entries(context.importedVariables).forEach(([src, variables]) => {
 variables.forEach((variableName) => {
 const actualFilePath = utils.isUrl()
 ? src
 : path.resolve(path.dirname(context.cwf), decodeURIComponent(url.parse(src).path));
 if (!VARIABLE_LOOKUP[actualFilePath] || !VARIABLE_LOOKUP[actualFilePath][variableName]) {
 // eslint-disable-next-line no-console
 console.warn(`Missing variable ${variableName} in ${src} referenced by ${context.cwf}\n`);
 return;
 }
 const variableValue = VARIABLE_LOOKUP[actualFilePath][variableName];
 if (!importedVariables[variableName]) {
 importedVariables[variableName] = variableValue;
 }
 });
 });
 return importedVariables;
}

Parser.prototype.getDynamicIncludeSrc = function () {
 return _.clone(this.dynamicIncludeSrc);
};
Expand All@@ -207,13 +172,13 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.attribs = element.attribs || {};
 element.attribs[ATTRIB_CWF] = path.resolve(context.cwf);

 const requiresSrc = ['include', 'import'].includes(element.name);
 const requiresSrc = ['include'].includes(element.name);
 if (requiresSrc && _.isEmpty(element.attribs.src)) {
 const error = new Error(`Empty src attribute in ${element.name} in: ${element.attribs[ATTRIB_CWF]}`);
 this._onError(error);
 return createErrorNode(element, error);
 }
 const shouldProcessSrc = ['include', 'panel', 'import'].includes(element.name);
 const shouldProcessSrc = ['include', 'panel'].includes(element.name);
 const hasSrc = _.hasIn(element.attribs, 'src');
 let isUrl;
 let includeSrc;
Expand DownExpand Up@@ -246,8 +211,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 }
 }

 if (element.name === 'include' || element.name === 'import') {
 const isImport = element.name === 'import';
 if (element.name === 'include') {
 const isInline = _.hasIn(element.attribs, 'inline');
 const isDynamic = _.hasIn(element.attribs, 'dynamic');
 const isOptional = _.hasIn(element.attribs, 'optional');
Expand DownExpand Up@@ -299,17 +263,22 @@ Parser.prototype._preprocess = function (node, context, config) {
 element.name = 'markdown';
 }

const fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
let fileContent = self._fileCache[actualFilePath]; // cache the file contents to save some I/O
 const { parent, relative } = calculateNewBaseUrls(filePath, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
 const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 const pageVariables = extractPageVariables(actualFilePath, fileContent,
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables },
 { path: actualFilePath });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
 if (attribute.startsWith('var-')) {
Expand All@@ -327,28 +296,8 @@ Parser.prototype._preprocess = function (node, context, config) {
 const segmentSrc = cheerio.parseHTML(fileContent, true);
 const $ = cheerio.load(segmentSrc);
 const hashContent = $(includeSrc.hash).html();

 if (isImport) {
 const variableContent = $(`variable[name=${includeSrc.hash.substring(1)}]`).html();
 if (!variableContent) {
 // eslint-disable-next-line no-console
 console.warn(`Missing import variable ${includeSrc.pathname} in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 if (!context.importedVariables) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables = {};
 }
 if (!context.importedVariables[includeSrc.pathname]) {
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname] = [];
 }
 // eslint-disable-next-line no-param-reassign
 context.importedVariables[includeSrc.pathname].push(includeSrc.hash.substring(1));
 return createEmptyNode();
 }

 let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;

 if (actualContent === null) {
 if (isOptional) {
 // set empty content for optional segment include that does not exist
Expand DownExpand Up@@ -382,12 +331,6 @@ Parser.prototype._preprocess = function (node, context, config) {
 true,
 );
 } else {
 if (isImport) {
 // eslint-disable-next-line no-console
 console.warn(`Missing hash for import variable ${includeSrc.pathname}`
 + ` in ${element.attribs[ATTRIB_CWF]}.`);
 return createEmptyNode();
 }
 let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
 if (isIncludeSrcMd) {
 if (context.mode === 'include') {
Expand All@@ -409,30 +352,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = { ...includeVariables };
 childContext.importedVariables = {};
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
 const error = new CyclicReferenceError(childContext.callStack);
 this._onError(error);
 return createErrorNode(element, error);
 }
 element.children = element.children.map((e) => {
 let processedEle = cheerio.html(self._preprocess(e, childContext, config));
 const importedVariables = extractImportedVariables(childContext);
 userDefinedVariables.hostBaseUrl = '{{hostBaseUrl}}';
 processedEle
 = nunjucks.renderString(processedEle,
 {
 ...pageVariables,
 ...importedVariables,
 ...includeVariables,
 ...userDefinedVariables,
 },
 { path: actualFilePath });
 return cheerio.parseHTML(processedEle)[0];
 });
 element.children = element.children.map(e => self._preprocess(e, childContext, config));
 }
 } else if ((element.name === 'panel') && hasSrc) {
 if (!isUrl && includeSrc.hash) {
Expand DownExpand Up@@ -603,17 +531,8 @@ Parser.prototype.includeFile = function (file, config) {
 context.cwf = config.cwf || file; // current working file
 context.mode = 'include';
 context.callStack = [];
 let fileData = null;

 return new Promise((resolve, reject) => {
 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 const handler = new htmlparser.DomHandler((error, dom) => {
 if (error) {
 reject(error);
Expand All@@ -630,29 +549,35 @@ Parser.prototype.includeFile = function (file, config) {
 }
 return processed;
 });
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), fileData, userDefinedVariables, {});
 const importedVariables = extractImportedVariables(context);
 resolve(nunjucks.renderString(cheerio.html(nodes),
 { ...pageVariables, ...importedVariables, ...userDefinedVariables },
 { path: actualFilePath }));
 resolve(cheerio.html(nodes));
 });

 const parser = new htmlparser.Parser(handler, {
 xmlMode: true,
 decodeEntities: true,
 });

 let actualFilePath = file;
 if (!utils.fileExists(file)) {
 const boilerplateFilePath = calculateBoilerplateFilePath(path.basename(file), file, config);
 if (utils.fileExists(boilerplateFilePath)) {
 actualFilePath = boilerplateFilePath;
 }
 }

 // Read files
 fs.readFile(actualFilePath, 'utf-8', (err, data) => {
 fileData = data;
 if (err) {
 reject(err);
 return;
 }
 const { parent, relative } = calculateNewBaseUrls(file, config.rootPath, config.baseUrlMap);
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data,
 { ...pageVariables, ...userDefinedVariables },
 { path: actualFilePath });
 const fileExt = utils.getExt(file);
 const fileContent = data;
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
 parser.parseComplete(fileContent.toString());
Expand Down

14 changes: 0 additions & 14 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,17 +183,6 @@ <h1 id="page-variable-referencing-included-variable">Page Variable Referencing I
 <div></div>
 Page Variable Referencing Included Variable
 </div>
 <div>
 <h1 id="imported-variable">Imported Variable<a class="fa fa-anchor" href="#imported-variable"></a></h1>
 <div></div>
 Imported Variable
 <h1 id="imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable<a class="fa fa-anchor" href="#imported-variable-referencing-global-variable"></a></h1>
 <div></div>
 Imported Variable Referencing Global Variable
 </div>
 <h1 id="imported-variable-on-top-level">Imported Variable on Top Level<a class="fa fa-anchor" href="#imported-variable-on-top-level"></a></h1>
 <div></div>
 Imported Variable on Top Level
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
 <span class="keyword">keyword 2</span></p>
Expand DownExpand Up@@ -486,9 +475,6 @@ <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-alwa
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable">Imported Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-referencing-global-variable">Imported Variable Referencing Global Variable&#x200E;</a>
 <a class="nav-link py-1" href="#imported-variable-on-top-level">Imported Variable on Top Level&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand Down

3 changes: 0 additions & 3 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,9 +53,6 @@
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "imported-variable": "Imported Variable",
 "imported-variable-referencing-global-variable": "Imported Variable Referencing Global Variable",
 "imported-variable-on-top-level": "Imported Variable on Top Level",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

6 changes: 0 additions & 6 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,12 +55,6 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd
 <variable name="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</variable>
</include>

<include src="testImportedVariables.md" />

# Imported Variable on Top Level
<import src="testImportedVariablesToImport.md#imported_variable_on_top_level" />
{{ imported_variable_on_top_level }}

# Heading with multiple keywords
<span class="keyword">keyword 1</span>
<span class="keyword">keyword 2</span>
Expand Down

7 changes: 0 additions & 7 deletions
test/functional/test_site/testImportedVariables.md

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
test/functional/test_site/testImportedVariablesToImport.md

View file


Open in desktop


This file was deleted.