GithubHelp home page GithubHelp logo

Proposal: cli refactor about big HOT 4 CLOSED

delvedor avatar delvedor commented on May 27, 2024
Proposal: cli refactor

from big.

Comments (4)

tmcw avatar tmcw commented on May 27, 2024

I'm not sure if this would constitute an improvement - in exchange for replacing a - with a space, there are fewer cli 'binaries', but, for example, typing big-presentation<tab> wouldn't auto-complete the various big-presentation CLI utilities. Additionally, the help command for each command would have to move from big-presentation-compose --help to big-presentation --help compose, which I think is less discoverable.

Ps. Are you ok on adding a JavaScript linter? I see that you use semicolons, is semistandard ok for you?

This project already has prettier as a dependency - I haven't set up the infrastructure to auto-run it on commit because I merge most commits manually, but - prettier's auto-formatting is the style standard.

from big.

delvedor avatar delvedor commented on May 27, 2024

I'm not sure if this would constitute an improvement - in exchange for replacing a - with a space

Is not about removing a dash, but I think this enables a future-proof API that is easy to "scale" if needed.

typing big-presentation wouldn't auto-complete the various big-presentation CLI utilities.

That's true; I don't know how to do that.

CLI utilities. Additionally, the help command for each command would have to move from big-presentation-compose --help to big-presentation --help compose, which I think is less discoverable.

Actually is slightly different. And I think it helps a lot regarding discoverability:

big-presentation                 # prints the full help message
big-presentation help            # prints all the supported commands
big-presentation help compose    # prints all the supported flags of the compose command

This project already has prettier as a dependency - I haven't set up the infrastructure to auto-run it on commit because I merge most commits manually, but - prettier's auto-formatting is the style standard.

Prettier is a fantastic tool, but as far as I know is a code formatter and not a code linter, am I right?
In any case, no problem!

from big.

delvedor avatar delvedor commented on May 27, 2024

You can see here my approach.
If you feel that is a massive change and you prefer to avoid it, no worries!
I will keep a separate fork just for me :)

from big.

tmcw avatar tmcw commented on May 27, 2024

Yep, I think I'm happy with the CLI setup as-is - this change might be an improvement, but I'm not sure that it justifies the change & major version bump that'd be required to release. Thanks again for the suggestion, it's just not quite what I think I'm going for, for the project mythology.

from big.

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.