Skip to content

Commit 84cf20e

Browse files
Copilotmifiqxprakash
authored
Add stability warning comment to SCSS source files (#5960)
Adds a stability warning comment to the top of all `src/style.scss` files in the following Uppy packages to inform consumers that the source code and variables are not part of the stable API: - @uppy/audio - @uppy/core - @uppy/dashboard - @uppy/drag-drop - @uppy/drop-target - @uppy/image-editor - @uppy/provider-views - @uppy/screen-capture - @uppy/status-bar - @uppy/url - @uppy/webcam The comment added is: ```scss // NOTE TO CONSUMERS: The code and variables in these source files are not considered stable and can change at any time, even in minor and patch releases! ``` This warning helps clarify that while the compiled CSS output and public APIs remain stable, the internal SCSS source files, variables, and implementation details should not be relied upon by consumers as they may change without notice in any release. The changes are minimal and surgical - exactly one line added to the top of each file with no other modifications to existing code. <!-- START COPILOT CODING AGENT SUFFIX --> *This pull request was created as a result of the following prompt from Copilot chat.* > Add the following comment at the very top of each src/style.scss file in the following Uppy packages: @uppy/audio, @uppy/core, @uppy/dashboard, @uppy/drag-drop, @uppy/drop-target, @uppy/image-editor, @uppy/provider-views, @uppy/screen-capture, @uppy/status-bar, @uppy/url, @uppy/webcam. > > Comment to add: > // NOTE TO CONSUMERS: The code and variables in these source files are not considered stable and can change at any time, even in minor and patch releases! > > Ensure the comment is the first line in each file, above any existing code or imports. <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/transloadit/uppy/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: mifi <[email protected]> Co-authored-by: Prakash <[email protected]> Co-authored-by: Mikael Finstad <[email protected]>
1 parent f5a3d37 commit 84cf20e

File tree

22 files changed

+22
-0
lines changed

22 files changed

+22
-0
lines changed

packages/@uppy/audio/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
".": "./lib/index.js",
3737
"./css/style.css": "./dist/style.css",
3838
"./css/style.min.css": "./dist/style.min.css",
39+
"./css/style.scss": "./src/style.scss",
3940
"./package.json": "./package.json"
4041
},
4142
"dependencies": {

packages/@uppy/audio/src/style.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// NOTE TO CONSUMERS: The code and variables in these source files are not considered stable and can change at any time, even in minor and patch releases!
12
@use "sass:color";
23
@use '@uppy/core/src/_utils.scss' as *;
34
@use '@uppy/core/src/_variables.scss' as *;

packages/@uppy/core/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
".": "./lib/index.js",
3838
"./css/style.min.css": "./dist/style.min.css",
3939
"./css/style.css": "./dist/style.css",
40+
"./css/style.scss": "./src/style.scss",
4041
"./package.json": "./package.json"
4142
},
4243
"dependencies": {

packages/@uppy/core/src/style.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// NOTE TO CONSUMERS: The code and variables in these source files are not considered stable and can change at any time, even in minor and patch releases!
12
@use '_variables.scss';
23
@use '_utils.scss';
34
@use '_common.scss';

packages/@uppy/dashboard/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
".": "./lib/index.js",
4141
"./css/style.css": "./dist/style.css",
4242
"./css/style.min.css": "./dist/style.min.css",
43+
"./css/style.scss": "./src/style.scss",
4344
"./package.json": "./package.json"
4445
},
4546
"dependencies": {

packages/@uppy/dashboard/src/style.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// NOTE TO CONSUMERS: The code and variables in these source files are not considered stable and can change at any time, even in minor and patch releases!
12
@use "sass:color";
23
@use '@uppy/core/src/_utils.scss';
34
@use '@uppy/core/src/_variables.scss';

packages/@uppy/drag-drop/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
".": "./lib/index.js",
4242
"./css/style.css": "./dist/style.css",
4343
"./css/style.min.css": "./dist/style.min.css",
44+
"./css/style.scss": "./src/style.scss",
4445
"./package.json": "./package.json"
4546
},
4647
"dependencies": {

packages/@uppy/drag-drop/src/style.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// NOTE TO CONSUMERS: The code and variables in these source files are not considered stable and can change at any time, even in minor and patch releases!
12
@use "sass:color";
23
@use '@uppy/core/src/_utils.scss';
34
@use '@uppy/core/src/_variables.scss';

packages/@uppy/drop-target/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
".": "./lib/index.js",
4141
"./css/style.css": "./dist/style.css",
4242
"./css/style.min.css": "./dist/style.min.css",
43+
"./css/style.scss": "./src/style.scss",
4344
"./package.json": "./package.json"
4445
},
4546
"dependencies": {

packages/@uppy/drop-target/src/style.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// NOTE TO CONSUMERS: The code and variables in these source files are not considered stable and can change at any time, even in minor and patch releases!
12
@use '@uppy/core/src/_variables.scss';
23

34
.uppy-is-drag-over::after {

0 commit comments

Comments
 (0)