Add new tasks and expose them via a CLI

[niieani]

Related to the new build system: https://github.com/aurelia/validation/issues/357

Includes the prepare release task (bump version, changelog).

TODO:

• [x] aurelia-tools needs to use the new tag prefix option from standard-version.
• [x] It would also be good to separate the CLI file from the index.js
• [x] Test if doc generation works properly on Windows

[EisenbergEffect]

Are we good to go on this? It's not going to break anything is it?

[niieani]

It should be a non-breaking change, just adds features. I still wanted to fix that v before the version name when bumping versions/generating changelog though. I was thinking it might make sense to separate the CLI file from the index too.

[EisenbergEffect]

Should I merge this and then take another PR for the other changes or do you just want to fix up this PR?

[niieani]

I'll try to fix this up today. Doesn't make sense to release before we have this working properly.

[niieani]

I sent a PR to standard-version to make that tag prefix configurable and they already released it to NPM. Added TODO to first post.

[EisenbergEffect]

@niieani @jdanyow Is this ready for merge?

[niieani]

TODO from the first post applies. I didn't have time to finish this yet :(. If somebody else wants to do those two tasks, feel free to take over the PR.

[EisenbergEffect]

@jdanyow @niieani Any chance to look at this so we can get it out and start moving more libs to TS?

[niieani]

Best I could do is somewhere in the first half of February.

[niieani]

Looks like this is ready now. If you, @EisenbergEffect, have no more remarks, we can merge and release, we can probably bump to v1.1.0, if not even v2.0.0, just cause we had so many new features (even though we shouldn't be breaking anything).

[EisenbergEffect]

I'd like to see if @jdanyow can make a final review. You two know this better than I do. If you both feel it's good, then I'm happy and we can do a 2.0 release.

[StrahilKazlachev]

@niieani, @jdanyow if you could give some feedback when you have time. So for the past couple of weeks I've been trying to set up the dialog API doc tasks using the cli branch. Problems I've found:

• typedoc doesn't support extends in tsconfig - opened a PR
• the inDir option doesn't seem to work as expected, not exactly sure why I'll just explain how I see it:
  1. using the tsconfig makes it work like in TS, with no include or files in the effective tsconfig it uses all .ts files in the current project, applying exclude if defined(and it is).
  2. the definition file we want to use is in dist/doc-temp, and dist is in the exclude list of the tsconfig. With the previous issue this leads to generating the api.json from the files in the src directory only - not what we want.
• since the input is incorrect shape-doc operates on something different from the expected and includes only one module - the first in alphabetical order - I see the same behavior in aurelia-validation(which doesn't use the tools), only the exports of src/aurelia-validation.ts get in the api.json.

My current working setup uses aurelia-tools, an additional tsconfig.doc.json file and typedoc with the extends fix.

{
  "extends": "./tsconfig.build",
  "compilerOptions": {},
  "include": [
      "./dist/doc-temp/*.d.ts"
  ],
  "exclude": []
}

Part of the npm script for the doc task aurelia-tools typedoc --project tsconfig.build.json. Any suggestions how to further streamline this?

[EisenbergEffect]

Yikes! This has sat here a long time. @niieani @jdanyow Is this something we want to merge or is it no longer valid?

[niieani]

The related https://github.com/TypeStrong/typedoc/pull/436 was unfortunately closed. However, it's possible the feature was added by someone else at a different time. Would need to check.

I'd say this is still a good start for a unified build/release system.

[Alexander-Taran]

seems similar to build targets https://github.com/aurelia/cli/pull/765

[EisenbergEffect]

@jdanyow Do we need this anymore?