Permalink
Browse files

packaged up

  • Loading branch information...
1 parent 0334e64 commit f3b22ee75f5629f9eb74d66c4e7142a4310192ef @substack committed Aug 12, 2012
Showing with 79 additions and 0 deletions.
  1. +18 −0 LICENSE
  2. +2 −0 bin/cmd.js
  3. +33 −0 package.json
  4. +26 −0 readme.markdown
View
@@ -0,0 +1,18 @@
+This software is released under 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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -9,6 +9,8 @@ if (process.argv.length === 2) {
return console.error('usage: codebux [file or directory]');
}
+console.log(formatPrice(100) + ' # initial stipend');
+
var s = codebux(dir, function (err, total) {
if (err) console.error(err)
else console.log(Array(50).join('') + '\n' + formatPrice(total))
View
@@ -0,0 +1,33 @@
+{
+ "name" : "codebux",
+ "version" : "0.0.0",
+ "description" : "calculate technical debt",
+ "main" : "index.js",
+ "bin" : {
+ "codebux": "bin/cmd.js"
+ },
+ "dependencies" : {
+ "falafel" : "~0.1.1",
+ "detective" : "~0.2.0",
+ "resolve" : "~0.2.2"
+ },
+ "repository" : {
+ "type" : "git",
+ "url" : "git://github.com/substack/codebux.git"
+ },
+ "homepage" : "https://github.com/substack/codebux",
+ "keywords" : [
+ "debt",
+ "philosophy",
+ "craft",
+ "code",
+ "lint",
+ "linter"
+ ],
+ "author" : {
+ "name" : "James Halliday",
+ "email" : "mail@substack.net",
+ "url" : "http://substack.net"
+ },
+ "license" : "MIT"
+}
View
@@ -12,6 +12,32 @@ You lose codebux for:
Your codebux score doesn't stop at $0, it keeps going down into the negative
numbers.
+# example
+
+For instance codebux itself has a score of:
+
+```
+$ codebux ~/projects/codebux
++ 100.00 # initial stipend
+- 5.63 # index.js
+- 1.94 # lib/complexity.js
+—————————————————————————————————————————————————
++ 92.42
+```
+
+other projects don't fare as well:
+
+```
+$ codebux ~/projects/node-browserify
++ 100.00 # initial stipend
+- 12.55 # index.js
+- 34.91 # lib/wrap.js
+- 0.33 # lib/wrappers.js
+- 100.32 # lib/watch.js
+—————————————————————————————————————————————————
+- 48.12
+```
+
# usage
```

0 comments on commit f3b22ee

Please sign in to comment.