Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish to NPM #64

Closed
mstenta opened this issue Feb 26, 2020 · 7 comments
Closed

Publish to NPM #64

mstenta opened this issue Feb 26, 2020 · 7 comments
Labels

Comments

@mstenta
Copy link
Member

mstenta commented Feb 26, 2020

Should we publish farmOS-map to NPM?

@mstenta
Copy link
Member Author

mstenta commented Feb 26, 2020

@jgaehring made the point that we might need to rename from farmOS-map to farmos-map in package.json.

@jgaehring
Copy link
Member

The main benefits I can come up with at the moment are that it would make the library:

  • easier to find by other applications/developers
  • easier to install by other applications/developers

So I guess the first question is, do we want to prioritize discovery of this library?

My sense at this time is that, no, that is not a priority. This library would be useful to other developers I think only at the point that they are consuming other libraries first, like farmOS.js etc, and potentially farmLog (if we make that an independent lib), because until they are able to access and maintain farmOS data, particularly farm geometries and location data, there won't be a need for rendering that data to a map. Maybe if someday we want to put together a farmOS SDK this would be a key component, but I don't think that's on our roadmap at the moment.

@jgaehring
Copy link
Member

@jgaehring made the point that we might need to rename from farmOS-map to farmos-map in package.json.

😱

@mstenta
Copy link
Member Author

mstenta commented Feb 26, 2020

This library would be useful to other developers I think only at the point that they are consuming other libraries first

Our Sci is considering using the library in their PWA and potentially in their Quick Carbon app. The latter does not have any direct connection to farmOS. Just to say that there are some potential use-cases developing... but they can also just do what farmOS-client is doing in package.json and reference the GitHub repo directly with "farmOS-map": "github:farmOS/farmOS-map#v1.0.0".

@jgaehring
Copy link
Member

Just to say that there are some potential use-cases developing

Oh interesting, not sure I realized that. I guess I'm wondering whether we want to capture third-party developers who might not otherwise be aware it was an option. Folks we're not already working with, or might not ever have a close connection to.

@mstenta
Copy link
Member Author

mstenta commented Feb 8, 2021

Bumping up the priority of this. We need to be able to pull farmOS-map from NPM (or Bower) in order to include it in farmOS 2.x via Composer. These needs are described in: https://www.drupal.org/project/farm/issues/3186641

mstenta added a commit to mstenta/farmOS-map that referenced this issue Feb 8, 2021
@mstenta
Copy link
Member Author

mstenta commented Feb 9, 2021

Done!

https://www.npmjs.com/package/@farmos.org/farmos-map

And available on asset-packagist.org:

https://asset-packagist.org/package/detail?fullname=npm-asset/farmos.org--farmos-map

Encountered an issue in the process, and implemented a workaround, which I documented here: #99

@mstenta mstenta closed this as completed Feb 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

2 participants