Skip to content
This repository has been archived by the owner on Aug 21, 2023. It is now read-only.

Commit

Permalink
Rename project
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomek Wiszniewski committed Jul 20, 2015
1 parent 30d9508 commit 100d86a
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 28 deletions.
20 changes: 10 additions & 10 deletions Readme.md
@@ -1,12 +1,12 @@
[![Coveralls – test coverage
](https://img.shields.io/coveralls/studio-b12/get-comments-cli.svg?style=flat-square)
](https://coveralls.io/r/studio-b12/get-comments-cli)
](https://img.shields.io/coveralls/studio-b12/dump-comments.svg?style=flat-square)
](https://coveralls.io/r/studio-b12/dump-comments)
[![Travis – build status
](https://img.shields.io/travis/studio-b12/get-comments-cli/master.svg?style=flat-square)
](https://travis-ci.org/studio-b12/get-comments-cli)
](https://img.shields.io/travis/studio-b12/dump-comments/master.svg?style=flat-square)
](https://travis-ci.org/studio-b12/dump-comments)
[![David – status of dependencies
](https://img.shields.io/david/studio-b12/get-comments-cli.svg?style=flat-square)
](https://david-dm.org/studio-b12/get-comments-cli)
](https://img.shields.io/david/studio-b12/dump-comments.svg?style=flat-square)
](https://david-dm.org/studio-b12/dump-comments)
[![Stability: experimental
](https://img.shields.io/badge/stability-experimental-yellow.svg?style=flat-square)
](https://nodejs.org/api/documentation.html#documentation_stability_index)
Expand All @@ -17,15 +17,15 @@



get-comments-cli
================
dump-comments
=============

**Dump raw comments from JavaScript files as JSON.**


**⚠ Heads up!** This is totally a work in progress. [Thoughts and ideas][] are very welcome.

[Thoughts and ideas]: https://github.com/studio-b12/get-comments-cli/issues
[Thoughts and ideas]: https://github.com/studio-b12/dump-comments/issues



Expand All @@ -34,7 +34,7 @@ Installation
------------

```sh
$ npm install get-comments-cli
$ npm install dump-comments
```


Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion module/bin/help/examples.js
Expand Up @@ -4,5 +4,5 @@ module.exports =
` ${bold('EXAMPLES')}
${yellow('# A lightweight alternative to <http://npm.im/polydox>:')}
$ get-comments *.js > doxie --render --inject into Readme.md
$ dump-comments *.js > doxie --render --inject into Readme.md
`;
2 changes: 1 addition & 1 deletion module/bin/help/usage.js
@@ -1,3 +1,3 @@
export default
`Usage: get-comments [options] ...<source>
`Usage: dump-comments [options] ...<source>
`;
6 changes: 3 additions & 3 deletions package.json
@@ -1,8 +1,8 @@
{ "name": "get-comments-cli"
{ "name": "dump-comments"
, "version": "0.0.0-work-in-progress"
, "description": "Dump raw comments from JavaScript files as JSON."
, "bin":
{ "get-comments": "bin/get-comments.js"
{ "dump-comments": "bin/dump-comments.js"
}
, "dependencies":
{ "async": "^1.3.0"
Expand Down Expand Up @@ -62,6 +62,6 @@
, "author": "© 2015 Studio B12 GmbH (http://studio-b12.de)"
, "repository":
{ "type": "git"
, "url": "git@github.com:studio-b12/get-comments-cli.git"
, "url": "git@github.com:studio-b12/dump-comments.git"
}
}
2 changes: 1 addition & 1 deletion test.js
@@ -1,2 +1,2 @@
import './test/bin/get-comments.test';
import './test/bin/dump-comments.test';
import './test/index.test';
24 changes: 12 additions & 12 deletions test/bin/get-comments.test.js → test/bin/dump-comments.test.js
Expand Up @@ -8,16 +8,16 @@ const plus = require('1-liners/plus');
const curry = require('1-liners/curry');

const title = curry(plus)('The CLI program: ');
const getComments = resolve(__dirname, '../../module/bin/get-comments.js');
const $getComments = curry(execFile)(getComments);
const dumpComments = resolve(__dirname, '../../module/bin/dump-comments.js');
const $dumpComments = curry(execFile)(dumpComments);
const cwd = resolve(__dirname, '../mock-cwd');

tape(title('Prints usage'), (is) => {
is.plan(8);

$getComments([], (error, _, stderr) => {
$dumpComments([], (error, _, stderr) => {
is.equal(error && error.code, 1,
'`get-comments` fails…'
'`dump-comments` fails…'
);

is.ok(
Expand All @@ -26,10 +26,10 @@ tape(title('Prints usage'), (is) => {
);
});

$getComments(['--invalid', '--options', 'one.js'], {cwd},
$dumpComments(['--invalid', '--options', 'one.js'], {cwd},
(error, _, stderr) => {
is.equal(error && error.code, 1,
'`get-comments --invalid --options one.js` fails…'
'`dump-comments --invalid --options one.js` fails…'
);

is.ok(
Expand All @@ -39,9 +39,9 @@ tape(title('Prints usage'), (is) => {
}
);

$getComments(['-h'], (error, stdout) => {
$dumpComments(['-h'], (error, stdout) => {
is.equal(error, null,
'`get-comments -h` succeeds…'
'`dump-comments -h` succeeds…'
);

is.ok(
Expand All @@ -50,9 +50,9 @@ tape(title('Prints usage'), (is) => {
);
});

$getComments(['--help'], (error, stdout) => {
$dumpComments(['--help'], (error, stdout) => {
is.equal(error, null,
'`get-comments --help` succeeds…'
'`dump-comments --help` succeeds…'
);

is.ok(
Expand All @@ -63,9 +63,9 @@ tape(title('Prints usage'), (is) => {
});

tape(title('Works for a single file'), (is) => {
$getComments(['one.js'], {cwd}, (error, output) => {
$dumpComments(['one.js'], {cwd}, (error, output) => {
is.equal(error, null,
'`get-comments <single file>` succeeds'
'`dump-comments <single file>` succeeds'
);

let outputData;
Expand Down

0 comments on commit 100d86a

Please sign in to comment.