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

Rename Node-API to something less confusing/misleading #38573

Closed
bnb opened this issue May 6, 2021 · 4 comments
Closed

Rename Node-API to something less confusing/misleading #38573

bnb opened this issue May 6, 2021 · 4 comments
Labels
node-api Issues and PRs related to the Node-API.

Comments

@bnb
Copy link
Contributor

bnb commented May 6, 2021

Is your feature request related to a problem? Please describe.
There was recently a decision to rename N-API to Node-API. I believe this is a poor decision that will result in actively harmful results for both users of the API and general Node.js users.

Specifically, there are multiple problems with this naming:

  • Building APIs are a common use case for Node.js. This naming can lead to confusing information or misleading search results.
  • Products often refer to the way to access their services with JavaScript or Node.js as their "JavaScript API". If people want to use this from Node.js, there is a non-trivial chance they will look for "Node.js API" which will lead to confusing results.
  • Node.js itself has an API, which theoretically includes this API. Naming a part of the whole the same thing as the whole is immensely confusing from an education perspective.
  • This API is far less likely to be used than other parts of the Ndoe.js API, which leads to an exacerbation of challenge presented by the problems above.

Describe the solution you'd like

Rename Node-API to something else.

Describe alternatives you've considered

  • Undoing Node-API rename, moving it back to N-API.
    • There is a reason a rename was done initially, and that reason is valid.
  • Leave it as is.
    • This is going to be actively harmful to communication and education n the long-run.
@mhdawson
Copy link
Member

mhdawson commented May 6, 2021

For context the rename/work is complete. The blog post which explains the changes is https://nodejs.medium.com/renaming-n-api-to-node-api-27aa8ca30ed8.

The node-api team was asked to change the name in: nodejs/abi-stable-node#420 . Being sensitive to the concern the team took on this extra work.

@Trott
Copy link
Member

Trott commented May 10, 2021

Repeating what I wrote 3 months ago:

I support changing the name N-API to something else, but the new term does have an obvious downside. The term "Node API" already has a straightforward meaning. Applying it to a specific API is more vague than descriptive.

That said, I don't know that I have better ideas. (Native Bindings API? Addon API? ABI Stability API?)

I'll also add that Node API is somewhat contrary to our years-long efforts to have the name of the runtime spelled Node.js and not Node (or NodeJS or a number of other variatns).

Of course, now that the name change has already happened, there are significant costs/downsides to changing the name a second time in such a short period of time. I'd still support it, though, if the name was more descriptive and not subject to misinterpretation. A better name is better for our users.

@jasnell
Copy link
Member

jasnell commented May 20, 2021

I'm -1 on changing the name again and I appreciate the effort the node-api team put into making the changes. It's a good change.

@nodejs nodejs locked as too heated and limited conversation to collaborators May 30, 2021
@nodejs nodejs deleted a comment from Fengtao1314520 May 30, 2021
@targos targos added the node-api Issues and PRs related to the Node-API. label Aug 9, 2021
@mhdawson
Copy link
Member

mhdawson commented Jun 3, 2022

This was discussed in the Node-API team meeting today and and consensus was we don't think we want/will change at this point. Some of the team members could not comment directly since it was locked.

@Trott Trott changed the title Rename Node-API to something less conusing/misleading Rename Node-API to something less confusing/misleading Jun 4, 2022
@Trott Trott closed this as completed Jun 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
node-api Issues and PRs related to the Node-API.
Projects
None yet
Development

No branches or pull requests

5 participants