') + ')', '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('^' + ".*" + ', '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" + ', '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('^' + ".*" + ', '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); } })(); })(); Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content

Allow an array of globs for the globs option - #1118

Merged
marvinchin merged 1 commit into
MarkBind:masterfrom
ang-zeyu:list-of-globs
Mar 28, 2020
Merged

Allow an array of globs for the globs option#1118
marvinchin merged 1 commit into
MarkBind:masterfrom
ang-zeyu:list-of-globs

Conversation

@ang-zeyu

@ang-zeyuang-zeyu commented Mar 11, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [x] Documentation update
• [x] Enhancement to an existing feature

Resolves#789

What is the rationale for this request?
Allow authors to specify an array of globs for the globs option, which can help reduce repeated configuration

What changes did you make? (Give an overview)

  • Simple one line code change to allow said feature
  • Small rewrite of the complex reduce - concat method of collecting pages with globs and walkSync using flatMap instead.
  • Some other minor refactors to collectAddressablePages
  • Update documentation accordingly
  • Update existing site.json for test sites / docs and update test files accordingly.
    • Two of the test sites' expected siteData.json's page entries order was swapped due to walkSync now collecting the pages from all globs in the array simultaneously. ( the properties remain the same though )

Provide some example code that this change will affect:

...
globs: Array.isArray(page.glob) ? page.glob : [page.glob],
...

Is there anything you'd like reviewers to focus on?

  • Should we allow this for src as well?

Testing instructions:

  • npm run test should pass ( existing site.json for docs and test sites were updated to use new syntax )

Proposed commit message: (wrap lines at 72 characters)
Allow an array for specifying page src or glob

The site configuration does not allow using an array for specifying
pages in the src or glob property.
The method for collecting the addressable pages can also be
made slightly simpler in the process.

Let’s do so, reducing the amount of repeated configuration the
author potentially needs to write.
Let’s also simplify the method for collecting addressable pages
in the process.

@ang-zeyu
ang-zeyuforce-pushed the list-of-globs branch 3 times, most recently from 4a67349 to 10395a9CompareMarch 23, 2020 09:54
@ang-zeyu

ang-zeyu commented Mar 26, 2020

Copy link
Copy Markdown
ContributorAuthor

@yash-chowdhary could I get your review here?

The functional changes are summarised by this line
globs: Array.isArray(page.glob) ? page.glob : [page.glob],,
while the rest of the changes are just to refactor collectAddressablePages using lodash's flatMap.

@yash-chowdhary

yash-chowdhary commented Mar 27, 2020

Copy link
Copy Markdown
Contributor
  • Should we allow this for src as well?

Yes, I think this would be good. It would solve the same issue of repeated configuration. Unless there was a reason for making it a per-file configuration?
Maybe we can get the opinions of @damithc@marvinchin?

Otherwise, LGTM!

@damithc

damithc commented Mar 27, 2020

Copy link
Copy Markdown
Contributor
  • Should we allow this for src as well?

No objections from me

@ang-zeyu
Allow an array for specifying page src or glob
91c3227
The site configuration does not allow using an array for specifying
pages in the src or glob property.
The method for collecting the addressable pages can also be
made slightly simpler in the process.
Let’s do so, reducing the amount of repeated configuration the
author potentially needs to write.
Let’s also simplify the method for collecting addressable pages
in the process.
marvinchin
marvinchin approved these changes Mar 28, 2020
View reviewed changes

@marvinchinmarvinchin left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?

@marvinchinmarvinchin added this to the v2.12.1 milestone Mar 28, 2020
ang-zeyu
ang-zeyu commented Mar 28, 2020
View reviewed changes
Comment threadsrc/Site.js
this.addressablePages = pages.filter(page => page.src);
const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
: [page]));

@ang-zeyuang-zeyuMar 28, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin

Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?

My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!

@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its just a three line change here ^ though, let me know if it should be in a separate PR!

I think it can be left in this PR. 👍

@marvinchin
marvinchin merged commit f7351af into MarkBind:masterMar 28, 2020
Tejas2805 added a commit to Tejas2805/markbind that referenced this pull request Mar 28, 2020
@Tejas2805
Merge branch 'remove-fixed-bugs' ofhttps://github.com/Tejas2805/mark…
422e202
…bind into remove-fixed-bugs
* 'remove-fixed-bugs' of https://github.com/Tejas2805/markbind:
Docs: Add contributing.md (MarkBind#1139)
Show pointer and use underline dashed for click trigger (MarkBind#1111)
Support variables to be defined as by JSON (MarkBind#1117)
Allow an array for specifying page src or glob (MarkBind#1118)
Code blocks: Implement inline markdown support for heading (MarkBind#1137)
Fix lazy reload for urls without index (MarkBind#1110)
Changes remaining references from filterTags to tags (MarkBind#1149)
marvinchin pushed a commit that referenced this pull request Apr 10, 2020
@ang-zeyuMarvin Chin
Allow an array for specifying page src or glob (#1118)
bf1239d
The site configuration does not allow using an array for specifying
pages in the src or glob property.
The method for collecting the addressable pages can also be
made slightly simpler in the process.
Let’s do so, reducing the amount of repeated configuration the
author potentially needs to write.
Let’s also simplify the method for collecting addressable pages
in the process.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yash-chowdharyyash-chowdharyyash-chowdhary left review comments
@marvinchinmarvinchinmarvinchin approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v2.13.0

Development

Successfully merging this pull request may close these issues.

site.json: allow a list for glob

4 participants

@ang-zeyu@yash-chowdhary@damithc@marvinchin