Code Monkey home page Code Monkey logo

Comments (6)

newyork-anthonyng avatar newyork-anthonyng commented on June 1, 2024

Running just by itself gives me this output:

just <cmd> [options]

Tasks:

  just blimey  An exclamation of surprise.

Options:
  --version  Show version number                                       [boolean]
  --config   path to a just-task.js file (includes the file name)
  --name
  --help     Show help                                                 [boolean]

No default tasks are defined.
[12:28:13 PM] x Error previously detected. See above for error messages.

Should we update the docs to reflect this? Or should we do code changes to have just --help have the same output as just.

Also, what do we expect just blimey --help to return? I believe it should return a description for blimey as well as the options that it accepts. However, with the current API, there's no way to associate an option with a task.

@kenotron thoughts?

from just.

anikethsaha avatar anikethsaha commented on June 1, 2024

As far as the optimal behaviour is concerned it should print the helping message when passed with --help flag. I guess its an issue !....

from just.

jugglingjsons avatar jugglingjsons commented on June 1, 2024

just on it's own indeed prints everything.
just with --help however doesn't neither does just taskname --help

I will take more time to look at this on Sunday at the earliest, but seems like a good issue to get familiar with yargs and just : ) So feel free to tweak the finding

from just.

anikethsaha avatar anikethsaha commented on June 1, 2024

I guess the options are a wrapper for yargs. If it so then just check if anything missing in the yargs implementation. Cause yargs should take care of command --help flag

from just.

kenotron avatar kenotron commented on June 1, 2024

Show help is not very much help at the moment for the options it seems. I mainly did as much as possible to list

Running just by itself gives me this output:

just <cmd> [options]

Tasks:

  just blimey  An exclamation of surprise.

Options:
  --version  Show version number                                       [boolean]
  --config   path to a just-task.js file (includes the file name)
  --name
  --help     Show help                                                 [boolean]

No default tasks are defined.
[12:28:13 PM] x Error previously detected. See above for error messages.

Should we update the docs to reflect this? Or should we do code changes to have just --help have the same output as just.

Also, what do we expect just blimey --help to return? I believe it should return a description for blimey as well as the options that it accepts. However, with the current API, there's no way to associate an option with a task.

@kenotron Ken Chau FTE thoughts?

The issue here is that options and tasks are defined all in one. That's actually how it would work elsewhere. In a just.config.js that has multiple tasks defined and multiple options, you could actually run any of the tasks with any of the options. This means that options aren't really tied to a task. All options are essentially global.

I really think the help message should include all options and all tasks like when you run just by itself. This is a bug - probably because I'm using yargs in a way that's not how it's directly designed to do. I'm considering switching to yargs-parser and handle command and help inside just-task itself.

from just.

github-actions avatar github-actions commented on June 1, 2024

Issues seem to have gone stale.

from just.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.