snap package prints erroneous token config instructions

Open
#905 5 comments 11 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
go
Domain
cli

Research direction

Reproduce the issue with the snap installation and the exercism download --exercise=hello-world --track=typescript command, then compare the displayed configure path with the working exercism configure --token=... command. Trace where the token error message is assembled and how the snap executable path is determined. Done means the guidance works for snap users without requiring a hard-coded /snap/exercism/5/exercism path.

Written by the indexing model from the issue text.

Description

I haven't used exercism for a while, but upon deciding to revisit after a hiatus, I was pleased to find there is now a snap package available. Following the instructions at

https://exercism.io/cli-walkthrough

> sudo snap install exercism

and then, admittedly, not completely following all the instructions, I jumped to trying to install an exercise, and got the following error message

> exercism download --exercise=hello-world --track=typescript
Error:

    Welcome to Exercism!

    To get started, you need to configure the tool with your API token.
    Find your token at

        https://exercism.io/my/settings

    Then run the configure command:

        /snap/exercism/5/exercism configure --token=YOUR_TOKEN

In copying the instructions and replacing with my token

/snap/exercism/5/exercism configure --token=<my_token>

and getting a positive confirmation message that it had worked correctly, I tried re-downloading the exercise

> exercism download --exercise=hello-world --track=typescript

only to receive the same error message. After a minor amount of debugging to determine the path of the actual exercism binary

> which exercism
/snap/bin/exercism

and using the updated path when running configure

/snap/bin/exercism configure --token=<my_token>

it worked. Ultimately, I stumbled upon the correct instruction on the third page of

https://exercism.io/cli-walkthrough

exercism configure --token=<my_token>

But it seems like the command

> exercism download --exercise=<exercise-name> --track=<language>

should output this instead of the /snap/exercism/5/exercism path.

I realize I probably should have RTFM and I don't know enough about snaps to know how hard it is to fix, but seems like a reasonable fix given it's a beginner tool and the much appreciated effort for creating the snap.

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.