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

doc: fix esm extension example with type module #33409

Closed
wants to merge 2 commits into from

Conversation

guybedford
Copy link
Contributor

As an alternative to #33408, fixing up the docs issue with the "type": "module" instructions, while still noting .mjs.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. esm Issues and PRs related to the ECMAScript Modules implementation. labels May 14, 2020
@devsnek
Copy link
Member

devsnek commented May 14, 2020

If our docs blindly tell you to set a configuration parameter every time you set up a project, we should make that parameter the default.

@guybedford
Copy link
Contributor Author

@devsnek yes making it the default in npm init and other tooling is a high priority! We need to chase up those conversations.

The reason we can't blanket make it the default is because the defaults are for third-party package support for CommonJS. There's simply no way to change the default as a blanket rule without timestamping packages or having support directly in npm tooling / the registry itself.

Please do try to work on your tone... the project is only as good as we treat eachother.

@devsnek
Copy link
Member

devsnek commented May 14, 2020

Ok to put it another way, if we can't make it the default (as in how node behaves with no package.json present) then it shouldn't be the heading example.

@guybedford
Copy link
Contributor Author

@devsnek if it matters to you that much then sure, let's merge your original PR. But the fact that your terrible tone is winning this argument makes me pretty sad.

@guybedford guybedford closed this May 15, 2020
@devsnek
Copy link
Member

devsnek commented May 15, 2020

@guybedford apologies, i am not intending any animosity

@guybedford guybedford deleted the doc-type-module-ext-fix branch May 15, 2020 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. esm Issues and PRs related to the ECMAScript Modules implementation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants