miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): add description to storybook package (#9523)

Browse Source
This commit is contained in:
Benjamin Cabanes 2022-03-25 14:55:37 -04:00 committed by GitHub
parent 1e2f3ce618
commit dce0e94666
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/generated/packages/storybook.json
View File

@ -1,7 +1,7 @@
{
"githubRoot": "https://github.com/nrwl/nx/blob/master",
"name": "storybook",
"description": "Storybook plugin for Nx",
"description": "The Nx Plugin for Storybook that contains executors and generators for allowing your workspace to use the powerful Storybook integration testing & documenting capabilities.",
"root": "/packages/storybook",
"source": "/packages/storybook/src",
"generators": [
@ -33,7 +33,7 @@
},
"presets": []
},
"description": "Add storybook configuration to the workspace",
"description": "Add Storybook configuration to the workspace.",
"aliases": ["ng-add"],
"hidden": true,
"implementation": "/packages/storybook/src/generators/init/init.ts",
@ -89,7 +89,7 @@
"required": ["name"],
"presets": []
},
"description": "Add storybook configuration to a ui library or an application",
"description": "Add Storybook configuration to a UI library or an application.",
"hidden": false,
"implementation": "/packages/storybook/src/generators/configuration/configuration.ts",
"aliases": [],
@ -134,7 +134,7 @@
"required": ["name"],
"presets": []
},
"description": "Add cypress e2e app to test a ui library that is set up for storybook",
"description": "Add cypress e2e app to test a UI library that is set up for Storybook.",
"hidden": false,
"implementation": "/packages/storybook/src/generators/cypress-project/cypress-project.ts",
"aliases": [],
@ -170,7 +170,7 @@
"required": [],
"presets": []
},
"description": "Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.",
"description": "Generate default Storybook configuration files using Storybook version `>=6.x` specs, for projects that already have Storybook instances and configurations of versions `<6.x`.",
"hidden": false,
"implementation": "/packages/storybook/src/generators/migrate-defaults-5-to-6/migrate-defaults-5-to-6.ts",
"aliases": [],
@ -190,7 +190,7 @@
"required": [],
"presets": []
},
"description": "Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.",
"description": "Generate default Storybook configuration files using Storybook version `>=6.x` specs, for projects that already have Storybook instances and configurations of versions `<6.x`.",
"hidden": false,
"implementation": "/packages/storybook/src/generators/migrate-stories-to-6-2/migrate-stories-to-6-2.ts",
"aliases": [],
@ -359,7 +359,7 @@
"required": ["uiFramework", "config"],
"presets": []
},
"description": "Serve Storybook",
"description": "Serve Storybook.",
"aliases": [],
"hidden": false,
"path": "/packages/storybook/src/executors/storybook/schema.json"
@ -486,7 +486,7 @@
"required": ["uiFramework", "config"],
"presets": []
},
"description": "Build Storybook",
"description": "Build Storybook.",
"aliases": [],
"hidden": false,
"path": "/packages/storybook/src/executors/build-storybook/schema.json"

8
packages/storybook/executors.json
View File

@ -3,24 +3,24 @@
"storybook": {
"implementation": "./src/executors/storybook/compat",
"schema": "./src/executors/storybook/schema.json",
"description": "Serve Storybook"
"description": "Serve Storybook."
},
"build": {
"implementation": "./src/executors/build-storybook/compat",
"schema": "./src/executors/build-storybook/schema.json",
"description": "Build Storybook"
"description": "Build Storybook."
}
},
"executors": {
"storybook": {
"implementation": "./src/executors/storybook/storybook.impl",
"schema": "./src/executors/storybook/schema.json",
"description": "Serve Storybook"
"description": "Serve Storybook."
},
"build": {
"implementation": "./src/executors/build-storybook/build-storybook.impl",
"schema": "./src/executors/build-storybook/schema.json",
"description": "Build Storybook"
"description": "Build Storybook."
}
}
}

