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

chore: DLT-1941 add dialtone combinator package #8

Open
wants to merge 7 commits into
base: staging
Choose a base branch
from

Conversation

lizard-boy
Copy link

[NO-MERGE] Add Dialtone Combinator package to monorepo

⚠️ I will be branching off of this PR to keep adding to the dialtone-combinator migration, once is done, will merge this branch

Obligatory GIF (super important!)

Obligatory GIF

🛠️ Type Of Change

These types will not increment the version number, but will still deploy to documentation site on release:

  • Other (chore)

📖 Jira Ticket

https://dialpad.atlassian.net/browse/DLT-1941

📖 Description

  • Moved combinator package to the monorepo
  • Fixed some issues with dependencies version to be able to commit
  • Added combinator files to .markdownlintignore and .stylelintignore
  • This should not interfere with any other package/library on our monorepo, just wanted to move here and have it ready so I can use our local packages in an easier/faster way.

💡 Context

Starting the investigation to make the dialtone-combinator work on our documentation site.

📝 Checklist

For all PRs:

  • I have ensured no private Dialpad links or info are in the code or pull request description (Dialtone is a public repo!).
  • I have reviewed my changes.
  • I have added all relevant documentation.
  • I have considered the performance impact of my change.

For all Vue changes:

  • I have added / updated unit tests.
  • I have made my changes in Vue 2 and Vue 3. Note: you may sync your changes from Vue 2 to Vue 3 (or vice versa) using the ./scripts/dialtone-vue-sync.sh script. Read docs here: Dialtone Vue Sync Script
  • I have validated components with a screen reader.
  • I have validated components keyboard navigation.

For all CSS changes:

  • I have used design tokens whenever possible.
  • I have considered how this change will behave on different screen sizes.
  • I have visually validated my change in light and dark mode.
  • I have used gap or flexbox properties for layout instead of margin whenever possible.

If new component:

  • I am exporting any new components or constants:
    • from the index.js in the component directory.
    • from the index.js in the root (either packages/dialtone-vue2 or packages/dialtone-vue3).
  • I have added the styles for the new component to the packages/dialtone-css package.
  • I have created a page for the new component on the documentation site in apps/dialtone-documentation.
  • I have added the new component to common/components_list.js
  • I have created a component story in storybook
  • I have created story / stories for any relevant component variants in storybook
  • I have created a docs page for the component in storybook.
  • I have checked that changing all props/slots via the UI in storybook works as expected.

🔮 Next Steps

  • Keep investigating how to make the dialtone-combinator work with our latest library versions.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

This pull request introduces the Dialtone Combinator package to the monorepo, focusing on integration and preparation for future development.

  • Added packages/combinator to .markdownlintignore and .stylelintignore to exclude it from linting
  • Simplified ComponentCombinator.vue, now using dtc-combinator for rendering
  • Updated apps/dialtone-documentation/docs/.vuepress/config.js to accommodate Combinator integration
  • Modified apps/dialtone-documentation/docs/.vuepress/theme/client.js to include Combinator CSS and register components
  • Added '@dialpad/dialtone-combinator' as a workspace dependency in apps/dialtone-documentation/package.json

12 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings

Comment on lines +6 to +10
'pnpm exec stylelint --fix --allow-empty-input',
],
'*.{md, mdx}': [
'pnpm exec markdownlint'
]
'pnpm exec markdownlint',
],
Copy link

Choose a reason for hiding this comment

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

style: Consider using a consistent style for trailing commas in the configuration object

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.

2 participants