swagger-editor 4.13.1 → 4.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -0
- package/dist/swagger-editor-bundle.js +1 -1
- package/dist/swagger-editor-bundle.js.map +1 -1
- package/dist/swagger-editor-es-bundle-core.js +1 -1
- package/dist/swagger-editor-es-bundle.js +1 -1
- package/dist/swagger-editor.css +1 -1
- package/dist/swagger-editor.css.map +1 -1
- package/dist/swagger-editor.js +1 -1
- package/package.json +7 -6
package/README.md
CHANGED
|
@@ -34,6 +34,23 @@ This repository publishes to two different NPM modules:
|
|
|
34
34
|
|
|
35
35
|
If you're building a single-page application, using `swagger-editor` is strongly recommended, since `swagger-editor-dist` is significantly larger.
|
|
36
36
|
|
|
37
|
+
## Anonymized analytics
|
|
38
|
+
|
|
39
|
+
Swagger Editor uses [Scarf](https://scarf.sh/) to collect [anonymized installation analytics](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-what-information-does-scarf-js-send-about-me). These analytics help support the maintainers of this library and ONLY run during installation. To [opt out](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics), you can set the `scarfSettings.enabled` field to `false` in your project's `package.json`:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
// package.json
|
|
43
|
+
{
|
|
44
|
+
// ...
|
|
45
|
+
"scarfSettings": {
|
|
46
|
+
"enabled": false
|
|
47
|
+
}
|
|
48
|
+
// ...
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` as part of the environment that installs your npm packages, e.g., `SCARF_ANALYTICS=false npm install`.
|
|
53
|
+
|
|
37
54
|
## Helpful scripts
|
|
38
55
|
|
|
39
56
|
Any of the scripts below can be run by typing `npm run <script name>` in the project's root directory.
|