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.

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

Consistent file naming style #612

Closed
12 of 15 tasks
bajtos opened this issue Oct 3, 2017 · 6 comments
Closed
12 of 15 tasks

Consistent file naming style #612

bajtos opened this issue Oct 3, 2017 · 6 comments
Assignees
Labels
developer-experience Issues affecting ease of use and overall experience of LB users refactor
Milestone

Comments

@bajtos
Copy link
Member

bajtos commented Oct 3, 2017

In a slack-chat vote, we agreed to follow Angular's file naming convention in our project:

src/decorators/authenticate.decorator.ts

Now we need to clean up the code in loopback-next, loopback-next-hello-world, loopback-next-extension-starter (and possibly other repositories) to follow this new style.

Tasks

Out of scope

@bajtos bajtos self-assigned this Oct 3, 2017
@bajtos bajtos added p2 and removed p1 labels Oct 3, 2017
@bajtos bajtos added MVP developer-experience Issues affecting ease of use and overall experience of LB users refactor and removed p2 labels Dec 12, 2017
@dhmlau
Copy link
Member

dhmlau commented Mar 12, 2018

UPDATES (03/12):
Update the original description with updated links as we've moved the repos around.

@dhmlau
Copy link
Member

dhmlau commented Mar 13, 2018

Document the file naming style in our docs - either here on wiki, or preferably somewhere inside http://loopback.io/doc/en/contrib/code-contrib.html

I'm thinking the naming convention also applicable to users who are just creating LB4 app, not only contributing code. I wonder if it's a better place to put in the official documentation. Somewhere under "Best Practices" might be good, but don't know if it fits given what we have in this section.
http://loopback.io/doc/en/lb4/Best-practices-with-Loopback-4.html

@dhmlau
Copy link
Member

dhmlau commented Mar 29, 2018

Following up the discussion from here regarding the test file naming convention, the proposal was to have the type of test as suffix, i.e.
.acceptance.ts, .integration.ts, .unit.ts instead of .test.ts.

Also, I assume the test files are categorized by type as well. i.e.
test/acceptance/file1.acceptance.ts
test/integration/filexx.integration.ts

@strongloop/lb-next-dev , thoughts?

@shimks
Copy link
Contributor

shimks commented Mar 29, 2018

+1 for your proposal
i'm assuming we're advocating users name their test files as such for their artifacts?: user.controller.integration.ts

@virkt25 virkt25 added this to the April 2018 milestone Apr 2, 2018
@shimks shimks self-assigned this Apr 3, 2018
@shimks
Copy link
Contributor

shimks commented Apr 11, 2018

Updating convention on loopback4-example-microservices is tracked by strongloop/loopback4-example-microservices#94

@shimks
Copy link
Contributor

shimks commented Apr 11, 2018

Closing since it's done

@shimks shimks closed this as completed Apr 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience Issues affecting ease of use and overall experience of LB users refactor
Projects
None yet
Development

No branches or pull requests

4 participants