Norkart / Leaflet-MiniMap

A minimap control plugin for Leaflet
BSD 2-Clause "Simplified" License
395 stars 125 forks source link

Add missing bower.json. #50

Closed timgluz closed 9 years ago

timgluz commented 10 years ago

Hey, maintainer(s) of Norkart/Leaflet-MiniMap!

We at VersionEye are working hard to keep up the quality of the bower's registry.

We just finished our initial analysis of the quality of the Bower.io registry:

7530 - registered packages, 224 of them doesnt exists anymore;

We analysed 7306 existing packages and 1070 of them don't have bower.json on the master branch ( that's where a Bower client pulls a data ).

Sadly, your library Norkart/Leaflet-MiniMap is one of them.

Can you spare 15 minutes to help us to make Bower better?

Just add a new file bower.json and change attributes.

{
  "name": "Norkart/Leaflet-MiniMap",
  "version": "1.0.0",
  "main": "path/to/main.css",
  "description": "please add it",
  "license": "Eclipse",
  "ignore": [
    ".jshintrc",
    "**/*.txt"
  ],
  "dependencies": {
    "<dependency_name>": "<semantic_version>",
    "<dependency_name>": "<Local_folder>",
    "<dependency_name>": "<package>"
  },
  "devDependencies": {
    "<test-framework-name>": "<version>"
  }
}

Read more about bower.json on the official spefication and nodejs semver library has great examples of proper versioning.

NB! Please validate your bower.json with jsonlint before commiting your updates.

Thank you!

Timo, twitter: @versioneye email: timo@versioneye.com VersionEye - no more legacy software!

robpvn commented 10 years ago

I see that this is an automated message, but the point is good. (I don't know how this project got registered with Bower when we don't have a bower.json to begin with.) We could get around to this some day. First we will need to start making proper tagged releases in git, and marking the Leaflet versions they depend on.

Actually, before that Leaflet will have to start making Bower-compatible releases since the plugin is meaningless without Leaflet. (https://github.com/Leaflet/Leaflet/blob/18be02fbba820d9a2f012c5a0460e92fb7a960aa/FAQ.md#misc) :leaves:

timgluz commented 10 years ago

Ok, thanks! Good to know.

Can you also contact Bower guys and ask how you will get authorship for this package on Bower registry?

reiz commented 10 years ago

Totally agree on that. Having a package manager without tags and versions will not work out ;-)

robpvn commented 10 years ago

OK, so Bower registration works on a completely unauthenticated, first-come first-serve basis with no possibility of editing mistakes, and noone owns a package once it has been registered. Changes to them can only be made by a manual database edit requested in the world's longest GitHub issue. I don't think that is the best system, to put it that way, but at least our package seems to be correctly defined.

reiz commented 10 years ago

The first time I heard about bower.io I was totally enthusiastic. But then I took a closer look and as package manager it's pretty poor. I don't think that a package manager should be based on tags at GitHub. RubyGems is not perfect but still more robust as a backend. On the other side I don't know why each language has his own package manager. They all do kind of the same. There should be a language agnostic package repository with a clean REST API. It should have multiple clients, because all the language specific things should be handled on the client anyway.

robpvn commented 9 years ago

I see from the 0.7.3 changelog for Leaflet that they've included bower support a while now. Might be time to revisit this issue now.

reiz commented 9 years ago

I just checked out the changes, but there is still no bower.json file in the root directory. We track the project anyway, but as long there is now bower.json file we have no information about dependencies, licenses, description, authors and so on.

Xennis commented 9 years ago

+1 for a bower.json

deeg commented 9 years ago

+1 for bower support!

deeg commented 9 years ago

Is there anything we can do to help with bower support?

robpvn commented 9 years ago

I've added a bower.json, so I think things should be available now soon. (Someone had already registered this repo in the bower registry with the correct git address, so I suppose things should be showing up correctly now that the bower.json is in place.)

@deeg: If you want to help, try using bower to install leaflet-minimap and see if it all works properly. If something is wrong with the bower.json, pull requests are welcome.

reiz commented 9 years ago

Cool! Many THX for the bower.json :-)

deeg commented 9 years ago

It is working now, thanks. I do suggest adding to the readme about how to run the command to install it, since it is all lower case while this repo as caps.

Also I think it is pretty good practice to have a version number in your bower.json file if you want to add one.

robpvn commented 9 years ago

The spec actually says that a version number is deprecated and ignored, so I'm happy to not have to mess about with updating that manually when I npm version major/minor/patch.

I can put somtehing in the readme!

deeg commented 9 years ago

Ah, thanks for letting me know!