Autogenerate the customizer's variables form #11158

cvrebert · 2013-10-18T09:15:24Z

Implements #11095 (or the main part of it anyway). This could use a lot of testing and review.
/cc @twbs/team

This doesn't address the issue of JS plugin or LESS file interdependencies, and it doesn't generate the checkbox sections at the top of the customizer page.

cvrebert · 2013-10-18T09:18:26Z

Gruntfile.js

+          pretty: true,
+          data: function (dest, src) {
+            /*
+            Mini-language:


If you guys wanna tweak the syntax, I'm all ears.

this whole piece of code is awesomeness! well done (Y)

cvrebert · 2013-10-21T18:09:54Z

After some testing, I'm now fairly confident about this from a technical standpoint, although the template definitely does need some styling love.
(In any event, I'd like to squash more of the commits before final merge though.)

mdo · 2013-10-21T22:19:59Z

Holy shit so much <3 for doing this. Will dive in after 3.0.1 ships. <3

cvrebert · 2013-10-21T22:24:35Z

Gruntfile.js

+              return markdown.toHTML(markdownString.trim()).slice(3, -4);
+            }
+            function VarDocstring(markdownString) {
+              // the slice removes the <p>...</p> wrapper output by Markdown processor


should move this comment into markdown2html()

zlatanvasovic · 2013-11-03T14:04:12Z

@cvrebert This also removes unneeded Accordition section from Customizer.

zlatanvasovic · 2013-11-03T14:08:15Z

Gruntfile.js

@@ -178,7 +353,7 @@ module.exports = function(grunt) {
  grunt.registerTask('validate-html', ['jekyll', 'validation']);

  // Test task.
-  var testSubtasks = ['dist-css', 'jshint', 'qunit', 'validate-html'];
+  var testSubtasks = ['dist-css', 'jshint', 'qunit', 'build-customizer-vars-form', 'validate-html'];


build-customizer-vars is much better (and shorter) name for task than build-customizer-vars-form.

zlatanvasovic · 2013-11-06T19:16:33Z

@cvrebert Could you rewrite these things to be just in Jekyll? Jekyll 1.3.0 datafiles now can replace Jade. ;)

cvrebert · 2013-11-06T19:28:40Z

@zdroid Meh.

zlatanvasovic · 2013-11-06T20:26:08Z

@cvrebert Or give me a chance to do that thing (just wait some time to GitHub update the Jekyll)? :D

ssorallen · 2013-11-06T22:05:08Z

@zdroid I think the idea of this pull request was to generate the page from the .less files so the data stays in one place. Moving some of it to YAML data files would make it possible for them to get out of sync again.

Or what did you have in mind for the YAML data files?

cvrebert · 2013-11-06T23:14:42Z

@ssorallen Well, you could generate YAML from the LESS, which Jekyll could then template into HTML. It'd be another level of indirection/complexity though.

zlatanvasovic · 2013-11-07T06:27:27Z

I suggested Jekyll to avoid importing Jade (and maybe Markdown?).

2013/11/7 Chris Rebert notifications@github.com

@ssorallen https://github.com/ssorallen Well, you could generate YAML
from the LESS, which Jekyll could then template into HTML. It'd be another
level of indirection/complexity though.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/11158#issuecomment-27923751
.

Zlatan Vasović - ZDroid

cvrebert · 2013-11-17T02:10:43Z

@mdo Any feedback man?

mdo · 2013-12-08T10:58:41Z

This all looks glorious. There are a few things that came to mind:

Column sizing (I mentioned this in a code comment) needs to happen. A generic parent wrapper should suffice so we can make it into a grid column.
Need those for attributes on the labels.
v3 Customizer allow edit rather than overwrite #9829 asks for values instead of placeholders—thoughts?

Everything else is looking pretty good at this point. What are our options for expanding this language to include more granularity with subheading and such?

mdo · 2013-12-08T10:58:55Z

Also, I merged master and may have fucked something up 😁.

zlatanvasovic · 2013-12-08T11:10:15Z

@mdo drop these commits :O

zlatanvasovic · 2013-12-08T11:11:06Z

#9829 is good idea, should be done.

cvrebert · 2013-12-09T05:41:30Z

@mdo Made the changes you requested. Also clobbered that merge with a proper rebase.

Everything else is looking pretty good at this point. What are our options for expanding this language to include more granularity with subheading and such?

Just tell me what syntax/scheme you desire, and I'll implement it 😄

cvrebert · 2013-12-10T05:20:57Z

TODO: add //=== for <h3> subsections, per mdo's request

zlatanvasovic · 2013-12-10T12:08:09Z

@cvrebert Can you, after a completing pull request, merge these commits into one? Commit history looks so bad. :D

cvrebert · 2013-12-10T12:14:46Z

Yes, I definitely plan to do some squashing before the final merge.

mdo · 2013-12-12T23:20:53Z

As part of this, or a follow up, can you generate the list of Glyphicons on the Components page? Would be most useful for adding Flash-based click-to-copy.

cvrebert · 2013-12-13T00:57:32Z

@mdo Punted Glyphicons to #11862.

zlatanvasovic · 2013-12-13T13:31:16Z

And auto-generate component list (I may do it, when autogenerating variables is finished)! :)

mdo · 2013-12-15T22:38:53Z

@cvrebert Cool, fine by me. Where do we stand on this then? I know I have to finish up the code comments revamp from the variables file, but anything else still open? Let's put together a quick check list if there's a few things.

cvrebert · 2013-12-15T22:43:14Z

I need to add support for another level of sectioning like you asked for, and I'd like to squash this PR into way fewer commits.

fat · 2013-12-29T05:15:49Z

Gruntfile.js

@@ -206,6 +206,182 @@ module.exports = function (grunt) {
      docs: {}
    },

+    jade: {


i feel like it's pretty gnarly this thing has to exist here… is it possible to make this script a node package, require it and execute it?

Yes, agreed.

cvrebert · 2013-12-30T07:39:35Z

TODO:

move the parser into a separate file/module
once there's a /docs/, move the jade template & the parser JS files to be under it

cvrebert · 2014-01-08T05:44:27Z

@mdo Okay, this now supports the h3 syntax you requested. Can we merge this bad boy?

zlatanvasovic · 2014-01-08T09:43:07Z

@cvrebert Did you merge master? It has /docs/ now. Also, squash these commits if possible. :)

juthilo · 2014-01-08T09:53:39Z

@zdroid Squashing commits would make the most sense once we know there's nothing left to be done, don't you think? :)

zlatanvasovic · 2014-01-08T09:58:35Z

@juthilo Yup, that's why I said it as the last. :)

@mdo

…iables.less; fixes #11095 also updates variables file organization (courtesy @mdo)

cvrebert · 2014-01-08T20:43:03Z

It's already been squashed as much as I'm gonna squash it.

zlatanvasovic · 2014-01-08T20:50:03Z

kk

2014/1/8 Chris Rebert notifications@github.com

It's already been squashed as much as I'm gonna squash it.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/11158#issuecomment-31875876
.

Zlatan Vasović - ZDroid

cvrebert · 2014-01-09T02:31:46Z

The variable docstrings might perhaps need further tweaking and more h3 subsections probably need to be added, but those are minor tweaks to the text rather than the parser code and can be done separately later.

Autogenerate the customizer's variables form

mdo · 2014-01-10T04:34:20Z

Thanks for getting this done @cvrebert <3. Everything looks great!

cvrebert reviewed Oct 18, 2013
View reviewed changes

cvrebert reviewed Oct 21, 2013
View reviewed changes

zlatanvasovic reviewed Nov 3, 2013
View reviewed changes

zlatanvasovic mentioned this pull request Dec 7, 2013

Split styles/sections in customizer with comments #9986

Closed

mdo mentioned this pull request Dec 9, 2013

how can I change the fonts file path variable via customizer? #10171

Closed

cvrebert mentioned this pull request Dec 10, 2013

Correct simple typo on customize page. #11813

Closed

cvrebert mentioned this pull request Dec 16, 2013

The Customizer page should be autogenerated #11095

Closed

fat reviewed Dec 29, 2013
View reviewed changes

ghost assigned cvrebert Jan 6, 2014

cvrebert added 3 commits January 8, 2014 12:37

JSCS can be dumb sometimes

c9ba678

Use JS & Jade to generate the customizer variables form HTML from var…

3986171

…iables.less; fixes #11095 also updates variables file organization (courtesy @mdo)

add support for '//===' for <h3>s in bs-lessdoc

db829f8

cvrebert added a commit that referenced this pull request Jan 9, 2014

Merge pull request #11158 from twbs/templated-customizer

9443044

Autogenerate the customizer's variables form

cvrebert merged commit 9443044 into master Jan 9, 2014

cvrebert deleted the templated-customizer branch January 9, 2014 02:36

mdo mentioned this pull request Jan 10, 2014

v3.1.0 ship list #11734

Closed

Autogenerate the customizer's variables form #11158

Autogenerate the customizer's variables form #11158

Conversation

cvrebert commented Oct 18, 2013

cvrebert Oct 18, 2013

Choose a reason for hiding this comment

ZainShaikh Oct 22, 2013

Choose a reason for hiding this comment

cvrebert commented Oct 21, 2013

mdo commented Oct 21, 2013

cvrebert Oct 21, 2013

Choose a reason for hiding this comment

zlatanvasovic commented Nov 3, 2013

zlatanvasovic Nov 3, 2013

Choose a reason for hiding this comment

zlatanvasovic commented Nov 6, 2013

cvrebert commented Nov 6, 2013

zlatanvasovic commented Nov 6, 2013

ssorallen commented Nov 6, 2013

cvrebert commented Nov 6, 2013

zlatanvasovic commented Nov 7, 2013

cvrebert commented Nov 17, 2013

mdo commented Dec 8, 2013

mdo commented Dec 8, 2013

zlatanvasovic commented Dec 8, 2013

zlatanvasovic commented Dec 8, 2013

cvrebert commented Dec 9, 2013

cvrebert commented Dec 10, 2013

zlatanvasovic commented Dec 10, 2013

cvrebert commented Dec 10, 2013

mdo commented Dec 12, 2013

cvrebert commented Dec 13, 2013

zlatanvasovic commented Dec 13, 2013

mdo commented Dec 15, 2013

cvrebert commented Dec 15, 2013

fat Dec 29, 2013

Choose a reason for hiding this comment

cvrebert Dec 30, 2013

Choose a reason for hiding this comment

cvrebert Jan 8, 2014

Choose a reason for hiding this comment

cvrebert commented Dec 30, 2013

cvrebert commented Jan 8, 2014

zlatanvasovic commented Jan 8, 2014

juthilo commented Jan 8, 2014

zlatanvasovic commented Jan 8, 2014

cvrebert commented Jan 8, 2014

zlatanvasovic commented Jan 8, 2014

cvrebert commented Jan 9, 2014

mdo commented Jan 10, 2014