use default options in Renderer by default

[UziTech]

Marked version: 0.3.19

Description

• Sets the Renderer options to the default options by default

I'm not sure if there is a reason the Renderer options were set to an empty object instead of the default options. The Parser and Lexers are set to the default options already

function Renderer(options) {
  this.options = options || {};
  ...

function Lexer(options) {
  this.options = options || marked.defaults;
  ...

function InlineLexer(links, options) {
  this.options = options || marked.defaults;
  ...

function Parser(options) {
  this.options = options || marked.defaults;
  ...

Contributor

• Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
• no tests required for this PR.

Committer

In most cases, this should be a different person than the contributor.

• Draft GitHub release notes have been updated.
• CI is green (no forced merge required).
• Merge PR

[UziTech]

@Feder1co5oave is there any reason Renderer options would be set to an empty object instead of the marked.defaults?

[styfle]

That's odd, maybe it was a miss?
This probably should use the defaults.

This is a breaking change for anyone using var r = new Renderer(), right?

[UziTech]

Yes it would be a breaking change but I feel like it would be a fix. Right now that would be the same as the following:

var r = new Renderer({
  baseUrl: undefined,
  breaks: undefined,
  gfm: undefined,
  headerIds: undefined,
  headerPrefix: undefined,
  highlight: undefined,
  langPrefix: undefined,
  mangle: undefined,
  pedantic: undefined,
  renderer: undefined,
  sanitize: undefined,
  sanitizer: undefined,
  silent: undefined,
  smartLists: undefined,
  smartypants: undefined,
  tables: undefined,
  xhtml: undefined
});

which I don't think anyone would do willingly. So it would be more likely that anyone using the renderer would pass some options so this wouldn't break anything.

[joshbruce]

Would want to make sure our next release is 0.4.x due to the breaking change, but I think the options need some work anyway given what I've seen so far...might be a good place to start stabilizing things.

[joshbruce]

ps. Just because this is a breaking change doesn't stop me from merging this. If neither @UziTech or @styfle are concerned committing to a 0.4.x as the next release, I would say we are good to go.

[UziTech]

Ya I would say we should merge it as a bug fix and release when 0.4.x milestone is ready. I was looking through the blame and it looks like it was just missed when the renderer was created.

[styfle]

Done

[Feder1co5oave]

Because of lines 549 and 980. It gets overwritten anyways,