Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@niieani
Copy link
Contributor

@niieani niieani commented Nov 11, 2016

Related to the new build system: aurelia/validation#357

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

TODO:

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

niieani added a commit to niieani/validation that referenced this pull request Nov 11, 2016
src/index.js Outdated
const variations = [
{ module: "amd" },
{ module: "commonjs" },
{ module: "es2015", directory: "native-modules" },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can drop the native-modules build, I shouldn't have included it in the first place.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we want it for Webpack tree-shaking! :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's another directory called es2015 with the same output

Copy link
Contributor Author

@niieani niieani Nov 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, es2015 is es2015 code with es2015 modules.
native-modules is es5 code but with es2015 modules (import/export) retained.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah- I see the distinction now: tsc --outDir dist/native-modules --module es2015 vs tsc --outDir dist/es2015 --target es2015 --module es2015. I think I broke this in the ux build 😬

@EisenbergEffect
Copy link
Contributor

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

@niieani
Copy link
Contributor Author

niieani commented Nov 28, 2016

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
Copy link
Contributor

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

@niieani
Copy link
Contributor Author

niieani commented Nov 29, 2016

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

@niieani
Copy link
Contributor Author

niieani commented Dec 9, 2016

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
Copy link
Contributor

@niieani @jdanyow Is this ready for merge?

@niieani
Copy link
Contributor Author

niieani commented Dec 28, 2016

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
Copy link
Contributor

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

@niieani
Copy link
Contributor Author

niieani commented Jan 22, 2017

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

@niieani
Copy link
Contributor Author

niieani commented Feb 9, 2017

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).

@niieani niieani self-assigned this Feb 9, 2017
@EisenbergEffect
Copy link
Contributor

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
Copy link

StrahilKazlachev commented Feb 26, 2017

@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
Copy link
Contributor

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

@niieani
Copy link
Contributor Author

niieani commented Dec 10, 2017

The related TypeStrong/typedoc#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
Copy link

seems similar to build targets
aurelia/cli#765

@EisenbergEffect
Copy link
Contributor

@jdanyow Do we need this anymore?

@EisenbergEffect EisenbergEffect removed their request for review January 28, 2022 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants