Rename default configuration file

[kaelig]

Currently, view.json is parsed by default when running $ sassdoc in the cli.

This is a very generic name that doesn't have its place in the root folder of a project.

I suggest .sassdoc.json instead, which should encourage authors to put the config file at a prime location.

[pascalduez]

Obviously a good point, I would also be in favor of a more precise namespace.
Some time ago, It crossed my mind that we could have used something similar to the rc sheme.
.sassdocrc
See https://github.com/dominictarr/rc

[kaelig]

Even better 👏

[KittyGiraudel]

I want this for 2.0. Not before since it will break default API.

[valeriangalliat]

+1 for a .sassdocsomething, and +1 for the proper rc thing.

[valeriangalliat]

SassDoc upgrade script for 2.0

mv view.json .sassdocrc || :

Boom.

[valeriangalliat]

Oh and @hugogiraudel, if we don't want to break the API, we can still search in view.json for config, and merge it with rc's output (and gently depreciate the view.json, and definitely removing it for 2.0). But 2.0 is close enough to wait I think.

[KittyGiraudel]

What I would like to do actually is adding a message right now whenever someone relies on the default naming (view.json) to warn about breaking change in 2.0. Something like:

Starting SassDoc 2.0, the default configuration file won't named view.json anymore.

Regarding this rc thing, it looks cool but it seems like it doesn't support YAML which is coming with 1.6 so I'm not sure.

[valeriangalliat]

You're right for the YAML, I'll have a look but I don't think this library will support dynamic parse function according to the extension... maybe we can extend it for this?

I'm not sure with the "merge config with parent" behavior too, if I understood, we can have a .sassdocrc in the package directory, but if there's a parent .sassdocrc, it will be merged too? And the ~/.config/sassdoc/config will too? I prefer to stop at the first .sassdocrc, and use ~/.config/sassdoc/config only if nothing is found.

The thing is .sassdocrc won't work, we need .sassdoc.json or .sassdoc.yaml, and ~/.config/sassdoc/config.yaml or ~/.config/sassdoc/config.json.

What about switching everything to YAML only? SassDoc isn't opinionated after all? But that won't work with the rc library, and I don't like the INI format either.

[KittyGiraudel]

Why do you want to ditch JSON? Definitely not, we aim for both extensions.