This came up in a discussion with @justinseanmartin the other day. Rather than pulling this in as a submodule in newer projects, might be nice to have a pod.

CC @dnkoutso @alanf @dfed

Hey there, I'm not amazing on my bash skills, so please double check me, but this should be checking for the existence of the $FISH_VERSION env var, and then offering different instructions.

A follow-up from #30 and #32. clang-format 3.7 and 3.8 have some pretty significant differences in how they do block formatting. The changes appear to be by design, but I disagree pretty strongly with the design (see also this clang Bugzilla bug). I've attached two files showing the difference between 3.7 and 3.8. 3.8 is extremely aggressive about block indentation, regardless of settings.

format-test-3.8.txt format-test-3.7.txt

I made a custom build of clang-format that reverts or adds options for the behaviors that cause this change in block formatting behavior (my clang fork at https://github.com/ksuther/clang/tree/clang-format-customization and my spacecommander fork at https://github.com/ksuther/spacecommander/commit/af9708b32bcc36ebc99a4e8e5b569ba2a0dcba20).

For anyone wondering "upgrade at all?" 3.7 has a number of bugs that have been fixed. The big one is that formatting inside blocks was broken in 3.7, and fixed in 3.8 (I believe this is what #30 is about). Some small ones that I've noticed in my own code have to do with Obj-C literals, handling casting inside Obj-C literals, and general handling of parentheses in Obj-C.

I can't tell if this is Bash witchcraft, or intended behaviour, or what.

Looking at https://github.com/square/spacecommander/blob/master/lib/common-lib.sh#L12, we see that directories_to_check() replaces spaces (' ') with escaped spaces ('\ ') via a sed command, which seems like a good idea Because Bash™.

BUT tracing the output, it seems that Bash will automatically quote the paths automatically (?!), and as such it will be looking for a string with a literal '\' in its path. Obviously it won't find that!

Detail

I've cut the .formatting-directory down to the following:

Clue/Tests
Clue/Clue WatchKit Extension

Then running the format-objc-files-in-repo.sh, I get the following output:

$ Submodules/spacecommander/format-objc-files-in-repo.sh
+ IFS='
'
++ date +%s
+ start_date=1446651719
+ export CDPATH=
+ CDPATH=
+++ dirname Submodules/spacecommander/format-objc-files-in-repo.sh
++ cd Submodules/spacecommander
++ pwd
+ DIR=/Users/joshua/dev/work/Clue/wheel-iOS/Submodules/spacecommander
+ source /Users/joshua/dev/work/Clue/wheel-iOS/Submodules/spacecommander/lib/common-lib.sh
++ IFS='
'
++ all_valid_objc_files_in_repo
++ directories_to_check
++ locations_to_diff=
++ '[' -e .formatting-directory ']'
+++ cat .formatting-directory
+++ sed 's/ /\\ /g'
++ locations_to_diff='Clue/Tests
Clue/Clue\ WatchKit\ Extension'
+++ git ls-tree --name-only --full-tree -r HEAD -- Clue/Tests 'Clue/Clue\ WatchKit\ Extension'
+++ grep -e '\.m$' -e '\.mm$' -e '\.h$' -e '\.hh$'
++ files='Clue/Tests/BWAPICredentialServiceTest.m
Clue/Tests/BWAPIRequestOperationManagerTest.m
Clue/Tests/BWAPIServiceTest.m
...
Clue/Tests/TagParsingTest.m'
++ grep -v Pods/
++ grep -v Carthage/
+ objc_files='Clue/Tests/BWAPICredentialServiceTest.m
Clue/Tests/BWAPIRequestOperationManagerTest.m
Clue/Tests/BWAPIServiceTest.mtionManagerTest.m
Clue/Tests/BWAPIServiceTest.m
...
Clue/Tests/TagParsingTest.m'
+ '[' -z 'Clue/Tests/BWAPICredentialServiceTest.m
Clue/Tests/BWAPIRequestOperationManagerTest.m
Clue/Tests/BWAPIServiceTest.m
...
Clue/Tests/TagParsingTest.m' ']'
...
+ '[' -z '' ']'
++ date +%s
+ end_date=1446651719
+ time_diff=0
+ echo '0 minutes and 0 seconds to format objc.'
0 minutes and 0 seconds to format objc.
+ exit 0

Specifically the lines:

++ locations_to_diff='Clue/Tests
Clue/Clue\ WatchKit\ Extension'
+++ git ls-tree --name-only --full-tree -r HEAD -- Clue/Tests 'Clue/Clue\ WatchKit\ Extension'

See the escaping in the quoted string? That's not the best of situations :crocodile:

The fix I'm using, but I can't tell if it's a totally stupid idea (or else I'd send a PR!) is to remove the sed, and then I get the output as expected:

...
++ '[' -e .formatting-directory ']'
+++ cat .formatting-directory
++ locations_to_diff='Clue/Tests
Clue/Clue WatchKit Extension'
+++ git ls-tree --name-only --full-tree -r HEAD -- Clue/Tests 'Clue/Clue WatchKit Extension'
...
++ files='Clue/Clue WatchKit Extension/BWWKEApplication.h
Clue/Clue WatchKit Extension/BWWKEApplication.m
Clue/Tests/BWAPICredentialServiceTest.m
Clue/Tests/BWAPIRequestOperationManagerTest.m
...

So basically..

Can we drop that sed command and trust Bash to do the Right Thing™? Is that a flag option, a version thing, an OS thing?

• Commit hook was missing shebang
• Commit hook wasn't working correctly with spaces in the repository path
• .clang-format is no longer overwritten with a symlink if it exists already
• .clang-format is no longer added to .gitignore if it's already part of the git tree

I've got my block formatted like this

[deviceManager syncDatasByIndexes:indexes finish:^{
[self doSomething]; // not formatted
}];

or this way:

[deviceManager syncDatasByIndexes:indexes
[deviceManager syncDatasByIndexes
                           finish:^{
  [self doSomething]; // not formatted
                           }];

Should I change the .clang-format "Language" value? Or this feature hasn't supported yet?

Currently it outputs the quotes:

🚸 Format and stage individual files:
"/Users/cwoodward/Development/register/Pods/SpaceCommander"/format-objc-file.sh 'Frameworks/SquarePOS/Sources/OpenTicket/UI/RQParentOpenTicketsViewController.m' && git add 'Frameworks/SquarePOS/Sources/OpenTicket/UI/RQParentOpenTicketsViewController.m';

🚀  Format and stage all affected files:
	 "/Users/cwoodward/Development/register/Pods/SpaceCommander"/format-objc-files.sh -s

🔴  There were formatting issues with this commit, run the👆 above👆 command to fix.
💔  Commit anyway and skip this check by running git commit --no-verify

After fix:

🚸 Format and stage individual files:
/Users/cwoodward/Development/register/Pods/SpaceCommander/format-objc-file.sh 'Frameworks/SquarePOS/Sources/OpenTicket/UI/RQParentOpenTicketsViewController.m' && git add 'Frameworks/SquarePOS/Sources/OpenTicket/UI/RQParentOpenTicketsViewController.m';

🚀  Format and stage all affected files:
	 /Users/cwoodward/Development/register/Pods/SpaceCommander/format-objc-files.sh -s

🔴  There were formatting issues with this commit, run the👆 above👆 command to fix.
💔  Commit anyway and skip this check by running git commit --no-verify

common-lib.sh will now ignore files in directories listed in .formatting-directories-ignore. Included usage under the configuration section in the README.

Related issue: https://github.com/square/spacecommander/issues/49

common-lib.sh will now check .formatting-directory for multiple lines. This makes it easier to support the standard Xcode project format where there's one directory per target.

Ideally I'd be able to exclude individual directories or files, but this is a pretty good solution and works without any other changes.

Consider the following method signature:

+ (void)swapImplementationOf:(SEL)old with:(SEL)new
{
    // ...
}

For some reason the use of the word new triggers a space being inserted before it:

-+ (void)swapImplementationOf:(SEL)old with:(SEL)new
++ (void)swapImplementationOf:(SEL)old with:(SEL) new

This doesn’t seem to be a configurable option, so it appears to be a bug. I did a quick search through the codebase but couldn’t find anything related to new, so at least filing a ticket for now.

I’m working around it for now by renaming the parameter.

If you have this block of code:

[system presentViewControllerWithClass:[TAFOutboundSearchResultsViewController class]
                    configurationBlock:^(TAFOutboundSearchResultsViewController *outboundSearchResultsViewController) {
// TODO: Fill In Code Here
}];

When you run the formatter, it converts the block of code to this:

[system presentViewControllerWithClass:[TAFOutboundSearchResultsViewController class]
                    configurationBlock:^(TAFOutboundSearchResultsViewController *outboundSearchResultsViewController) {
// TODO: Fill In Code Here
                    }];

This issue existed in the past when I was just using a .clang-format file and the clang-format command-line tool, so I think fixing this is more of a feature request than an actual bug. Thanks again for fixing #10.

Bumps addressable from 2.7.0 to 2.8.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps tzinfo from 1.2.8 to 1.2.10.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps cocoapods-downloader from 1.4.0 to 1.6.3.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Given the following code in a header:

typedef NS_ENUM(NSUInteger, MyEnum) {
    MyEnumValueA,
    MyEnumValueB,
    MyEnumValueC,
};

extern NSString *MyEnumGetDescription(MyEnum value) NS_SWIFT_NAME(getter:MyEnum.description(self:));

running format-objc-file.sh will result in this:

typedef NS_ENUM(NSUInteger, MyEnum) {
    MyEnumValueA,
    MyEnumValueB,
    MyEnumValueC,
};

extern NSString *MyEnumGetDescription(MyEnum value) NS_SWIFT_NAME(getter
                                                                  : MyEnum.description(self:));

which is invalid, and throws a warning in Xcode:

'swift_name' attribute has invalid identifier for context name`

here's the .clang-format used when running against this code:

---
IndentNestedBlocks: false
AllowNewlineBeforeBlockParameter: false

Language:        Cpp
AccessModifierOffset: -1
ConstructorInitializerIndentWidth: 4
SortIncludes: false

AlignAfterOpenBracket: true
AlignEscapedNewlinesLeft: true
AlignOperands: false
AlignTrailingComments: true

AllowAllParametersOfDeclarationOnNextLine: false
AllowShortBlocksOnASingleLine: false
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: true
AllowShortIfStatementsOnASingleLine: true
AllowShortFunctionsOnASingleLine: All
AllowShortLoopsOnASingleLine: true

AlwaysBreakAfterDefinitionReturnType: false
AlwaysBreakTemplateDeclarations: false
AlwaysBreakBeforeMultilineStrings: false

BreakBeforeBinaryOperators: None
BreakBeforeTernaryOperators: false
BreakConstructorInitializersBeforeComma: false

BinPackArguments: true
BinPackParameters: true
ColumnLimit: 0
ConstructorInitializerAllOnOneLineOrOnePerLine: true
DerivePointerAlignment: false
ExperimentalAutoDetectBinPacking: false
IndentCaseLabels: true
IndentWrappedFunctionNames: false
IndentFunctionDeclarationAfterType: false
MaxEmptyLinesToKeep: 2
KeepEmptyLinesAtTheStartOfBlocks: false
NamespaceIndentation: Inner
ObjCBlockIndentWidth: 4
ObjCSpaceAfterProperty: true
ObjCSpaceBeforeProtocolList: true
PenaltyBreakBeforeFirstCallParameter: 10000
PenaltyBreakComment: 300
PenaltyBreakString: 1000
PenaltyBreakFirstLessLess: 120
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 200
PointerAlignment: Right
SpacesBeforeTrailingComments: 1
Cpp11BracedListStyle: true
Standard:        Auto
IndentWidth:     4
TabWidth:        8
UseTab:          Never
BreakBeforeBraces: Custom
BraceWrapping: 
    AfterClass: true
    AfterControlStatement: false
    AfterEnum: false
    AfterFunction: true
    AfterNamespace: true
    AfterObjCDeclaration: true
    AfterStruct: false
    AfterUnion: false
    BeforeCatch: false
    BeforeElse: false
    IndentBraces: false

SpacesInParentheses: false
SpacesInSquareBrackets: false
SpacesInAngles:  false
SpaceInEmptyParentheses: false
SpacesInCStyleCastParentheses: false
SpaceAfterCStyleCast: false
SpacesInContainerLiterals: true
SpaceBeforeAssignmentOperators: true

ContinuationIndentWidth: 4
CommentPragmas:  '^ IWYU pragma:'
ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
SpaceBeforeParens: ControlStatements
DisableFormat:   false
...

This:

        NSDateComponents *todayComp = [calendar components:(NSCalendarUnitYear |
                                                            NSCalendarUnitMonth |
                                                            NSCalendarUnitDay |
                                                            NSCalendarUnitWeekday |
                                                            NSCalendarUnitHour |
                                                            NSCalendarUnitMinute |
                                                            NSCalendarUnitSecond)
                                                  fromDate:today];

gets formatted into this:

        NSDateComponents *todayComp = [calendar components:(NSCalendarUnitYear |
                                                            NSCalendarUnitMonth |
                                                            NSCalendarUnitDay |
                                                            NSCalendarUnitWeekday |
                                                            NSCalendarUnitHour |
                                                            NSCalendarUnitMinute |
                                                            NSCalendarUnitSecond);
                                                  fromDate:today];