Skip to content
This repository has been archived by the owner on Mar 4, 2020. It is now read-only.

chore(Tree): rename to HierarchicalTree #1752

Merged
merged 7 commits into from
Aug 8, 2019
Merged

Conversation

silviuaavram
Copy link
Collaborator

@silviuaavram silviuaavram commented Aug 2, 2019

Renamed Tree to HierarchicalTree, TreeItem to HierarchicalTreeItem and TreeTitle to HierarchicalTreeTitle.
Renamed treeBehavior to hierarchicalTreeBehavior, treeItemBehavior to hierarchicalTreeItemBehavior, treeTitleBehavior to hierarchicalTreeTitleBehavior and subtreeBehavior to hierarchicalSubtreeBehavior.

BREAKING CHANGE MITIGATION

Perform the renames where the components and behaviors are used.

@codecov
Copy link

codecov bot commented Aug 2, 2019

Codecov Report

Merging #1752 into master will not change coverage.
The diff coverage is 75%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1752   +/-   ##
=======================================
  Coverage   69.97%   69.97%           
=======================================
  Files         868      868           
  Lines        7335     7335           
  Branches     2142     2119   -23     
=======================================
  Hits         5133     5133           
  Misses       2196     2196           
  Partials        6        6
Impacted Files Coverage Δ
packages/react/src/index.ts 100% <ø> (ø) ⬆️
...HierarchicalTree/hierarchicalTreeTitleVariables.ts 0% <0%> (ø)
...HierarchicalTree/hierarchicalTreeTitleVariables.ts 0% <0%> (ø)
...HierarchicalTree/hierarchicalTreeTitleVariables.ts 0% <0%> (ø)
...nts/HierarchicalTree/hierarchicalTreeItemStyles.ts 50% <100%> (ø)
...viors/HierarchicalTree/hierarchicalTreeBehavior.ts 100% <100%> (ø)
...s/HierarchicalTree/hierarchicalTreeItemBehavior.ts 100% <100%> (ø)
...ponents/HierarchicalTree/HierarchicalTreeTitle.tsx 70% <100%> (ø)
...rs/HierarchicalTree/hierarchicalSubtreeBehavior.ts 100% <100%> (ø)
...ts/HierarchicalTree/hierarchicalTreeTitleStyles.ts 50% <100%> (ø)
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4bbffab...738422a. Read the comment docs.

@@ -75,7 +75,7 @@ export { default as ToolbarMenu } from './components/Toolbar/toolbarMenuVariable
export { default as ToolbarMenuDivider } from './components/Toolbar/toolbarMenuDividerVariables'
export { default as ToolbarMenuItem } from './components/Toolbar/toolbarMenuItemVariables'

export { default as TreeTitle } from './components/Tree/treeTitleVariables'
export { default as TreeTitle } from './components/HierarchicalTree/hierarchicalTreeTitleVariables'
Copy link
Contributor

Choose a reason for hiding this comment

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

HierarchialTreeTitle?

Tree?: TreeProps
TreeItem?: TreeItemProps
TreeTitle?: TreeTitleProps
Tree?: HierarchicalTreeProps
Copy link
Contributor

Choose a reason for hiding this comment

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

Add Hierarchial prefix?

@@ -70,11 +70,11 @@ const checkOpenTitles = (wrapper: ReactWrapper, expected: string[]): void => {
}

describe('Tree', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

HierarchialTree?

@@ -3,7 +3,7 @@ import * as _ from 'lodash'
import * as PropTypes from 'prop-types'
Copy link
Contributor

Choose a reason for hiding this comment

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

Where / how can we mark as depreciated?

Copy link
Contributor

Choose a reason for hiding this comment

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

Created request #1756 to properly handle depreciated methods in DocSite. For now, can we update text descriptions to make this clear.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

should we do this in the current PR?

Copy link
Contributor

Choose a reason for hiding this comment

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

In the current PR, just put (DEPRECATED) to the beginning of the description of the Tree. See https://stardust-ui.github.io/react/components/item-layout as an example.

Copy link
Member

Choose a reason for hiding this comment

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

We should also provide console warnings when using deprecated components/props once we ship the new Tree.

Copy link
Contributor

@jurokapsiar jurokapsiar left a comment

Choose a reason for hiding this comment

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

please add a breaking change changelog entry

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

Successfully merging this pull request may close these issues.

None yet

6 participants