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

[✨][cli] runespoor-cli package #102

Open
BorysShulyak opened this issue Apr 12, 2024 · 0 comments
Open

[✨][cli] runespoor-cli package #102

BorysShulyak opened this issue Apr 12, 2024 · 0 comments
Labels
type::feature Effort to deliver new features, feature changes & improvements. workflow::backlog validation

Comments

@BorysShulyak
Copy link
Member

BorysShulyak commented Apr 12, 2024

Is your feature request related to a problem?

The problem of boilerplate and conventions of the react application files structure.

Describe the solution you'd like

High Level:
Create @runespoor/cli package. With the following functionality allowed by reactadd command:

  • component
    • —name ComponentName, -n ComponentName
    • —type atom/molecule/organism/nested/page/template
    • —test - create the component integration tests file
    • —stories, -s - create the component stories file
    • —types - create the component types file
    • —constants - create the component constants file
    • —hooks - create the component hooks folder
    • —utils - create the component utils folder
  • components-group - generate the components group with atoms, molecules, organisms folders
  • stories
    • —name ComponentName, -n ComponentName
  • hook
    • —name useHookName, -n useHookName
    • —test
  • util
    • —name utilName, -n utilName
    • —test
  • context
    • —name ContextName, -n ContextName
    • —test
    • —types - create the context types file
    • —constants - create the context constants file
    • —hooks - create the context hooks folder
    • —utils - create the context utils folder
  • test-integration
    • —name ComponentName, -n ComponentName
  • test-unit
    • —name functionName, -n functionName
  • api-group
    • —name groupName, -n groupName
  • api

Low Level:

  • The package should be available to install globally via npx and as a devDependencies to use as a projects script via npm run.
  • The -h parameter should be provided for all the commands and for the global reactadd one.
  • If the command is not provided, the prompt should be displayed with the list of available commands.
  • shared method for files creating
  • provide the config for all the methods to configure TS/JS language, vitests/jest lib, file placeholder code, file path and naming pattern, erc.

Describe alternatives you've considered

Additional context

Tech Stack to analyze:

Guides:

@BorysShulyak BorysShulyak added type::feature Effort to deliver new features, feature changes & improvements. workflow::backlog validation labels Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::feature Effort to deliver new features, feature changes & improvements. workflow::backlog validation
Projects
None yet
Development

No branches or pull requests

1 participant