Add the supplyDefaultsInJsDoc setting

[cmaster11]

Add the supplyDefaultsInJsDoc setting

If a field has a default value, add its stringified representation to the JsDoc using the @default annotation.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.50%. Comparing base (2cb6f45) to head (7d1f986).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #442      +/-   ##
==========================================
+ Coverage   98.48%   98.50%   +0.02%     
==========================================
  Files           9        9              
  Lines         661      670       +9     
  Branches      266      262       -4     
==========================================
+ Hits          651      660       +9     
  Misses         10       10              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cmaster11]

I'm wondering whether this should use util.inspect 🤔 For prettier docs

[cmaster11]

Difference

JSON

export interface Test {
  /**
   * @default "Test"
   */
  alt?: string | number;
  /**
   * @default {"val":false}
   */
  alt2?: string | number | {
      /**
       * @default true
       */
      val?: boolean;
    };
  /**
   * @default [1,2,3]
   */
  arr?: number[];
  /**
   * @default ["X","Y","Z"]
   */
  arr2?: string[];
  /**
   * @default true
   */
  bool?: boolean;
  /**
   * @default true
   */
  boolOptional?: boolean;
  /**
   * @default null
   */
  fieldWithAnyNull?: any;
  /**
   * A field with a
   * multiline doc
   *
   * @default "My string!"
   */
  fieldWithDoc?: string;
  /**
   * @default 1
   */
  num?: number;
  /**
   * @default 1
   */
  numOptional?: number;
  /**
   * @default {"val":"Test"}
   */
  obj?: {
    val?: string;
  };
  /**
   * @default "Test"
   */
  str?: string;
  /**
   * @default "Test"
   */
  strOptional?: string;
  /**
   * @default "Test\\\\World$Hello🚀Hey\\nYay"
   */
  strWithSpecialChars?: string;
}

util.inspect

export interface Test {
  /**
   * @default 'Test'
   */
  alt?: string | number;
  /**
   * @default { val: false }
   */
  alt2?: string | number | {
      /**
       * @default true
       */
      val?: boolean;
    };
  /**
   * @default [ 1, 2, 3 ]
   */
  arr?: number[];
  /**
   * @default [ 'X', 'Y', 'Z' ]
   */
  arr2?: string[];
  /**
   * @default true
   */
  bool?: boolean;
  /**
   * @default true
   */
  boolOptional?: boolean;
  /**
   * @default null
   */
  fieldWithAnyNull?: any;
  /**
   * A field with a
   * multiline doc
   *
   * @default 'My string!'
   */
  fieldWithDoc?: string;
  /**
   * @default 1
   */
  num?: number;
  /**
   * @default 1
   */
  numOptional?: number;
  /**
   * @default { val: 'Test' }
   */
  obj?: {
    val?: string;
  };
  /**
   * @default 'Test'
   */
  str?: string;
  /**
   * @default 'Test'
   */
  strOptional?: string;
  /**
   * @default 'Test\\World$Hello🚀Hey\nYay'
   */
  strWithSpecialChars?: string;
}

[mrjono1]

I had to google it, but it sounds interesting, it would be easier than calculating indentations

[mrjono1]

@cmaster11 would you like to be a collaborator on this repo?

[cmaster11]

@mrjono1 I can be interested for sure, given how much I've been loving it :D

[mrjono1]

invite sent!

[cmaster11]

Getting back to the feat, there are multiple options.

• JSON.stringify
• util.inspect (still doesn't handle nicely multiline strings: @default 'A multiline\nstring with\nsome lines')
• Could be also worth using a yaml dump?

Thing is, JSON.stringify and util.inspect produce JS-valid code, yaml would not 🤔

[cmaster11]

Maybe the tradeoff can be the util.inspect, where it's a tad cleaner than JSON but still compatible. The more I look at it, the more it seems friendly.

[cmaster11]

Still LGTM?