question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

npm i cloudevents

See original GitHub issue

We should make it really as simple as possible to use this module.

Expected

npm i cloudevents

Actual

npm install cloudevents-sdk

Not sure who’s publishing the npm module, happy to give cloudevents for publishing source in this repo.

Python, Ruby, C# all don’t use cloudevents-sdk, just cloudevents.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:10 (10 by maintainers)

github_iconTop GitHub Comments

1reaction
lholmquistcommented, Jun 8, 2020

I would argue that it would create more confusion if the name changed now.

I would suggest that you, @grant , deprecate that module and point your readme to this repo.

0reactions
grantcommented, Jun 9, 2020

You have not provided any compelling reason to change the name of this module beyond an aesthetic desire to reduce typing by four characters.

But this module is not an SDK. This is not a “software development kit”. The set of 7 languages is the SDK, the kit. This library is a small library for handling CloudEvents, part of the SDK. The CloudEvents SDK is meant to refer to a collection of multiple libraries in different languages, not an individual language library.

Moreover, this name with “-sdk” is not idiomatic for JavaScript and Node. It would be more acceptable for other languages like Java.

The only real example of a npm package using “-sdk” was AWS’ SDK, which is not comparable to this library. That package is really a set of tools for multiple APIs and is aptly named.


Here are more data points:

Look at: https://www.npmjs.com/

Search SDK in npm: https://www.npmjs.com/search?q=-sdk

Read about SDK on Wikipedia referencing multiple tools: https://en.wikipedia.org/wiki/Software_development_kit


This whole repo used Java-like constructs like builder patters. Using -sdk is one of the historical parts that I would like to fix now. It’s doable like moving to TypeScript. I’d like strong counterarguments for saying no, it’s not idiomatic or better due to the above arguments.

Read more comments on GitHub >

github_iconTop Results From Across the Web

cloudevents - npm
Start using cloudevents in your project by running `npm i cloudevents`. There are 44 other projects in the npm registry using cloudevents.
Read more >
cloudevents - npm
The CloudEvents SDK for JavaScript. Features. Represent CloudEvents in memory; Serialize and deserialize CloudEvents in different event formats. Send and ...
Read more >
cloudevents-router - npm
Cloud Events Router. The simplest typed cloudevents routing library for nodejs. Library has a single dependency to cloudevents npm library.
Read more >
cloudevent - npm
The purpose of this library is to create instances of CloudEvents in a simple way (with some useful defaults), or in a full...
Read more >
cloudevents-kafka - npm
Kafka transport plugin for CloudEvents JS SDK. ... Start using cloudevents-kafka in your project by running `npm i cloudevents-kafka`.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found