Version to 1.0.0 about typedoc HOT 5 CLOSED

Sorry, I haven't been aware of that one. If I understand the documentation of semver correctly (https://www.npmjs.org/doc/misc/semver.html) we could also raise the version to 0.1.0 to allow users to update TypeDoc without trouble and still have the opportunity to raise the minor version if breaking changes arrive. As the project is in a quite early stage and as one may use it as a module for generating models out of TypeScript projects in their applications, I would prefer that one.

from typedoc.

That is fine as long as you reserve the middle number for breaking changes (which is what you propose). However, users who have not read the post will be left wondering about that. Given my new knowledge about version numbers, I've gone through all package.json files I have and used ^ for all packages that happen to be >0.x.y and ~ for all packages 0.x.y. The latter is necessary because I cannot reasonably know what I can upgrade, so I simply have to let it upgrade until it breaks. Having read your answer, I myself could use ^0.0.7 for typedoc specifically, but I don't think many other users will.

At my work we currently have the following rule: use first number for breaking changes, middle number for additions (new features), and last number for bugfixes. Then, in package.json dependencies, you can use ^1.0.0 for always getting the latest compatible version and ~1.0.0 for a more conservative variant. To ensure that this works, we always start from 1.0.0 to avoid the exceptional cases.

Just a thought, please do as you like - you did solve the problem for me ;)

from typedoc.

Okay, sounds reasonable. Thank you for sharing your insights, I'm a version noob ;)

Bart van der Schoor just opened issue #19 regarding module support which tells me that other developers use this project not only as a command line tool but also script it, e.g. to automate processes.

As I said, the project is in a pretty early state and I would like to preserve the possibility to easily change the structure without having to raise the main version number. For now, lets raise the version to 0.1.x and stick to this until breaking changed arrive. Let us switch to 1.0.0 when the project has reached a mature state.

from typedoc.

^ is a bit risky, it is safer to use ~. No idea why npm does ^ now.

But IMHO any node based util should be able to work as node module for maximum hackability (in the spirit of OSS). CLI-only is so limiting.

For example I'm using it to hack something for #7 at this very moment 😉

from typedoc.

Ok I think everyone's opinion is clear & reasonable. Thanks all, I'm closing this.

from typedoc.