Specify import require paths (continuation of #1941) #1962

josdejong · 2020-09-09T12:32:51Z

@GreenImp I continued your PR and got everything working I think.

I resolved a few merge conflicts
All unit tests can now run using plain node.js, no transpilation needed anymore when running mocha
I created a script which generates /lib/cjs/package.json and /lib/browser/package.json during the build
I updated the urls in the browser examples

Still to do:

Only generate a single, minified bundle math.js
Write some unit tests to validate running loading the library via ESM and CJS
Create backward compatible warnings for all old index files and the removed bundle files from the dist folder
Describe breaking changes in HISTORY.md
A few more cleanup actions in the build scripts and tests
Update download description on the website, remove the part about the non-minified bundle
BONUS: try to rewrite the gulpfile and some of the left over commonjs files in the build/testing part to ESM.

Reference #1941

Specify package type as `commonjs` (It's good to be specific)

Remove ./number.js (You can use the compiled ones in `./lib/*`) Tell node that the `esm` directory is type `module` and enable tree shaking. Remove unused files from packages `files` property

….com/GreenImp/mathjs into GreenImp-feature/specify-import-require-paths # Conflicts: # package-lock.json # package.json # src/expression/embeddedDocs/embeddedDocs.js # src/factoriesAny.js # src/function/algebra/solver/utils/solveValidation.js

- Refactor `bundleAny` into `defaultInstance.js` and `browserBundle.cjs` - Refactor unit tests to be able to run with plain nodejs (no transpiling) - Fix browser examples

GreenImp · 2020-09-09T13:38:41Z

gulpfile.cjs

-  'browser',
-  'docs'
+  bundle,
+  generateDocs


Just thought it worth mentioning, I set these to the string names of the tasks that I created above, so Gulp will run those tasks. That way, if one of the tasks changes (Like with the browser compiling changing from bundle, minify to just bundle) you only need to change the individual task, and not the one here as well.

Yes, true. Formerly the 'browser' task did two things: bundle and minify. There is only one left now: bundle, so I thought like let's remove this indirection. I think we can maybe remove gulp.task('browser', bundle) because it's not used anywhere externally from the package.json scripts. The task 'docs' only does one thing (generateDocs) but is actually used in the package.json scripts.

Yeah, I initially created those tasks because I found that I kept needing to clean out things and only rebuild certain things when I was testing, so it made it a bit easier.

Ah! Makes sense. If you like it better to call the gulp tasks instead of the function it's totally fine with me, for me both is ok.

I don't really mind. It's a minor thing anyway, so might as well leave it as is for now.

Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1. **This update includes a security fix.** - [Release notes](https://github.com/bitinn/node-fetch/releases) - [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md) - [Commits](node-fetch/node-fetch@v2.6.0...v2.6.1) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

…mber only)

…ed since v8

josdejong · 2020-09-13T19:02:02Z

I think this PR is now ready to be merged. I hope to publish a release candidate for v8 somewhere coming week.

Bumps [karma](https://github.com/karma-runner/karma) from 5.2.1 to 5.2.2. - [Release notes](https://github.com/karma-runner/karma/releases) - [Changelog](https://github.com/karma-runner/karma/blob/master/CHANGELOG.md) - [Commits](karma-runner/karma@v5.2.1...v5.2.2) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

GreenImp · 2020-09-17T08:27:10Z

Thanks for sorting the deprecation messages on the old files! I just didn't seem to have the time to get around to it.

josdejong · 2020-09-20T16:01:42Z

I merged this PR now in the v8 branch. I hope to do a beta release of v8 somewhere coming week.

GreenImp · 2020-09-25T01:11:04Z

I've npm installed the V8 branch in one of my projects, and it seems to be working okay.

I'm able to compile my library, without including mathjs in the bundle, but have it as a dependency of my project. So when installing my library it brings down mathjs and everything still works as if it was bundled
That's using both ESM and CommonJS.

And my Jest tests still seem to work as well!

That's exactly what I needed from these changes, so I'm really happy. It's looking really good! Thanks.

josdejong · 2020-09-25T18:39:25Z

That's great news, thanks for testing it out Lee 👍

josdejong · 2020-10-18T16:09:41Z

I've finally published the first beta version on npm: 8.0.0-beta.0.

I'm still thinking about how we can make it easier or more obvious that all imports now require to have the *.js extension in the file name. This gives a bit vague errors as long as your IDE thinks all is ok. IDE's are normally configured to not add file extensions in case of automatically adding an import, so that can be quite annoying.

Maybe it's possible to create a lint rule to check for that (not possible with standardjs, so we may have to switch to eslint-config-standard for example).

GreenImp · 2020-10-23T13:18:27Z

That's fab! I'm really looking forward to being able to use v8.

I'm not sure I understand the problem with file extensions?
When a developer requires the library, they can include it by name (If using npm). If they want to include a particular script, that's listed in the exports, then they will all work.
So you can still import:

'math-js'         // points to ./lib/{esm|cjs}/index.js
'math-js/number'  // points to ./lib/{esm|cjs}/number.js

But you can also import various other files with the full path (Including extension).

Or am I misunderstanding the issue?

josdejong · 2020-10-28T09:58:35Z

@GreenImp I mean not when consuming mathjs as a library, but when you're developing mathjs itself (like add a new function). When creating a new file in the mathjs repo, you have to be careful to add the file extensions.

josdejong · 2020-11-06T09:26:16Z

For now, I've added a section "Develop" in the README.md explaining this. I think it's a generic issue that we'll see with more libraries when more and libraries start being written in plain ESM.

josdejong · 2020-11-06T11:02:17Z

I've just published v8.0.0

GreenImp · 2020-11-25T12:17:18Z

Thanks @josdejong that's brilliant! Really appreciate your time in getting this all sorted and merged in.
I've started implementing v8 in my project and it's working well so far!

josdejong · 2020-11-25T15:12:01Z

Thanks! Good to hear it's working smoothly in your project.

GreenImp and others added 9 commits August 6, 2020 23:55

Add .js extension to source file imports

cbed43e

Specify package exports in package.json

d755bca

Specify package type as `commonjs` (It's good to be specific)

Move all compiled scripts into lib directory

42d1743

Remove ./number.js (You can use the compiled ones in `./lib/*`) Tell node that the `esm` directory is type `module` and enable tree shaking. Remove unused files from packages `files` property

Allow importing of package.json

e2a11e0

Make library ESM first

d98fb11

- Fix merge conflicts

19e16a2

- Refactor `bundleAny` into `defaultInstance.js` and `browserBundle.cjs` - Refactor unit tests to be able to run with plain nodejs (no transpiling) - Fix browser examples

Fix browser and browserstack tests

e4d07da

Fix running unit tests on Node 10 (which has no support for modules)

2617cab

josdejong mentioned this pull request Sep 9, 2020

Feature/specify import require paths #1941

Closed

josdejong added 3 commits September 9, 2020 14:56

Fix node.js examples (those are still commonjs)

f0a5778

Remove the need for browserBundle.cjs

ebbfa46

Generate minified bundle only

ca7b31c

GreenImp reviewed Sep 9, 2020

View reviewed changes

dependabot-preview bot and others added 5 commits September 12, 2020 16:51

Cleanup console.log

79b90d8

Add integration tests to test the entry points (commonjs/esm, full/nu…

c386ba8

…mber only)

Create backward compatibility error messages in the files moved/remov…

df0f8a1

…ed since v8

Describe breaking changes in HISTORY.md

b900b5b

josdejong mentioned this pull request Sep 16, 2020

TypeError: Cannot read property 'prototype' of undefined when run in jest #1898

Open

GreenImp mentioned this pull request Sep 17, 2020

Reduce package size dice-roller/rpg-dice-roller#110

Open

josdejong mentioned this pull request Sep 18, 2020

Usage in Node take error #1969

Closed

Merge branch 'develop' into specify-import-require-paths

ac12e2a

josdejong changed the base branch from develop to v8 September 20, 2020 15:57

josdejong merged commit 6f00715 into v8 Sep 20, 2020

josdejong deleted the specify-import-require-paths branch September 20, 2020 16:01

josdejong mentioned this pull request Oct 18, 2020

Breaking changes for v8 #1960

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Specify import require paths (continuation of #1941) #1962

Specify import require paths (continuation of #1941) #1962

josdejong commented Sep 9, 2020 •

edited

Loading

GreenImp Sep 9, 2020

josdejong Sep 9, 2020

GreenImp Sep 9, 2020

josdejong Sep 9, 2020

GreenImp Sep 17, 2020

josdejong commented Sep 13, 2020

GreenImp commented Sep 17, 2020

josdejong commented Sep 20, 2020

GreenImp commented Sep 25, 2020

josdejong commented Sep 25, 2020

josdejong commented Oct 18, 2020

GreenImp commented Oct 23, 2020

josdejong commented Oct 28, 2020

josdejong commented Nov 6, 2020

josdejong commented Nov 6, 2020

GreenImp commented Nov 25, 2020

josdejong commented Nov 25, 2020

Specify import require paths (continuation of #1941) #1962

Specify import require paths (continuation of #1941) #1962

Conversation

josdejong commented Sep 9, 2020 • edited Loading

GreenImp Sep 9, 2020

Choose a reason for hiding this comment

josdejong Sep 9, 2020

Choose a reason for hiding this comment

GreenImp Sep 9, 2020

Choose a reason for hiding this comment

josdejong Sep 9, 2020

Choose a reason for hiding this comment

GreenImp Sep 17, 2020

Choose a reason for hiding this comment

josdejong commented Sep 13, 2020

GreenImp commented Sep 17, 2020

josdejong commented Sep 20, 2020

GreenImp commented Sep 25, 2020

josdejong commented Sep 25, 2020

josdejong commented Oct 18, 2020

GreenImp commented Oct 23, 2020

josdejong commented Oct 28, 2020

josdejong commented Nov 6, 2020

josdejong commented Nov 6, 2020

GreenImp commented Nov 25, 2020

josdejong commented Nov 25, 2020

josdejong commented Sep 9, 2020 •

edited

Loading