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

Maintenance: Remove deprecation of manager-api's types export #26202

Merged
merged 2 commits into from
Feb 27, 2024

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Feb 26, 2024

Closes storybookjs/addon-kit#65

What I did

I removed the JSdoc deprecation tag from the comment above the types export from manager-api.

It should now no longer be marked as deprecated inside of addons/user'smanager.ts files.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

Use the following API in an addon or manager.ts file, and check in an editor like vscode if the types export is marked as deprecated (it should NOT be, after this change)

import { types } from '@storybook/manager-api`;

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@ndelangen ndelangen added maintenance User-facing maintenance tasks typescript ci:normal labels Feb 26, 2024
@ndelangen ndelangen self-assigned this Feb 26, 2024
@ndelangen ndelangen requested a review from JReinhold February 26, 2024 15:41
@ndelangen ndelangen marked this pull request as ready for review February 26, 2024 15:41
code/lib/manager-api/src/index.tsx Outdated Show resolved Hide resolved
@JReinhold
Copy link
Contributor

@ndelangen this doesn't close that issue completely, it just fixes the first issue of the deprecation notice. There are other problems mentioned in that issue that still needs to be addresseed.

@ndelangen
Copy link
Member Author

Thanks for calling that out, I can fix both issues in this PR

@ndelangen
Copy link
Member Author

ndelangen commented Feb 27, 2024

I tested this locally via setting ui/.storybook/manager.tsx to this content:

import React, { memo, useCallback, useEffect } from 'react';
import { addons, types, useGlobals, useStorybookApi } from '@storybook/manager-api';
import startCase from 'lodash/startCase.js';
import { Icons, IconButton } from '@storybook/components';

addons.setConfig({
  sidebar: {
    renderLabel: ({ name, type }) => (type === 'story' ? name : startCase(name)),
  },
});

const PARAM_KEY = 'null';
const ADDON_ID = 'null';
const TOOL_ID = 'null';

export const Tool = memo(function MyAddonSelector() {
  const [globals, updateGlobals] = useGlobals();
  const api = useStorybookApi();

  const isActive = [true, 'true'].includes(globals[PARAM_KEY]);

  const toggleMyTool = useCallback(() => {
    updateGlobals({
      [PARAM_KEY]: !isActive,
    });
  }, [isActive]);

  useEffect(() => {
    api.setAddonShortcut(ADDON_ID, {
      label: 'Toggle Addon [8]',
      defaultShortcut: ['8'],
      actionName: 'myaddon',
      showInMenu: false,
      action: toggleMyTool,
    });
  }, [toggleMyTool, api]);

  return (
    <IconButton
      key={TOOL_ID}
      active={isActive}
      title="Apply outlines to the preview"
      onClick={toggleMyTool}
    >
      <Icons icon="lightning" />
    </IconButton>
  );
});

addons.register(ADDON_ID, () => {
  // Register the tool
  addons.add(TOOL_ID, {
    type: types.TOOL,
    title: 'My addon',
    match: ({ viewMode }) => !!(viewMode && viewMode.match(/^(story|docs)$/)),
    render: Tool,
  });
  addons.add(TOOL_ID, {
    type: types.TOOL,
    title: 'My addon',
    match: ({ viewMode }) => !!(viewMode && viewMode.match(/^(story|docs)$/)),
    render: ({ active }) => undefined,
  });
});

It's all valid now:
Screenshot 2024-02-27 at 11 40 46

@ndelangen ndelangen merged commit 670c58c into next Feb 27, 2024
58 checks passed
@ndelangen ndelangen deleted the norbert/remove-deprecation-manager-api-types branch February 27, 2024 11:13
@github-actions github-actions bot mentioned this pull request Feb 27, 2024
30 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal maintenance User-facing maintenance tasks typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Deprecated APIs and types are being used
2 participants