Skip to content

Commit

Permalink
feat(cli): improve --help output and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieMason committed Oct 29, 2018
1 parent 749078d commit dfe6274
Show file tree
Hide file tree
Showing 9 changed files with 396 additions and 107 deletions.
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"arrowParens": "always",
"printWidth": 80,
"proseWrap": "always",
"singleQuote": true
}
84 changes: 58 additions & 26 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,46 @@

### Features

- **cli:** read sources from lerna.json if present ([77b90eb](https://github.com/JamieMason/syncpack/commit/77b90eb)), closes [#11](https://github.com/JamieMason/syncpack/issues/11)
- **cli:** read sources from lerna.json if present
([77b90eb](https://github.com/JamieMason/syncpack/commit/77b90eb)), closes
[#11](https://github.com/JamieMason/syncpack/issues/11)

<a name="3.3.0"></a>

# [3.3.0](https://github.com/JamieMason/syncpack/compare/3.0.0...3.3.0) (2018-10-28)

### Features

- **cli:** specify dependency types as options ([ec5ef6b](https://github.com/JamieMason/syncpack/commit/ec5ef6b)), closes [#10](https://github.com/JamieMason/syncpack/issues/10)
- **cli:** specify indentation as option ([8b408bd](https://github.com/JamieMason/syncpack/commit/8b408bd)), closes [#12](https://github.com/JamieMason/syncpack/issues/12)
- **format:** sort contributors alphabetically ([935ffcf](https://github.com/JamieMason/syncpack/commit/935ffcf))
- **cli:** specify dependency types as options
([ec5ef6b](https://github.com/JamieMason/syncpack/commit/ec5ef6b)), closes
[#10](https://github.com/JamieMason/syncpack/issues/10)
- **cli:** specify indentation as option
([8b408bd](https://github.com/JamieMason/syncpack/commit/8b408bd)), closes
[#12](https://github.com/JamieMason/syncpack/issues/12)
- **format:** sort contributors alphabetically
([935ffcf](https://github.com/JamieMason/syncpack/commit/935ffcf))

### Performance Improvements

- **npm:** move [@types](https://github.com/types) to devDependencies ([ad5951c](https://github.com/JamieMason/syncpack/commit/ad5951c)), closes [#13](https://github.com/JamieMason/syncpack/issues/13)
- **npm:** move [@types](https://github.com/types) to devDependencies
([ad5951c](https://github.com/JamieMason/syncpack/commit/ad5951c)), closes
[#13](https://github.com/JamieMason/syncpack/issues/13)

<a name="3.0.0"></a>

# [3.0.0](https://github.com/JamieMason/syncpack/compare/2.0.1...3.0.0) (2018-08-25)

### Features

- **bin:** override package locations using repeatable --source options ([5dbcfd4](https://github.com/JamieMason/syncpack/commit/5dbcfd4))
- **list-mismatches:** return exit code on finding mismatches ([06958c6](https://github.com/JamieMason/syncpack/commit/06958c6))
- **bin:** override package locations using repeatable --source options
([5dbcfd4](https://github.com/JamieMason/syncpack/commit/5dbcfd4))
- **list-mismatches:** return exit code on finding mismatches
([06958c6](https://github.com/JamieMason/syncpack/commit/06958c6))

### BREAKING CHANGES

- **bin:** Previously the location of package.json files could be overridden like so:
- **bin:** Previously the location of package.json files could be overridden
like so:

```
syncpack list './package.json' './packages/*/package.json'
Expand All @@ -52,15 +64,19 @@ overridable `--target` option.

### Bug Fixes

- **core:** ensure pattern overrides are read ([7513ba5](https://github.com/JamieMason/syncpack/commit/7513ba5))
- **core:** ensure pattern overrides are read
([7513ba5](https://github.com/JamieMason/syncpack/commit/7513ba5))

<a name="2.0.0"></a>

# [2.0.0](https://github.com/JamieMason/syncpack/compare/1.3.2...2.0.0) (2018-04-29)

### Features

- **core:** support multiple glob patterns ([a2b5af0](https://github.com/JamieMason/syncpack/commit/a2b5af0)), closes [#5](https://github.com/JamieMason/syncpack/issues/5) [#6](https://github.com/JamieMason/syncpack/issues/6)
- **core:** support multiple glob patterns
([a2b5af0](https://github.com/JamieMason/syncpack/commit/a2b5af0)), closes
[#5](https://github.com/JamieMason/syncpack/issues/5)
[#6](https://github.com/JamieMason/syncpack/issues/6)

### BREAKING CHANGES

Expand All @@ -72,16 +88,19 @@ overridable `--target` option.

### Features

- **core:** add set-semver-ranges command ([4d206b9](https://github.com/JamieMason/syncpack/commit/4d206b9))
- **core:** add set-semver-ranges command
([4d206b9](https://github.com/JamieMason/syncpack/commit/4d206b9))

<a name="1.2.2"></a>

## [1.2.2](https://github.com/JamieMason/syncpack/compare/1.0.2...1.2.2) (2018-02-10)

### Features

- **core:** add format command ([bae1133](https://github.com/JamieMason/syncpack/commit/bae1133))
- **core:** output current version ([e53cd99](https://github.com/JamieMason/syncpack/commit/e53cd99))
- **core:** add format command
([bae1133](https://github.com/JamieMason/syncpack/commit/bae1133))
- **core:** output current version
([e53cd99](https://github.com/JamieMason/syncpack/commit/e53cd99))

<a name="1.0.2"></a>

Expand All @@ -93,24 +112,32 @@ overridable `--target` option.

### Bug Fixes

- **core:** correct paths to binaries ([5682cd6](https://github.com/JamieMason/syncpack/commit/5682cd6))
- **core:** correct paths to binaries
([5682cd6](https://github.com/JamieMason/syncpack/commit/5682cd6))

<a name="1.0.0"></a>

# [1.0.0](https://github.com/JamieMason/syncpack/compare/0.3.1...1.0.0) (2018-02-02)

### Bug Fixes

- **core:** correctly check a file is package.json ([d1da609](https://github.com/JamieMason/syncpack/commit/d1da609))
- **core:** handle missing dependency maps ([372aa68](https://github.com/JamieMason/syncpack/commit/372aa68))
- **core:** handle semver ranges containing 1.x.x ([a0f8f56](https://github.com/JamieMason/syncpack/commit/a0f8f56))
- **core:** correctly check a file is package.json
([d1da609](https://github.com/JamieMason/syncpack/commit/d1da609))
- **core:** handle missing dependency maps
([372aa68](https://github.com/JamieMason/syncpack/commit/372aa68))
- **core:** handle semver ranges containing 1.x.x
([a0f8f56](https://github.com/JamieMason/syncpack/commit/a0f8f56))

### Features

- **core:** add fix-mismatches command ([4793f1f](https://github.com/JamieMason/syncpack/commit/4793f1f))
- **core:** add list command ([3b29176](https://github.com/JamieMason/syncpack/commit/3b29176))
- **core:** add list-mismatches command ([735ad2b](https://github.com/JamieMason/syncpack/commit/735ad2b))
- **core:** update command line API ([de8dcb2](https://github.com/JamieMason/syncpack/commit/de8dcb2))
- **core:** add fix-mismatches command
([4793f1f](https://github.com/JamieMason/syncpack/commit/4793f1f))
- **core:** add list command
([3b29176](https://github.com/JamieMason/syncpack/commit/3b29176))
- **core:** add list-mismatches command
([735ad2b](https://github.com/JamieMason/syncpack/commit/735ad2b))
- **core:** update command line API
([de8dcb2](https://github.com/JamieMason/syncpack/commit/de8dcb2))

### BREAKING CHANGES

Expand All @@ -122,36 +149,41 @@ overridable `--target` option.

### Bug Fixes

- **copy-values:** write results to disk ([a641de4](https://github.com/JamieMason/syncpack/commit/a641de4))
- **copy-values:** write results to disk
([a641de4](https://github.com/JamieMason/syncpack/commit/a641de4))

<a name="0.3.0"></a>

# [0.3.0](https://github.com/JamieMason/syncpack/compare/0.2.1...0.3.0) (2017-08-22)

### Features

- **cli:** add copy-values command ([b51a2c9](https://github.com/JamieMason/syncpack/commit/b51a2c9))
- **cli:** add copy-values command
([b51a2c9](https://github.com/JamieMason/syncpack/commit/b51a2c9))

<a name="0.2.1"></a>

## [0.2.1](https://github.com/JamieMason/syncpack/compare/0.2.0...0.2.1) (2017-08-20)

### Bug Fixes

- **core:** update dependencies, fix lint warnings ([a65eef7](https://github.com/JamieMason/syncpack/commit/a65eef7))
- **core:** update dependencies, fix lint warnings
([a65eef7](https://github.com/JamieMason/syncpack/commit/a65eef7))

<a name="0.2.0"></a>

# [0.2.0](https://github.com/JamieMason/syncpack/compare/0.1.0...0.2.0) (2017-08-20)

### Features

- **sync:** synchronise versions across multiple package.json ([7d5848a](https://github.com/JamieMason/syncpack/commit/7d5848a))
- **sync:** synchronise versions across multiple package.json
([7d5848a](https://github.com/JamieMason/syncpack/commit/7d5848a))

<a name="0.1.0"></a>

# [0.1.0](https://github.com/JamieMason/syncpack/compare/f6dada7...0.1.0) (2017-08-18)

### Features

- **cli:** create scaffold cli ([f6dada7](https://github.com/JamieMason/syncpack/commit/f6dada7))
- **cli:** create scaffold cli
([f6dada7](https://github.com/JamieMason/syncpack/commit/f6dada7))
47 changes: 30 additions & 17 deletions DEPENDENCIES.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ Manage multiple package.json files, such as in Lerna Monorepos
This is a [Node.js](https://nodejs.org/) module available through the
[npm registry](https://www.npmjs.com/). It can be installed using the
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
or
[`yarn`](https://yarnpkg.com/en/)
command line tools.
or [`yarn`](https://yarnpkg.com/en/) command line tools.

```sh
npm install syncpack --save
Expand All @@ -25,29 +23,44 @@ npm test
## Dependencies

- [chalk](http://ghub.io/chalk): Terminal string styling done right
- [commander](http://ghub.io/commander): the complete solution for node.js command-line programs
- [fs-extra](http://ghub.io/fs-extra): fs-extra contains methods that aren&#39;t included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf.
- [globby](http://ghub.io/globby): Extends `glob` with support for multiple patterns and exposes a Promise API
- [commander](http://ghub.io/commander): the complete solution for node.js
command-line programs
- [fs-extra](http://ghub.io/fs-extra): fs-extra contains methods that aren&#39;t
included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm
-rf.
- [globby](http://ghub.io/globby): Extends `glob` with support for multiple
patterns and exposes a Promise API
- [lodash](http://ghub.io/lodash): Lodash modular utilities.
- [semver](http://ghub.io/semver): The semantic version parser used by npm.

## Dev Dependencies

- [@types/fs-extra](http://ghub.io/@types/fs-extra): TypeScript definitions for fs-extra
- [@types/globby](http://ghub.io/@types/globby): TypeScript definitions for globby
- [@types/fs-extra](http://ghub.io/@types/fs-extra): TypeScript definitions for
fs-extra
- [@types/globby](http://ghub.io/@types/globby): TypeScript definitions for
globby
- [@types/jest](http://ghub.io/@types/jest): TypeScript definitions for Jest
- [@types/lodash](http://ghub.io/@types/lodash): TypeScript definitions for Lo-Dash
- [@types/mock-fs](http://ghub.io/@types/mock-fs): TypeScript definitions for mock-fs
- [@types/lodash](http://ghub.io/@types/lodash): TypeScript definitions for
Lo-Dash
- [@types/mock-fs](http://ghub.io/@types/mock-fs): TypeScript definitions for
mock-fs
- [@types/node](http://ghub.io/@types/node): TypeScript definitions for Node.js
- [@types/semver](http://ghub.io/@types/semver): TypeScript definitions for semver
- [expect-more-jest](http://ghub.io/expect-more-jest): Write Beautiful Specs with Custom Matchers
- [@types/semver](http://ghub.io/@types/semver): TypeScript definitions for
semver
- [expect-more-jest](http://ghub.io/expect-more-jest): Write Beautiful Specs
with Custom Matchers
- [jest](http://ghub.io/jest): Delightful JavaScript Testing.
- [mock-fs](http://ghub.io/mock-fs): A configurable mock file system. You know, for testing.
- [mock-fs](http://ghub.io/mock-fs): A configurable mock file system. You know,
for testing.
- [prettier](http://ghub.io/prettier): Prettier is an opinionated code formatter
- [rimraf](http://ghub.io/rimraf): A deep deletion module for node (like `rm -rf`)
- [ts-jest](http://ghub.io/ts-jest): A preprocessor with source maps support to help use TypeScript with Jest
- [tslint](http://ghub.io/tslint): An extensible static analysis linter for the TypeScript language
- [typescript](http://ghub.io/typescript): TypeScript is a language for application scale JavaScript development
- [rimraf](http://ghub.io/rimraf): A deep deletion module for node (like
`rm -rf`)
- [ts-jest](http://ghub.io/ts-jest): A preprocessor with source maps support to
help use TypeScript with Jest
- [tslint](http://ghub.io/tslint): An extensible static analysis linter for the
TypeScript language
- [typescript](http://ghub.io/typescript): TypeScript is a language for
application scale JavaScript development

## License

Expand Down

0 comments on commit dfe6274

Please sign in to comment.