feat(post-process-html): add post-process-html package - Githubissues

angular / dgeni-packages

A collection of dgeni packages for generating documentation from source code.

MIT License

142 stars 106 forks source link

feat(post-process-html): add post-process-html package #283

Closed BrunnerLivio closed 5 years ago

BrunnerLivio commented 5 years ago

Resolves #282

Changes:

feat(post-process-html): add initial package Copies the contents of the post-process-html package from the angular/angular repository and glues it together with the style of this repository.
docs(readme): add postProcessHtml section

BrunnerLivio commented 5 years ago

@petebacondarwin I tried to copy the code style of this repository as good as possible. I am not quite sure whether the package is too opinionated - please leave some feedback onto that.

BrunnerLivio commented 5 years ago

Fixed the VFile type problem @petebacondarwin

petebacondarwin commented 5 years ago

Great stuff @BrunnerLivio. Thanks

petebacondarwin commented 5 years ago

I squashed some of the commits together.

BrunnerLivio commented 5 years ago

@petebacondarwin Thanks for the merge & cleaning up! I will follow-up and add a PR to the Angular repository to use post-process-html from dgeni-packages instead of their own implementation as soon as a new version is released.

Thanks for your assistance through the whole process :)

petebacondarwin commented 5 years ago

Released as 0.27.4

petebacondarwin commented 5 years ago

Oh dear I don't think the compiled code was published to npm...

BrunnerLivio commented 5 years ago

@petebacondarwin Ohh I think it is because of the .gitignore file. NPM uses .gitignore when no .npmignore is present (???). Therefore the compiled files won't get added to the package. touch post-process-html/.npmignore should bypass that. The typescript package in the repository did the same thing. My bad :sweat_smile:

petebacondarwin commented 5 years ago

And I just noticed that we were not cleaning the new package in prepublish:

    "prepublish": "git clean -xdf typescript && yarn build",

petebacondarwin commented 5 years ago

Fixed at 0.27.5 (hopefully :-) )

petebacondarwin commented 5 years ago

https://github.com/angular/angular/pull/31368