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

[meta] change file naming to be consistent #13308

Closed
2 tasks done
hasezoey opened this issue Apr 22, 2023 · 1 comment
Closed
2 tasks done

[meta] change file naming to be consistent #13308

hasezoey opened this issue Apr 22, 2023 · 1 comment
Labels
developer-experience This issue improves error messages, debugging, or reporting discussion If you have any thoughts or comments on this issue, please share them! refactor This is a purely internal change for making Mongoose internals easier to understand and work with
Milestone

Comments

@hasezoey
Copy link
Collaborator

hasezoey commented Apr 22, 2023

Prerequisites

  • I have written a descriptive issue title
  • I have searched existing issues to ensure the issue has not already been raised

Issue

currently this project uses inconsistent file naming for the files in lib/, in use are:

  • fully-lowercased (majority of the files)
    • lib/connectionstate.js
    • lib/validoptions.js
  • snake_cased
    • lib/document_provider.js
  • camelCased
    • lib/browserDocument.js
  • PascalCased
    • lib/schema/SubdocumentPath.js

this issue is to track renaming of those files in a consistent manner (but likely for some major version)

@hasezoey hasezoey added discussion If you have any thoughts or comments on this issue, please share them! developer-experience This issue improves error messages, debugging, or reporting refactor This is a purely internal change for making Mongoose internals easier to understand and work with labels Apr 22, 2023
@hasezoey hasezoey added this to the 8.0 milestone Apr 22, 2023
@hasezoey hasezoey changed the title [meta] consistenize file naming [meta] change file naming to be consistent Apr 24, 2023
@hasezoey
Copy link
Collaborator Author

@vkarpov15 as there is now a PR for this change already, should we change filenames to be consistently camelCased (which the majority of files already are and the PR changes some files to)?

vkarpov15 added a commit that referenced this issue Sep 14, 2023
BREAKING CHANGE: rename top-level files to camel case
vkarpov15 added a commit that referenced this issue Sep 30, 2023
vkarpov15 added a commit that referenced this issue Oct 1, 2023
camelCase remaining filenames for 8.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience This issue improves error messages, debugging, or reporting discussion If you have any thoughts or comments on this issue, please share them! refactor This is a purely internal change for making Mongoose internals easier to understand and work with
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants