Skip to content

[RFC] Improved CLI #33

@chrisdmacrae

Description

@chrisdmacrae

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions