Skip to content

Commit bd361b5

Browse files
agerard-godaddyagerard-godaddy
committed
docs: regen
1 parent 2107f35 commit bd361b5

2 files changed

Lines changed: 66 additions & 52 deletions

File tree

‎README.md‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Available structure
135135
| test/ | Test files |
136136
| test/ | Test files |
137137
| [app.config.js] | App configuration with environment overrides |
138-
| [cypress.config.js]| Cypress configuration |
138+
| [cypress.json] | Cypress configuration |
139139
| [gasket.config.js] | Gasket config for an app |
140140
| [jest.config.js] | Jest configuration |
141141
| [redux/store.js] | Setup to make Redux store |
@@ -146,67 +146,67 @@ Available presets
146146

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

153153
## Plugins
154154

155155
Available plugins
156156

157157
| Name | Version | Description |
158158
| ------------------------------- | ------- | -------------------------------------------------------------------------- |
159-
| [@gasket/plugin-analyze] | 6.36.1 | Gasket Analyzer Plugin |
160-
| [@gasket/plugin-command] | 6.36.1 | Plugin to enable other plugins to inject new gasket commands |
161-
| [@gasket/plugin-config] | 6.36.1 | Supports application-specific (non-Gasket) configuration |
162-
| [@gasket/plugin-cypress] | 6.36.1 | Integrates Cypress based testing into your Gasket application |
163-
| [@gasket/plugin-docs] | 6.37.0 | Centralize doc files from plugins and modules |
164-
| [@gasket/plugin-docs-graphs] | 6.36.1 | Generate mermaid graphs of an applications gasket lifecycles |
165-
| [@gasket/plugin-docsify] | 6.36.1 | View collated docs with Docsify |
166-
| [@gasket/plugin-docusaurus] | 6.36.1 | Gasket plugin for docusaurus |
167-
| [@gasket/plugin-elastic-apm] | 6.36.1 | Adds Elastic APM instrumentation to your application |
168-
| [@gasket/plugin-express] | 6.36.1 | Adds express support to your application |
169-
| [@gasket/plugin-fastify] | 6.36.1 | Adds fastify support to your application |
170-
| [@gasket/plugin-git] | 6.36.1 | Adds git support to your application |
171-
| [@gasket/plugin-https] | 6.36.1 | Create http/s servers with graceful termination |
172-
| [@gasket/plugin-intl] | 6.37.0 | NodeJS script to build localization files. |
173-
| [@gasket/plugin-jest] | 6.36.1 | Integrated jest into your application. |
174-
| [@gasket/plugin-lifecycle] | 6.36.1 | Allows a gasket/ directory to be used for lifecycle hooks in applications. |
175-
| [@gasket/plugin-lint] | 6.36.1 | Adds GoDaddy standard linting to your application |
176-
| [@gasket/plugin-log] | 6.36.1 | Gasket log plugin |
177-
| [@gasket/plugin-manifest] | 6.36.1 | The web app manifest for progressive Gasket applications |
178-
| [@gasket/plugin-metadata] | 6.36.1 | Adds metadata to gasket lifecycles |
179-
| [@gasket/plugin-metrics] | 6.36.1 | Collect metrics for gasket commands |
180-
| [@gasket/plugin-mocha] | 6.36.1 | Integrates mocha based testing in to your Gasket application |
181-
| [@gasket/plugin-morgan] | 6.36.1 | Adds morgan request logger to your app |
182-
| [@gasket/plugin-nextjs] | 6.37.0 | Adds Next support to your application |
183-
| [@gasket/plugin-redux] | 6.36.1 | Gasket Redux Setup |
184-
| [@gasket/plugin-service-worker] | 6.36.1 | Gasket Service Worker Plugin |
185-
| [@gasket/plugin-start] | 6.36.1 | Adds commands for building and starting Gasket apps |
186-
| [@gasket/plugin-swagger] | 6.36.1 | Generate and serve swagger docs |
187-
| [@gasket/plugin-webpack] | 6.36.1 | Adds webpack support to your application |
188-
| [@gasket/plugin-workbox] | 6.36.1 | Gasket Workbox Plugin |
159+
| [@gasket/plugin-analyze] | 6.38.1 | Gasket Analyzer Plugin |
160+
| [@gasket/plugin-command] | 6.38.1 | Plugin to enable other plugins to inject new gasket commands |
161+
| [@gasket/plugin-config] | 6.38.1 | Supports application-specific (non-Gasket) configuration |
162+
| [@gasket/plugin-cypress] | 6.38.1 | Integrates Cypress based testing into your Gasket application |
163+
| [@gasket/plugin-docs] | 6.38.1 | Centralize doc files from plugins and modules |
164+
| [@gasket/plugin-docs-graphs] | 6.38.1 | Generate mermaid graphs of an applications gasket lifecycles |
165+
| [@gasket/plugin-docsify] | 6.38.1 | View collated docs with Docsify |
166+
| [@gasket/plugin-docusaurus] | 6.38.1 | Gasket plugin for docusaurus |
167+
| [@gasket/plugin-elastic-apm] | 6.38.1 | Adds Elastic APM instrumentation to your application |
168+
| [@gasket/plugin-express] | 6.38.1 | Adds express support to your application |
169+
| [@gasket/plugin-fastify] | 6.38.1 | Adds fastify support to your application |
170+
| [@gasket/plugin-git] | 6.38.1 | Adds git support to your application |
171+
| [@gasket/plugin-https] | 6.38.1 | Create http/s servers with graceful termination |
172+
| [@gasket/plugin-intl] | 6.38.1 | NodeJS script to build localization files. |
173+
| [@gasket/plugin-jest] | 6.38.1 | Integrated jest into your application. |
174+
| [@gasket/plugin-lifecycle] | 6.38.1 | Allows a gasket/ directory to be used for lifecycle hooks in applications. |
175+
| [@gasket/plugin-lint] | 6.38.1 | Adds GoDaddy standard linting to your application |
176+
| [@gasket/plugin-log] | 6.38.1 | Gasket log plugin |
177+
| [@gasket/plugin-manifest] | 6.38.1 | The web app manifest for progressive Gasket applications |
178+
| [@gasket/plugin-metadata] | 6.38.1 | Adds metadata to gasket lifecycles |
179+
| [@gasket/plugin-metrics] | 6.38.1 | Collect metrics for gasket commands |
180+
| [@gasket/plugin-mocha] | 6.38.1 | Integrates mocha based testing in to your Gasket application |
181+
| [@gasket/plugin-morgan] | 6.38.1 | Adds morgan request logger to your app |
182+
| [@gasket/plugin-nextjs] | 6.38.1 | Adds Next support to your application |
183+
| [@gasket/plugin-redux] | 6.38.1 | Gasket Redux Setup |
184+
| [@gasket/plugin-service-worker] | 6.38.1 | Gasket Service Worker Plugin |
185+
| [@gasket/plugin-start] | 6.38.1 | Adds commands for building and starting Gasket apps |
186+
| [@gasket/plugin-swagger] | 6.38.1 | Generate and serve swagger docs |
187+
| [@gasket/plugin-webpack] | 6.38.1 | Adds webpack support to your application |
188+
| [@gasket/plugin-workbox] | 6.38.1 | Gasket Workbox Plugin |
189189