20
packages/storybook/generators.json
View File

@ -5,32 +5,32 @@
"init": {
"factory": "./src/generators/init/init#initSchematic",
"schema": "./src/generators/init/schema.json",
"description": "Add storybook configuration to the workspace",
"description": "Add Storybook configuration to the workspace.",
"aliases": ["ng-add"],
"hidden": true
},
"configuration": {
"factory": "./src/generators/configuration/configuration#configurationSchematic",
"schema": "./src/generators/configuration/schema.json",
"description": "Add storybook configuration to a ui library or an application",
"description": "Add Storybook configuration to a UI library or an application.",
"hidden": false
},
"cypress-project": {
"factory": "./src/generators/cypress-project/cypress-project#cypressProjectSchematic",
"schema": "./src/generators/cypress-project/schema.json",
"description": "Add cypress e2e app to test a ui library that is set up for storybook",
"description": "Add cypress e2e app to test a UI library that is set up for Storybook.",
"hidden": false
},
"migrate-defaults-5-to-6": {
"factory": "./src/generators/migrate-defaults-5-to-6/migrate-defaults-5-to-6#migrateDefaultsSchematic",
"schema": "./src/generators/migrate-defaults-5-to-6/schema.json",
"description": "Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.",
"description": "Generate default Storybook configuration files using Storybook version `>=6.x` specs, for projects that already have Storybook instances and configurations of versions `<6.x`.",
"hidden": false
},
"migrate-stories-to-6-2": {
"factory": "./src/generators/migrate-stories-to-6-2/migrate-stories-to-6-2#migrateStoriesSchematic",
"schema": "./src/generators/migrate-stories-to-6-2/schema.json",
"description": "Migrate stories syntax to 6.2",
"description": "Migrate stories syntax to `6.2`.",
"hidden": false
}
},
@ -38,32 +38,32 @@
"init": {
"factory": "./src/generators/init/init",
"schema": "./src/generators/init/schema.json",
"description": "Add storybook configuration to the workspace",
"description": "Add Storybook configuration to the workspace.",
"aliases": ["ng-add"],
"hidden": true
},
"configuration": {
"factory": "./src/generators/configuration/configuration",
"schema": "./src/generators/configuration/schema.json",
"description": "Add storybook configuration to a ui library or an application",
"description": "Add Storybook configuration to a UI library or an application.",
"hidden": false
},
"cypress-project": {
"factory": "./src/generators/cypress-project/cypress-project",
"schema": "./src/generators/cypress-project/schema.json",
"description": "Add cypress e2e app to test a ui library that is set up for storybook",
"description": "Add cypress e2e app to test a UI library that is set up for Storybook.",
"hidden": false
},
"migrate-defaults-5-to-6": {
"factory": "./src/generators/migrate-defaults-5-to-6/migrate-defaults-5-to-6",
"schema": "./src/generators/migrate-defaults-5-to-6/schema.json",
"description": "Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.",
"description": "Generate default Storybook configuration files using Storybook version `>=6.x` specs, for projects that already have Storybook instances and configurations of versions `<6.x`.",
"hidden": false
},
"migrate-stories-to-6-2": {
"factory": "./src/generators/migrate-stories-to-6-2/migrate-stories-to-6-2",
"schema": "./src/generators/migrate-stories-to-6-2/schema.json",
"description": "Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.",
"description": "Generate default Storybook configuration files using Storybook version `>=6.x` specs, for projects that already have Storybook instances and configurations of versions `<6.x`.",
"hidden": false
}
}

2
packages/storybook/package.json
View File

@ -1,7 +1,7 @@
{
"name": "@nrwl/storybook",
"version": "0.0.1",
"description": "Storybook plugin for Nx",
"description": "The Nx Plugin for Storybook that contains executors and generators for allowing your workspace to use the powerful Storybook integration testing & documenting capabilities.",
"repository": {
"type": "git",
"url": "https://github.com/nrwl/nx.git",