576bcf554f
I originally planned to add component documentation, but as this dragged on and I found that JSDoc-to-Markdown sometimes needed hand-tuning, I decided to skip it and focus on replicating what was already present in Freestyle. Adding documentation is a finite task that can be revisited in the future.
My goal was to migrate everything from Freestyle with as few changes as possible. Some adaptations that I found necessary:
• the DelayedArray and DelayedTruth utilities that delay component rendering until slightly after initial render because without them:
◦ charts were rendering with zero width
◦ the JSON viewer was rendering with empty content
• Storybook in Ember renders components in a routerless/controllerless context by default, so some component stories needed changes:
◦ table pagination/sorting stories access to query params, which necessitates some reaching into Ember internals to start routing and dynamically generate a Storybook route/controller to render components into
◦ some stories have a faux controller as part of their Storybook context that hosts setInterval-linked dynamic computed properties
• some jiggery-pokery with anchor tags
◦ inert href='#' had to become href='javascript:;
◦ links that are actually meant to navigate need target='_parent' so they don’t navigate inside the Storybook iframe
Maybe some of these could be addressed by fixes in ember-cli-storybook but I’m wary of digging around in there any more than I already have, as I’ve lost a lot of time to Storybook confusion and frustrations already 😞
The STORYBOOK=true environment variable tweaks some environment settings to get things working as expected in the Storybook context.
I chose to:
• use angle bracket invocation within stories rather than have to migrate them soon after having moved to Storybook
• keep Freestyle around for now for its palette and typeface components
37 lines
892 B
JavaScript
37 lines
892 B
JavaScript
const getPathOption = require('ember-cli-get-component-path-option');
|
|
const stringUtil = require('ember-cli-string-utils');
|
|
const path = require('path');
|
|
|
|
module.exports = {
|
|
description: 'generates a story for storybook',
|
|
|
|
fileMapTokens: function() {
|
|
let { project } = this;
|
|
return {
|
|
__path__: function() {
|
|
return path.relative(project.root, project.root);
|
|
},
|
|
__markdownname__: function(options) {
|
|
return options.dasherizedModuleName;
|
|
},
|
|
__name__: function(options) {
|
|
return options.dasherizedModuleName;
|
|
},
|
|
};
|
|
},
|
|
|
|
locals: function(options) {
|
|
let contents = '';
|
|
|
|
return {
|
|
contents: contents,
|
|
path: getPathOption(options),
|
|
header: stringUtil
|
|
.dasherize(options.entity.name)
|
|
.split('-')
|
|
.map(word => stringUtil.capitalize(word))
|
|
.join(' '),
|
|
};
|
|
},
|
|
};
|