docs(nxdev): better api generator templates (#8109)

This commit is contained in:
Benjamin Cabanes 2021-12-10 12:18:46 -05:00 committed by GitHub
parent 3fa53857d7
commit ea0d65b019
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
865 changed files with 4356 additions and 24 deletions

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:delegate-build executor'
description: 'Delegates the build to a different target while supporting incremental builds.'
---
# @nrwl/angular:delegate-build
Delegates the build to a different target while supporting incremental builds.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:ng-packagr-lite executor'
description: 'Builds a library with support for incremental builds.'
---
# @nrwl/angular:ng-packagr-lite
Builds a library with support for incremental builds.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:package executor'
description: 'Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.'
---
# @nrwl/angular:package
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:webpack-browser executor'
description: 'Builds a browser application with support for incremental builds and custom webpack configuration.'
---
# @nrwl/angular:webpack-browser
Builds a browser application with support for incremental builds and custom webpack configuration.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:webpack-server executor'
description: 'Serves a browser application with support for a custom webpack configuration.'
---
# @nrwl/angular:webpack-server
Serves a browser application with support for a custom webpack configuration.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:application generator'
description: 'Creates an Angular application.'
---
# @nrwl/angular:application
Creates an Angular application.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:convert-tslint-to-eslint generator'
description: 'Converts a project from TSLint to ESLint.'
---
# @nrwl/angular:convert-tslint-to-eslint
Converts a project from TSLint to ESLint.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:downgrade-module generator'
description: 'Sets up a Downgrade Module.'
---
# @nrwl/angular:downgrade-module
Sets up a Downgrade Module.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:karma-project generator'
description: 'Adds Karma configuration to a project.'
---
# @nrwl/angular:karma-project
Adds Karma configuration to a project.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:karma generator'
description: 'Adds Karma configuration to a workspace.'
---
# @nrwl/angular:karma
Adds Karma configuration to a workspace.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:library-secondary-entry-point generator'
description: 'Creates a secondary entry point for an Angular publishable library.'
---
# @nrwl/angular:library-secondary-entry-point
Creates a secondary entry point for an Angular publishable library.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:library generator'
description: 'Creates an Angular library.'
---
# @nrwl/angular:library
Creates an Angular library.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:move generator'
description: 'Moves an Angular application or library to another folder within the workspace and updates the project configuration.'
---
# @nrwl/angular:move
Moves an Angular application or library to another folder within the workspace and updates the project configuration.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:ngrx generator'
description: 'Adds NgRx support to an application or library.'
---
# @nrwl/angular:ngrx
Adds NgRx support to an application or library.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:scam generator'
description: 'Generate a component with an accompanying Single Component Angular Module (SCAM).'
---
# @nrwl/angular:scam
Generate a component with an accompanying Single Component Angular Module (SCAM).

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:setup-mfe generator'
description: 'Generate a Module Federation configuration for a given Angular application.'
---
# @nrwl/angular:setup-mfe
Generate a Module Federation configuration for a given Angular application.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:stories generator'
description: 'Creates stories/specs for all components declared in a project.'
---
# @nrwl/angular:stories
Creates stories/specs for all components declared in a project.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:storybook-configuration generator'
description: 'Adds Storybook configuration to a project.'
---
# @nrwl/angular:storybook-configuration
Adds Storybook configuration to a project.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:storybook-migrate-defaults-5-to-6 generator'
description: 'Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.'
---
# @nrwl/angular:storybook-migrate-defaults-5-to-6
Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:storybook-migrate-stories-to-6-2 generator'
description: 'Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export.'
---
# @nrwl/angular:storybook-migrate-stories-to-6-2
Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:upgrade-module generator'
description: 'Sets up an Upgrade Module.'
---
# @nrwl/angular:upgrade-module
Sets up an Upgrade Module.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/angular:web-worker generator'
description: 'Creates a Web Worker.'
---
# @nrwl/angular:web-worker
Creates a Web Worker.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/cypress:cypress executor'
description: 'Run Cypress e2e tests'
---
# @nrwl/cypress:cypress
Run Cypress e2e tests

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/detox:build executor'
description: 'Run the command defined in build property of the specified configuration.'
---
# @nrwl/detox:build
Run the command defined in build property of the specified configuration.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/detox:test executor'
description: 'Initiating your detox test suite.'
---
# @nrwl/detox:test
Initiating your detox test suite.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/detox:application generator'
description: 'Create a detox application'
---
# @nrwl/detox:application
Create a detox application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/express:application generator'
description: 'Create an express application'
---
# @nrwl/express:application
Create an express application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:build executor'
description: 'Build a Gatsby app'
---
# @nrwl/gatsby:build
Build a Gatsby app

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:server executor'
description: 'Starts server for app'
---
# @nrwl/gatsby:server
Starts server for app

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:application generator'
description: 'Create an application'
---
# @nrwl/gatsby:application
Create an application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:component generator'
description: 'Create a component'
---
# @nrwl/gatsby:component
Create a component

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:page generator'
description: 'Create a page'
---
# @nrwl/gatsby:page
Create a page

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/jest:jest executor'
description: 'Run Jest unit tests'
---
# @nrwl/jest:jest
Run Jest unit tests

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/js:tsc executor'
description: 'Build a project using TypeScript.'
---
# @nrwl/js:tsc
Build a project using TypeScript.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/js:application generator'
description: 'Create a application'
---
# @nrwl/js:application
Create a application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/js:library generator'
description: 'Create a library'
---
# @nrwl/js:library
Create a library

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/linter:eslint executor'
description: 'Run ESLint on a project'
---
# @nrwl/linter:eslint
Run ESLint on a project

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/linter:lint executor'
description: '**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0'
---
# @nrwl/linter:lint
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/linter:workspace-rule generator'
description: 'Create a new workspace ESLint rule'
---
# @nrwl/linter:workspace-rule
Create a new workspace ESLint rule

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:application generator'
description: 'Create a NestJS application.'
---
# @nrwl/nest:application
Create a NestJS application.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:class generator'
description: 'Run the `class` NestJS generator with Nx project support.'
---
# @nrwl/nest:class
Run the `class` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:controller generator'
description: 'Run the `controller` NestJS generator with Nx project support.'
---
# @nrwl/nest:controller
Run the `controller` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:convert-tslint-to-eslint generator'
description: 'Convert a project from TSLint to ESLint.'
---
# @nrwl/nest:convert-tslint-to-eslint
Convert a project from TSLint to ESLint.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:decorator generator'
description: 'Run the `decorator` NestJS generator with Nx project support.'
---
# @nrwl/nest:decorator
Run the `decorator` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:filter generator'
description: 'Run the `filter` NestJS generator with Nx project support.'
---
# @nrwl/nest:filter
Run the `filter` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:gateway generator'
description: 'Run the `gateway` NestJS generator with Nx project support.'
---
# @nrwl/nest:gateway
Run the `gateway` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:guard generator'
description: 'Run the `guard` NestJS generator with Nx project support.'
---
# @nrwl/nest:guard
Run the `guard` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:interceptor generator'
description: 'Run the `interceptor` NestJS generator with Nx project support.'
---
# @nrwl/nest:interceptor
Run the `interceptor` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:interface generator'
description: 'Run the `interface` NestJS generator with Nx project support.'
---
# @nrwl/nest:interface
Run the `interface` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:library generator'
description: 'Create a new NestJS library.'
---
# @nrwl/nest:library
Create a new NestJS library.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:middleware generator'
description: 'Run the `middleware` NestJS generator with Nx project support.'
---
# @nrwl/nest:middleware
Run the `middleware` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:module generator'
description: 'Run the `module` NestJS generator with Nx project support.'
---
# @nrwl/nest:module
Run the `module` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:pipe generator'
description: 'Run the `pipe` NestJS generator with Nx project support.'
---
# @nrwl/nest:pipe
Run the `pipe` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:provider generator'
description: 'Run the `provider` NestJS generator with Nx project support.'
---
# @nrwl/nest:provider
Run the `provider` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:resolver generator'
description: 'Run the `resolver` NestJS generator with Nx project support.'
---
# @nrwl/nest:resolver
Run the `resolver` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:resource generator'
description: 'Run the `resource` NestJS generator with Nx project support.'
---
# @nrwl/nest:resource
Run the `resource` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nest:service generator'
description: 'Run the `service` NestJS generator with Nx project support.'
---
# @nrwl/nest:service
Run the `service` NestJS generator with Nx project support.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/next:build executor'
description: 'Build a Next.js app'
---
# @nrwl/next:build
Build a Next.js app

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/next:export executor'
description: 'Export a Next.js app. The exported application is located at dist/$outputPath/exported.'
---
# @nrwl/next:export
Export a Next.js app. The exported application is located at dist/$outputPath/exported.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/next:server executor'
description: 'Serve a Next.js app'
---
# @nrwl/next:server
Serve a Next.js app

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/next:application generator'
description: 'Create a Next.js application'
---
# @nrwl/next:application
Create a Next.js application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/next:component generator'
description: 'Create a React component'
---
# @nrwl/next:component
Create a React component

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/next:page generator'
description: 'Create a Next.js page component'
---
# @nrwl/next:page
Create a Next.js page component

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/node:build executor'
description: 'Build a Node application'
---
# @nrwl/node:build
Build a Node application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/node:execute executor'
description: 'Execute a Node application'
---
# @nrwl/node:execute
Execute a Node application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/node:package executor'
description: 'Package a Node library'
---
# @nrwl/node:package
Package a Node library

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/node:application generator'
description: 'Create a node application'
---
# @nrwl/node:application
Create a node application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/node:library generator'
description: 'Create a library'
---
# @nrwl/node:library
Create a library

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nx-plugin:e2e executor'
description: 'Creates and runs the e2e tests for an Nx Plugin.'
---
# @nrwl/nx-plugin:e2e
Creates and runs the e2e tests for an Nx Plugin.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nx-plugin:executor generator'
description: 'Create a executor for an Nx Plugin'
---
# @nrwl/nx-plugin:executor
Create a executor for an Nx Plugin

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nx-plugin:generator generator'
description: 'Create a generator for an Nx Plugin'
---
# @nrwl/nx-plugin:generator
Create a generator for an Nx Plugin

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nx-plugin:migration generator'
description: 'Create a migration for an Nx Plugin'
---
# @nrwl/nx-plugin:migration
Create a migration for an Nx Plugin

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/nx-plugin:plugin generator'
description: 'Create a Nx Plugin'
---
# @nrwl/nx-plugin:plugin
Create a Nx Plugin

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:build-android executor'
description: 'Release Build for Android.'
---
# @nrwl/react-native:build-android
Release Build for Android.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:bundle executor'
description: 'Builds the JS bundle.'
---
# @nrwl/react-native:bundle
Builds the JS bundle.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:ensure-symlink executor'
description: "Ensure workspace node_modules is symlink under app's node_modules folder."
---
# @nrwl/react-native:ensure-symlink
Ensure workspace node_modules is symlink under app's node_modules folder.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:run-android executor'
description: 'Runs Android application.'
---
# @nrwl/react-native:run-android
Runs Android application.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:run-ios executor'
description: 'Runs iOS application.'
---
# @nrwl/react-native:run-ios
Runs iOS application.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:start executor'
description: 'Starts the dev server for JS bundle.'
---
# @nrwl/react-native:start
Starts the dev server for JS bundle.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:sync-deps executor'
description: 'Syncs dependencies to package.json (required for autolinking).'
---
# @nrwl/react-native:sync-deps
Syncs dependencies to package.json (required for autolinking).

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:application generator'
description: 'Create an application'
---
# @nrwl/react-native:application
Create an application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:component generator'
description: 'Create a component'
---
# @nrwl/react-native:component
Create a component

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react-native:library generator'
description: 'Create a library'
---
# @nrwl/react-native:library
Create a library

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:application generator'
description: 'Create an application'
---
# @nrwl/react:application
Create an application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:component-cypress-spec generator'
description: 'Create a cypress spec for a ui component that has a story'
---
# @nrwl/react:component-cypress-spec
Create a cypress spec for a ui component that has a story

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:component-story generator'
description: 'Generate storybook story for a react component'
---
# @nrwl/react:component-story
Generate storybook story for a react component

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:component generator'
description: 'Create a component'
---
# @nrwl/react:component
Create a component

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:hook generator'
description: 'Create a hook'
---
# @nrwl/react:hook
Create a hook

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:library generator'
description: 'Create a library'
---
# @nrwl/react:library
Create a library

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:redux generator'
description: 'Create a redux slice for a project'
---
# @nrwl/react:redux
Create a redux slice for a project

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:stories generator'
description: 'Create stories/specs for all components declared in a library'
---
# @nrwl/react:stories
Create stories/specs for all components declared in a library

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:storybook-configuration generator'
description: 'Set up storybook for a react library'
---
# @nrwl/react:storybook-configuration
Set up storybook for a react library

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/react:storybook-migrate-defaults-5-to-6 generator'
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.'
---
# @nrwl/react:storybook-migrate-defaults-5-to-6
Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/storybook:build executor'
description: 'Build Storybook'
---
# @nrwl/storybook:build
Build Storybook

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/storybook:storybook executor'
description: 'Serve Storybook'
---
# @nrwl/storybook:storybook
Serve Storybook

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/storybook:configuration generator'
description: 'Add storybook configuration to a ui library or an application'
---
# @nrwl/storybook:configuration
Add storybook configuration to a ui library or an application

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/storybook:cypress-project generator'
description: 'Add cypress e2e app to test a ui library that is set up for storybook'
---
# @nrwl/storybook:cypress-project
Add cypress e2e app to test a ui library that is set up for storybook

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/storybook:migrate-defaults-5-to-6 generator'
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.'
---
# @nrwl/storybook:migrate-defaults-5-to-6
Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/storybook:migrate-stories-to-6-2 generator'
description: 'Migrate stories syntax to 6.2'
---
# @nrwl/storybook:migrate-stories-to-6-2
Migrate stories syntax to 6.2

View File

@ -1,3 +1,8 @@
---
title: '@nrwl/web:dev-server executor'
description: 'Serve a web application'
---
# @nrwl/web:dev-server
Serve a web application

Some files were not shown because too many files have changed in this diff Show More