storybook-addon-sdc 0.16.1 → 0.18.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/dist/preset.js +9 -12
- package/package.json +9 -7
package/README.md
CHANGED
|
@@ -434,6 +434,7 @@ export const Basic = {}
|
|
|
434
434
|
- **customDefs**: An object with custom JSON schema definitions for your components.
|
|
435
435
|
- **externalDefs**: An array of URLs or local file paths to external schema definition files.
|
|
436
436
|
- **validate**: A URL or path to a JSON schema for validating your SDC components.
|
|
437
|
+
- **useBasicArgsForStories**: Boolean. When `true` (default) generated stories inherit `...Basic.args` from the component; set to `false` to prevent automatic spreading of `Basic.args`.
|
|
437
438
|
|
|
438
439
|
### Twig.js with `vitePluginTwigDrupalOptions`
|
|
439
440
|
|
|
@@ -561,6 +562,16 @@ const config = {
|
|
|
561
562
|
}
|
|
562
563
|
```
|
|
563
564
|
|
|
565
|
+
### `useBasicArgsForStories`
|
|
566
|
+
|
|
567
|
+
By default, when generating stories for your SDC components, the addon automatically spreads the `Basic.args` into each generated story. This behavior can be controlled using the `useBasicArgsForStories` option.
|
|
568
|
+
|
|
569
|
+
```js
|
|
570
|
+
useBasicArgsForStories: false,
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
When set to `false`, the generated stories will not inherit the `Basic.args`, allowing you to define story-specific arguments without the influence of the default `Basic` configuration.
|
|
574
|
+
|
|
564
575
|
## Setting Default Values
|
|
565
576
|
|
|
566
577
|
For `json-schema-faker` to generate reliable data, use `default` or `examples` in your SDC schema:
|
package/dist/preset.js
CHANGED
|
@@ -529,20 +529,18 @@ var vite_plugin_storybook_yaml_stories_default = ({
|
|
|
529
529
|
},
|
|
530
530
|
...argTypesGenerator_default(content)
|
|
531
531
|
};
|
|
532
|
-
const
|
|
532
|
+
const baseArgs = {
|
|
533
533
|
defaultAttributes: [
|
|
534
|
-
[
|
|
535
|
-
"data-component-id",
|
|
536
|
-
`${namespaces.pathToNamespace(dirname3(id), true)}`
|
|
537
|
-
]
|
|
534
|
+
["data-component-id", namespaces.pathToNamespace(dirname3(id), true)]
|
|
538
535
|
],
|
|
539
536
|
componentMetadata: metadata,
|
|
540
537
|
...content.variants && {
|
|
541
538
|
variant: Object.keys(content.variants)[0]
|
|
542
|
-
}
|
|
543
|
-
...generateStorybookArgs(content, jsonSchemaFakerOptions)
|
|
539
|
+
}
|
|
544
540
|
};
|
|
545
|
-
const
|
|
541
|
+
const generatedArgs = generateStorybookArgs(content, jsonSchemaFakerOptions);
|
|
542
|
+
const args = sdcStorybookOptions.useBasicArgsForStories ? { ...baseArgs, ...generatedArgs } : baseArgs;
|
|
543
|
+
const basicArgs = sdcStorybookOptions.useBasicArgsForStories ? baseArgs : { ...baseArgs, ...generatedArgs };
|
|
546
544
|
const stories = previewsStories ? storiesGenerator_default(previewsStories) : "";
|
|
547
545
|
return `
|
|
548
546
|
${imports}
|
|
@@ -681,6 +679,7 @@ async function loadAndMergeDefinitions(externalDefs, customDefs) {
|
|
|
681
679
|
// src/constants.ts
|
|
682
680
|
var DEFAULT_ADDON_OPTIONS = {
|
|
683
681
|
sdcStorybookOptions: {
|
|
682
|
+
useBasicArgsForStories: true,
|
|
684
683
|
twigLib: "twig",
|
|
685
684
|
validate: false
|
|
686
685
|
// validate:
|
|
@@ -699,11 +698,9 @@ var DEFAULT_ADDON_OPTIONS = {
|
|
|
699
698
|
};
|
|
700
699
|
|
|
701
700
|
// src/preset.ts
|
|
701
|
+
import { merge as lodashMerge } from "lodash-es";
|
|
702
702
|
async function viteFinal(config, options) {
|
|
703
|
-
options = {
|
|
704
|
-
...DEFAULT_ADDON_OPTIONS,
|
|
705
|
-
...options
|
|
706
|
-
};
|
|
703
|
+
options = lodashMerge({}, DEFAULT_ADDON_OPTIONS, options);
|
|
707
704
|
const {
|
|
708
705
|
sdcStorybookOptions,
|
|
709
706
|
vitePluginTwigDrupalOptions,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "storybook-addon-sdc",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.18.1",
|
|
4
4
|
"description": "Drupal Single Directory Components as stories",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"SDC",
|
|
@@ -37,21 +37,23 @@
|
|
|
37
37
|
"format": "prettier --write ."
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"glob": "^
|
|
40
|
+
"glob": "^13.0.0",
|
|
41
41
|
"json-schema-faker": "^0.5.8",
|
|
42
42
|
"jsonschema": "^1.5.0",
|
|
43
|
+
"lodash-es": "^4.17.21",
|
|
43
44
|
"node-fetch": "^3.3.2",
|
|
44
45
|
"pino": "^10.1.0",
|
|
45
46
|
"pino-pretty": "^13.1.2",
|
|
46
|
-
"vite-plugin-twing-drupal": "^1.0.13",
|
|
47
47
|
"vite-plugin-twig-drupal": "^1.6.1",
|
|
48
|
+
"vite-plugin-twing-drupal": "^1.0.13",
|
|
48
49
|
"yaml": "^2.7.1"
|
|
49
50
|
},
|
|
50
51
|
"devDependencies": {
|
|
51
|
-
"@storybook/addon-
|
|
52
|
-
"@storybook/addon-
|
|
53
|
-
"@storybook/html-vite": "^
|
|
52
|
+
"@storybook/addon-docs": "^10.0.8",
|
|
53
|
+
"@storybook/addon-links": "^10.0.8",
|
|
54
|
+
"@storybook/html-vite": "^10.0.8",
|
|
54
55
|
"@types/json-schema": "^7.0.15",
|
|
56
|
+
"@types/lodash-es": "^4.17.12",
|
|
55
57
|
"@types/node": "^24.2.1",
|
|
56
58
|
"@types/node-fetch": "^2.6.12",
|
|
57
59
|
"@types/twig": "^1.12.16",
|
|
@@ -62,7 +64,7 @@
|
|
|
62
64
|
"prompts": "^2.4.2",
|
|
63
65
|
"react": "^19.1.0",
|
|
64
66
|
"react-dom": "^19.1.0",
|
|
65
|
-
"storybook": "^
|
|
67
|
+
"storybook": "^10.0.8",
|
|
66
68
|
"tsup": "^8.4.0",
|
|
67
69
|
"typescript": "^5.8.2",
|
|
68
70
|
"vite": "^6.2.3",
|