fix: Switch to Tailwind v3 - v4 incompatible with Astro
This commit is contained in:
Kunthawat
217
node_modules/jiti/README.md
generated
vendored
217
node_modules/jiti/README.md
generated
vendored
@@ -1,152 +1,90 @@
|
||||
# jiti
|
||||
|
||||
<!-- automd:badges color=F0DB4F bundlephobia -->
|
||||
[![npm version][npm-version-src]][npm-version-href]
|
||||
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
||||
[![bundle][bundle-src]][bundle-href]
|
||||
[![License][license-src]][license-href]
|
||||
|
||||
[](https://npmjs.com/package/jiti)
|
||||
[](https://npmjs.com/package/jiti)
|
||||
[](https://bundlephobia.com/package/jiti)
|
||||
|
||||
<!-- /automd -->
|
||||
|
||||
> This is the active development branch. Check out [jiti/v1](https://github.com/unjs/jiti/tree/v1) for legacy v1 docs and code.
|
||||
|
||||
## 🌟 Used in
|
||||
|
||||
[Docusaurus](https://docusaurus.io/), [ESLint](https://github.com/eslint/eslint), [FormKit](https://formkit.com/), [Histoire](https://histoire.dev/), [Knip](https://knip.dev/), [Nitro](https://nitro.unjs.io/), [Nuxt](https://nuxt.com/), [PostCSS loader](https://github.com/webpack-contrib/postcss-loader), [Rsbuild](https://rsbuild.dev/), [Size Limit](https://github.com/ai/size-limit), [Slidev](https://sli.dev/), [Tailwindcss](https://tailwindcss.com/), [Tokenami](https://github.com/tokenami/tokenami), [UnoCSS](https://unocss.dev/), [WXT](https://wxt.dev/), [Winglang](https://www.winglang.io/), [Graphql code generator](https://the-guild.dev/graphql/codegen), [Lingui](https://lingui.dev/), [Scaffdog](https://scaff.dog/), [Storybook](https://storybook.js.org), [...UnJS ecosystem](https://unjs.io/), [...60M+ npm monthly downloads](https://npm.chart.dev/jiti), [...6M+ public repositories](https://github.com/unjs/jiti/network/dependents).
|
||||
|
||||
## ✅ Features
|
||||
|
||||
- Seamless TypeScript and ESM syntax support for Node.js
|
||||
- Seamless interoperability between ESM and CommonJS
|
||||
- Asynchronous API to replace `import()`
|
||||
- Synchronous API to replace `require()` (deprecated)
|
||||
- Super slim and zero dependency
|
||||
- Custom resolve aliases
|
||||
- Smart syntax detection to avoid extra transforms
|
||||
- Node.js native `require.cache` integration
|
||||
- Filesystem transpile with hard disk caches
|
||||
- ESM Loader support
|
||||
- JSX support (opt-in)
|
||||
Runtime Typescript and ESM support for Node.js.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> To enhance compatibility, jiti `>=2.1` enabled [`interopDefault`](#interopdefault) using a new Proxy method. If you migrated to `2.0.0` earlier, this might have caused behavior changes. In case of any issues during the upgrade, please [report](https://github.com/unjs/jiti/issues) so we can investigate to solve them. 🙏🏼
|
||||
> This is the support branch for jiti v1. Check out [jiti/main](https://github.com/unjs/jiti/tree/main) for the latest version and [unjs/jiti#174](https://github.com/unjs/jiti/issues/174) for the roadmap.
|
||||
|
||||
## 💡 Usage
|
||||
## Features
|
||||
|
||||
### CLI
|
||||
- Seamless typescript and ESM syntax support
|
||||
- Seamless interoperability between ESM and CommonJS
|
||||
- Synchronous API to replace `require`
|
||||
- Super slim and zero dependency
|
||||
- Smart syntax detection to avoid extra transforms
|
||||
- CommonJS cache integration
|
||||
- Filesystem transpile hard cache
|
||||
- V8 compile cache
|
||||
- Custom resolve alias
|
||||
|
||||
You can use `jiti` CLI to quickly run any script with TypeScript and native ESM support!
|
||||
|
||||
```bash
|
||||
npx jiti ./index.ts
|
||||
```
|
||||
## Usage
|
||||
|
||||
### Programmatic
|
||||
|
||||
Initialize a jiti instance:
|
||||
|
||||
```js
|
||||
// ESM
|
||||
import { createJiti } from "jiti";
|
||||
const jiti = createJiti(import.meta.url);
|
||||
const jiti = require("jiti")(__filename);
|
||||
|
||||
// CommonJS (deprecated)
|
||||
const { createJiti } = require("jiti");
|
||||
const jiti = createJiti(__filename);
|
||||
jiti("./path/to/file.ts");
|
||||
```
|
||||
|
||||
Import (async) and resolve with ESM compatibility:
|
||||
You can also pass options as second argument:
|
||||
|
||||
```js
|
||||
// jiti.import(id) is similar to import(id)
|
||||
const mod = await jiti.import("./path/to/file.ts");
|
||||
|
||||
// jiti.esmResolve(id) is similar to import.meta.resolve(id)
|
||||
const resolvedPath = jiti.esmResolve("./src");
|
||||
const jiti = require("jiti")(__filename, { debug: true });
|
||||
```
|
||||
|
||||
If you need the default export of module, you can use `jiti.import(id, { default: true })` as shortcut to `mod?.default ?? mod`.
|
||||
|
||||
```js
|
||||
// shortcut to mod?.default ?? mod
|
||||
const modDefault = await jiti.import("./path/to/file.ts", { default: true });
|
||||
```
|
||||
|
||||
CommonJS (sync & deprecated):
|
||||
|
||||
```js
|
||||
// jiti() is similar to require(id)
|
||||
const mod = jiti("./path/to/file.ts");
|
||||
|
||||
// jiti.resolve() is similar to require.resolve(id)
|
||||
const resolvedPath = jiti.resolve("./src");
|
||||
```
|
||||
|
||||
You can also pass options as the second argument:
|
||||
|
||||
```js
|
||||
const jiti = createJiti(import.meta.url, { debug: true });
|
||||
```
|
||||
|
||||
### Register global ESM loader
|
||||
|
||||
You can globally register jiti using [global hooks](https://nodejs.org/api/module.html#initialize). (Important: Requires Node.js > 20)
|
||||
|
||||
```js
|
||||
import "jiti/register";
|
||||
```
|
||||
|
||||
Or:
|
||||
### CLI
|
||||
|
||||
```bash
|
||||
node --import jiti/register index.ts
|
||||
jiti index.ts
|
||||
# or npx jiti index.ts
|
||||
```
|
||||
|
||||
## 🎈 `jiti/native`
|
||||
### Register require hook
|
||||
|
||||
You can alias `jiti` to `jiti/native` to directly depend on runtime's [`import.meta.resolve`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta/resolve) and dynamic [`import()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import) support. This allows easing up the ecosystem transition to runtime native support by giving the same API of jiti.
|
||||
```bash
|
||||
node -r jiti/register index.ts
|
||||
```
|
||||
|
||||
## ⚙️ Options
|
||||
Alternatively, you can register `jiti` as a require hook programmatically:
|
||||
|
||||
```js
|
||||
const jiti = require("jiti")();
|
||||
const unregister = jiti.register();
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
### `debug`
|
||||
|
||||
- Type: Boolean
|
||||
- Default: `false`
|
||||
- Environment variable: `JITI_DEBUG`
|
||||
- Environment Variable: `JITI_DEBUG`
|
||||
|
||||
Enable verbose logging. You can use `JITI_DEBUG=1 <your command>` to enable it.
|
||||
Enable debug to see which files are transpiled
|
||||
|
||||
### `fsCache`
|
||||
### `cache`
|
||||
|
||||
- Type: Boolean | String
|
||||
- Default: `true`
|
||||
- Environment variable: `JITI_FS_CACHE`
|
||||
- Environment Variable: `JITI_CACHE`
|
||||
|
||||
Filesystem source cache (enabled by default)
|
||||
Use transpile cache
|
||||
|
||||
By default (when is `true`), jiti uses `node_modules/.cache/jiti` (if exists) or `{TMP_DIR}/jiti`.
|
||||
If set to `true` will use `node_modules/.cache/jiti` (if exists) or `{TMP_DIR}/node-jiti`
|
||||
|
||||
**Note:** It is recommended that this option be enabled for better performance.
|
||||
### `esmResolve`
|
||||
|
||||
### `rebuildFsCache`
|
||||
|
||||
- Type: Boolean
|
||||
- Type: Boolean | String
|
||||
- Default: `false`
|
||||
- Environment variable: `JITI_REBUILD_FS_CACHE`
|
||||
- Environment Variable: `JITI_ESM_RESOLVE`
|
||||
|
||||
Rebuild filesystem source cache created by `fsCache`.
|
||||
|
||||
### `moduleCache`
|
||||
|
||||
- Type: String
|
||||
- Default: `true`
|
||||
- Environment variable: `JITI_MODULE_CACHE`
|
||||
|
||||
Runtime module cache (enabled by default).
|
||||
|
||||
Disabling allows editing code and importing the same module multiple times.
|
||||
|
||||
When enabled, jiti integrates with Node.js native CommonJS cache-store.
|
||||
Using esm resolution algorithm to support `import` condition.
|
||||
|
||||
### `transform`
|
||||
|
||||
@@ -159,65 +97,48 @@ Transform function. See [src/babel](./src/babel.ts) for more details
|
||||
|
||||
- Type: Boolean
|
||||
- Default `false`
|
||||
- Environment variable: `JITI_SOURCE_MAPS`
|
||||
- Environment Variable: `JITI_SOURCE_MAPS`
|
||||
|
||||
Add inline source map to transformed source for better debugging.
|
||||
|
||||
### `interopDefault`
|
||||
|
||||
- Type: Boolean
|
||||
- Default: `true`
|
||||
- Environment variable: `JITI_INTEROP_DEFAULT`
|
||||
- Default: `false`
|
||||
|
||||
Jiti combines module exports with the `default` export using an internal Proxy to improve compatibility with mixed CJS/ESM usage. You can check the current implementation [here](https://github.com/unjs/jiti/blob/main/src/utils.ts#L105).
|
||||
Return the `.default` export of a module at the top-level.
|
||||
|
||||
### `alias`
|
||||
|
||||
- Type: Object
|
||||
- Default: -
|
||||
- Environment variable: `JITI_ALIAS`
|
||||
- Environment Variable: `JITI_ALIAS`
|
||||
|
||||
You can also pass an object to the environment variable for inline config. Example: `JITI_ALIAS='{"~/*": "./src/*"}' jiti ...`.
|
||||
|
||||
Custom alias map used to resolve IDs.
|
||||
Custom alias map used to resolve ids.
|
||||
|
||||
### `nativeModules`
|
||||
|
||||
- Type: Array
|
||||
- Default: ['typescript']
|
||||
- Environment variable: `JITI_NATIVE_MODULES`
|
||||
- Default: ['typescript`]
|
||||
- Environment Variable: `JITI_NATIVE_MODULES`
|
||||
|
||||
List of modules (within `node_modules`) to always use native `require()` for them.
|
||||
List of modules (within `node_modules`) to always use native require for them.
|
||||
|
||||
### `transformModules`
|
||||
|
||||
- Type: Array
|
||||
- Default: []
|
||||
- Environment variable: `JITI_TRANSFORM_MODULES`
|
||||
- Environment Variable: `JITI_TRANSFORM_MODULES`
|
||||
|
||||
List of modules (within `node_modules`) to transform them regardless of syntax.
|
||||
|
||||
### `importMeta`
|
||||
|
||||
Parent module's [`import.meta`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta) context to use for ESM resolution. (only used for `jiti/native` import).
|
||||
|
||||
### `tryNative`
|
||||
### `experimentalBun`
|
||||
|
||||
- Type: Boolean
|
||||
- Default: Enabled if bun is detected
|
||||
- Environment variable: `JITI_TRY_NATIVE`
|
||||
- Default: Enabled if `process.versions.bun` exists (Bun runtime)
|
||||
- Environment Variable: `JITI_EXPERIMENTAL_BUN`
|
||||
|
||||
Try to use native require and import without jiti transformations first.
|
||||
|
||||
### `jsx`
|
||||
|
||||
- Type: Boolean | {options}
|
||||
- Default: `false`
|
||||
- Environment Variable: `JITI_JSX`
|
||||
|
||||
Enable JSX support using [`@babel/plugin-transform-react-jsx`](https://babeljs.io/docs/babel-plugin-transform-react-jsx).
|
||||
|
||||
See [`test/fixtures/jsx`](./test/fixtures/jsx) for framework integration examples.
|
||||
Enable experimental native Bun support for transformations.
|
||||
|
||||
## Development
|
||||
|
||||
@@ -229,15 +150,15 @@ See [`test/fixtures/jsx`](./test/fixtures/jsx) for framework integration example
|
||||
|
||||
## License
|
||||
|
||||
<!-- automd:contributors license=MIT author="pi0" -->
|
||||
MIT. Made with 💖
|
||||
|
||||
Published under the [MIT](https://github.com/unjs/jiti/blob/main/LICENSE) license.
|
||||
Made by [@pi0](https://github.com/pi0) and [community](https://github.com/unjs/jiti/graphs/contributors) 💛
|
||||
<br><br>
|
||||
<a href="https://github.com/unjs/jiti/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=unjs/jiti" />
|
||||
</a>
|
||||
<!-- Badged -->
|
||||
|
||||
<!-- /automd -->
|
||||
|
||||
<!-- automd:with-automd -->
|
||||
[npm-version-src]: https://img.shields.io/npm/v/jiti?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[npm-version-href]: https://npmjs.com/package/jiti
|
||||
[npm-downloads-src]: https://img.shields.io/npm/dm/jiti?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[npm-downloads-href]: https://npmjs.com/package/jiti
|
||||
[bundle-src]: https://img.shields.io/bundlephobia/minzip/jiti?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[bundle-href]: https://bundlephobia.com/result?p=h3
|
||||
[license-src]: https://img.shields.io/github/license/unjs/jiti.svg?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[license-href]: https://github.com/unjs/jiti/blob/main/LICENSE
|
||||
|
||||
Reference in New Issue
Block a user