Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: update typedoc and improvemnts to docs cmd #727

Merged
merged 4 commits into from
Jan 26, 2021
Merged

Conversation

hugomrdias
Copy link
Member

@hugomrdias hugomrdias commented Jan 25, 2021

Changes:

88a6a0c (Hugo Dias, 56 seconds ago)
fix: move ts docs to docs cmd and improve config

  • move ts -p docs cmd to docs cmd directly
  • start proper config merging between config file and cmd flags
    - updated cmds: build, docs, lint and ts, more will be updated in the future
  • add new options for docs entryPoint
  • user config uses lilconfig to parse and find the local file or
    package.json

f629a3c (Hugo Dias, 9 minutes ago)
fix: update to latest typedoc

  • fix some internal calls to ts cmd
  • new config and plugin for typedoc 0.20

BREAKING CHANGE: aegir ts -p docs removed use aegir docs directly

- fix some internal calls to ts cmd
- new config and plugin for typedoc 0.20
- move ts -p doc cmd to docs cmd directly
- start proper config merging between config file and cmd flags
  - build, docs, lint and ts cmds, more will be updated in the future
- add new options for docs `entryPoint`
- user config uses `lilconfig` to parse and find the local file or package.json
Copy link
Member

@vasco-santos vasco-santos left a comment

Choose a reason for hiding this comment

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

Looking good, left a couple of questions before approval

})
.options('ts', {
type: 'boolean',
describe: 'Enable support for Typescript',
default: false
default: userConfig.ts // needs to be changed to another name to not conflict with the ts cmd options
Copy link
Member

Choose a reason for hiding this comment

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

Is this needed now?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes this enables support for TS repos, actual TS code not like ours which are JS with JSDocs types

@hugomrdias hugomrdias merged commit 1149281 into master Jan 26, 2021
@hugomrdias hugomrdias deleted the feat/docs2.0 branch January 26, 2021 19:12
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants