fossas / spectrometer

Flexible, robust, and performant dependency analysis.
Mozilla Public License 2.0
20 stars 7 forks source link

Welcome messages #151

Closed xizhao closed 2 years ago

xizhao commented 4 years ago
  1. install welcome message

After running install:

fossamac:~ kevin$ curl -H 'Cache-Control: no-cache' https://raw.githubusercontent.com/fossas/spectrometer/master/install.sh | bash
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  9462  100  9462    0     0  21801      0 --:--:-- --:--:-- --:--:-- 21801
fossas/spectrometer info checking GitHub for latest tag
fossas/spectrometer info found version: 2.3.4 for v2.3.4/darwin/amd64
Archive:  fossa_2.3.4_darwin_amd64.zip
  inflating: fossa
fossas/spectrometer info installed /usr/local/bin/fossa

It would be really nice to have a welcome message with some color or something letting the user know how to get started.

i.e.

Successfully installed fossa-cli!

Visit {docs links} to start get an API key or run `fossa auth`.

When ready, navigate to your repo and run `fossa analyze`.
  1. Running fossa should default to some kind of help or getting started text

  2. Errors should have some instructions on how to contact fossa

fossamac:fossa-site kevin$ fossa report --json attribution

Using project name: `git@github.com:fossas/fossa-site.git`
Using revision: `956e7113b4d861d979618b90cdde3a3a9c4b09e4`
----------
A fatal error occurred:

    The build failed. Check the FOSSA webapp for more details.

>>>
Relevant warnings include:
xizhao commented 4 years ago

I know this is a backend change too, but it would be amazing if we could jump in and add a tiny bit of parsing in order to humanize the titles that end up in fossa.

image

skilly-lily commented 4 years ago

@xizhao The title change is doable. We can parse URLs which have known patterns. For the meantime, we have the --title option as a workaround.

meghfossa commented 2 years ago

Added this on internal backlog, closing this for now, as spectrometer code is migrated to fossa-cli repository.