Skip to content

Dev #42

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.

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
merged 21 commits into from
May 8, 2014
Merged

Dev #42

Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 8 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@ language: node_js
node_js:
- 0.11
- 0.10
- 0.9
- 0.8

before_install:
- phantomjs --version

before_script:
- npm install -g grunt-cli

branches:
only:
- dev
only:
- master
9 changes: 9 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.

PL-node-v0.1.1
- FIX: Removed View All Pattern SubItem Link Logic, no longer in reference implementation
- ADD: Flag for generating debug file
- ADD: Travis CI test support!
- ADD: Contributing file
- ADD: Repository to package.json
- FIX: Manage Mustache dependency using NPM
- THX: thank you @tbranyen for tip on repository, Mustache, and NPM!

PL-node-v0.1.0
- FIX: Links to patterns did not work when visited from a server
- FIX: Patterns with hyphens in the name were breaking the iframe messaging
Expand Down
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#Contributing to Patternlab - Node
If you'd like to contribute to patternlab - node, please do so! There is always a lot of ground to cover, with patternlab - php being so feature-rich.

No pull request is too small.

##Guidelines
1. Please keep your pull requests concise
2. _ALWAYS_ submit it against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request.
11 changes: 9 additions & 2 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
clean: ['./public/patterns'],
clean: {
options: { force: true },
files: ['./public/patterns']
},
concat: {
options: {
stripBanners: true,
Expand Down Expand Up @@ -66,7 +69,11 @@ module.exports = function(grunt) {
}
},
qunit: {
files: ["./test/tests.js"]
all:{
options:{
urls: ['./test/tests.html']
}
}
}
});

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

The Node version of Pattern Lab is, at its core, a static site generator. It combines platform-agnostic assets, like the [Mustache](http://mustache.github.io/)-based patterns and the JavaScript-based viewer, with a Node-based "builder" that transforms and dynamically builds the Pattern Lab site. By making it a static site generator, the Node version of Pattern Lab strongly separates patterns, data, and presentation from build logic. The Node version is a work in progress, the [PHP version](https://github.com/pattern-lab/patternlab-php) should be seen as a reference for other developers to improve upon as they build their own Pattern Lab Builders in their language of choice.

## Under Active Development

The Node version of Pattern Lab is under active development by [@bmuenzenmeyer](https://twitter.com/bmuenzenmeyer). Contributions welcome!

### Getting Started

To run patternlab-node, just do the following from the command line at the root of patternlab-node:
Expand All @@ -14,18 +10,22 @@ To run patternlab-node, just do the following from the command line at the root
2. `npm install -g grunt-cli`
3. `grunt`

This creates all patterns, the styleguide, and the patternlab site. `patternlab.json` is a file created for debugging purposes. It tells you all the secrets in tidy json.
This creates all patterns, the styleguide, and the pattern lab site. `patternlab.json` is a file created for debugging purposes. It tells you all the secrets in tidy json.

To have patternlab-node watch for changes to either a mustache template, data, or stylesheets, run `grunt watch`. The `Gruntfile` governs what is watched. It should be easy to add scss or whatever preprocessor you fancy.

#### Watching Progress
### Under Active Development

[![Build Status](https://travis-ci.org/pattern-lab/patternlab-node.png?branch=master)](https://travis-ci.org/pattern-lab/patternlab-node) The Node version of Pattern Lab is under active development by [@bmuenzenmeyer](https://twitter.com/bmuenzenmeyer) and contributors. Pull requests welcome, but please take a moment to read the [guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/CONTRIBUTING.md).

#### Forward, To the Specification!

Dave Olsen has published the [specification](https://github.com/pattern-lab/the-spec/blob/draft/SPEC.md) for Pattern Lab ports. Development will be oriented toward compliance with this as the spec and the port mature together.

#### Is Pattern Lab a Platform or a Build Tool?

Patternlab Node has reached [minimum viable product](http://en.wikipedia.org/wiki/Minimum_viable_product) status. The main branch will always have the most up to date version of patternlab-node. Watch the dev branch for what it coming next!
A lot of good conversation has revolved around whether Pattern Lab is a platform or a tool in the toolbox, part of a larger solution. It's my goal to #1) adhere to the specification and #2) meet the needs of both use cases.

#### Roadmap
* Full Patternlab site support. (This is the uber cool navigation found at [demo.pattern-lab.info](http://demo.pattern-lab.info)).
* More Documentation
* Tests

**THE FOLLOWING IS FROM THE PATTERNLAB-PHP PROJECT. A LOT STILL APPLIES TO PATTERNLAB-NODE, BUT IT HAS NOT BEEN ADAPTED YET. USE AT YOUR OWN PERIL**

Expand Down
10 changes: 0 additions & 10 deletions builder/lib/Mustache/.gitignore

This file was deleted.

3 changes: 0 additions & 3 deletions builder/lib/Mustache/.gitmodules

This file was deleted.

5 changes: 0 additions & 5 deletions builder/lib/Mustache/.jshintrc

This file was deleted.

4 changes: 0 additions & 4 deletions builder/lib/Mustache/.travis.yml

This file was deleted.

43 changes: 0 additions & 43 deletions builder/lib/Mustache/CHANGES

This file was deleted.

10 changes: 0 additions & 10 deletions builder/lib/Mustache/LICENSE

This file was deleted.

Loading