Skip to content

Commit

Permalink
docs: regen
Browse files Browse the repository at this point in the history
  • Loading branch information
@agerard-godaddy
agerard-godaddy committed Feb 8, 2023
1 parent 2107f35 commit bd361b5
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 52 deletions.
96 changes: 48 additions & 48 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Available structure
| test/ | Test files |
| test/ | Test files |
| [app.config.js] | App configuration with environment overrides |
| [cypress.config.js]| Cypress configuration |
| [cypress.json] | Cypress configuration |
| [gasket.config.js] | Gasket config for an app |
| [jest.config.js] | Jest configuration |
| [redux/store.js] | Setup to make Redux store |
Expand All @@ -146,67 +146,67 @@ Available presets

| Name | Version | Description |
| ----------------------- | ------- | ------------------------------------------ |
| [@gasket/preset-api] | 6.37.0 | Create Express-based API with Gasket |
| [@gasket/preset-nextjs] | 6.37.0 | Basic NextJS Framework |
| [@gasket/preset-pwa] | 6.36.1 | Turn Gasket apps into Progressive Web Apps |
| [@gasket/preset-api] | 6.38.1 | Create Express-based API with Gasket |
| [@gasket/preset-nextjs] | 6.38.1 | Basic NextJS Framework |
| [@gasket/preset-pwa] | 6.38.1 | Turn Gasket apps into Progressive Web Apps |

## Plugins

Available plugins

