Skip to content

Commit

Permalink
v2.4.0. Extracted out a bunch of balUtilPaths stuff into their own mo…
Browse files Browse the repository at this point in the history
…dules.
  • Loading branch information
balupton committed Dec 10, 2013
1 parent 416bd5e commit 6bf7a7e
Show file tree
Hide file tree
Showing 11 changed files with 132 additions and 318 deletions.
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# v1.3.5 October 31, 2013
# v1.3.10 December 10, 2013
# https://github.com/bevry/base

# Temp Files
**/*.log
**/.docpad.db

# Build Files
build/
components/
bower_components/
node_modules/
out/

# =====================================
# CUSTOM MODIFICATIONS

# None
10 changes: 8 additions & 2 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# v1.3.3 October 26, 2013
# v1.3.10 December 10, 2013
# https://github.com/bevry/base

# Temp Files
**/*.log
**/.docpad.db

# Build Files
build/
Expand All @@ -23,4 +24,9 @@ HISTORY.md
# Other Package Definitions
template.js
component.json
bower.json
bower.json

# =====================================
# CUSTOM MODIFICATIONS

# None
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# v1.3.2 October 26, 2013
# v1.3.8 November 7, 2013
# https://github.com/bevry/base
language: node_js
install: "npm install"
install: "npm install; ./node_modules/.bin/cake install"
before_script: "./node_modules/.bin/cake compile"
script: "npm test"
node_js:
Expand Down
54 changes: 49 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,38 @@
<!--
v1.3.10 December 10, 2013
https://github.com/bevry/base
-->


# Contribute


## Resources

