diff --git a/package-lock.json b/package-lock.json index f053cd64..e310301c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -32,7 +32,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" } }, @@ -4720,9 +4720,9 @@ } }, "node_modules/tsdoc-markdown": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/tsdoc-markdown/-/tsdoc-markdown-0.2.1.tgz", - "integrity": "sha512-m4H0k5VZzeDNc35RSWN0S+ybBig0HwbNoKMQPBN141NeTyT2C7u+xSDSFca9l6blC87OGiHX+6L6KN6IS1ucUA==", + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/tsdoc-markdown/-/tsdoc-markdown-0.3.0.tgz", + "integrity": "sha512-K+sHc4lKL5GjYmXNxvVbGvjryq5i0w6QA3A/EEqBdqOBIfawKH7Oo9GfKGuORbqOoJGbVV1tqGwX3iahRun5Rg==", "dev": true, "bin": { "tsdoc": "bin/index.js" @@ -8098,9 +8098,9 @@ } }, "tsdoc-markdown": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/tsdoc-markdown/-/tsdoc-markdown-0.2.1.tgz", - "integrity": "sha512-m4H0k5VZzeDNc35RSWN0S+ybBig0HwbNoKMQPBN141NeTyT2C7u+xSDSFca9l6blC87OGiHX+6L6KN6IS1ucUA==", + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/tsdoc-markdown/-/tsdoc-markdown-0.3.0.tgz", + "integrity": "sha512-K+sHc4lKL5GjYmXNxvVbGvjryq5i0w6QA3A/EEqBdqOBIfawKH7Oo9GfKGuORbqOoJGbVV1tqGwX3iahRun5Rg==", "dev": true, "requires": {} }, diff --git a/package.json b/package.json index 93850c97..b7d5de77 100644 --- a/package.json +++ b/package.json @@ -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": [ diff --git a/packages/config/README.md b/packages/config/README.md index 12d354b5..e9365775 100644 --- a/packages/config/README.md +++ b/packages/config/README.md @@ -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. | diff --git a/packages/config/src/types/juno.config.ts b/packages/config/src/types/juno.config.ts index de7761b9..b697fc55 100644 --- a/packages/config/src/types/juno.config.ts +++ b/packages/config/src/types/juno.config.ts @@ -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;