190190
## Modules
191191

192192
Supporting modules
193193

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

211211
## Configurations
212212

‎packages/gasket-utils/docs/api.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ Name | Description
1111
------ | -----------
1212
[applyConfigOverrides(config, context)] | Normalize the config by applying any overrides for environments, commands, or local-only config file.
1313
~~[applyEnvironmentOverrides(gasketConfig, config, \[localFile\])]~~ | Normalize the config by applying any environment or local overrides
14-
[requireWithInstall(dependency, gasket)] | requireWithInstall - load devDependency programmatically when needed
14+
[installDependency(dependency, gasket)] | installDependency - install dependency
15+
[requireWithInstall(dependency, gasket)] | requireWithInstall - load devDependency request programmatically when needed
1516
[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.
1617
[tryRequire(path)] | Tries to require a module, but ignores if it is not found. If not found, result will be null.
1718
[tryResolve(modulePath, options)] |
@@ -167,16 +168,28 @@ Normalize the config by applying any environment or local overrides
167168
| \[localFile\] | `string` | Optional file to load relative to gasket root |
168169

169170

171+
## installDependency(dependency, gasket)
172+
173+
installDependency - install dependency
174+
175+
**Kind**: global function
176+
177+
| Param | Type | Description |
178+
| --- | --- | --- |
179+
| dependency | `string` | The dep/s needed |
180+
| gasket | `Gasket` | Gasket instance |
181+
182+
170183
## requireWithInstall(dependency, gasket)
171184

172-
requireWithInstall - load devDependency programmatically when needed
185+
requireWithInstall - load devDependency request programmatically when needed
173186

174187
**Kind**: global function
175-
**Returns**: `object` - module
188+
**Returns**: `object` ⎮ `Array.<object>` - module or list of modules
176189

177190
| Param | Type | Description |
178191
| --- | --- | --- |
179-
| dependency | `string` | The require'ed dep needed |
192+
| dependency | `string` \| `Array.<string>` | The require'ed dep/s needed |
180193
| gasket | `Gasket` | Gasket instance |
181194

182195

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

0 commit comments

Comments
 (0)