Editorconfig support

.editorconfig

@@ -1,12 +1,21 @@
-[*.d]
-end_of_line = lf
-insert_final_newline = true
-indent_size = 4
-tab_width = 8
-trim_trailing_whitespace = true
-indent_style = space
-
 [*]
 trim_trailing_whitespace = true
 end_of_line = lf
 insert_final_newline = true
+
+[*.d]
+dfmt_align_switch_statements = true
+dfmt_brace_style = otbs
+dfmt_outdent_attributes = true
+dfmt_outdent_labels = true
+dfmt_soft_max_line_length = 80
+dfmt_space_after_cast = true
+dfmt_space_after_keywords = true
+dfmt_split_operator_at_line_end = false
+end_of_line = lf
+indent_size = 8
+indent_style = tab
+insert_final_newline = true
+max_line_length = 120
+tab_width = 8
+trim_trailing_whitespace = true

README.md

@@ -25,6 +25,32 @@ file instead, and output will be written to ```stdout```.
   placing opening braces on their own line. This is the default.
 * ```--tabs```: Use tabs for indentation instead of spaces.
 
+## Configuration
+**dfmt** uses [EditorConfig](http://editorconfig.org/) configuration files.
+**dfmt**-specific properties are prefixed with *dfmt_*.
+### Standard EditorConfig properties
+Property Name | Allowed Values | Default Value | Description
+--------------|----------------|---------------|------------
+end_of_line | | TODO | Not yet supported
+insert_final_newline | | `true` | Not supported. **dfmt** always inserts a final newline
+charset | | `UTf-8` | Not supported. **dfmt** only works correctly on UTF-8.
+indent_style | `tab`, `space` | `space` | Supported
+indent_size | positive integers | `4` | Supported
+tab_width | positive integers | `8` | Supported
+trim_trailing_whitespace | | `true` | Not supported. **dfmt** does not emit trailing whitespace
+max_line_length | positive integers | `120` | Supported
+### dfmt-specific properties
+Property Name | Allowed Values | Default Value | Description
+--------------|----------------|---------------|------------
+dfmt_brace_style | `allman`, `otbs`, or `stroustrup` | https://en.wikipedia.org/wiki/Brace_style
+dfmt_soft_max_line_length | positive integers | The formatting process will usually keep lines below this length, but they may be up to max_line_length columns long.
+dfmt_outdent_labels (Not yet implemented) | `true`, `false` | Decrease the indentation of labels
+dfmt_align_switch_statements (Not yet implemented) | `true`, `false` | Align labels, cases, and defaults with their enclosing switch
+dfmt_outdent_attributes (Not yet implemented) | `true`, `false` | Decrease the indentation level of attributes
+dfmt_split_operator_at_line_end (Not yet implemented) | `true`, `false` | Place operators on the end of the previous line when splitting lines
+dfmt_space_after_cast (Not yet implemented) | `true`, `false` | Insert space after the closing paren of a `cast` expression
+dfmt_space_after_keywords (Not yet implemented) | `true`, `false` | Insert space after `if`, `while`, `foreach`, etc, and before the `(`
+
 ## Terminology
 * Braces - `{` and `}`
 * Brackets - `[` and `]`

src/dfmt/config.d

@@ -5,9 +5,12 @@
 
 module dfmt.config;
 
+import dfmt.editorconfig;
+
 /// Brace styles
 enum BraceStyle
 {
+    unspecified,
     /// $(LINK https://en.wikipedia.org/wiki/Indent_style#Allman_style)
     allman,
     /// $(LINK https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS)
@@ -16,76 +19,42 @@ enum BraceStyle
     stroustrup
 }
 
-/// Newline styles
-enum Newlines
-{
-    /// Old Mac
-    cr,
-    /// UNIX, Linux, BSD, New Mac, iOS, Android, etc...
-    lf,
-    /// Windows
-    crlf
-}
-
-template getHelp(alias S)
-{
-    enum getHelp = __traits(getAttributes, S)[0].text;
-}
-
 /// Configuration options for formatting
 struct Config
 {
     ///
-    @Help("Number of spaces used for indentation")
+    OptionalBoolean dfmt_align_switch_statements = OptionalBoolean.t;
-    uint indentSize = 4;
-
     ///
-    @Help("Use tabs or spaces")
+    BraceStyle dfmt_brace_style = BraceStyle.allman;
-    bool useTabs = false;
-
     ///
-    @Help("Size of a tab character")
+    OptionalBoolean dfmt_outdent_attributes = OptionalBoolean.t;
-    uint tabSize = 4;
-
     ///
-    @Help("Soft line wrap limit")
+    OptionalBoolean dfmt_outdent_labels = OptionalBoolean.t;
-    uint columnSoftLimit = 80;
-
     ///
-    @Help("Hard line wrap limit")
+    int dfmt_soft_max_line_length = 80;
-    uint columnHardLimit = 120;
-
     ///
-    @Help("Brace style can be 'otbs', 'allman', or 'stroustrup'")
+    OptionalBoolean dfmt_space_after_cast = OptionalBoolean.t;
-    BraceStyle braceStyle = BraceStyle.allman;
-
     ///
-    @Help("Align labels, cases, and defaults with their enclosing switch")
+    OptionalBoolean dfmt_space_after_keywords = OptionalBoolean.t;
-    bool alignSwitchStatements = true;
-
     ///
-    @Help("Decrease the indentation of labels")
+    OptionalBoolean dfmt_split_operator_at_line_end = OptionalBoolean.f;
-    bool outdentLabels = true;
 
-    ///
+    mixin StandardEditorConfigFields;
-    @Help("Decrease the indentation level of attributes")
-    bool outdentAttributes = true;
 
-    ///
-    @Help("Place operators on the end of the previous line when splitting lines")
-    bool splitOperatorAtEnd = false;
 
-    ///
+    /**
-    @Help("Insert spaces after the closing paren of a cast expression")
+     * Initializes the standard EditorConfig properties with default values that
-    bool spaceAfterCast = true;
+     * make sense for D code.
-
+     */
-    ///
+    void initializeWithDefaults()
-    @Help("Newline style can be 'cr', 'lf', or 'crlf'")
+    {
-    Newlines newlineType;
+		pattern = "*.d";
-
+        end_of_line = EOL.lf;
-    ///
+        indent_style = IndentStyle.space;
-    @Help("Insert spaces after 'if', 'while', 'foreach', etc, and before the '('")
+        indent_size = 4;
-    bool spaceAfterBlockKeywords;
+        tab_width = 4;
+        max_line_length = 120;
+    }
 
     /**
      * Returns:
@@ -95,7 +64,7 @@ struct Config
     {
         import std.stdio : stderr;
 
-        if (columnSoftLimit > columnHardLimit)
+        if (dfmt_soft_max_line_length > max_line_length)
         {
             stderr.writeln("Column hard limit must be greater than or equal to column soft limit");
             return false;
@@ -103,30 +72,3 @@ struct Config
         return true;
     }
 }
-
-/**
- * Reads arguments from a file at the given path into the given string array
- */
-void readConfig(string path, ref string[] args)
-{
-    import std.stdio : File;
-    import std.file : exists;
-    import std.array : empty, RefAppender;
-
-    if (!exists(path))
-        return;
-    auto f = File(path);
-
-    auto app = RefAppender!(string[])(&args);
-
-	import std.algorithm : map, copy, sort, uniq, filter;
-
-	foreach (a; f.byLine().filter!(a => !a.empty).map!(a => a.idup))
-		app.put(a);
-    app.data[1 .. $].sort();
-}
-
-private struct Help
-{
-    string text;
-}

src/dfmt/editorconfig.d

@@ -155,13 +155,3 @@ private EC[] parseConfig(EC)(string dir)
     sections ~= section;
     return sections;
 }
-
-version (editorconfig_main) void main()
-{
-	import std.stdio : writeln;
-
-	static struct EditorConfig { mixin StandardEditorConfigFields; }
-
-	auto c = getConfigFor!EditorConfig("/home/brian/src/aias/src/dummy.d");
-	writeln(c);
-}

src/dfmt/formatter.d

@@ -321,7 +321,7 @@ private:
                 }
                 assert(lengthOfNextChunk > 0);
                 writeToken();