- [Coding Standards](http://bevry.me/bevry/coding-standards)
- [Documentation Guidelines](http://bevry.me/bevry/documentation-guidelines)
- [Support Guidelines](http://bevry.me/bevry/support-guidelines)


## Development

1. Fork the project and clone your fork
For developers and contributors

1. Fork project and clone your fork

2. Install global dependencies

``` bash
npm install -g coffee-script
```

3. Compile the project
3. Install local dependencies

``` bash
cake install
```

4. Compile project

``` bash
# Only once
Expand All @@ -19,20 +42,41 @@
cake watch
```

4. Run your tests
5. Run tests

``` bash
cake test
```

5. Prepare the project for publishing

## Publishing

For project maintainers

1. Update meta files with latest information

``` bash
cake prepublish
```

6. Publish the project
2. Add a changelog entry to `HISTORY.md` with change information

```
v2.0.0 April 17, 2013
- Something that changes
```

3. Update `version` entry in `package.json` with new version number

4. Commit changes

``` bash
git commit -a -m "A message about what changed"
```

5. Publish new version

``` bash
cake publish
```

32 changes: 24 additions & 8 deletions Cakefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# v1.3.4 October 30, 2013
# v1.3.10 December 10, 2013
# https://github.com/bevry/base


Expand All @@ -25,6 +25,7 @@ SRC_DIR = pathUtil.join(APP_DIR, "src")
OUT_DIR = pathUtil.join(APP_DIR, "out")
TEST_DIR = pathUtil.join(APP_DIR, "test")
MODULES_DIR = pathUtil.join(APP_DIR, "node_modules")
DOCPAD_DIR = pathUtil.join(MODULES_DIR, "docpad")
BIN_DIR = pathUtil.join(MODULES_DIR, ".bin")
GIT = "git"
CAKE = pathUtil.join(BIN_DIR, "cake#{EXT}")
Expand Down Expand Up @@ -87,22 +88,37 @@ actions =
fsUtil.exists TEST_DIR, (exists) ->
return next() unless exists
# npm install (for test)
spawn(NPM, ['install'], {stdio:'inherit', cwd:TEST_DIR}).on('close', safe next)
spawn(NPM, ['install'], {stdio:'inherit', cwd:TEST_DIR}).on('close', safe next, step3)
step3 = ->
fsUtil.exists DOCPAD_DIR, (exists) ->
return next() unless exists
# npm install (for test)
spawn(NPM, ['install'], {stdio:'inherit', cwd:DOCPAD_DIR}).on('close', safe next)
step1()

compile: (opts,next) ->
(next = opts; opts = {}) unless next?
# cake install
actions.install opts, safe next, ->
step1 = ->
# cake install
actions.install(opts, safe next, step2)
step2 = ->
# coffee compile
spawn(COFFEE, ['-co', OUT_DIR, SRC_DIR], {stdio:'inherit', cwd:APP_DIR}).on('close', safe next)
fsUtil.exists COFFEE, (exists) ->
return next() unless exists
spawn(COFFEE, ['-co', OUT_DIR, SRC_DIR], {stdio:'inherit', cwd:APP_DIR}).on('close', safe next)
step1()

watch: (opts,next) ->
(next = opts; opts = {}) unless next?
# cake install
actions.install opts, safe next, ->
step1 = ->
# cake install
actions.install(opts, safe next, step2)
step2 = ->
# coffee watch
spawn(COFFEE, ['-wco', OUT_DIR, SRC_DIR], {stdio:'inherit', cwd:APP_DIR}).on('close', safe next)
fsUtil.exists COFFEE, (exists) ->
return next() unless exists
spawn(COFFEE, ['-wco', OUT_DIR, SRC_DIR], {stdio:'inherit', cwd:APP_DIR}).on('close', safe next)
step1()

test: (opts,next) ->
(next = opts; opts = {}) unless next?
Expand Down
10 changes: 10 additions & 0 deletions History.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# History

- v2.4.0 December 10, 2013
- `balUtilPaths` changes:
- Added `resolveCaseSensitivePath(path, next)`
- Extracted out:
- [binaryextensions](https://github.com/bevry/binaryextensions) < `balUtilPaths.binaryExtensions`
- [ignorefs](https://github.com/bevry/ignorefs) < `balUtilPaths.isIgnoredPath`
- [ignorepatterns](https://github.com/bevry/ignorepatterns/blob/master/HISTORY.md) < `balUtilPaths.ignoreCommonPatterns`
- [istextorbinary](https://github.com/bevry/istextorbinary) < `balUtilPaths.(isTextSync|isText|getEncodingSync|getEncoding)`
- [textextensions](https://github.com/bevry/textextensions) < `balUtilPaths.textExtensions`

- v2.3.2 November 1, 2013
- Can now pass `binary` as the `readFiles` option value to return buffers instead of strings for file contents
- Updated dependencies
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# License

Copyright &copy; Benjamin Lupton <b@lupton.cc> (http://balupton.com)
Copyright &copy; 2011+ Benjamin Lupton <b@lupton.cc> (http://balupton.com)

## The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,20 @@ Best off looking at source, it's well documented, and there are plenty of tests
We're in the process of abstracting the pieces of bal-util out into their own modules. So far, we've done the following:

- [ambi](https://github.com/bevry/ambi) < `balUtilFlow.fireWithOptionalCallback`
- [binaryextensions](https://github.com/bevry/binaryextensions) < `balUtilPaths.binaryExtensions`
- [eachr](https://github.com/bevry/eachr) < `balUtilFlow.each`
- [event-emitter-grouped](https://github.com/bevry/event-emitter-grouped) < `balUtilEvents.EventEmitterEnhanced`
- [extendr](https://github.com/bevry/extendr) < `balUtilFlow.(extend|clone|etc)`
- [extract-opts](https://github.com/bevry/extract-opts) < `balUtilFlow.extractOptsAndCallback`
- [getsetdeep](https://github.com/bevry/getsetdeep) < `balUtilFlow.(get|set)Deep`
- [ignorefs](https://github.com/bevry/ignorefs) < `balUtilPaths.isIgnoredPath`
- [ignorepatterns](https://github.com/bevry/ignorepatterns/blob/master/HISTORY.md) < `balUtilPaths.ignoreCommonPatterns`
- [istextorbinary](https://github.com/bevry/istextorbinary) < `balUtilPaths.(isTextSync|isText|getEncodingSync|getEncoding)`
- [safecallback](https://github.com/bevry/safecallback) < `balUtilFlow.safeCallback`
- [safefs](https://github.com/bevry/safefs) < `balUtilPaths.(openFile|closeFile|etc)`
- [safeps](https://github.com/bevry/safeps) < `balUtilModules`
- [taskgroup](https://github.com/bevry/taskgroup) < `balUtilFlow.Group`
- [textextensions](https://github.com/bevry/textextensions) < `balUtilPaths.textExtensions`
- [typechecker](https://github.com/bevry/typechecker) < `balUtilTypes`


Expand Down Expand Up @@ -113,7 +118,7 @@ These amazing people have contributed code to this project:

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://creativecommons.org/licenses/MIT/)

Copyright &copy; Benjamin Lupton <b@lupton.cc> (http://balupton.com)
Copyright &copy; 2011+ Benjamin Lupton <b@lupton.cc> (http://balupton.com)

<!-- /LICENSE -->

Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"title": "[Benjamin Lupton's](http://balupton.com) Utility Functions",
"name": "bal-util",
"version": "2.3.2",
"version": "2.4.0",
"description": "Common utility functions for Node.js used and maintained by Benjamin Lupton",
"homepage": "https://github.com/balupton/bal-util",
"license": {
Expand Down Expand Up @@ -35,7 +35,7 @@
"comparison",
"html"
],
"author": "Benjamin Lupton <b@lupton.cc> (http://balupton.com)",
"author": "2011+ Benjamin Lupton <b@lupton.cc> (http://balupton.com)",
"maintainers": [
"Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)"
],
Expand All @@ -60,7 +60,8 @@
"safefs": "~3.0.1",
"taskgroup": "~3.3.0",
"typechecker": "~2.0.8",
"extract-opts": "~2.2.0"
"extract-opts": "~2.2.0",
"ignorefs": "~1.0.0"
},
"devDependencies": {
"coffee-script": "~1.6.2",
Expand Down
Loading

0 comments on commit 6bf7a7e

Please sign in to comment.