Refactoring code often causes components to become obsolete or irrelevant. This is where removing and deprecating components becomes useful and necessary.
When you deprecate a component you update it. This requires the component to be authored in your workspace or imported into it.
Run the following to deprecate a component:
The output should display the following:
The component has been modified. Snap it and export it to its remote scope.
The component's deprecated status can be seen in the UI (scope and workspace), as well as in the terminal, when running bit show, bit status, bit install, etc.
Local components should be removed with caution
Learn more in the Effects of deleting components from a workspace section.
foo/bar
Other components in the workspace may depend on removed components. Meaning that removing these dependencies affects dependent components. Several cases may occur when deleting a local component:
- A new component that depends on a removed component is not affected. This is because Bit did not isolate the component.
- A staged component that depends on a removed component causes Bit to stop the remove command. To force it, we use the
--forceflag. - An exported component that depends on a local removed component is not affected. This is because an exported component is isolated and immutable. So deleting a local dependency does not affect.
Removing components from their remote scope is highly inadvisable!
Deprecate components instead to avoid possible damage to dependent components and projects.
Learn more in the Effects of deleting components section.
To remove a component from a remote scope, specify the full component ID.
The output should display the following:
my-org.my-scope/foo/bar
To better understand how Bit handles deleted components, let's follow this example:
- The
left-padin theutilsscope. - A component
trim-rightdepends onleft-padand is also inutilsscope. - A component
loginalso depends onleft-padbut is in another scope -onboarding.
This is what happens if we remove left-pad:
- Bit notifies that
trim-rightdepends onleft-pad. If we want to remove it, Bit asks to use the --force flag. This is because scopes don't cache their components. - The
trim-rightcomponent has a missing dependencyleft-pad. A refactor fortrim-rightis critical for it to work. loginthat also depends onleft-padis not affected by the removal ofleft-pad. This is because scopes keep a cache of external dependencies.- It is still possible to source
loginto another consumer project, as the cache works for Bit. - Installing
loginusing npm fails because npm tries to installleft-padfrom its original scope.