-                if (currentLineLength + 1 + lengthOfNextChunk >= config.columnSoftLimit)
+                if (currentLineLength + 1 + lengthOfNextChunk >= config.dfmt_soft_max_line_length)
                 {
                     pushWrapIndent(tok!",");
                     newline();
@@ -359,7 +359,7 @@ private:
         }
         else if (!currentIs(tok!")") && !currentIs(tok!"]")
                 && (linebreakHints.canFindIndex(index - 1) || (linebreakHints.length == 0
-                && currentLineLength > config.columnHardLimit)))
+                && currentLineLength > config.max_line_length)))
         {
             pushWrapIndent(p);
             newline();
@@ -455,7 +455,7 @@ private:
     {
         if ((parenDepth > 0 && sBraceDepth == 0) || (sBraceDepth > 0 && niBraceDepth > 0))
         {
-            if (currentLineLength > config.columnSoftLimit)
+            if (currentLineLength > config.dfmt_soft_max_line_length)
             {
                 writeToken();
                 pushWrapIndent(tok!";");
@@ -488,7 +488,7 @@ private:
             auto e = expressionEndIndex(index);
             immutable int l = currentLineLength + tokens[index .. e].map!(a => tokenLength(a)).sum();
             writeToken();
-            if (l > config.columnSoftLimit)
+            if (l > config.dfmt_soft_max_line_length)
             {
                 indents.push(tok!"{");
                 newline();
@@ -504,7 +504,7 @@ private:
             auto e = expressionEndIndex(index);
             immutable int l = currentLineLength + tokens[index .. e].map!(a => tokenLength(a)).sum();
             writeToken();
-            if (l > config.columnSoftLimit)
+            if (l > config.dfmt_soft_max_line_length)
             {
                 indents.push(tok!"{");
                 newline();
@@ -520,7 +520,7 @@ private:
             if (!justAddedExtraNewline && !peekBackIsOneOf(false, tok!"{",
                     tok!"}", tok!";", tok!";"))
             {
-                if (config.braceStyle != BraceStyle.allman)
+                if (config.dfmt_brace_style != BraceStyle.allman)
                 {
                     if (!astInformation.structInitStartLocations.canFindIndex(tokens[index].index)
                             && !astInformation.funLitStartLocations.canFindIndex(
@@ -583,7 +583,7 @@ private:
                 currentLineLength = 0;
                 justAddedExtraNewline = true;
             }
-            if (config.braceStyle == BraceStyle.otbs && currentIs(tok!"else"))
+            if (config.dfmt_brace_style == BraceStyle.otbs && currentIs(tok!"else"))
                 write(" ");
             if (!peekIs(tok!",") && !peekIs(tok!")") && !peekIs(tok!";"))
             {
@@ -788,7 +788,7 @@ private:
             break;
         case tok!".":
             if (linebreakHints.canFind(index) || (linebreakHints.length == 0
-                    && currentLineLength + nextTokenLength() > config.columnHardLimit))
+                    && currentLineLength + nextTokenLength() > config.max_line_length))
             {
                 pushWrapIndent();
                 newline();
@@ -869,7 +869,7 @@ private:
             newline();
         }
         else if (!peekIs(tok!"}") && (linebreakHints.canFind(index)
-                || (linebreakHints.length == 0 && currentLineLength > config.columnSoftLimit)))
+                || (linebreakHints.length == 0 && currentLineLength > config.dfmt_soft_max_line_length)))
         {
             writeToken();
             pushWrapIndent(tok!",");
@@ -1072,15 +1072,16 @@ private:
 
     void indent()
     {
-        if (config.useTabs)
+        import dfmt.editorconfig : IndentStyle;
+        if (config.indent_style == IndentStyle.tab)
             foreach (i; 0 .. indentLevel)
             {
-                currentLineLength += config.tabSize;
+                currentLineLength += config.tab_width;
                 output.put("\t");
             }
         else
             foreach (i; 0 .. indentLevel)
-                foreach (j; 0 .. config.indentSize)
+                foreach (j; 0 .. config.indent_size)
                 {
                     output.put(" ");
                     currentLineLength++;

src/dfmt/main.d

@@ -12,93 +12,57 @@ else
 {
     import std.array : front, popFront;
     import std.stdio : stdout, stdin, stderr, writeln, File;
-    import dfmt.config : Config, getHelp, readConfig;
+    import dfmt.config : Config;
     import dfmt.formatter : format;
     import std.path : buildPath, expandTilde;
+    import dfmt.editorconfig : getConfigFor;
+    import std.getopt : getopt;
 
     int main(string[] args)
     {
         bool inplace = false;
-        Config config;
+        Config optConfig;
-        string configPath = expandTilde("~/.config/dfmt/dfmtrc");
+        optConfig.pattern = "*.d";
-        readConfig(configPath, args);
-
-        static if (__VERSION__ >= 2067)
-        {
-            import std.getopt : getopt, defaultGetoptPrinter;
-            auto getOptResult = getopt(args,
-                "inplace", "Modify files in-place", &inplace,
-                "tabs|t", getHelp!(Config.useTabs), &config.useTabs,
-                "braces", getHelp!(Config.braceStyle), &config.braceStyle,
-                "colSoft", getHelp!(Config.columnSoftLimit), &config.columnSoftLimit,
-                "colHard", getHelp!(Config.columnHardLimit), &config.columnHardLimit,
-                "tabSize", getHelp!(Config.tabSize), &config.tabSize,
-                "indentSize", getHelp!(Config.indentSize), &config.indentSize,
-                "alignSwitchCases", getHelp!(Config.alignSwitchStatements), &config.alignSwitchStatements,
-                "outdentLabels", getHelp!(Config.outdentLabels), &config.outdentLabels,
-                "outdentAttributes", getHelp!(Config.outdentAttributes), &config.outdentAttributes,
-                "splitOperatorAtEnd", getHelp!(Config.splitOperatorAtEnd), &config.splitOperatorAtEnd,
-                "spaceAfterCast", getHelp!(Config.spaceAfterCast), &config.spaceAfterCast,
-                "newlineType", getHelp!(Config.newlineType), &config.newlineType,
-                "spaceAfterBlockKeywords", getHelp!(Config.spaceAfterBlockKeywords), &config.spaceAfterBlockKeywords);
-
-            if (getOptResult.helpWanted)
-            {
-                defaultGetoptPrinter("dfmt 0.3.0-dev\n\nOptions:", getOptResult.options);
-                return 0;
-            }
-        }
-        else
-        {
-            import std.getopt : getopt;
         bool showHelp;
         getopt(args,
+            "align_switch_statements", &optConfig.dfmt_align_switch_statements,
+            "brace_style", &optConfig.dfmt_brace_style,
+            "end_of_line", &optConfig.end_of_line,
             "help|h", &showHelp,
+            "indent_size", &optConfig.indent_size,
+            "indent_style|t", &optConfig.indent_style,
             "inplace", &inplace,
-                "tabs|t", &config.useTabs,
+            "max_line_length", &optConfig.max_line_length,
-                "braces", &config.braceStyle,
+            "max_line_length", &optConfig.max_line_length,
-                "colSoft", &config.columnSoftLimit,
+            "outdent_attributes", &optConfig.dfmt_outdent_attributes,
-                "colHard", &config.columnHardLimit,
+            "outdent_labels", &optConfig.dfmt_outdent_labels,
-                "tabSize", &config.tabSize,
+            "space_after_cast", &optConfig.dfmt_space_after_cast,
-                "indentSize", &config.indentSize,
+            "split_operator_at_line_end", &optConfig.dfmt_split_operator_at_line_end,
-                "alignSwitchCases", &config.alignSwitchStatements,
+            "tab_width", &optConfig.tab_width);
-                "outdentLabels", &config.outdentLabels,
+
-                "outdentAttributes", &config.outdentAttributes,
-                "splitOperatorAtEnd", &config.splitOperatorAtEnd,
-                "spaceAfterCast", &config.spaceAfterCast,
-                "newlineType", &config.newlineType);
         if (showHelp)
         {
-                writeln(`dfmt 0.3.0-dev
+            printHelp();
-
-Options:
-    --help | -h            Print this help message
-    --inplace              Edit files in place
-    --tabs | -t            Use tabs instead of spaces
-    --braces               Brace style can be 'otbs', 'allman', or 'stroustrup'
-    --colSoft              Column soft limit
-    --colHard              Column hard limit
-    --tabSize              Size of tabs
-    --indentSize           Number of spaces used for indentation
-    --alignSwitchCases     Align cases, defaults, and labels with enclosing
-                           switches
-    --outdentLabels        Outdent labels
-    --outdentAttributes    Outdent attribute declarations
-    --splitOperatorAtEnd   Place operators at the end of the previous line when
-                           wrapping
-    --spaceAfterCast       Insert spaces after cast expressions
-    --newlineType          Newline type can be 'cr', 'lf', or 'crlf'`);
             return 0;
         }
-        }
+
+        args.popFront();
+        immutable bool readFromStdin = args.length == 0;
+        immutable string filePath = createFilePath(readFromStdin, readFromStdin ? null : args[0]);
+        Config config;
+        config.initializeWithDefaults();
+        Config fileConfig = getConfigFor!Config(filePath);
+        fileConfig.pattern = "*.d";
+        config.merge(fileConfig, filePath);
+        config.merge(optConfig, filePath);
 
         if (!config.isValid())
             return 1;
 
         File output = stdout;
         ubyte[] buffer;
-        args.popFront();
+
-        if (args.length == 0)
+        if (readFromStdin)
         {
             ubyte[4096] inputBuffer;
             ubyte[] b;
@@ -142,3 +106,46 @@ Options:
         return 0;
     }
 }
+
+private void printHelp()
+{
+    writeln(`dfmt 0.3.0-dev
+
+Options:
+    --help | -h            Print this help message
+    --inplace              Edit files in place
+
+Formatting Options:
+    --align_switch_statements
+    --brace_style
+    --end_of_line
+    --help|h
+    --indent_size
+    --indent_style|t
+    --inplace
+    --max_line_length
+    --max_line_length
+    --outdent_attributes
+    --outdent_labels
+    --space_after_cast
+    --split_operator_at_line_end`);
+}
+
+private string createFilePath(bool readFromStdin, string fileName)
+//out (result)
+//{
+//    stderr.writeln(__FUNCTION__, ": ", result);
+//}
+//body
+{
+    import std.file : getcwd;
+    import std.path : isRooted;
+
+    immutable string cwd = getcwd();
+    if (readFromStdin)
+        return buildPath(cwd, "dummy.d");
+    if (isRooted(fileName))
+        return fileName;
+    else
+        return buildPath(cwd, fileName);
+}

src/dfmt/wrapping.d

@@ -18,7 +18,7 @@ struct State
         import core.bitop : popcnt, bsf;
         import std.algorithm : min, map, sum;
 
-        immutable int remainingCharsMultiplier = config.columnHardLimit - config.columnSoftLimit;
+        immutable int remainingCharsMultiplier = config.max_line_length - config.dfmt_soft_max_line_length;
         immutable int newlinePenalty = remainingCharsMultiplier * 20;
 
         this.breaks = breaks;
@@ -29,9 +29,9 @@ struct State
         if (breaks == 0)
         {
             immutable int l = currentLineLength + tokens.map!(a => tokenLength(a)).sum();
-            if (l > config.columnSoftLimit)
+            if (l > config.dfmt_soft_max_line_length)
             {
-                immutable int longPenalty = (l - config.columnSoftLimit) * remainingCharsMultiplier;
+                immutable int longPenalty = (l - config.dfmt_soft_max_line_length) * remainingCharsMultiplier;
                 this._cost += longPenalty;
                 this._solved = longPenalty < newlinePenalty;
             }
@@ -58,18 +58,18 @@ struct State
                 immutable uint bits = b ? 0 : bsf(k);
                 immutable size_t j = min(i + bits + 1, tokens.length);
                 ll += tokens[i .. j].map!(a => tokenLength(a)).sum();
-                if (ll > config.columnSoftLimit)
+                if (ll > config.dfmt_soft_max_line_length)
                 {
-                    immutable int longPenalty = (ll - config.columnSoftLimit) * remainingCharsMultiplier;
+                    immutable int longPenalty = (ll - config.dfmt_soft_max_line_length) * remainingCharsMultiplier;
                     this._cost += longPenalty;
                 }
-                if (ll > config.columnHardLimit)
+                if (ll > config.max_line_length)
                 {
                     this._solved = false;
                     break;
                 }
                 i = j;
-                ll = indentLevel * config.indentSize;
+                ll = indentLevel * config.indent_size;
                 if (b)
                     break;
             }

tests/test.sh

@@ -6,7 +6,7 @@ do
 	for source in *.d
 	do
 		echo "${source}.ref" "${braceStyle}/${source}.out"
-		../bin/dfmt --braces=${braceStyle} "${source}" > "${braceStyle}/${source}.out"
+		../bin/dfmt --brace_style=${braceStyle} "${source}" > "${braceStyle}/${source}.out"
 		diff -u "${braceStyle}/${source}.ref" "${braceStyle}/${source}.out"
 	done
 done