Documentation

[AaronNGray]

Types

• Overall API documentation
• Inline code documentation

Documentation generator

Ideally a documentation generator like used in Backbone Annotated source code documentation might be used. This is generated using docco.

[nickredmark]

Hey @AaronNGray thanks for your suggestion. Just to have an estimate of the urgency of this: how do you feel about the current documentation? How is it lacking? https://github.com/nmaro/ooth/wiki

[AaronNGray]

Hi Nick, yeah I have had a quick look, I also tried building your code on Windows and Linux an had npm install problems so have to been able to evaluate it properly as of yet. I will try on Mac hopefully within the next few days as I am also very busy :)

[nickredmark]

The documentation is now prettier :) https://nmaro.github.io/ooth/
I still keep this open for generated docs...

[AaronNGray]

The documentation looks a lot better.

One thing though is Ooth OAuth/OAuth2 compatible as it does not mention this at all in the documentation ?

[nickredmark]

I personally haven't needed it but it shouldn't be difficult to build a plugin on top of a passport.js strategy similarly to e.g. https://github.com/nmaro/ooth/tree/master/packages/ooth-facebook

[MickaelBZH]

Talking about documentation, do you have a way to customize the password validation for ooth-local?

[nickredmark]

@MickaelBZH yep, take this object as reference, and pass it as validators to the constructor, e.g.

const validators = {
  password: {
    test: (password: string) =>
      /\d/.test(password) && /[a-z]/.test(password) && /[A-Z]/.test(password) && /.{6,}/.test(password),
    error: 'validators.invalid_password',
  },
}
oothLocal({
  /* other configs */
  validators,
}))

[MickaelBZH]

Ok thanks. Another question related to ooth-local. Calling register set the email and the password, but not the username? Is that intended? Am I supposed to also call set-username after to actually set a username so a user can login with it?

[nickredmark]

@MickaelBZH correct. If you are motivated, the feature you are mentioning could be implemented by copying some logic from set-username to register.

[chase-moskal]

@AaronNGray
I also tried building your code on Windows and Linux an had npm install problems so have to been able to evaluate it properly as of yet.

pull request #69 should fix the npm installation problems for you ✔

[nickredmark]

@chase-moskal his install problems most likely had a different nature since I only just introduced typescript.