Styler mangles multi-line comments in config files

[cschmatzler]

This config file:

import Config

# Note we also include the path to a cache manifest
# containing the digested version of static files. This
# manifest is generated by the `mix assets.deploy` task,
# which you should run after static files are built and
# before starting your production server.
config :tuist, cache_static_manifest: "priv/static/cache_manifest.json"

# Configures Bamboo API Client
config :tuist, Tuist.Mailer, adapter: Bamboo.MailgunAdapter

# Do not print debug messages in production
config :logger, level: :info

After applying Styler, looks like this:

import Config

# Do not print debug messages in production
config :logger, level: :info

# Note we also include the path to a cache manifest
# containing the digested version of static files. This
# manifest is generated by the `mix assets.deploy` task,

# Configures Bamboo API Client
# which you should run after static files are built and
# before starting your production server.
config :tuist, Tuist.Mailer, adapter: Bamboo.MailgunAdapter
config :tuist, cache_static_manifest: "priv/static/cache_manifest.json"

No idea where it sees the newline, but it's a lot of manual work to rearrange comments.

This is on 1.4.1.

[novaugust]

thanks @cschmatzler , i was aware of this issue but needed a small repro. this is great info.

if this happens to you again, the easiest workaround is to revert styler's changes, then manually sort the one line that was added out of order to the others (in the case above, the config :logger. that saves you moving all the comments around

cc @milmazz who had it on his TODOs to create a repro :)

[novaugust]

thanks a lot @cschmatzler , this bug's been driving me batty for ages :) so glad to finally track down my mistake with your repro

[ryoung786]

Styler 1.4.2, Elixir 1.8.3, OTP 27

I think there may still be an issue. To reproduce run with $ mix phx.new demo and look at the generated config/dev.exs.

I tried to make the smallest example and came up with this:

import Config

config :demo, DemoWeb.Endpoint,
  http: [ip: {127, 0, 0, 1}, port: 4000]

# In order to use HTTPS in development, a self-signed
#
#     mix phx.gen.cert
#
# If desired, both `http:` and `https:` keys can be

# Set a higher stacktrace during development. Avoid configuring such
config :phoenix, :stacktrace_depth, 20

# Initialize plugs at runtime for faster development compilation
config :phoenix, :plug_init_mode, :runtime

Applying Styler:

import Config

config :demo, DemoWeb.Endpoint, http: [ip: {127, 0, 0, 1}, port: 4000]

# In order to use HTTPS in development, a self-signed
#
#     mix phx.gen.cert

# Initialize plugs at runtime for faster development compilation
#
# If desired, both `http:` and `https:` keys can be
# Set a higher stacktrace during development. Avoid configuring such
config :phoenix, :plug_init_mode, :runtime
config :phoenix, :stacktrace_depth, 20

[trap98]

Hi,

In case you don't know the issue is not fixed in version 1.4.2

Thanks

[novaugust]

thanks @ryoung786 , finally looking at this. thought you'd appreciate the note i found to myself while investigating :P

  # TODO this doesn't grab comments which are floating as their own paragraph, unconnected to a node
  # they'll just be left floating where they were, then mangled with the re-ordered comments..

darn phx, having comments attached to nothing in its generators :P i'll see what i can do

PS: i greatly appreciate the shrunken repro