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
71 lines
1.5 KiB
JavaScript
71 lines
1.5 KiB
JavaScript
module.exports = {
|
|
root: true,
|
|
globals: {
|
|
server: true,
|
|
},
|
|
env: {
|
|
browser: true,
|
|
es6: true,
|
|
},
|
|
extends: 'eslint:recommended',
|
|
parserOptions: {
|
|
ecmaVersion: 2018,
|
|
sourceType: 'module',
|
|
},
|
|
rules: {
|
|
indent: ['error', 2, { SwitchCase: 1 }],
|
|
'linebreak-style': ['error', 'unix'],
|
|
quotes: ['error', 'single', 'avoid-escape'],
|
|
semi: ['error', 'always'],
|
|
'no-constant-condition': [
|
|
'error',
|
|
{
|
|
checkLoops: false,
|
|
},
|
|
],
|
|
},
|
|
overrides: [
|
|
// node files
|
|
{
|
|
files: [
|
|
'.eslintrc.js',
|
|
'.template-lintrc.js',
|
|
'ember-cli-build.js',
|
|
'testem.js',
|
|
'blueprints/*/index.js',
|
|
'config/**/*.js',
|
|
'server/**/*.js',
|
|
'lib/*/index.js',
|
|
],
|
|
parserOptions: {
|
|
sourceType: 'script',
|
|
},
|
|
env: {
|
|
browser: false,
|
|
node: true,
|
|
},
|
|
plugins: ['node'],
|
|
rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
|
|
// add your custom rules and overrides for node files here
|
|
|
|
// this can be removed once the following is fixed
|
|
// https://github.com/mysticatea/eslint-plugin-node/issues/77
|
|
'node/no-unpublished-require': 'off'
|
|
}),
|
|
},
|
|
{
|
|
files: [
|
|
'stories/**/*.js'
|
|
],
|
|
parserOptions: {
|
|
sourceType: 'module',
|
|
},
|
|
env: {
|
|
browser: false,
|
|
node: true,
|
|
},
|
|
plugins: ['node'],
|
|
},
|
|
],
|
|
};
|