pattern-lab / patternlab-node Goto Github PK

Remaining todo to ship this:

• Update gulpfile to omit scss where possible as a default
• Revert project back to grunt-first
• Update readme with browsersync
• Update readme installation instructions to help users wanting to init with gulp. Mention Windows caveat
• Update readme to help users switch to gulp
• Create upgrade instructions
• Create known issue section in readme for the other device page follow problems using the menu.
• Changelog
• Make sure gulp files are properly cited as deriving form oscar-g's work
• Create ticket for small optimization to better target grunt watches more efficiently
• Remove sass from package jsons, instead include directions to include and turn on

Make sure we do this too. Should be easy with grunt.
pattern-lab/patternlab-php#15

Still references to patternlab php wiki documents. Better to use patternlab.io or my own.

Enhancement Idea: Just throwing it out there, what do you think about using bower to manage dependencies like jquery, modernizr, and anything else that is in bower? Since it's a node project it seems to make sense. If not I might just do it for my own personal use 😄

Is this possible?

Been a while since I dead async node for realZ, should be fun 👊

pattern-lab/patternlab-php#23

Got the following error on a recent pull down from work. .gitignore has these excluded, so I must have missed them on the transfer from midnightspecial to pl

Converting the builder to straight-up node will decouple the core components from the build tool.

• Helps with unit testing and single responsibility
• More easily allows patternlab-node to be reused, in, say, something like gulp

Above is a screen shot of the icons not showing. They do work when I install the php version, so I'm not sure where to start debugging. The "Code" option that shows code also works right off the bat in the php version but I haven't been able to get it working in the node version.

Might be relevant: My dev tools is showing on line 453 of styleguide.js, event.data.lineage is returning undefined.

Any suggestions?

there is a fair amount of bloat inside the pattern object from a lot of piecemeal coding - it would be nice to make this simpler

As tridnguyen pointed out on twitter:

@bmuenzenmeyer hey is there a reason why there’s no connect task to serve static files for patternlab-node?

— Tri Nguyen (@tridnguyen) July 15, 2014

There may not be a good reason. He goes on to state that out of the box, pl ships a means to compile templates to generate files, but no way to view them in a "production" setting.

A question to @dmolsen and @bradfrost and @benedfit, do you see any downside to including mini-webservers with patternlab?

Pros

• A decision made for end-users is a good one if it reduces barrier to entry
• More precise analog to actual web server than filesystem

Cons

• A decision made for end-users is something not everyone may want (see pattern-only discussions)
• Shipping more complexity

It's fairly easy for a savvy designer/developer to add or remove grunt tasks for connect, so the decision really falls, in my mind, to what's best for those new to the space.

Also - is this something the spec should address?

CLI to output help

CLI command to output current version

pattern-lab/patternlab-php#22

Especially with data model

Review and reconcile https://github.com/pattern-lab/website/tree/dev/patternlabsite/docs with current version of software

• advanced-auto-regenerate.md
• advanced-clean-public.md
• advanced-config-options.md
• advanced-exporting-patterns.md
• advanced-generating-css.md Not implemented
• advanced-integration-with-compass.md Not implemented
• advanced-integration-with-grunt.md Not applicable. PL Node uses Grunt or Gulp as foundational portions
• advanced-keyboard-shortcuts.md
• advanced-page-follow.md
• advanced-pattern-lab-nav.md
• advanced-reload-browser.md
• command-line.md
• command-prompt-windows.md Not applicable
• data-json-mustache.md
• data-link-variable.md
• data-listitems.md
• data-pattern-specific.md
• editing-source-files.md
• first-run.md
• index.html
• installation.md
• pattern-add-new.md
• pattern-adding-annotations.md - identical, no references
• pattern-converting.md - looks like a dead file
• pattern-header-footer.md
• pattern-hiding.md - identical, no references
• pattern-including.md
• pattern-linking.md
• pattern-managing-assets.md
• pattern-mobile-view.md - not implemented
• pattern-organization.md
• pattern-parameters.md
• pattern-pseudo-patterns.md
• pattern-reorganizing.md
• pattern-states.md
• pattern-stylemodifier.md
• requirements.md
• upgrading.md

NEW THINGS

• Grunt vs Gulp - added to install.md

