Skip to content

Commit

Permalink
docs(nxdev): added some presets (#9552)
Browse files Browse the repository at this point in the history
  • Loading branch information
@mandarini
mandarini committed Mar 28, 2022
1 parent b7ed00f commit 3c662c2
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 26 deletions.
77 changes: 63 additions & 14 deletions docs/generated/packages/storybook.json
View file
Expand Up @@ -206,6 +206,23 @@
"cli": "nx",
"description": "Serve up storybook in development mode.",
"type": "object",
"presets": [
{
"name": "Default minimum setup",
"keys": ["uiFramework", "port", "projectBuildConfig", "config"]
},
{
"name": "Angular setup with styles",
"keys": [
"uiFramework",
"port",
"projectBuildConfig",
"config",
"styles",
"stylePreprocessorOptions"
]
}
],
"properties": {
"uiFramework": {
"type": "string",
Expand Down Expand Up @@ -262,7 +279,7 @@
},
"styles": {
"type": "array",
"description": "Global styles to be included in the build. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"description": "Global styles to be included in the build. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": {
"oneOf": [
{
Expand Down Expand Up @@ -290,10 +307,16 @@
]
}
},
"stylePreprocessorOptions.includePaths": {
"description": "Options to pass to style preprocessors. The paths to include. Paths will be resolved to workspace root. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"type": "array",
"items": { "type": "string" }
"stylePreprocessorOptions": {
"type": "object",
"description": "Options to pass to style preprocessors.",
"properties": {
"includePaths": {
"type": "array",
"description": "The paths to include. Paths will be resolved to workspace root. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": { "type": "string" }
}
}
},
"config": {
"type": "object",
Expand Down Expand Up @@ -356,8 +379,7 @@
]
}
},
"required": ["uiFramework", "config"],
"presets": []
"required": ["uiFramework", "config"]
},
"description": "Serve Storybook.",
"aliases": [],
Expand All @@ -372,6 +394,28 @@
"cli": "nx",
"description": "Build storybook in production mode.",
"type": "object",
"presets": [
{
"name": "Default minimum setup",
"keys": [
"uiFramework",
"outputPath",
"projectBuildConfig",
"config"
]
},
{
"name": "Angular setup with styles",
"keys": [
"uiFramework",
"outputPath",
"projectBuildConfig",
"config",
"styles",
"stylePreprocessorOptions"
]
}
],
"properties": {
"uiFramework": {
"type": "string",
Expand All @@ -389,7 +433,7 @@
},
"styles": {
"type": "array",
"description": "Global styles to be included in the build. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"description": "Global styles to be included in the build. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": {
"oneOf": [
{
Expand Down Expand Up @@ -417,10 +461,16 @@
]
}
},
"stylePreprocessorOptions.includePaths": {
"description": "Options to pass to style preprocessors. The paths to include. Paths will be resolved to workspace root. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"type": "array",
"items": { "type": "string" }
"stylePreprocessorOptions": {
"type": "object",
"description": "Options to pass to style preprocessors.",
"properties": {
"includePaths": {
"type": "array",
"description": "The paths to include. Paths will be resolved to workspace root. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": { "type": "string" }
}
}
},
"config": {
"type": "object",
Expand Down Expand Up @@ -483,8 +533,7 @@
]
}
},
"required": ["uiFramework", "config"],
"presets": []
"required": ["uiFramework", "config"]
},
"description": "Build Storybook.",
"aliases": [],
Expand Down
35 changes: 29 additions & 6 deletions packages/storybook/src/executors/build-storybook/schema.json
View file
Expand Up @@ -3,6 +3,23 @@
"cli": "nx",
"description": "Build storybook in production mode.",
"type": "object",
"presets": [
{
"name": "Default minimum setup",
"keys": ["uiFramework", "outputPath", "projectBuildConfig", "config"]
},
{
"name": "Angular setup with styles",
"keys": [
"uiFramework",
"outputPath",
"projectBuildConfig",
"config",
"styles",
"stylePreprocessorOptions"
]
}
],
"properties": {
"uiFramework": {
"type": "string",
Expand All @@ -20,16 +37,22 @@
},
"styles": {
"type": "array",
"description": "Global styles to be included in the build. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"description": "Global styles to be included in the build. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": {
"$ref": "#/definitions/extraEntryPoint"
}
},
"stylePreprocessorOptions.includePaths": {
"description": "Options to pass to style preprocessors. The paths to include. Paths will be resolved to workspace root. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"type": "array",
"items": {
"type": "string"
"stylePreprocessorOptions": {
"type": "object",
"description": "Options to pass to style preprocessors.",
"properties": {
"includePaths": {
"type": "array",
"description": "The paths to include. Paths will be resolved to workspace root. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": {
"type": "string"
}
}
}
},
"config": {
Expand Down
35 changes: 29 additions & 6 deletions packages/storybook/src/executors/storybook/schema.json
View file
Expand Up @@ -3,6 +3,23 @@
"cli": "nx",
"description": "Serve up storybook in development mode.",
"type": "object",
"presets": [
{
"name": "Default minimum setup",
"keys": ["uiFramework", "port", "projectBuildConfig", "config"]
},
{
"name": "Angular setup with styles",
"keys": [
"uiFramework",
"port",
"projectBuildConfig",
"config",
"styles",
"stylePreprocessorOptions"
]
}
],
"properties": {
"uiFramework": {
"type": "string",
Expand Down Expand Up @@ -61,16 +78,22 @@
},
"styles": {
"type": "array",
"description": "Global styles to be included in the build. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"description": "Global styles to be included in the build. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": {
"$ref": "#/definitions/extraEntryPoint"
}
},
"stylePreprocessorOptions.includePaths": {
"description": "Options to pass to style preprocessors. The paths to include. Paths will be resolved to workspace root. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.",
"type": "array",
"items": {
"type": "string"
"stylePreprocessorOptions": {
"type": "object",
"description": "Options to pass to style preprocessors.",
"properties": {
"includePaths": {
"type": "array",
"description": "The paths to include. Paths will be resolved to workspace root. This is for Angular projects only. It will be ignored in non-Angular projects.",
"items": {
"type": "string"
}
}
}
},
"config": {
Expand Down

1 comment on commit 3c662c2

@vercel
Copy link

@vercel vercel bot commented on 3c662c2 Mar 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

Please sign in to comment.