Design question: what should the cli and api packages actually look like?

Open
#719 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
go
Domain
api, backend-api-design, cli

Research direction

Start by comparing the contents and responsibilities of the cli and api packages, focusing on CLI-specific logic such as build and version handling versus code that talks to remote servers. Review the existing package organization and discuss whether api or remote better describes that boundary. Done requires an agreed package structure and naming decision; the issue does not identify specific files or tests.

Written by the indexing model from the issue text.

Description

@nywilken I was looking at the contents of the cli package and the api package. I think we've got a bit of ambiguity around where things belong.

I'm wondering if we should have the CLI-specific logic in the cli package (build stuff, logic around versions, maybe), and then have everything that talks to remote servers in api. But maybe api is the wrong name. Maybe remote?

Dominant language
Go
Stars
1.4k
Forks
363
Avg merge
6d 13h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from exercism/cli

All issues in exercism/cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.