Skip to content
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.

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

Improving command help content #612

Open
leggetter opened this issue May 6, 2014 · 0 comments
Open

Improving command help content #612

leggetter opened this issue May 6, 2014 · 0 comments

Comments

@leggetter
Copy link
Contributor

We should take some time to make sure that the help messages for each command don't make too many assumptions about in-depth BRJS knowledge.

For example, the dep-insight command talks about 'source modules'. Is there a simpler way of explaining this without the need to introduce a new concept?

Related to #548 and #549.

2.0.0-p353 in sdk/
› ./brjs help dep-insight
Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=128M; support was removed in 8.0
creating plugins
performing node discovery
making plugins available via model
BladeRunnerJS version: v0.7-108-g0b13594, built: 28 April 2014 22:18 BST

Description:
  Show inverse dependencies for a given source module.

Usage:
  brjs dep-insight <app-name> <require-path> [<aspect-name>] [-p|--prefix] [-a|--alias] [-A|--all]

Help:
    <app-name>
        the application to show dependencies for

  <require-path>
        the source module to show dependencies for

  [<aspect-name>]
        the aspect to show dependencies for (default: default)

  [-p|--prefix]
        display dependencies for all source modules starting with the given
        require path

  [-a|--alias]
        display dependencies for an alias rather than a require path

  [-A|--all]
        show all ocurrences of a dependency

create-library command should provide all the "type" parameter options within the help text

./brjs help create-library

› ./brjs help create-library
Description:
  Create a new empty library within a given application.

Usage:
  brjs create-library <target-app-name> <new-library-name> [(-t|--type) <type>]

Help:
    <target-app-name>
        the application the new library will be created within

  <new-library-name>
        the name of the library that will be created

  [(-t|--type) <type>]
        (default: br)

The default value for --type is br. What are the other options?

The other option is thirdparty as per the docs: http://bladerunnerjs.org/docs/use/use_libraries/#tocAnchor-1-3

dchambers pushed a commit that referenced this issue Aug 26, 2014
JSDoc has a few requirements that are somewhat unusual for a Node.js app:

1. We need `require('jsdoc/foo')` to work from any module.
2. We need `require('jsdoc/foo')` to work from external code, such as templates and plugins.

Prior to this commit, JSDoc did two separate things to meet these requirements:

1. Use an npm post-install script to create a symlink from `lib/jsdoc` to `node_modules/jsdoc`.
2. When a user runs JSDoc, copy templates and plugins into the JSDoc directory.

These fixes worked, sort of. But they also caused numerous issues with file permissions, especially on Windows.

We now use the Requizzle module, which hacks the Node.js module system to support JSDoc's use cases. There's no longer a post-install script, and there's no need for a symlink in `node_modules`.
@andy-berry-dev andy-berry-dev removed the BVP label Jun 2, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants