Skip to content

Commit

Permalink
Include Docusaurus in the list of frameworks that are using jiti
Browse files Browse the repository at this point in the history
  • Loading branch information
aryaemami59 committed Mar 17, 2024
1 parent 0e09c10 commit 3c37a94
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion designs/2024-support-ts-config-files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The goal is to seamlessly support TypeScript configuration files in ESLint. To a
- There should not be extra overhead for JavaScript users. This means this change should not have a significant impact (if any at all) affecting users who use plain JavaScript config files.
- The external tools that are used to parse the config files written in TypeScript should not create side effects. Specifically, it is imperative that these tools do not interfere with Node.js's native module resolution system by hooking into or altering the standard `import/require` mechanisms. This means tools like [`ts-node`](https://github.com/TypeStrong/ts-node) and [`tsx`](https://github.com/privatenumber/tsx) might not be suitable for this purpose.

So far the tool that seems to be the most suitable for this purpose is [`jiti`](https://www.npmjs.com/package/jiti). It does not introduce side effects and performs well, demonstrating its reliability. It also seems to be more battle-tested given some established frameworks such as [Nuxt](https://github.com/nuxt/nuxt) and [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) have been using it to load their configuration files.
So far the tool that seems to be the most suitable for this purpose is [`jiti`](https://www.npmjs.com/package/jiti). It does not introduce side effects and performs well, demonstrating its reliability. It also seems to be more battle-tested given some established frameworks such as [Nuxt](https://github.com/nuxt/nuxt), [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) and [Docusaurus](https://github.com/facebook/docusaurus) have been using it to load their configuration files.

## Examples

Expand Down Expand Up @@ -250,3 +250,6 @@ I will be implementing this feature. I will need help from the team to review th
- [Vitest on Github](https://github.com/vitest-dev/vitest)
- [Vitest on NPM](https://www.npmjs.com/package/vitest)
- [Vitest Docs](https://vitest.dev)
- [Docusaurus on Github](https://github.com/facebook/docusaurus)
- [Docusaurus on NPM](https://www.npmjs.com/package/docusaurus)
- [Docusaurus Docs](https://docusaurus.io)

0 comments on commit 3c37a94

Please sign in to comment.