Coder Social home page Coder Social logo

v1.0.0 about json-schema-to-jsdoc HOT 5 CLOSED

n3ps avatar n3ps commented on June 16, 2024
v1.0.0

from json-schema-to-jsdoc.

Comments (5)

brettz9 avatar brettz9 commented on June 16, 2024

I think it's fine for 1.0.0 now, though maybe having the Travis checks in #22 passing first would give a little extra assurance that everything is in order before releasing.

As far as new features, I still hope to offer a maxLength option and add array property support, but those could be added as minor bumps without any breaking changes (unless you wanted maxLength on by default in which case it would be a minor breaking change).

I guess there is one feature that I should probably see about working on first if you wanted to hold for it since I think you may want to go with it and replace the old behavior (or at least make it the default)--changing the nested property syntax to match the jsdoc docs (e.g., @property anObjectProp.aNestedProp instead of @property .aNestedProp). Of course, it could always be added, assuming made ready, as a version 2.0 release if you preferred.

from json-schema-to-jsdoc.

n3ps avatar n3ps commented on June 16, 2024

I can hold off for nested prop syntax and maxLength if they're not too hard to implement.

I'm sure though if a maxLength should be on by default though. For example, if some user has their max cols way below our default.

from json-schema-to-jsdoc.

brettz9 avatar brettz9 commented on June 16, 2024

I can hold off for nested prop syntax and maxLength if they're not too hard to implement.

This is high on my current priority list, but please don't hold off if it ends up taking longer than you want. I have some health/fatigue issues, so cannot be too reliable. The maxLength is not trivial but also don't expect it to be too bad. I haven't looked too carefully at how easy nested prop syntax would be, but also wouldn't think it should be too hard. Plan to work on these today.

I'm sure though if a maxLength should be on by default though. For example, if some user has their max cols way below our default.

I guess you mean you're not sure it should be on by default (because someone might not want wrapping if the wrapping ends up still too large (or small) for their tastes)? In such a case, sure, that makes sense. Since you might not want it on by default, I can give priority to the nested property change.

from json-schema-to-jsdoc.

n3ps avatar n3ps commented on June 16, 2024

Of course, no rush or pressure. I'll get the Travis stuff in.

Yeah, sometimes my typing and thoughts aren't in sync 😄

from json-schema-to-jsdoc.

brettz9 avatar brettz9 commented on June 16, 2024

Of course, no rush or pressure. I'll get the Travis stuff in.

Cool. I submitted #23 for nested properties and will look to do a husky PR next I think. I expect the maxLength to take some more time, though I do already have docs and a test for it as well as a bit of code.

Yeah, sometimes my typing and thoughts aren't in sync 😄

I hear you on that for myself!

from json-schema-to-jsdoc.

Related Issues (11)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.