Switch from rollup to vite, from commonjs to ecmascript modules

[flevi29]

Pull Request

Related issue

Fixes #1626
Waiting on #1739

What does this PR do?

• switches bundler from rollup to vite, which internally uses rollup, but makes things a lot shorter and simpler
  • removes the need for separate vitest.config.js
  • removes the need for scripts/file-size.js, packages kleur, pretty-bytes, brotli-size, gzip-size, as it prints sizes by default
  • removes the need for all of the rollup plugins and dependencies (@rollup/plugin-terser, @babel/core, @babel/preset-env, @rollup/plugin-babel, @rollup/plugin-commonjs, @rollup/plugin-json, @rollup/plugin-node-resolve, rollup-plugin-typescript2)
  • removes the need for shx package, and cleanup script, as it clears dist itself
• switches from CJS to ESM ("type": "module")
  • every .js project file now needs to be written in ESM syntax, the web standard syntax
  • TypeScript files were already written in ESM syntax, so this just makes things more consistent
• updates TypeScript and makes some changes to tsconfig.json according to https://www.typescriptlang.org/docs/handbook/modules/guides/choosing-compiler-options.html#im-writing-a-library
  • is now used to transpile ESM version of this package
  • most importantly sets module to node16 and verbatimModuleSyntax to true, this requires changes to all TypeScript files so they may be compatible with the web standard ESM
    • all imported files now require a .js extension
    • there is no more support for index directory imports, as that is only a Node.js thing, the web doesn't support it
    • when importing types, we need to explicitly specify that we're doing so with the type keyword

Warning

• DEPRECATE default export Remove default export #1789

Warning

• DEPRECATION: UMD bundle will no longer extend window with the exports in the future, instead it will only extend it with property meilisearch which contains the exports Do not extend window with all of the exports in UMD bundle, rather just a property of window #1806

Old

<script>
  const client = new MeiliSearch(/* ... */);
</script>

New

<script>
  const client = new meilisearch.MeiliSearch(/* ... */);
</script>

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.21%. Comparing base (896b5c0) to head (e1ca1ab).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1740   +/-   ##
=======================================
  Coverage   98.20%   98.21%           
=======================================
  Files          18       17    -1     
  Lines        1562     1565    +3     
  Branches      333      333           
=======================================
+ Hits         1534     1537    +3     
  Misses         28       28           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[flevi29]

EXPLAINER: These are no longer required, as exports below contains the types, and TypeScript primarily looks there.

[flevi29]

EXPLAINER: "exports" is the replacement for these and we no longer officially support Node.js versions prior to 18, so we do not need the backwards compatibility.

[flevi29]

Hey @brunoocasali, it's been a while. Please, can you take a look at this PR? It would unblock me from contributing even more, for instance using vite to greatly improve the live demo test.

[Strift]

I support this change too 👍 However, I would recommend making this non-breaking for users.

For the exports: I would add information in the documentation to explain that default export is deprecated, will be removed one day, and named export should be preferred.

For the UMD bundle: is there a way to approach it in the same way? Via documentation, and roll out the breaking change in the future.

[flevi29]

Thanks for the feedback, I'll try to do just that.

[flevi29]

Hey @Strift, I've reverted the default export change, and deprecated it instead. However I couldn't find a solution for the second breaking change. At least not a straight forward one, I don't think it's worth hacking around with it though too much. That one's either extending window with all the exports, or a property (meilisearch) which has all the exports, doesn't really do both.

[flevi29]

@brunoocasali @Strift No good?

[flevi29]

@brunoocasali @Strift Hey, I managed to make this a non breaking change.

[flevi29]

Is this fine here? Or should it just be in the release notes? If it's fine should I also mention the window deprecation as well here?