search

gyandeeps / gruntify-eslint

Grunt plugin for Eslint
MIT License
14 stars 8 forks source link

grunt-contrib is reserved #2

Closed Nate-Wilkins closed 10 years ago

Nate-Wilkins commented 10 years ago

The grunt-contrib namespace is reserved to the grunt team for common tasks that most of the community usually always uses in their projects. It'd be nice if this module name was a custom one so we as consumers can differentiate.

Partially related to #1

gyandeeps commented 10 years ago

Officially maintained "contrib" plugins are marked with a star icon. This helps people to differentiate.

Nate-Wilkins commented 10 years ago

A star? I'm talking about the name of the actual plugin. Like the differences between

grunt-dotnet-assembly-info vs grunt-contrib-assembly

I know that the first name conveys to the user that it's

1) a grunt plugin 2) related to dotnet 3) something with a dotnet assembly file

Where as the second one conveys that it's:

1) a grunt plugin 2) a common grunt plugin maintained by the grunt team 3) related to assembly?

The last inference is harder to guess and even harder to see that this plugin isn't maintained by the grunt team nor that it's not common...

Names mean something and if I was to make a plugin for grunt or eslint or any third party tool I would try to conform as much as possible to their wishes. Since they're the architects in this situation I'd also assume they know what they're talking about - even if their reasons were documented or not. Consistency is king.

I'm not sure which star you're talking about but if I search npm for grunt-contrib- I'd expect to see grunt maintained projects because I'd expect most developers to be disciplined enough to name their projects related to what it does.

Granted there is a grunt-contrib-jshint but it's maintained by the grunt team... Seems like it might even be a good idea to ask/help the grunt team to do an eslint plugin. Sure anyone can do these plugins or any plugin for that matter but the advantages of having open source projects is that we can add to any existing package we don't see fit to our requirements.

But I think requirements of this plugin that differ from grunt-eslint (and others) would have to be nailed down first in the docs.

gyandeeps commented 10 years ago

on your concern that its a plugin maintained by the grunt team. please read this http://gruntjs.com/plugins look at the very first sentence on this page.

Nate-Wilkins commented 10 years ago

Oh right they have their own search page. Did you read "namespace is reserved to the grunt team"? It literally says that the name shouldn't be used just thought you'd want to comply with their expectations.

My point is that if someone is going to be working on a plugin for any type of system it should adhere to that system's standards and expectations.

gyandeeps commented 10 years ago

it says Officially maintained "contrib" plugins are marked with a star icon.

Nate-Wilkins commented 10 years ago

No we're talking about two different things here - I'm talking about naming the task module - the heading that says "Naming your task" on the "Creating plugins" page

mgol commented 10 years ago

@gyandeeps I don't get what you don't understand here; the official Grunt site clearly states: "The "grunt-contrib" namespace is reserved for tasks maintained by the Grunt team, please name your task something appropriate that avoids that naming scheme."

You're directly violating that rule; what's there to discuss?

Nate-Wilkins commented 10 years ago

By the way @gyandeeps this is labeled as a question it's more a verified statement. Do as you wish with it.

shinnn commented 10 years ago

I added grunt-contrib-eslint to the banned plugin list.

@gyandeeps You should understand what you are really doing.

gyandeeps commented 10 years ago

@shinnn The name of grunt-contrib-eslint has been changed to gruntify-eslint. Sorry about that.

Askelkana commented 9 years ago

Why 'gruntify-eslint' and not 'grunt-eslint' which would have been the standard way to name it? For example, now the load-grunt-tasks job cannot find this, so a separate call to load this plugin is required. It's needlessly sloppy, IMO.