ObjectSchema.required without parameters wrongly set the last prop as required about fluent-json-schema HOT 4 CLOSED

Would you like to send a Pull Request to address this issue? Remember to add unit tests.

from fluent-json-schema.

I've seen this in fluent-schema's code:
https://github.com/fastify/fluent-schema/blob/b5a5c80334529a2febcc4b3a54b35f5680752e3a/src/BaseSchema.js#L180

/**
   * Required has to be chained to a property:
   * Examples:
   * - S.prop('prop').required()
   * - S.prop('prop', S.number()).required()
   * - S.required(['foo', 'bar'])

But in the README.md it's used like this:

.prop(
    'email',
    S.string()
      .format(S.FORMATS.EMAIL)
      .required() // <- It's not chained to `prop` call !
  )

I'm wondering which one is correct?

from fluent-json-schema.

The correct schema is:

    S.object()
      .prop(
        'perm',
        S.object()
          .required()
          .prop('admin', S.boolean())
          .prop('comment', S.boolean())
      )
      .valueOf()

If you put required() after a property definition it's attached to the last property declared ( comment in this case )

The README is correct because in the case of the String.format('EMAIL').required() there isn't a property so we attach required to the root element.

Given that I agree the README is a bit misleading perhaps we could put String.required().format('EMAIL') to be more consistent. Also, we could add in the main example a required object so we can show the correct syntax.

from fluent-json-schema.

Thanks very much! I'll close this issue now.

from fluent-json-schema.