| Name | Version | Description |
| ------------------------------- | ------- | -------------------------------------------------------------------------- |
| [@gasket/plugin-analyze] | 6.36.1 | Gasket Analyzer Plugin |
| [@gasket/plugin-command] | 6.36.1 | Plugin to enable other plugins to inject new gasket commands |
| [@gasket/plugin-config] | 6.36.1 | Supports application-specific (non-Gasket) configuration |
| [@gasket/plugin-cypress] | 6.36.1 | Integrates Cypress based testing into your Gasket application |
| [@gasket/plugin-docs] | 6.37.0 | Centralize doc files from plugins and modules |
| [@gasket/plugin-docs-graphs] | 6.36.1 | Generate mermaid graphs of an applications gasket lifecycles |
| [@gasket/plugin-docsify] | 6.36.1 | View collated docs with Docsify |
| [@gasket/plugin-docusaurus] | 6.36.1 | Gasket plugin for docusaurus |
| [@gasket/plugin-elastic-apm] | 6.36.1 | Adds Elastic APM instrumentation to your application |
| [@gasket/plugin-express] | 6.36.1 | Adds express support to your application |
| [@gasket/plugin-fastify] | 6.36.1 | Adds fastify support to your application |
| [@gasket/plugin-git] | 6.36.1 | Adds git support to your application |
| [@gasket/plugin-https] | 6.36.1 | Create http/s servers with graceful termination |
| [@gasket/plugin-intl] | 6.37.0 | NodeJS script to build localization files. |
| [@gasket/plugin-jest] | 6.36.1 | Integrated jest into your application. |
| [@gasket/plugin-lifecycle] | 6.36.1 | Allows a gasket/ directory to be used for lifecycle hooks in applications. |
| [@gasket/plugin-lint] | 6.36.1 | Adds GoDaddy standard linting to your application |
| [@gasket/plugin-log] | 6.36.1 | Gasket log plugin |
| [@gasket/plugin-manifest] | 6.36.1 | The web app manifest for progressive Gasket applications |
| [@gasket/plugin-metadata] | 6.36.1 | Adds metadata to gasket lifecycles |
| [@gasket/plugin-metrics] | 6.36.1 | Collect metrics for gasket commands |
| [@gasket/plugin-mocha] | 6.36.1 | Integrates mocha based testing in to your Gasket application |
| [@gasket/plugin-morgan] | 6.36.1 | Adds morgan request logger to your app |
| [@gasket/plugin-nextjs] | 6.37.0 | Adds Next support to your application |
| [@gasket/plugin-redux] | 6.36.1 | Gasket Redux Setup |
| [@gasket/plugin-service-worker] | 6.36.1 | Gasket Service Worker Plugin |
| [@gasket/plugin-start] | 6.36.1 | Adds commands for building and starting Gasket apps |
| [@gasket/plugin-swagger] | 6.36.1 | Generate and serve swagger docs |
| [@gasket/plugin-webpack] | 6.36.1 | Adds webpack support to your application |
| [@gasket/plugin-workbox] | 6.36.1 | Gasket Workbox Plugin |
| [@gasket/plugin-analyze] | 6.38.1 | Gasket Analyzer Plugin |
| [@gasket/plugin-command] | 6.38.1 | Plugin to enable other plugins to inject new gasket commands |
| [@gasket/plugin-config] | 6.38.1 | Supports application-specific (non-Gasket) configuration |
| [@gasket/plugin-cypress] | 6.38.1 | Integrates Cypress based testing into your Gasket application |
| [@gasket/plugin-docs] | 6.38.1 | Centralize doc files from plugins and modules |
| [@gasket/plugin-docs-graphs] | 6.38.1 | Generate mermaid graphs of an applications gasket lifecycles |
| [@gasket/plugin-docsify] | 6.38.1 | View collated docs with Docsify |
| [@gasket/plugin-docusaurus] | 6.38.1 | Gasket plugin for docusaurus |
| [@gasket/plugin-elastic-apm] | 6.38.1 | Adds Elastic APM instrumentation to your application |
| [@gasket/plugin-express] | 6.38.1 | Adds express support to your application |
| [@gasket/plugin-fastify] | 6.38.1 | Adds fastify support to your application |
| [@gasket/plugin-git] | 6.38.1 | Adds git support to your application |
| [@gasket/plugin-https] | 6.38.1 | Create http/s servers with graceful termination |
| [@gasket/plugin-intl] | 6.38.1 | NodeJS script to build localization files. |
| [@gasket/plugin-jest] | 6.38.1 | Integrated jest into your application. |
| [@gasket/plugin-lifecycle] | 6.38.1 | Allows a gasket/ directory to be used for lifecycle hooks in applications. |
| [@gasket/plugin-lint] | 6.38.1 | Adds GoDaddy standard linting to your application |
| [@gasket/plugin-log] | 6.38.1 | Gasket log plugin |
| [@gasket/plugin-manifest] | 6.38.1 | The web app manifest for progressive Gasket applications |
| [@gasket/plugin-metadata] | 6.38.1 | Adds metadata to gasket lifecycles |
| [@gasket/plugin-metrics] | 6.38.1 | Collect metrics for gasket commands |
| [@gasket/plugin-mocha] | 6.38.1 | Integrates mocha based testing in to your Gasket application |
| [@gasket/plugin-morgan] | 6.38.1 | Adds morgan request logger to your app |
| [@gasket/plugin-nextjs] | 6.38.1 | Adds Next support to your application |
| [@gasket/plugin-redux] | 6.38.1 | Gasket Redux Setup |
| [@gasket/plugin-service-worker] | 6.38.1 | Gasket Service Worker Plugin |
| [@gasket/plugin-start] | 6.38.1 | Adds commands for building and starting Gasket apps |
| [@gasket/plugin-swagger] | 6.38.1 | Generate and serve swagger docs |
| [@gasket/plugin-webpack] | 6.38.1 | Adds webpack support to your application |
| [@gasket/plugin-workbox] | 6.38.1 | Gasket Workbox Plugin |

## Modules

Supporting modules

