elm-lang / elm-package

Command line tool to share Elm libraries

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Please use `.elm-stuff`, not `elm-stuff`

dterhorst-zz opened this issue · comments

Platform

$ elm --version
0.18.0
$ uname -a
Darwin hexbox 16.1.0 Darwin Kernel Version 16.1.0: Thu Oct 13 21:26:57 PDT 2016; root:xnu-3789.21.3~60/RELEASE_X86_64 x86_64

Steps to Reproduce

$ mkdir newproject
$ cd newproject/
$ elm package install
Some new packages are needed. Here is the upgrade plan.

  Install:
    elm-lang/core 5.1.1
    elm-lang/html 2.0.0
    elm-lang/virtual-dom 2.0.4

Do you approve of this plan? [Y/n] Y
Starting downloads...

  ● elm-lang/html 2.0.0
  ● elm-lang/virtual-dom 2.0.4
  ● elm-lang/core 5.1.1

Packages configured successfully!

Expected

The created directory to be a hidden directory named .elm-stuff, or preferably just .elm.

Actual

The created directory is a normal directory named elm-stuff.

Notes

This is a common standard. Git, for example, puts all of its metadata in a hidden .git directory. Elm projects will frequently be used in conjunction with git, so it makes sense to use the same standard instead of inventing our own.

It also has the nice benefit of keeping the output of ls clean and focused on the project being worked on rather than cluttering it with metadata that almost never needs direct attention.

Thanks for the issue! Make sure it satisfies this checklist. My human colleagues will appreciate it!

Here is what to expect next, and if anyone wants to comment, keep these things in mind.

Even if I do think this might be a good idea, I wanted to mention that Elm is, from what I understand, meant to appeal largely to JavaScript convertees who are likely to be familiar with the normal node_modules/ directory.

A fair enough point.