diff --git a/.build/sublime-text-configurations b/.build/sublime-text-configurations index eb35de9f..84bce7bb 100644 --- a/.build/sublime-text-configurations +++ b/.build/sublime-text-configurations @@ -1,3 +1,5 @@ +// Preferences Settings + { "update_check": false, "atomic_save": true, diff --git a/.build/sublime-text-keybindings-linux b/.build/sublime-text-keybindings-linux index 5eae6688..93b4b9e1 100644 --- a/.build/sublime-text-keybindings-linux +++ b/.build/sublime-text-keybindings-linux @@ -1,3 +1,5 @@ +// Preferences Key Bindings + [ { "keys": [ diff --git a/.build/sublime-text-keybindings-macosx b/.build/sublime-text-keybindings-macosx index d78244e7..f5b5ca92 100644 --- a/.build/sublime-text-keybindings-macosx +++ b/.build/sublime-text-keybindings-macosx @@ -1,3 +1,5 @@ +// Preferences Key Bindings + [ { "keys": [ diff --git a/.build/sublime-text-keybindings-windows b/.build/sublime-text-keybindings-windows index 5eae6688..93b4b9e1 100644 --- a/.build/sublime-text-keybindings-windows +++ b/.build/sublime-text-keybindings-windows @@ -1,3 +1,5 @@ +// Preferences Key Bindings + [ { "keys": [ diff --git a/.build/vs-code-configurations b/.build/vs-code-configurations index 8ae6a0be..ddb63da2 100644 --- a/.build/vs-code-configurations +++ b/.build/vs-code-configurations @@ -1,3 +1,5 @@ +// Preferences Open User Settings (JSON) + { "breadcrumbs.enabled": true, "editor.bracketPairColorization.enabled": true, diff --git a/.build/vs-code-keybindings-linux b/.build/vs-code-keybindings-linux index 2b8c25c5..066959a1 100644 --- a/.build/vs-code-keybindings-linux +++ b/.build/vs-code-keybindings-linux @@ -1,3 +1,5 @@ +// Preferences Open Keyboard Shortcuts (JSON) + [ { "key": "alt+1", diff --git a/.build/vs-code-keybindings-macosx b/.build/vs-code-keybindings-macosx index 8c540792..cd9aedff 100644 --- a/.build/vs-code-keybindings-macosx +++ b/.build/vs-code-keybindings-macosx @@ -1,3 +1,5 @@ +// Preferences Open Keyboard Shortcuts (JSON) + [ { "key": "cmd+1", diff --git a/.build/vs-code-keybindings-windows b/.build/vs-code-keybindings-windows index 2b8c25c5..066959a1 100644 --- a/.build/vs-code-keybindings-windows +++ b/.build/vs-code-keybindings-windows @@ -1,3 +1,5 @@ +// Preferences Open Keyboard Shortcuts (JSON) + [ { "key": "alt+1", diff --git a/software/base-node-script.js b/software/base-node-script.js index 94bde58f..d7219d6c 100644 --- a/software/base-node-script.js +++ b/software/base-node-script.js @@ -223,19 +223,27 @@ function backupText(aDir, text) { } } -function writeJson(aDir, json) { - writeText(aDir, JSON.stringify(json, null, 2)); +function writeJson(aDir, json, comments = '') { + let content = comments + '\n' + JSON.stringify(json, null, 2); + writeText(aDir, content.trim()); } function writeToBuildFile(tasks) { if (DEBUG_WRITE_TO_DIR) { - for (const [file, data, isJson = false] of [].concat(tasks)) { + for (let [file, data, isJson, comments] of [].concat(tasks)) { + isJson = !!isJson || false; + comments = comments || ''; + + if (comments) { + comments += '\n'; + } + if (isJson) { console.log(consoleLogColor1(' >> DEBUG Mode: write JSON to file'), consoleLogColor4(file)); - writeJson(file, data); + writeJson(file, data, comments); } else { console.log(consoleLogColor1(' >> DEBUG Mode: write TEXT to file'), consoleLogColor4(file)); - writeText(file, data); + writeText(file, (comments + data).trim()); } } return process.exit(); diff --git a/software/scripts/sublime-text-configurations.js b/software/scripts/sublime-text-configurations.js index d7368a8b..307b5199 100644 --- a/software/scripts/sublime-text-configurations.js +++ b/software/scripts/sublime-text-configurations.js @@ -44,7 +44,8 @@ async function doWork() { console.log(` >> Setting up Sublime Text configurations:`, consoleLogColor4(targetPath)); // write to build file - writeToBuildFile([['sublime-text-configurations', sublimeSetings, true]]); + const commentNote = '// Preferences Settings'; + writeToBuildFile([['sublime-text-configurations', sublimeSetings, true, commentNote]]); if (!filePathExist(targetPath)) { console.log(consoleLogColor1(' >> Skipped : Not Found')); diff --git a/software/scripts/sublime-text-keybindings.js b/software/scripts/sublime-text-keybindings.js index f27845a6..b1a2e40b 100644 --- a/software/scripts/sublime-text-keybindings.js +++ b/software/scripts/sublime-text-keybindings.js @@ -176,10 +176,16 @@ async function doWork() { console.log(` >> Setting up Sublime Text Keybindings:`, consoleLogColor4(targetPath)); // write to build file + const commentNote = '// Preferences Key Bindings'; writeToBuildFile([ - ['sublime-text-keybindings-windows', _formatKey([...COMMON_KEY_BINDINGS, ...WINDOWS_ONLY_KEY_BINDINGS], WINDOWS_OS_KEY), true], - ['sublime-text-keybindings-linux', _formatKey([...COMMON_KEY_BINDINGS, ...LINUX_ONLY_KEYBINDING], LINUX_OS_KEY), true], - ['sublime-text-keybindings-macosx', _formatKey([...COMMON_KEY_BINDINGS, ...MAC_ONLY_KEY_BINDINGS], MAC_OSX_KEY), true], + [ + 'sublime-text-keybindings-windows', + _formatKey([...COMMON_KEY_BINDINGS, ...WINDOWS_ONLY_KEY_BINDINGS], WINDOWS_OS_KEY), + true, + commentNote, + ], + ['sublime-text-keybindings-linux', _formatKey([...COMMON_KEY_BINDINGS, ...LINUX_ONLY_KEYBINDING], LINUX_OS_KEY), true, commentNote], + ['sublime-text-keybindings-macosx', _formatKey([...COMMON_KEY_BINDINGS, ...MAC_ONLY_KEY_BINDINGS], MAC_OSX_KEY), true, commentNote], ]); if (!filePathExist(targetPath)) { diff --git a/software/scripts/vs-code-configurations.js b/software/scripts/vs-code-configurations.js index 65cb66d8..6a7dfd3f 100644 --- a/software/scripts/vs-code-configurations.js +++ b/software/scripts/vs-code-configurations.js @@ -81,7 +81,8 @@ async function doWork() { let targetFile; // write to build file - writeToBuildFile([['vs-code-configurations', COMMON_CONFIGS, true]]); + const commentNote = '// Preferences Open User Settings (JSON)'; + writeToBuildFile([['vs-code-configurations', COMMON_CONFIGS, true, commentNote]]); if (!filePathExist(targetPath)) { console.log('Not supported - Exit - targetPath not found: ', consoleLogColor4(targetPath)); diff --git a/software/scripts/vs-code-keybindings.js b/software/scripts/vs-code-keybindings.js index b72713e7..446e6284 100644 --- a/software/scripts/vs-code-keybindings.js +++ b/software/scripts/vs-code-keybindings.js @@ -153,14 +153,16 @@ async function doWork() { let targetFile; // write to build file + const commentNote = '// Preferences Open Keyboard Shortcuts (JSON)'; writeToBuildFile([ - ['vs-code-keybindings-windows', _formatKey([...COMMON_KEY_BINDINGS, ...WINDOWS_ONLY_KEY_BINDINGS], WINDOWS_OS_KEY), true], + ['vs-code-keybindings-windows', _formatKey([...COMMON_KEY_BINDINGS, ...WINDOWS_ONLY_KEY_BINDINGS], WINDOWS_OS_KEY), true, commentNote], [ 'vs-code-keybindings-linux', _formatKey([...COMMON_KEY_BINDINGS, ...WINDOWS_ONLY_KEY_BINDINGS, ...LINUX_ONLY_KEYBINDING], LINUX_OS_KEY), true, + commentNote, ], - ['vs-code-keybindings-macosx', _formatKey([...COMMON_KEY_BINDINGS, ...MAC_ONLY_KEY_BINDINGS], MAC_OSX_KEY), true], + ['vs-code-keybindings-macosx', _formatKey([...COMMON_KEY_BINDINGS, ...MAC_ONLY_KEY_BINDINGS], MAC_OSX_KEY), true, commentNote], ]); if (!filePathExist(targetPath)) {