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

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

View File

@ -1,7 +1,7 @@
{ {
"githubRoot": "https://github.com/nrwl/nx/blob/master", "githubRoot": "https://github.com/nrwl/nx/blob/master",
"name": "storybook", "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", "root": "/packages/storybook",
"source": "/packages/storybook/src", "source": "/packages/storybook/src",
"generators": [ "generators": [
@ -33,7 +33,7 @@
}, },
"presets": [] "presets": []
}, },
"description": "Add storybook configuration to the workspace", "description": "Add Storybook configuration to the workspace.",
"aliases": ["ng-add"], "aliases": ["ng-add"],
"hidden": true, "hidden": true,
"implementation": "/packages/storybook/src/generators/init/init.ts", "implementation": "/packages/storybook/src/generators/init/init.ts",
@ -89,7 +89,7 @@
"required": ["name"], "required": ["name"],
"presets": [] "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, "hidden": false,
"implementation": "/packages/storybook/src/generators/configuration/configuration.ts", "implementation": "/packages/storybook/src/generators/configuration/configuration.ts",
"aliases": [], "aliases": [],
@ -134,7 +134,7 @@
"required": ["name"], "required": ["name"],
"presets": [] "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, "hidden": false,
"implementation": "/packages/storybook/src/generators/cypress-project/cypress-project.ts", "implementation": "/packages/storybook/src/generators/cypress-project/cypress-project.ts",
"aliases": [], "aliases": [],
@ -170,7 +170,7 @@
"required": [], "required": [],
"presets": [] "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, "hidden": false,
"implementation": "/packages/storybook/src/generators/migrate-defaults-5-to-6/migrate-defaults-5-to-6.ts", "implementation": "/packages/storybook/src/generators/migrate-defaults-5-to-6/migrate-defaults-5-to-6.ts",
"aliases": [], "aliases": [],
@ -190,7 +190,7 @@
"required": [], "required": [],
"presets": [] "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, "hidden": false,
"implementation": "/packages/storybook/src/generators/migrate-stories-to-6-2/migrate-stories-to-6-2.ts", "implementation": "/packages/storybook/src/generators/migrate-stories-to-6-2/migrate-stories-to-6-2.ts",
"aliases": [], "aliases": [],
@ -359,7 +359,7 @@
"required": ["uiFramework", "config"], "required": ["uiFramework", "config"],
"presets": [] "presets": []
}, },
"description": "Serve Storybook", "description": "Serve Storybook.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/storybook/src/executors/storybook/schema.json" "path": "/packages/storybook/src/executors/storybook/schema.json"
@ -486,7 +486,7 @@
"required": ["uiFramework", "config"], "required": ["uiFramework", "config"],
"presets": [] "presets": []
}, },
"description": "Build Storybook", "description": "Build Storybook.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/storybook/src/executors/build-storybook/schema.json" "path": "/packages/storybook/src/executors/build-storybook/schema.json"

View File

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

View File

@ -5,32 +5,32 @@
"init": { "init": {
"factory": "./src/generators/init/init#initSchematic", "factory": "./src/generators/init/init#initSchematic",
"schema": "./src/generators/init/schema.json", "schema": "./src/generators/init/schema.json",
"description": "Add storybook configuration to the workspace", "description": "Add Storybook configuration to the workspace.",
"aliases": ["ng-add"], "aliases": ["ng-add"],
"hidden": true "hidden": true
}, },
"configuration": { "configuration": {
"factory": "./src/generators/configuration/configuration#configurationSchematic", "factory": "./src/generators/configuration/configuration#configurationSchematic",
"schema": "./src/generators/configuration/schema.json", "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 "hidden": false
}, },
"cypress-project": { "cypress-project": {
"factory": "./src/generators/cypress-project/cypress-project#cypressProjectSchematic", "factory": "./src/generators/cypress-project/cypress-project#cypressProjectSchematic",
"schema": "./src/generators/cypress-project/schema.json", "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 "hidden": false
}, },
"migrate-defaults-5-to-6": { "migrate-defaults-5-to-6": {
"factory": "./src/generators/migrate-defaults-5-to-6/migrate-defaults-5-to-6#migrateDefaultsSchematic", "factory": "./src/generators/migrate-defaults-5-to-6/migrate-defaults-5-to-6#migrateDefaultsSchematic",
"schema": "./src/generators/migrate-defaults-5-to-6/schema.json", "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 "hidden": false
}, },
"migrate-stories-to-6-2": { "migrate-stories-to-6-2": {
"factory": "./src/generators/migrate-stories-to-6-2/migrate-stories-to-6-2#migrateStoriesSchematic", "factory": "./src/generators/migrate-stories-to-6-2/migrate-stories-to-6-2#migrateStoriesSchematic",
"schema": "./src/generators/migrate-stories-to-6-2/schema.json", "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 "hidden": false
} }
}, },
@ -38,32 +38,32 @@
"init": { "init": {
"factory": "./src/generators/init/init", "factory": "./src/generators/init/init",
"schema": "./src/generators/init/schema.json", "schema": "./src/generators/init/schema.json",
"description": "Add storybook configuration to the workspace", "description": "Add Storybook configuration to the workspace.",
"aliases": ["ng-add"], "aliases": ["ng-add"],
"hidden": true "hidden": true
}, },
"configuration": { "configuration": {
"factory": "./src/generators/configuration/configuration", "factory": "./src/generators/configuration/configuration",
"schema": "./src/generators/configuration/schema.json", "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 "hidden": false
}, },
"cypress-project": { "cypress-project": {
"factory": "./src/generators/cypress-project/cypress-project", "factory": "./src/generators/cypress-project/cypress-project",
"schema": "./src/generators/cypress-project/schema.json", "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 "hidden": false
}, },
"migrate-defaults-5-to-6": { "migrate-defaults-5-to-6": {
"factory": "./src/generators/migrate-defaults-5-to-6/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", "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 "hidden": false
}, },
"migrate-stories-to-6-2": { "migrate-stories-to-6-2": {
"factory": "./src/generators/migrate-stories-to-6-2/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", "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 "hidden": false
} }
} }

View File

@ -1,7 +1,7 @@
{ {
"name": "@nrwl/storybook", "name": "@nrwl/storybook",
"version": "0.0.1", "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": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/nrwl/nx.git", "url": "https://github.com/nrwl/nx.git",