pattern-lab/patternlab-php#31

Add querystring support for reloads and direct linking like pl-php.

Demo: http://demo.patternlab.io/?p=templates-homepage

sub.indexOf('/'); stopped working. @ line 126 of patternlab.js

path.sep resolved.

Drive progress toward adherence to the Pattern Lab specification:

• #35 4.1. Atomic Design Naming Convention Not Required
• #6 4.6.3. Annotations
• #36 5.5. Version Command
• #37 5.6. Help Command

Miscellaneous Fixes and Improvements

• #26 Code Option Not Working and Some Icons Not Showing
• #30 Version Mustache with NPM
• #31 Published to NPM
• Pattern compilation only support

Born out of #27

Integrate with Travis CI

Cf. pattern-lab/patternlab-php@4317405

Ran into an issue in which grunt-contrib sass was out of date.

Check to make sure the package.json file is constructed to specify latest version.

pattern-lab/patternlab-php#11
pattern-lab/patternlab-php#26

Original inspiration: pattern-lab/patternlab-php#21

We should create some command files that users can double-click to perform common tasks. This would reduce the need to know the command line as much.

• Grunt Install
• Gulp Install
• Build Pattern Lab - Grunt
• Build Pattern Lab - Gulp
• Build,Serve, And Watch Pattern Lab - Grunt
• Build,Serve, And Watch Pattern Lab - Gulp
• Stop Server
• Get Version
• Check for updates?

Focus would be on Mac and Windows environments, initially.

Hey Brian,

I hope to try my hand at this if I can find some time in the next couple of days, but feel free move it along without me if need be.

Dave's explanation here:
pattern-lab/patternlab-php#31 (comment)

Gist of the patternPaths array
https://gist.github.com/dmolsen/8336146

Gist of the navItems array
https://gist.github.com/dmolsen/8335963

pattern-lab/patternlab-php#24

Hey Brian, love that we are getting the grunt and gulp versions up and running!

Shoptology was previously running patternlab-php and we built out some great workflow items for building out the style guide as the "true source" of the design templates for an app. We build out all our styles for components before exporting the finished css and image assets to our app for real world usage.

My question is to what degree would you like to include any of the following in the grunt or gulp projects? Happy to pull request for any of these elements if you think they would be beneficial for the project.

https://github.com/shoptology/patternlab-php/blob/master/Gruntfile.js

We have BrowserSync, which lets you open the styleguide in unlimited number of devices and keeps them all in sync with navigation and source changes, great for building out responsive components in the style guide.
https://github.com/shakyShane/grunt-browser-sync

For testing the condition of your styles:
https://github.com/peterkeating/grunt-csscss
https://github.com/phamann/grunt-css-metrics

Visual regression tests (lets you visually test differences between versions of your style guide as your team makes changes)
https://github.com/BBC-News/wraith

UnCSS works perfectly with Patternlab, can scan all the pages and remove any css that wasn't used on the pages. We've seen 30-40% file size savings on Bootstrap projects, as has Addy Osmani who started the grunt plugin.
https://github.com/addyosmani/grunt-uncss

We also have some scripts that help with optimizing images as they come in and building sprite sheets.

Hi, I have my config/config.json configured like this:

 {
    "patterns" : {
        "source" : "/../../source/_patterns/",
        "public" : "/../../public/patterns/"
    },
    "ignored-extensions" : ["scss", "DS_Store", "less"],
    "ignored-directories" : ["scss"],
    "contentSyncPort" : 8002,
    "navSyncPort" : 8003
 }

but the .DS_Store files are still being picked up by the compiler. Am I doing something wrong?

'./public/styleguide/css/styleguide-specific.css': './public/styleguide/css/styleguide-specific.scss' in gruntfile

I've published this package to NPM and will maintain it so long as it's okay with the core team. I would like to make a change which is swapping devDependencies to dependencies.

Using this project within an existing Grunt project is as easy as configuring the grunt-hub plugin to point to this project nested within node_modules.

Ensure there are not hardcoded references to atoms/molecules/organisms.

pattern-lab/patternlab-php#27

Does it make sense to manage mustache.js within NPM using the latest stable? Opposed to checking in the entirety of Mustache.js within the builder/lib directory.