UX: Make root easier to import

[davesmith00000]

Hi!

I'm helping someone put together an example of routing a Tyrian app that uses url-dsl to do the path matching heavy lifting. Working well so far!

I'd like to suggest that the on-boarding experience could be simplified by organising packages / imports differently. (In my projects I often do this with package objects full of aliases so that I don't corrupt the real package structure in the name of user friendly-ness.)

For example: My first impression of this import was that the nice person building the routing example we're working on, had got the wrong import. That they'd dived into the implementation and yanked out something internal. 😄

import urldsl.language.simpleErrorImpl._

The Impl suffix to me implies that I shouldn't be importing that thing, the convention (to me?) means that its the internal implementation behind some interface.

In fact, to get our simple example working, I have to import all of this (it seems?):

import urldsl.errors.*
import urldsl.language.*
import urldsl.language.simpleErrorImpl.*
import urldsl.vocabulary.*

If the imports (with aliases) could be arranged so that I can import everything I need for simple routing with one import, I think that would be a good usability improvement, something like:

import urldsl.syntax.*

Just a suggestion, feel free to close the issue if you disagree.

[sherpal]

Hello,

Thank you for reporting this. Reducing getting started friction is obviously something I can't ignore!

I think you are right that we too often end up having too many lines of imports, and in particular the most important one is probably the most difficult to find...

Putting everything that's needed in a single import is a good idea, I will try to implement that.