Merge pull request #62 from keikoro/document_missing_option

Document missing option + fix typo
django-webpack · Jul 15, 2021 · a719704 · a719704
2 parents 6d1e9e6 + e5e03e8
commit a719704
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -181,10 +181,11 @@ passed to the `space` parameter in `JSON.stringify`. More information can be fou
 
 | Name              | Type        | Default                          | Description                                                                                                                     |
 | ----------------- | ----------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `path`            | `{String}`  | `'.'`                            | Output directory of bundle tracker JSON file .                                                                                  |
+| `path`            | `{String}`  | `'.'`                            | Output directory of bundle tracker JSON file.                                                                                   |
 | `filename`        | `{String}`  | `'webpack-stats.json'`           | Name of the bundle tracker JSON file.                                                                                           |
-| `publicPath`      | `{String}`  | `?`                              | Override `output.publicPath` from Webpack config.                                                                               |
-| `relativePath`    | `{Boolean}` | `?`                              | Show relative path instead of absolute path for bundles in JSON Tracker file. Path are relative from path of JSON Tracker file. |
+| `publicPath`      | `{String}`  | (ignored)                        | Override `output.publicPath` from Webpack config.                                                                               |
+| `relativePath`    | `{Boolean}` | `false`                          | Show relative path instead of absolute path for bundles in JSON Tracker file. Path are relative from path of JSON Tracker file. |
 | `logTime`         | `{Boolean}` | `false`                          | Output `startTime` and `endTime` properties in bundle tracker JSON file.                                                        |
 | `integrity`       | `{Boolean}` | `false`                          | Output `integrity` property for each asset entry.                                                                               |
 | `integrityHashes` | `{Array}`   | `['sha256', 'sha384', 'sha512']` | Cryptographic hash functions used to compute integrity for each asset.                                                          |
+| `indent`          | `{Integer}` | `undefined`                      | Format resulting JSON file for better readability.                                                                              |
diff --git a/typings.d.ts b/typings.d.ts
@@ -33,7 +33,7 @@ declare namespace BundleTrackerPlugin {
      */
     relativePath?: boolean;
     /**
-     * Indent JSON ouput file
+     * Indent JSON output file
      */
     indent?: number;
     /**