chore: editor ruler line length will be used for prettier default line length

Author: abose

src-node/package-lock.json

@@ -39,6 +39,8 @@ define(function (require, exports, module) {
         CLOSE_BRACKETS    = "closeBrackets",
         AUTO_HIDE_SEARCH  = "autoHideSearch";
 
+    let currentMaxLineLength = 120;
+
     const PREFERENCES_EDITOR_RULERS = "editor.rulers",
         PREFERENCES_EDITOR_RULER_COLORS = "editor.rulerColors",
         PREFERENCES_EDITOR_RULERS_ENABLED = "editor.rulersEnabled";
@@ -165,11 +167,21 @@ define(function (require, exports, module) {
             _createRulers(newActiveEditor);
         });
         PreferencesManager.on("change", PREFERENCES_EDITOR_RULERS_ENABLED, _resetRulers);
-        PreferencesManager.on("change", PREFERENCES_EDITOR_RULERS, _resetRulers);
+        PreferencesManager.on("change", PREFERENCES_EDITOR_RULERS, ()=>{
+            const rulerColumns = PreferencesManager.get(PREFERENCES_EDITOR_RULERS) || [];
+            currentMaxLineLength = rulerColumns.length ? Math.max(...rulerColumns) : 120;
+            _resetRulers();
+        });
         PreferencesManager.on("change", PREFERENCES_EDITOR_RULER_COLORS, _resetRulers);
         ThemeManager.on(ThemeManager.EVENT_THEME_CHANGE, _handleThemeChange);
         _resetRulers();
     }
 
+    function getMaxLineLength() {
+        return currentMaxLineLength;
+    }
+
     AppInit.appReady(_init);
+
+    exports.getMaxLineLength = getMaxLineLength;
 });

src/editor/EditorOptionHandlers.js

@@ -53,11 +53,11 @@ define(function (require, exports, module) {
         BeautificationManager = brackets.getModule("features/BeautificationManager"),
         PreferencesManager  = brackets.getModule("preferences/PreferencesManager"),
         Editor = brackets.getModule("editor/Editor").Editor,
+        EditorOptionHandlers = brackets.getModule("editor/EditorOptionHandlers"),
         ExtensionsWorker = brackets.getModule("worker/ExtensionsWorker");
 
     const prefs = PreferencesManager.getExtensionPrefs("beautify");
     prefs.definePreference("options", "object", {
-        printWidth: 120,
         semi: true,
         trailingComma: "none",
         singleQuote: false,
@@ -226,14 +226,16 @@ define(function (require, exports, module) {
                 return;
             }
 
-            let options = prefs.get("options");
+            let options = _clone(prefs.get("options"));
             let indentWithTabs = Editor.getUseTabChar(filepath);
+            const printWidth = options.printWidth || EditorOptionHandlers.getMaxLineLength();
             options._usePlugin = parsersForLanguage[languageId];
             Object.assign(options, {
                 parser: parsersForLanguage[languageId],
                 tabWidth: indentWithTabs ? Editor.getTabSize() : Editor.getSpaceUnits(),
                 useTabs: indentWithTabs,
                 filepath: filepath,
+                printWidth: printWidth,
                 endOfLine: "lf" // codemirror always does lf and only crlf before disk write in windows.
             });
             let prettierParams ={

src/extensions/default/Phoenix-prettier/main.js

@@ -27,6 +27,7 @@ define(function (require, exports, module) {
     let SpecRunnerUtils = brackets.getModule("spec/SpecRunnerUtils"),
         Editor = brackets.getModule("editor/Editor").Editor,
         FileUtils = brackets.getModule('file/FileUtils'),
+        PreferencesManager  = brackets.getModule("preferences/PreferencesManager"),
         BeautificationManager = brackets.getModule("features/BeautificationManager");
 
     const PLATFORM_LINE_ENDINGS = (FileUtils.getPlatformLineEndings() === 'CRLF' ? "\r\n" : "\n");
@@ -35,6 +36,7 @@ define(function (require, exports, module) {
 
     const jsFile = require("text!../../../../test/spec/prettier-test-files/js/test.js"),
         jsPrettyFile = require("text!../../../../test/spec/prettier-test-files/js/test-pretty.js"),
+        jsPrettyRulerFile = require("text!../../../../test/spec/prettier-test-files/js/test-pretty-ruler.js"),
         jsPrettySelection = require("text!../../../../test/spec/prettier-test-files/js/test-pretty-selection.js"),
         jsPrettySelectionOffset = require("text!../../../../test/spec/prettier-test-files/js/test-pretty-selection-offset.js"),
         jsPrettySingleSpace = require("text!../../../../test/spec/prettier-test-files/js/test-pretty-single-space.js"),
@@ -81,6 +83,34 @@ define(function (require, exports, module) {
                 expect(testEditor.document.getText(true)).toBe(jsPrettyFile);
             });
 
+            it("should use line max length from editor rulers by default", async function () {
+                const PREFERENCES_EDITOR_RULERS = "editor.rulers";
+                PreferencesManager.set(PREFERENCES_EDITOR_RULERS, [10, 20]);
+                createMockEditor(jsFile, "javascript", "/test.js");
+                await BeautificationManager.beautifyEditor(testEditor);
+                expect(testEditor.document.getText(true)).toBe(jsPrettyRulerFile);
+                PreferencesManager.set(PREFERENCES_EDITOR_RULERS, [120]); // restore default
+            });
+
+            it("should prioritise line max length from prettier options above editor rulers", async function () {
+                // here we set prettier options to 20 line width and ruler options to 120 chars. the prettier override
+                // should take preference above ruler config
+                const PREFERENCES_EDITOR_RULERS = "editor.rulers";
+                PreferencesManager.set(PREFERENCES_EDITOR_RULERS, [120]);
+                createMockEditor(jsFile, "javascript", "/test.js");
+                await BeautificationManager.beautifyEditor(testEditor);
+                expect(testEditor.document.getText(true)).toBe(jsPrettyFile);
+                // now override the prettier prefs
+                const extPrefs = PreferencesManager.getExtensionPrefs("beautify");
+                const originalPrefs = structuredClone(extPrefs.get("options"));
+                const newPrefs = structuredClone(originalPrefs);
+                newPrefs.printWidth = 20;
+                extPrefs.set("options", newPrefs);
+                await BeautificationManager.beautifyEditor(testEditor);
+                expect(testEditor.document.getText(true)).toBe(jsPrettyRulerFile);
+                extPrefs.set("options", originalPrefs);
+            });
+
             it("should beautify editor respect space options for js", async function () {
                 createMockEditor(jsFile, "javascript", "/test.js");
                 Editor.setUseTabChar(false);

src/extensions/default/Phoenix-prettier/unittests.js

@@ -213,6 +213,7 @@ define(function (require, exports, module) {
     require("thirdparty/lodash");
     require("thirdparty/jszip");
     require("editor/CodeHintManager");
+    require("editor/EditorOptionHandlers");
     require("utils/Global");
     require("command/Menus");
     require("utils/NodeDomain");

test/SpecRunner.js

@@ -0,0 +1,17 @@
+function hello() {
+    console.log(
+        "hello"
+    );
+}
+
+function world() {
+    console.log(
+        "world"
+    );
+}
+
+function yo() {
+    console.log(
+        "yo"
+    );
+}