lennardv2 / Leaflet.awesome-markers

Colorful, iconic & retina-proof markers for Leaflet, based on the Font Awesome/Twitter Bootstrap icons.
MIT License
1.27k stars 340 forks source link

[enhancement] Add missing bower.json. #23

Open timgluz opened 10 years ago

timgluz commented 10 years ago

Hey, maintainer(s) of lvoogdt/Leaflet.awesome-markers!

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 lvoogdt/Leaflet.awesome-markers 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": "lvoogdt/Leaflet.awesome-markers",
  "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!

cyrilchapon commented 9 years ago

In addition, leaflet should be added as a dependency.

For now, loading Leaflet.awesome-markers without leaflet results in a

leaflet.awesome-markers.js:17 Uncaught ReferenceError: L is not defined

The doc says "Version 2.0 of Leaflet.awesome-markers is tested with: Leaflet 0.5-Latest" which could be roughly traducted, in a

"dependencies": {
  "leaflet": "~0.5.x"
}

(bower follow this semver implementation that you can refer to)


I'd add that many dev tools, such as wiredep (auto inject dependencies in the right order), rely on a sane bower.json file to work. For community, waiting for a proper bower.json implementation, a tweak can be achieved in you app bower.json:

"overrides": {
  "Leaflet.awesome-markers": {
    "dependencies": {
      "leaflet": "~0.5.x"
    }
  }
}