| Name | Version | Description |
| -------------------------- | ------- | ------------------------------------------------------------------------------------ |
| [@gasket/assets] | 6.36.1 | Gasket assets |
| [@gasket/cli] | 6.36.1 | CLI for rapid application development with gasket |
| [@gasket/data] | 6.37.0 | Helper package for accessing embedded Gasket Data in the browser |
| [@gasket/engine] | 6.36.1 | Plugin engine for gasket |
| [@gasket/fetch] | 6.36.1 | Gasket Fetch API |
| [@gasket/helper-intl] | 6.36.1 | Internal helpers used by loaders to resolve locale file paths |
| [@gasket/log] | 6.36.1 | Gasket client and server logger |
| [@gasket/nextjs] | 6.37.0 | Gasket integrations for Next.js apps |
| [@gasket/react-intl] | 6.37.0 | React component library to enable localization for gasket apps. |
| [@gasket/redux] | 6.36.1 | Gasket Redux Configuration |
| [@gasket/resolve] | 6.36.1 | Essential module resolution & configuration management for gasket plugins & presets. |
| [@gasket/typescript-tests] | 6.37.0 | Not a published package; hosts unit tests to verify TypeScript support |
| [@gasket/utils] | 6.36.1 | Reusable utilities for Gasket internals |
| [create-gasket-app] | 6.37.0 | starter pack for creating a gasket app |
| [@gasket/assets] | 6.38.1 | Gasket assets |
| [@gasket/cli] | 6.38.1 | CLI for rapid application development with gasket |
| [@gasket/data] | 6.38.1 | Helper package for accessing embedded Gasket Data in the browser |
| [@gasket/engine] | 6.38.1 | Plugin engine for gasket |
| [@gasket/fetch] | 6.38.1 | Gasket Fetch API |
| [@gasket/helper-intl] | 6.38.1 | Internal helpers used by loaders to resolve locale file paths |
| [@gasket/log] | 6.38.0 | Gasket client and server logger |
| [@gasket/nextjs] | 6.38.1 | Gasket integrations for Next.js apps |
| [@gasket/react-intl] | 6.38.1 | React component library to enable localization for gasket apps. |
| [@gasket/redux] | 6.38.1 | Gasket Redux Configuration |
| [@gasket/resolve] | 6.38.1 | Essential module resolution & configuration management for gasket plugins & presets. |
| [@gasket/typescript-tests] | 6.38.1 | Not a published package; hosts unit tests to verify TypeScript support |
| [@gasket/utils] | 6.38.1 | Reusable utilities for Gasket internals |
| [create-gasket-app] | 6.38.1 | starter pack for creating a gasket app |

## Configurations

Expand Down
22 changes: 18 additions & 4 deletions packages/gasket-utils/docs/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Name | Description
------ | -----------
[applyConfigOverrides(config, context)] | Normalize the config by applying any overrides for environments, commands, or local-only config file.
~~[applyEnvironmentOverrides(gasketConfig, config, \[localFile\])]~~ | Normalize the config by applying any environment or local overrides
[requireWithInstall(dependency, gasket)] | requireWithInstall - load devDependency programmatically when needed
[installDependency(dependency, gasket)] | installDependency - install dependency
[requireWithInstall(dependency, gasket)] | requireWithInstall - load devDependency request programmatically when needed
[runShellCommand(cmd, \[argv\], \[options\], \[debug\])] | Promise friendly wrapper to running a shell command (eg: git, npm, ls) which passes back any { stdout, stderr } to the error thrown.
[tryRequire(path)] | Tries to require a module, but ignores if it is not found. If not found, result will be null.
[tryResolve(modulePath, options)] |
Expand Down Expand Up @@ -167,16 +168,28 @@ Normalize the config by applying any environment or local overrides
| \[localFile\] | `string` | Optional file to load relative to gasket root |


## installDependency(dependency, gasket)

installDependency - install dependency

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| dependency | `string` | The dep/s needed |
| gasket | `Gasket` | Gasket instance |


## requireWithInstall(dependency, gasket)

requireWithInstall - load devDependency programmatically when needed
requireWithInstall - load devDependency request programmatically when needed

**Kind**: global function
**Returns**: `object` - module
**Returns**: `object` ⎮ `Array.<object>` - module or list of modules

| Param | Type | Description |
| --- | --- | --- |
| dependency | `string` | The require'ed dep needed |
| dependency | `string` \| `Array.<string>` | The require'ed dep/s needed |
| gasket | `Gasket` | Gasket instance |


Expand Down Expand Up @@ -264,6 +277,7 @@ const { tryRequire } = require('@gasket/utils');
[`PackageManager`]:#new-packagemanageroptions
[applyConfigOverrides(config, context)]:#applyconfigoverridesconfig-context
[applyEnvironmentOverrides(gasketConfig, config, \[localFile\])]:#applyenvironmentoverridesgasketconfig-config-localfile
[installDependency(dependency, gasket)]:#installdependencydependency-gasket
[requireWithInstall(dependency, gasket)]:#requirewithinstalldependency-gasket
[runShellCommand(cmd, \[argv\], \[options\], \[debug\])]:#runshellcommandcmd-argv-options-debug
[tryRequire(path)]:#tryrequirepath
Expand Down

0 comments on commit bd361b5

Please sign in to comment.