Skip to content

Commit

Permalink
docs: default value for config source
Browse files Browse the repository at this point in the history
  • Loading branch information
peterpeterparker committed Feb 16, 2024
1 parent 00fc21b commit 80cc9a3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"node-fetch": "^3.3.2",
"prettier": "^3.2.5",
"prettier-plugin-organize-imports": "^3.2.4",
"tsdoc-markdown": "^0.2.1",
"tsdoc-markdown": "^0.3.0",
"typescript": "^5.2.2"
},
"size-limit": [
Expand Down
2 changes: 1 addition & 1 deletion packages/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Configures the Hosting behavior of the Storage.
| Property | Type | Description |
| ------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `satelliteId` | `string` | The unique identifier (ID) of the satellite where the application will be deployed. |
| `source` | `string` | Specifies the directory from which to deploy to storage. Defaults to 'build'.For instance, if `npm run build` outputs files to a `dist` folder, use `source: 'dist'`. |
| `source` | `string` | Specifies the directory from which to deploy to storage.For instance, if `npm run build` outputs files to a `dist` folder, use `source: 'dist'`. default: `build` |
| `storage` | `StorageConfig` | Optional configuration parameters for the satellite, affecting the operational behavior of its Storage.Changes to these parameters must be applied manually afterwards using `juno config` commands. |
| `ignore` | `string[]` | Specifies files or patterns to ignore during deployment, using glob patterns similar to those in .gitignore. |
| `gzip` | `string or false` | Controls the Gzip compression optimization for files in the source folder. By default, it targets JavaScript (js), ES Module (mjs), and CSS (css) files.You can disable this by setting it to `false` or customize it with a different file matching pattern using glob syntax. |
Expand Down
4 changes: 3 additions & 1 deletion packages/config/src/types/juno.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ export interface SatelliteConfig {
satelliteId: string;

/**
* Specifies the directory from which to deploy to storage. Defaults to 'build'.
* Specifies the directory from which to deploy to storage.
* For instance, if `npm run build` outputs files to a `dist` folder, use `source: 'dist'`.
*
* @default `build`
*/
source?: string;

Expand Down

0 comments on commit 80cc9a3

Please sign in to comment.