-
Notifications
You must be signed in to change notification settings - Fork 682
Add @rushstack/storybook-telemetry-stub package #5695
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
397c944
Initial plan
Copilot 52d1afc
Add @rushstack/storybook-telemetry-stub package with no-op stubs and …
Copilot b21f859
Fix lint warnings and test loading issues for storybook-telemetry-stub
Copilot 4e51f83
Address all review feedback: rename folder, fix tests, update README,…
Copilot 5871f3b
Move @storybook/telemetry to nonbrowser-approved-packages.json and us…
Copilot 7501910
Add Rush change file for @rushstack/storybook-telemetry-stub
Copilot 4150f44
Revert lockfiles to main and rerun rush update
Copilot 46ac29c
Remove storybook v7 dependency, hardcode v7 expected exports in tests…
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
...stack/storybook-telemetry-stub/add-storybook-telemetry-stub-package_2026-03-11-21-38.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "changes": [ | ||
| { | ||
| "packageName": "@rushstack/storybook-telemetry-stub", | ||
| "comment": "Initial package creation: stub replacement for @storybook/telemetry", | ||
| "type": "minor" | ||
| } | ||
| ], | ||
| "packageName": "@rushstack/storybook-telemetry-stub" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush. | ||
| { | ||
| "pnpmShrinkwrapHash": "8cea08431b1a848463c751666dcd35e9533ea73d", | ||
| "pnpmShrinkwrapHash": "fd55f1b42937aafab015d7ca41826e4e34b5ea85", | ||
| "preferredVersionsHash": "029c99bd6e65c5e1f25e2848340509811ff9753c" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO. | ||
|
|
||
| # Ignore all files by default, to avoid accidentally publishing unintended files. | ||
| * | ||
|
|
||
| # Use negative patterns to bring back the specific things we want to publish. | ||
| !/bin/** | ||
| !/lib/** | ||
| !/lib-*/** | ||
| !/dist/** | ||
| !/includes/** | ||
|
|
||
| !CHANGELOG.md | ||
| !CHANGELOG.json | ||
| !heft-plugin.json | ||
| !rush-plugin-manifest.json | ||
| !ThirdPartyNotice.txt | ||
|
|
||
| # Ignore certain patterns that should not get published. | ||
| /dist/*.stats.* | ||
| /lib/**/test/ | ||
| /lib-*/**/test/ | ||
| *.test.js | ||
| *.test.[cm]js | ||
| *.test.d.ts | ||
| *.test.d.[cm]ts | ||
|
|
||
| # NOTE: These don't need to be specified, because NPM includes them automatically. | ||
| # | ||
| # package.json | ||
| # README.md | ||
| # LICENSE | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below. | ||
| # --------------------------------------------------------------------------- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| @rushstack/storybook-telemetry-stub | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
|
||
| MIT License | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining | ||
| a copy of this software and associated documentation files (the | ||
| "Software"), to deal in the Software without restriction, including | ||
| without limitation the rights to use, copy, modify, merge, publish, | ||
| distribute, sublicense, and/or sell copies of the Software, and to | ||
| permit persons to whom the Software is furnished to do so, subject to | ||
| the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # @rushstack/storybook-telemetry-stub | ||
|
|
||
| A stub replacement of `@storybook/telemetry` for use in environments that absolutely forbid outbound | ||
| network connections and want to ensure that Storybook doesn't probe outside of its project folder, | ||
| e.g. for discovering what kind of package manager the repository uses. | ||
|
|
||
| All exported names mirror those of the official `@storybook/telemetry` package, but every function | ||
| is a no-op and every object is an empty stand-in. | ||
|
|
||
| ## Links | ||
|
|
||
| - [CHANGELOG.md](./CHANGELOG.md) - Find out what's new in the latest version | ||
|
|
||
| `@rushstack/storybook-telemetry-stub` is part of the [Rush Stack](https://rushstack.io/) family of projects. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "extends": "local-node-rig/profiles/default/config/jest.config.json" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json", | ||
| "rigPackageName": "local-node-rig" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. | ||
| // See LICENSE in the project root for license information. | ||
|
|
||
| const nodeTrustedToolProfile = require('local-node-rig/profiles/default/includes/eslint/flat/profile/node-trusted-tool'); | ||
| const friendlyLocalsMixin = require('local-node-rig/profiles/default/includes/eslint/flat/mixins/friendly-locals'); | ||
|
|
||
| module.exports = [ | ||
| ...nodeTrustedToolProfile, | ||
| ...friendlyLocalsMixin, | ||
| { | ||
| files: ['**/*.ts', '**/*.tsx'], | ||
| languageOptions: { | ||
| parserOptions: { | ||
| tsconfigRootDir: __dirname | ||
| } | ||
| } | ||
| } | ||
| ]; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| { | ||
| "name": "@rushstack/storybook-telemetry-stub", | ||
| "version": "0.0.0", | ||
| "description": "A stub replacement of @storybook/telemetry for environments that forbid outbound network connections", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/microsoft/rushstack.git", | ||
| "directory": "storybook/telemetry-stub" | ||
| }, | ||
| "license": "MIT", | ||
| "scripts": { | ||
| "build": "heft build --clean", | ||
| "start": "heft test --clean --watch", | ||
| "_phase:build": "heft run --only build -- --clean", | ||
| "_phase:test": "heft run --only test -- --clean" | ||
| }, | ||
| "dependencies": {}, | ||
| "devDependencies": { | ||
| "@storybook/telemetry-8": "npm:@storybook/telemetry@~8.6.0", | ||
| "@rushstack/heft": "workspace:*", | ||
| "eslint": "~9.37.0", | ||
| "local-node-rig": "workspace:*" | ||
| }, | ||
| "typesVersions": { | ||
| "*": { | ||
| "lib/*": [ | ||
| "lib-dts/*" | ||
| ] | ||
| } | ||
| }, | ||
| "sideEffects": false | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This README is important, since the usage and underlying motivations are not obvious from looking at the package itself. I think the README can be organized a bit better, along the lines of: