I'm applying to have my living styleguide module promoted to a full project. Once installed and enabled, the module will scan the default theme directory looking for Sass, Less or CSS comments that match a certain syntax. It will display the markup, styling and documentation associated with the CSS declarations. The syntax is based on the KSS methodology. This module does not generate predefined elements like the style guide module and will only render items that are defined within the CSS comment.

Project sandbox: https://drupal.org/sandbox/jeremy-green/2176415
Project git repository: git.drupal.org:sandbox/jeremy-green/2176415.git

CommentFileSizeAuthor
#13 Screen Shot 2014-04-02 at 3.47.15 PM.png59.94 KBfrogdog_tech
#13 scss.zip624 bytesfrogdog_tech

Comments

PA robot’s picture

PA robot commented
Status: Needs review » Needs work

There are some errors reported by automated review tools, did you already check them? See http://pareview.sh/pareview/httpgitdrupalorgsandboxjeremy-green2176415git

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

jeremy-green’s picture

jeremy-green commented
Issue summary: View changes
jeremy-green’s picture

jeremy-green commented
Status: Needs work » Needs review

I fixed all the errors except for the camel case ones. I'm using a Composer package, and those methods are camel cased. I can't seem to find anything on the web one way or another about having a Composer dependency in a contrib module. Any suggestions?

jeremy-green’s picture

jeremy-green commented
Status: Needs review » Needs work
jeremy-green’s picture

jeremy-green commented
Status: Needs work » Needs review

Removed master branch and all other errors.

nitesh sethia’s picture

nitesh sethia commented

Hey,

Your module looks good to me. If you could change the name of the js file from 

kss.js

to something like 

living_styleguide.js

So that the js file does not get any conflict with other js files.

jeremy-green’s picture

jeremy-green commented

I renamed the js file and updated the path in the module. Thanks!!

Anonymous’s picture

Anonymous (not verified) commented

Hello,
I would be nice to see theme_living_styleguide_get_section replaced with a template file and a preprocess function for it, the same for 'Guide/Section' pages. In this way it is easier to update and personalize your style-guide and the generated markup will look way cleaner.

You could also replace that custom theme_living_styleguide_get_top_level_section with a theme('item_list'...) invocation, since it's almost the same thing.

Regards,
Walter S.

jeremy-green’s picture

jeremy-green commented

I went through and refactored the code, removed the theme file and added some template files. I also replaced the theme_living_styleguide_get_top_level_section with the theme_item_list call. Thanks!!

jeremy-green’s picture

jeremy-green commented
Status: Needs review » Needs work

found some bugs

jeremy-green’s picture

jeremy-green commented
Status: Needs work » Needs review

fixed some bugs that were causing the section headers not to render.

Binu Varghese’s picture

Binu Varghese commented

@jeremy-green, I would suggest that you include Git Clone URL in your project application like:

git clone --branch 7.x-1.x http://git.drupal.org/sandbox/jeremy-green/2176415.git living_styleguide

cheers!

frogdog_tech’s picture

frogdog_tech commented
StatusFileSize
new scss.zip624 bytes
new Screen Shot 2014-04-02 at 3.47.15 PM.png59.94 KB

@jeremy-green

I did some testing today with your module, great work so far!

I have a question about your implementation of the KSS element description in the comments. According to the KSS documentation it should be in the form of <element#id.class:pseudo>. I was only able to get it working by giving it a full element description i.e. <a class="button">DOWNLOAD NOW</a>. I couldn't find a way to implement pseudo-selectors via the current scheme.

Also, When I navigate to /admin/appearance/living-styleguide/ I don't see anything. I'm forced to put in a Styleguide value in the URL such as /admin/appearance/living-styleguide/1.0.0 in order to start seeing my rendered elements.

Attached are my test scss and screen shot of rendered output.

The test were conducted on a standard drupal 7.26 installation with omega 3 theme.

Keep up the good work!

jeremy-green’s picture

jeremy-green commented

Thanks for the review! I'll take a look at the module. The admin/appearance/living-styleguide path looks for top level sections to be declared within the CSS for it to list them. For example, a buttons section would be defined like so Styleguide 1.0.0.. Changing the status back to needs work til I have a chance to go through it again.

jeremy-green’s picture

jeremy-green commented
Status: Needs review » Needs work
PA robot’s picture

PA robot commented
Status: Needs work » Closed (won't fix)

Closing due to lack of activity. Feel free to reopen if you are still working on this application (see also the project application workflow).

I'm a robot and this is an automated message from Project Applications Scraper.