Skip to content

Commit c39bbe0

Browse files
committed
final removal of sass from gulpfile.
closes #57 closes #102 closes #103
1 parent c832ee7 commit c39bbe0

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

CHANGELOG

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ PL-node-v0.12.0
77
- CHG: Commented out all sass tasks in Grunt and Gulp files
88
- CHG: Changed static web server provider to BrowserSync
99
- CHG: Replaced the Style Guide toolbar Auto-Reload and Page Follow with a link to the BrowserSync UI
10+
- THX: Thanks @oscar-g for the initial work on the gulpfile!
1011

1112
PL-node-v0.11.0
1213
- ADD: Ignore pattern directories that start with an underscore.

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## About the Node Version of Pattern Lab
44

5-
The Node version of [Pattern Lab](http://patternlab.io/) is, at its core, a static site generator. It combines platform-agnostic assets, like the Mustache-based patterns, the JavaScript-based viewer, and the self-contained webserver, with a Node-based "builder" that transforms and dynamically builds the Pattern Lab site.
5+
The Node version of [Pattern Lab](http://patternlab.io/) is, at its core, a static site generator. It combines platform-agnostic assets, like the Mustache-based patterns, the JavaScript-based viewer, and the self-contained webserver, with a Node-based "builder" that transforms and dynamically builds the Pattern Lab site.
66

7-
This repository contains the vanilla builder logic, grunt and gulp configurations, and some sample template/css/data to illustrate the powe and flexibility of the tool.
7+
This repository contains the vanilla builder logic, grunt and gulp configurations, and some sample template/css/data to illustrate the power and flexibility of the tool.
88

99
### Download
1010

@@ -22,7 +22,7 @@ This repository ships with two `package.json` files, a `Gruntfile.js`, and a `gu
2222
To run patternlab-node using grunt, do the following in the directory you downloaded and extracted the zipped release:
2323

2424
1. Run `npm install` from the command line
25-
2. Optionally, delete `package.gulp.json`, `gulpfile.js`, and `builder/patternlab_gulp.js` files if you are certain you dont need it.
25+
2. Optionally, delete `package.gulp.json`, `gulpfile.js`, and `builder/patternlab_gulp.js` files if you are certain you don't need it.
2626
* Not deleting `builder/patternlab_gulp.js` may cause a harmless error when running grunt. Delete it.
2727
3. Run `grunt` or `grunt serve` from the command line
2828

@@ -33,7 +33,7 @@ This creates all patterns, the styleguide, and the pattern lab site. It's strong
3333
To run patternlab-node using gulp, you need to swap out the default grunt configuration. Do the following in the directory you downloaded and extracted the zipped release:
3434

3535
1. Rename `package.json` to `package.grunt.json` or delete it if you don't intend on going back
36-
2. Rename `package.gulp.json` to `package.json`
36+
2. Rename `package.gulp.json` to `package.json`
3737
3. Run `npm install` from the command line
3838
4. Run `gulp` or `gulp serve` from the command line
3939

@@ -74,7 +74,7 @@ Get more information about patternlab-node, pattern lab in general, and where to
7474
To have patternlab-node watch for changes to either a mustache template, data, or stylesheets, run `grunt|gulp watch` or `grunt|gulp serve`. The `Gruntfile|Gulpfile` governs what is watched. It should be easy to add scss or whatever preprocessor you fancy.
7575

7676
##### Preprocessor Support
77-
The patternlab-node release package ships with some `.scss` files utilized in the creation of the style guide and sample templates, but these are not required. The compilation tasks are commented out in the `Gruntfiles|Gulpfiles` but can be uncommented or changed to meet your needs. Sass modules are note included in `package.json` files - the prevailing thought being if you are familiar enough with preprocessors, you can use the instructions for [grunt-contrib-sass](https://github.com/gruntjs/grunt-contrib-sass) / [gulp-sass](https://github.com/dlmanning/gulp-sass) / _preprocessor of choice_ to install them.
77+
The patternlab-node release package ships with some `.scss` files utilized in the creation of the style guide and sample templates, but these are not required. The compilation tasks are commented out in the `Gruntfiles|Gulpfiles` but can be uncommented or changed to meet your needs. Sass modules are not included in `package.json` files - the prevailing thought being if you are familiar enough with preprocessors, you can use the instructions for [grunt-contrib-sass](https://github.com/gruntjs/grunt-contrib-sass) / [gulp-sass](https://github.com/dlmanning/gulp-sass) / _preprocessor of choice_ to install them. Uncomment the preprocessor configuration to fully utilize the example templates, css and style guide.
7878

7979
**NOTE:** You may run into issues installing gulp-sass if you don't have the latest Visual Studio on Windows. See [here](https://github.com/sass/node-sass/issues/469) for more information and [this query](https://github.com/sass/node-sass/issues?utf8=%E2%9C%93&q=is%3Aissue+install) for a slew of installation problems related to gulp-sass.
8080

@@ -146,9 +146,9 @@ You can also exclude complete directories by prepending the directory name with
146146
`patternlab.json` is a file created for debugging purposes. Set `debug` to true in `.config.json` to see all the secrets.
147147

148148
##### Server & BrowserSync
149-
Running `grunt serve` will compile the patternlab front end and host it by default on <a href="http://localhost:3000">http://localhost:3000</a> via [BrowserSync](http://www.browsersync.io/docs/). After it starts, templates, `data.json`, and scss/css changes in your source code will be automatically injected into the page.
149+
Running `grunt serve` will compile the patternlab front end and host it by default on <a href="http://localhost:3000">http://localhost:3000</a> via [BrowserSync](http://www.browsersync.io/docs/). After it starts, templates, `data.json`, and scss/css changes in your source code will be automatically injected into the page.
150150

151-
You'll notice that if you have this open across different browsers, we do our best to keep the front end in sync, but there is a known issue with synced navigation using the main menu.
151+
You'll notice that if you have this open across different browsers, we do our best to keep the front end in sync, but there is a known issue with synced navigation using the main menu.
152152

153153
### Roadmap
154154

gulpfile.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ var pkg = require('./package.json'),
77
strip_banner = require('gulp-strip-banner'),
88
header = require('gulp-header'),
99
nodeunit = require('gulp-nodeunit'),
10-
sass = require('gulp-sass'),
10+
//sass = require('gulp-sass'),
1111
browserSync = require('browser-sync').create();
1212

1313
require('gulp-load')(gulp);

0 commit comments

Comments
 (0)