Skip to content

Add option 'cwd' #15

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.

Sign up for GitHub

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

Open
feeela wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add option 'cwd' #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4232808
add option 'cwd' to set the current wqorking directory and execute Pr…
May 11, 2015
aab88e9
re-insert BradDenver repo GA
May 11, 2015
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
15 changes: 9 additions & 6 deletions lib/preen.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
var async = require('async');
var bower = require('bower');
var fs = require('fs.extra');
var path = require('path');
var readdirp = require('readdirp');
var minimatch = require('minimatch');
var winston = require('winston');
Expand All @@ -18,19 +19,21 @@ var bowerJSON;
var preview = false; // an optional argument to show would happen when preen is run
var verbose = false; // an optional argument to show details of the files/folders preened
var directory; // an optional argument to set a custom root directory (for processing after copying bower files)
var cwd; // an optional argument to set a custom project directory

function preen(options, callback) {

preview = options.preview;
verbose = options.verbose;
directory = options.directory;
cwd = options.cwd || process.cwd();

if(preview || verbose){
logger.transports.console.level = 'verbose';
}

try {
bowerJSON = require(process.cwd()+'/'+bower.config.json);
bowerJSON = require(path.join(cwd, bower.config.json));
}
catch(err) {
logger.error('Error trying to read '+bower.config.json, err);
Expand All @@ -49,7 +52,7 @@ var preenPackage = function(name, callback) {

logger.info(preview ? 'Previewing Preen of: '+name : 'Preening: '+name);

var root = getRootDirectory()+'/'+name+'/';
var root = path.join(getRootDirectory(), name);
var filters = bowerJSON.preen[name];

if(!filters.length){
Expand Down Expand Up @@ -98,7 +101,7 @@ var preenPackage = function(name, callback) {
logger.verbose('keep dir ' + res.directories[i].path);
} else {
logger.verbose('delete dir ' + res.directories[i].path);
dirsToDelete.push(root+res.directories[i].path);
dirsToDelete.push(path.join(root, res.directories[i].path));
}
}
// and then files
Expand All @@ -108,7 +111,7 @@ var preenPackage = function(name, callback) {
logger.verbose('keep file ' + res.files[i].path);
} else {
logger.verbose('delete file ' + res.files[i].path);
filesToDelete.push(root+res.files[i].path);
filesToDelete.push(path.join(root, res.files[i].path));
}
}

Expand Down Expand Up @@ -239,5 +242,5 @@ function removeDir(path, callback) {

function getRootDirectory() {

return directory || bower.config.directory
return path.join(cwd, (directory || bower.config.directory));
}
14 changes: 8 additions & 6 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ My projects `bower.json` file has jquery as a dependency.
}
}
```
which gives the following folder after running `bower install`
![](https://raw.github.com/BradDenver/Preen/master/screenshots/basic.png)
which gives the following folder after running `bower install`
![](https://raw.github.com/BradDenver/Preen/master/screenshots/basic.png)
but all I really need for this project is the 4 javascript files.
So I update my `bower.json` with a preen property as follows
```javascript
Expand All @@ -31,7 +31,7 @@ So I update my `bower.json` with a preen property as follows
}
}
```
and then run `preen` to end up with
and then run `preen` to end up with
![](https://raw.github.com/BradDenver/Preen/master/screenshots/basic2.png)

###Updated Example
Expand Down Expand Up @@ -70,16 +70,18 @@ Any packages not listed will not be preened.

##Options
when running via the command line you can add a preview flag to see a list of all paths and if they will be deleted or kept
`preen --preview`
![](https://raw.github.com/BradDenver/Preen/master/screenshots/preview.png)
you can then run `preen` if you are happy to go ahead
`preen --preview`
![](https://raw.github.com/BradDenver/Preen/master/screenshots/preview.png)
you can then run `preen` if you are happy to go ahead
![](https://raw.github.com/BradDenver/Preen/master/screenshots/preview2.png)

A verbose flag is also avaible to show the same level of detail as the actual preen is run
`preen --verbose`

You can also add a directory flag to override bower's default directory (or the one set in .bowerrc). This can be useful when using preen as part of your build pipeline. Example: `preen --directory ./tmp/path/to/bower/root`

Using `preen --cwd ./path/to/project` you can set another workung directory than the one where you started this script from. This is useful for automating tasks and run preen from a parent folder. (i.e. this option works similar to Bowers `cwd` option.)

##Grunt Task
while preen can be run via the command line it is well suited to running as a [grunt task](https://github.com/braddenver/grunt-preen)
[![NPM](https://nodei.co/npm/grunt-preen.png?downloads=true&stars=true)](https://github.com/braddenver/grunt-preen)
Expand Down