Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Build: Publish typings on travis publish #1517

Merged
merged 5 commits into from Jan 14, 2020
Merged

Build: Publish typings on travis publish #1517

merged 5 commits into from Jan 14, 2020

Conversation

elevatebart
Copy link
Collaborator

@elevatebart elevatebart commented Jan 8, 2020

As previously mentioned, I want to be able to use the types generated by rsg in vue-styleguidist.
This publishes the types with the compiled library.

There is a known limitation: rsg-component aliased path have to be kept in the tsconfig.json of any project using the types. It should redirect to node_modules/react-styleguidist/lib/client/rsg-component.

@elevatebart
Copy link
Collaborator Author

@sapegin do you want me to add a cookbook item for the usage of the types in components?

@sapegin
Copy link
Member

sapegin commented Jan 9, 2020

Thanks!

Yep, a cookbook entry would be nice.

@elevatebart
Copy link
Collaborator Author

The cookbook has been added.

@elevatebart elevatebart self-assigned this Jan 11, 2020
docs/Cookbook.md Outdated Show resolved Hide resolved
Copy link
Member

@sapegin sapegin left a comment

Choose a reason for hiding this comment

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

Thanks! A few edits, otherwise looks good.

docs/Cookbook.md Outdated Show resolved Hide resolved
docs/Cookbook.md Outdated

It allows the maintainers to catch type mismatch before execution and a better developer experience.

It also allows users to write their customized styleguide components using typescript TSX and plugins to build it.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
It also allows users to write their customized styleguide components using typescript TSX and plugins to build it.
It also allows users to write their customized style guide components using TypeScript and plugins to build it.

What plugins do you mean here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I meant to leverage the type checking powers of typescript and its red squigglies to help you code.
Plugins would be vscode type checking, or Sublime Text or Atom TS plugin.

I think I can omit it as it is self explanatory.

What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

Yup, that's quite confusing for me ;-)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I updated it.

docs/Cookbook.md Outdated Show resolved Hide resolved
docs/Cookbook.md Outdated Show resolved Hide resolved
Barthélémy Ledoux and others added 2 commits January 13, 2020 08:25
Co-Authored-By: Artem Sapegin <artem@sapegin.ru>
@sapegin sapegin merged commit 283c0cd into 11 Jan 14, 2020
@sapegin sapegin deleted the feat-publish-types branch January 14, 2020 15:10
@styleguidist-bot
Copy link
Collaborator

🎉 This PR is included in version 11.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants