Objective-C style checker

Cue

Last update: Feb 2, 2022

Related tags

Code Quality ocstyle

Overview

ocstyle

Objective-C style checker

Installation

pip install ocstyle

Example

If you have a file called test.m like this:

@implementation SomeClass

+(void) someMessage:(NSString*)subdomain {
    NSString *ShouldStartLowerCase;
    // ...
}

@end

and test.h like this:

@interface SomeClass

+ (void)someMessage:(NSString*)subdomain;

@property NSInteger value;

@end

You can check style like this:

$ ocstyle test.*
test.h
ERROR: 0:-97 [0] - ExpectedInterfaceDocInHeader - Interface requires /** documentation */
ERROR: 3:30 [51] - MissingSpace - Expected 1, got 0
ERROR: 5:1 [65] - ExpectedPropertyDocInHeader - Property requires /** documentation */

test.m
ERROR: 3:2 [28] - MissingSpace - Expected 1, got 0
ERROR: 3:9 [35] - ExtraSpace - Did not expect ' ' here
ERROR: 3:30 [56] - MissingSpace - Expected 1, got 0
ERROR: 3:42 [68] - MissingNewline - Should have newline after ;
ERROR: 3:42 [68] - MissingSemicolon - Expected a semicolon
ERROR: 4:35 [104] - BadLocalVariableName - Local variable must start with a lower case letter```

Goal

Make it easy to share and enforce style rules for Objective C. The less human time we spend thinking about whitespace and naming the better! Also enforces the existence of basic documentation.

At Cue we use this as a git pre-commit hook. This way we ensure everyone maintains a consistent coding style with a minimum of effort.

OCLint runs static analysis that helps to detect common logic errors. Use it alongside ocstyle!

Status

This is a pretty early stage project. We fully expect bugs and feature requests!

One notable absence is that right now style rules are not configurable. For example, we use the following style for message implementations:

+(void) someMessage:(NSString*)subdomain;
{
}

Note the inclusion of the ; and the { being on the next line. We like this style because it makes it easy to copy and paste from .h to .m and back, but maybe you have your own preferences. We'd be very happy to accept pull requests that make ocstyle more configurable.

For the motivated pull requesters out there, other notable TODOs include:

Allow inline disabling of specific errors.
Fix various whitespace false negatives noted in test files

License

Apache License version 2.0

Authors

Cue

You might also like...

Style Art library process images using COREML with a set of pre trained machine learning models and convert them to Art style.

StyleArt Style Art is a library that process images using COREML with a set of pre trained machine learning models and convert them to Art style. Prev

222 Dec 17, 2022

STPopup provides STPopupController, which works just like UINavigationController in popup style, for both iPhone and iPad. It's written in Objective-C and compatible with Swift.

STPopup STPopup provides STPopupController, which works just like UINavigationController in popup style, for both iPhone and iPad. It's written in Obj

2.6k Jan 6, 2023

Comments

Why does it expect newlines?
So I was looking at your example and I'm confused about something

So I copied in the text for test.m and kept fixing things until it ended up being this @implementation SomeClass

(void)someMessage:(NSString *)subdomain { NSString *shouldStartLowerCase; }

@end

But then you get the error

ERROR: 3:43 [69] - MissingNewline - Should have newline after ; ERROR: 3:43 [69] - MissingSemicolon - Expected a semicolon

Does it think that the .m file is a .h file or am I missing some kinda style that I don't fully comprehend here?
opened by HaloZero 2
Allow users to specify maximum line length on the command-line.

We use an 80 character line length at Maginatics, and I'd like ocstyle to enforce that. This pull request adds support for specifying the maximum line length on the command-line. I'm open to any suggestions and improvements you may have.

(Thanks for open-sourcing ocstyle! I'm a big believer in automating these sort of processes.)

opened by vibhav 1
Support for other code Format
I feel following is the more used standard code format for methods -

+ (void)someMessage:(NSString *)subdomain { }

Is it possible to select different coding style ?
opened by leapfrog-bishalghimire 3