What is the javascript filename naming convention?

javascript naming-conventions
ripper234 picture ripper234 · Sep 1, 2011 · Viewed 171.1k times · Source

Should files be named something-with-hyphens.js, camelCased.js, or something else?

I didn't find the answer to this question here.

Answer

Bryan Menard picture Bryan Menard · Sep 1, 2011

One possible naming convention is to use something similar to the naming scheme jQuery uses. It's not universally adopted but it is pretty common.

product-name.plugin-ver.sion.filetype.js

where the product-name + plugin pair can also represent a namespace and a module. The version and filetype are usually optional.

filetype can be something relative to how the content of the file is. Often seen are:

  • min for minified files
  • custom for custom built or modified files

Examples:

  • jquery-1.4.2.min.js
  • jquery.plugin-0.1.js
  • myapp.invoice.js

Related questions

Can someone explain the dollar sign in Javascript?

The code in question is here: var $item = $(this).parent().parent().find('input'); What is the purpose of the dollar sign in the variable name, why not just exclude it?

Read More
Why would a JavaScript variable start with a dollar sign?

I quite often see JavaScript with variables that start with a dollar sign. When/why would you choose to prefix a variable in this way? (I'm not asking about $('p.foo') syntax that you see in jQuery and others, but …

Read More
Underscore prefix for property and method names in JavaScript

Is the underscore prefix in JavaScript only a convention, like for example in Python private class methods are? From the 2.7 Python documentation: “Private” instance variables that cannot be accessed except from inside an object don’t exist in Python. However, …

Read More