Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Function Names #186

Closed
elbrujohalcon opened this issue Dec 15, 2014 · 7 comments
Closed

Function Names #186

elbrujohalcon opened this issue Dec 15, 2014 · 7 comments
Assignees
@kbaird
Labels
rule

Comments

@elbrujohalcon
Copy link
Member

We need a rule like the one we have for module names, but for function names (with a regular expression as the parameter and maybe a list of exceptions)
@kbaird
Copy link
Collaborator

kbaird commented Sep 24, 2015

Refer here for an exemplar: https://github.com/inaka/elvis/blob/master/src/elvis_style.erl#L151

macro_names only cares about uppercase, has no regex. Look also at ktn_code for functions to use as well.

@kbaird
Copy link
Collaborator

kbaird commented Sep 24, 2015

Add a file with improper function names in test_examples, make sure the new function complains appropriately.

@kbaird
Copy link
Collaborator

kbaird commented Sep 24, 2015

Uses Common Test, not EUnit.

@kbaird
Copy link
Collaborator

kbaird commented Sep 24, 2015

Ask here, or for more immediate feedback, http://inaka.net/hipchat

kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 25, 2015
[inaka#186] Add failing and passing test example files
4ade99f
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 25, 2015
[inaka#186] Add verify_function_naming_convention/1 to test/style_SUI…
a08b726 
…TE.erl, using new example files added in 4ade99
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 25, 2015
[inaka#186] Add function_naming_convention/3 to src/elvis_style.erl
3c7f2eb 
Currently only covers exported functions
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 25, 2015
[inaka#186] Add Initial_cap test example
23c5604
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 25, 2015
[inaka#186] Use Initial_cap test example and simplify regex
4ce1211
@kbaird
Copy link
Collaborator

kbaird commented Sep 25, 2015

I have some initial work at master...kbaird:Issue#186-FunctionNames. At the moment, it only covers exported functions, whereas I assume we want to try to catch bad names even for private/hidden functions, so that's my next plan.

@elbrujohalcon Do you see anything else wrong with the approach or style so far in that branch's additions that you would prefer to be changed before the final PR?

@elbrujohalcon
Copy link
Member Author

@kbaird It’s looking great, so far!

kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 26, 2015
[inaka#186] Shift badly-named functions to non-exported to ensure tha…
c91e24e 
…t hidden functions are still checked
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 26, 2015
[inaka#186] Hidden functions now examined as well as exported ones
92f47b3 
I'm not super-happy about the dpulication between the anonymous
functions within exported_functions/1 and function_names/1. I may
revisit those.
@kbaird
Copy link
Collaborator

kbaird commented Sep 26, 2015

More work in progress: kbaird/elvis@Issue#186-FunctionNames...kbaird:Issue#186-FunctionNames-AlsoHidden

kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 26, 2015
[inaka#186] @doc fixes
623230e
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 26, 2015
[inaka#186] Refactor with make_extractor_fun/1
1a18104 
Returns anonymous Funs that were previously inline
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 28, 2015
[inaka#186] Remove unused ignore component
898d120
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 28, 2015
[inaka#186] Add function naming rule to elivs.config
8ce37f7
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 28, 2015
[inaka#186] Move function name with digit from fail to pass file
419131d
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 28, 2015
[inaka#186] Allow digits in function names in test/style_SUITE.erl
49d2355
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 28, 2015
[inaka#186] Allow digits in function names in config/elvis.config
c4434d8
kbaird pushed a commit to kbaird/elvis that referenced this issue Sep 28, 2015
[inaka#186] Remove optional _SUITE suffix from allowed names, as that…
8a10acc 
… is a common-test need for modules that does not apply to function names
@jfacorro jfacorro closed this as completed Oct 2, 2015
ElFantasma added a commit to ElFantasma/elvis that referenced this issue Oct 13, 2015
@ElFantasma
[inaka#186] Added rule to detect nested try...catch blocks
eed0c0b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kbaird kbaird

Labels
rule
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kbaird @elbrujohalcon @jfacorro