New rule: module name should match module argument name

[xman85]

define(["./cart", "./inventory"], function(cart, inventory) {

Pretty self-explanatory: "./cart" -> cart, "./inventory" -> inventory.
The motivation is this: when I see "inventory" module variable in the code, I want to quickly navigate to the file where it's defined, and if filename doesn't match variable name it's annoying.

Thanks!

[platinumazure]

And what about paths involving multiple segments? Is the expected name just the last segment?

Personally I'd like to allow for case-insensitivity too, if I were to use this rule.

[cvisco]

@platinumazure yea I would see this as matching the basename of the path only

[xman85]

Yes, only the last segment - filename, because IDEs usually have a convenient search by filename.

[cvisco]

I'm curious about some common libs like:

define([ 'jquery', 'underscore' ], function ($, _) { /* ... */ });

Would you expect this rule to force that to be the following?

define([ 'jquery', 'underscore' ], function (jquery, underscore) { /* ... */ });

[cvisco]

Or would this apply only to relative paths (local modules)?

[xman85]

Good point, I think usually ppl are not interested in quickly navigating to a library source code. Moreover if a module has an alias, this feature doesn't make much sense because alias name can be different from filename. So only for local modules is sufficient.

[platinumazure]

Another possibility is to have an exceptions object:

{
    "rules": {
        "requirejs/module-match-file": ["error", { "exceptions": { "jquery": "$", "underscore": "_" } }]
    }
}

(I used a placeholder rule name, please pick a better one)

[cvisco]

@xman85 I understand your particular use case for this has to do with easier file navigation, but I see that as a side benefit of the rule itself. To me this is a much more general thing around enforcing naming conventions for module imports, so in that regard it needs to be sufficiently smart and/or flexible about what it warns on.

@platinumazure exceptions—or perhaps "aliases"—could work here, and i support the idea of a toggle for case sensitivity.

[cvisco]

I see one more potential issue here. What about filenames that would be illegal as identifiers in JavaScript? The modules in this plugin are a prime example of that: libs/rules/no-assign-exports for example.

[xman85]

If you filenames are not legal js identifiers then just don't enable module-match-file rule, I think :)

[cvisco]

Yea that's fair :)

Would consistent-dependency-names be an acceptable name for this?

[xman85]

I liked "module-match-file" actually.

[cvisco]

Without context, though, that's too vague. And, it's not the module we're concerned with but the dependency list for the module.

How about dependency-match-filename ?