storybook [功能请求]:在目录内实现人体工程学排序

iezvtpos  于 3个月前  发布在  其他
关注(0)|答案(3)|浏览(93)

你的功能请求是否与问题相关?请描述

如果你使用Storybook进行文本文档(主要是.mdx文件),你不能仅仅按字母顺序对章节进行排序。如果稍后想在中间添加一个章节,通过给文件添加数字前缀进行数字排序也很难,这样你就必须手动重命名很多文件。
因此,你目前不得不依赖于更改你的Storybook配置,以便对你的排序进行更改。但是编写文档的人不一定也是维护Storybook配置的人(也许它甚至来自第三方包)。

描述你希望实现的解决方案

如果能在编写故事的同一目录中配置故事文件的排序,但不受文件名的影响,那就太好了。
也许有一个可选的stories.config.js文件可以在目录级别应用?

描述你考虑过的替代方案

在目录级别导出一个排序数组并在我的preview.js中导入它,但显然这是不支持的?因为排序需要静态分析吗?

你是否能协助将这个功能变为现实?

是的,我可以

附加上下文

  • 无响应*
f8rj6qna

f8rj6qna1#

我理解这种情感,但我不确定我是否同意所提出的方案,因为它向系统引入了一种新的文件类型。
@tmeasday 和我最近讨论过这个问题,我记得我们的“解决方案”是手动指定 main.js

export default {
  stories: [
    'path/to/B.mdx',
    'path/to/A.mdx',
    'path/to/C.mdx',
    'other/path/to/**/*.stories.js',
    'path/to/Appendix.mdx',
  ]
}

中的顺序。这是否足够“用户友好”,以满足您的用例?还是反对意见在于到处都是重复的“path/to”?

r7xajy2e

r7xajy2e2#

这是否足够“用户友好”以满足您的用例?
我认为它与其他方法没有什么不同。负责 preview.js 的人可能也负责 main.js 。也许它甚至是一个共享的 Storybook 配置,位于某个包中。但是编写故事的人也应该维护它们的顺序(在我看来)。
(如果可以在这里动态加载一个数组,可能会有所帮助,但我认为在 preview.js 中这是不可能的。在这种情况下,我可以在用户界面中创建一些“目录级排序”解决方案。👍)
感谢您的快速回复和建议👍

b5lpy0ml

b5lpy0ml3#

我在过去的一年里一直反复思考这个问题。由于故事书的作者不一定是维护故事书设置的人,所以即使他们是同一个人,感觉故事的排序也与编写体验脱节。当我需要在我的项目中进行一些跳跃(当然,这取决于实际的项目设置)时,我编写新文档的地方和配置文档顺序的地方位于非常不同的位置。🤔

相关问题