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

[RFC] Improved CLI #33

Open
chrisdmacrae opened this issue Aug 23, 2020 · 0 comments
Open

[RFC] Improved CLI #33

chrisdmacrae opened this issue Aug 23, 2020 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@chrisdmacrae
Copy link
Owner

Use case (user story)

I’d like to convert this project to a monorepo, and:

  • create a core package in typescript
  • create a CLI using ink.js and glue.js

Scenarios

Scenario: new project
Given I am using atomic Algolia for the first time,
When I start my project, I should be able to call an init command,
Then atomic Algolia will be added to my project,
  and package.json will be updated with scripts,
  and package.json will be update with default config.

Scenario: Update a single index
Given I am updating an index,
When I call the atomic Algolia CLI,
Then I should be promoted for a path to the local index,
  And the remote index identifier,
  And Algolia API keys,
  Or be able to pass them directly to the CLI,
And the index is then updated. 

Scenario: interactive feedback
Given I am updating an index,
When the process is running,
Then the CLI should provide real-time feedback,
  And show which hits are being updated,
  And show which hits are being removed,
  And show which hits are being added,
  And show which hits haven’t changed.

Notes

This needs to be done incrementally.

  1. Add basic expanded CLI functionality piece by piece
  2. Add ink and basic reporting
  3. Add expanded reporting
  4. Add verbose reporting with expandable git information
@chrisdmacrae chrisdmacrae added enhancement New feature or request help wanted Extra attention is needed labels Aug 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant