search

embroider-build / addon-blueprint

Blueprint for v2-formatted Ember addons
MIT License
28 stars 23 forks source link

Align markdown format with Ember CLI blueprints #250

Closed jelhan closed 4 months ago

jelhan commented 5 months ago

Embroider addon blueprint use a different list for unordered style in markdown than Ember CLI blueprints. I feel both should be aligned.

Ember CLI uses the asterisk character (*): https://github.com/ember-cli/ember-cli/blob/134a252cdb0233684455c0b4eba139717cefaa8e/blueprints/addon/files/README.md?plain=1#L8

Embroider addon blueprint uses the hyphen character (-): https://github.com/embroider-build/addon-blueprint/blob/b1168b4616adf748bd713c5af39e104325982e9b/files/README.md?plain=1#L7

Both is valid markdown as far as I know. But using different conventions causes unnecessary churn in the ecosystem when migrating from v1 to v2 addons.

simonihmig commented 5 months ago

But prettier would convert * to -, shouldn't we align to that?

bertdeblock commented 4 months ago

I made https://github.com/ember-cli/ember-cli/pull/10446 for the v1 addon blueprint.

bertdeblock commented 4 months ago

https://github.com/ember-cli/ember-cli/pull/10446 was merged, so I think we can close this issue.