Proposal to change npm module name to 'cloudevents' #242

Activity

1. lance

   added

   type/questionFurther information is requestedFurther information is requested

   type/discussionIssues that need to be decided/debated/discussedIssues that need to be decided/debated/discussed

   version/3.xIssues related to the 3.0 release of this libraryIssues related to the 3.0 release of this library

   on Jul 7, 2020
2. lance

   changed the title [-]Proposal to Change npm Module Name to 'cloudevents'[/-] [+]Proposal to change npm module name to 'cloudevents'[/+] on Jul 7, 2020
3. helio-frota commented on Jul 7, 2020

   

   helio-frota

   on Jul 7, 2020

   Last edited by helio-frota

   Member

   More actions

   Additional comments:

   1. I agree this module is not a SDK, it is a library.
   2. I agree that, at that time, was not good to change, but now the project has an opportunity frame/window to be changed.
4. lance

   pinned this issue on Jul 7, 2020
5. loopingz commented on Jul 10, 2020

   

   loopingz

   on Jul 10, 2020

   Contributor

   More actions

   If we rename the module, I think it would be good to provide script to use with jscodeshift.
   So either reuse stuff like this: https://github.com/jurassix/refactoring-codemods

   or custom jscodeshift template, so people can just run npx jscodeshift -t cloudevents-sdk-2.0-3.0

   const util = require("util");
   // Update packages
   const packagesReplaceMap = {
     "cloudevents-sdk": { pkg: "cloudevents" }
   };
   
   // Update package.json?
   
   export default function transformer(fileInfo, api, options) {
     const j = api.jscodeshift;
     // eslint-disable-next-line global-require, import/no-dynamic-require
     const printOptions = options.printOptions || {};
     let root = j(fileInfo.source);
   
     // Replace all imports
     for (let i in packagesReplaceMap) {
       root
         .find(j.ImportDeclaration, {
           source: { value: i }
         })
         .replaceWith(path => {
           const { node, value } = path;
           value.source.value = packagesReplaceMap[i].pkg || i;
           return node;
         });
     }
   
     return root.toSource(printOptions);
   }
   

   This is a draft not final version, I can work on it if we think it is a good idea
6. lance commented on Jul 13, 2020

   

   lance

   on Jul 13, 2020

   MemberAuthor

   More actions

   @loopingz this is good - but since the API has also changed, I wonder how tricky it will be
7. grant commented on Jul 23, 2020

   

   grant

   on Jul 23, 2020

   Member

   More actions

   I think the votes are in, thanks for organizing @lance 👍
   9 👍
   3 👎
   as of July 23, 2020.

   Want to close this and resume in #215? I've created a PR.
8. lance commented on Jul 24, 2020

   

   lance

   on Jul 24, 2020

   MemberAuthor

   More actions

   Closing. Fixed in #260
9. lance

   closed this as completedon Jul 24, 2020
10. lance

    unpinned this issue on Jul 27, 2020