diff --git a/.gitignore b/.gitignore index f7fb0ab..566f25c 100644 --- a/.gitignore +++ b/.gitignore @@ -38,7 +38,8 @@ coverage/ # KoalaSync Specific # We ignore the synced files in the extension folder to ensure # the root 'shared/' remains the Single Source of Truth. -extension/shared/ +extension/shared/* +!extension/shared/README.md # Temporary scratch files scratch/ diff --git a/extension/shared/README.md b/extension/shared/README.md new file mode 100644 index 0000000..33cfe6f --- /dev/null +++ b/extension/shared/README.md @@ -0,0 +1,14 @@ +# ⚠️ READ BEFORE EDITING + +This directory is a **MIRROR** of the root `/shared` folder. + +**DO NOT edit these files directly.** Any changes made here will be overwritten the next time the synchronization script is run. + +### Proper Workflow: +1. **Edit** the source files in the root `[repo_root]/shared/` directory. +2. **Run** the synchronization script: + - **Windows**: `[repo_root]\scripts\sync-constants.bat` + - **Linux/macOS**: `[repo_root]/scripts/sync-constants.sh` +3. **Verify** that the changes have propagated to this folder. + +Failure to follow this protocol will result in out-of-sync components and broken protocol logic. diff --git a/shared/blacklist.js b/shared/blacklist.js index ba5e613..b41c23b 100644 --- a/shared/blacklist.js +++ b/shared/blacklist.js @@ -1,6 +1,10 @@ /** * blacklist.js * + * ⚠️ WARNING: This is the SINGLE SOURCE OF TRUTH. + * If you edit this file, you MUST run /scripts/sync-constants.bat + * to propagate changes to the extension and relay server. + * * Domains to be filtered out from the tab selection dropdown to reduce "noise". * These are typically sites that won't contain shareable video content. */ diff --git a/shared/constants.js b/shared/constants.js index d97876b..3d43593 100644 --- a/shared/constants.js +++ b/shared/constants.js @@ -1,5 +1,9 @@ /** * KoalaSync Shared Constants & Protocol Definitions + * + * ⚠️ WARNING: This is the SINGLE SOURCE OF TRUTH. + * If you edit this file, you MUST run /scripts/sync-constants.bat + * to propagate changes to the extension and relay server. */ export const PROTOCOL_VERSION = "1.0.0";