unplugin-todo-or-die

KO | EN

gitlite — search

#hacktoberfest #react #typescript #android #machine-learning #rust #linux #nodejs #java #windows #kubernetes #vue #pytorch #security

unplugin-todo-or-die

(★ 22)

TODO or Die plugin for JavaScript :)

unplugin-todo-or-die Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# unplugin-todo-or-die

[![NPM version](https://img.shields.io/npm/v/unplugin-todo-or-die?color=a1b858&label=)](https://www.npmjs.com/package/unplugin-todo-or-die)

> TODO or DIEEEEEEE!!!!!!!!!!!!!

This plugin turns these TODO comments:

```ts
// TODO::expires(2021-01-01): do something
// TODO::expire(2021-01-01): do something
```

Into such code:

```ts
if (Date.now() > 1_704_067_200_000) {
	throw new Error("TODO expired: do something");
}
```

## 📦 Installation

```bash
$ npm install -D unplugin-todo-or-die
$ yarn add -D unplugin-todo-or-die
$ pnpm add -D unplugin-todo-or-die
```

## 🚀 Usage

```ts
// vite.config.ts
import TodoOrDie from "unplugin-todo-or-die/vite";

export default defineConfig({
	plugins: [
		TodoOrDie({
			/* options */
		}),
	],
});
```

</details>

<details>
<summary>Rollup</summary>

```ts
// rollup.config.js
import TodoOrDie from "unplugin-todo-or-die/rollup";

export default {
	plugins: [
		TodoOrDie({
			/* options */
		}),
		// other plugins
	],
};
```

</details>

<details>
<summary>Webpack</summary>

```ts
// webpack.config.js
module.exports = {
	/* ... */
	plugins: [
		require("unplugin-todo-or-die/webpack")({
			/* options */
		}),
	],
};
```

</details>

```ts
// nuxt.config.ts
export default defineNuxtConfig({
	modules: ["unplugin-todo-or-die/nuxt"],
});
```

</details>

```ts
// vue.config.js
module.exports = {
	configureWebpack: {
		plugins: [
			require("unplugin-todo-or-die/webpack")({
				/* options */
			}),
		],
	},
};
```

</details>

<details>
<summary>Quasar</summary>

```ts
// quasar.conf.js [Vite]
module.exports = {
	vitePlugins: [
		[
			"unplugin-todo-or-die/vite",
			{
				/* options */
			},
		],
	],
};
```

```ts
// quasar.conf.js [Webpack]
const TodoOrDiePlugin = require("unplugin-todo-or-die/webpack");

module.exports = {
	build: {
		chainWebpack(chain) {
			chain.plugin("unplugin-todo-or-die").use(
				TodoOrDiePlugin({
					/* options */
				}),
			);
		},
	},
};
```

</details>

<details>
<summary>esbuild</summary>

```ts
// esbuild.config.js
import { build } from "esbuild";

build({
	/* ... */
	plugins: [
		require("unplugin-todo-or-die/esbuild")({
			/* options */
		}),
	],
});
```

</details>

<details>
<summary>Astro</summary>

```ts
// astro.config.mjs
import TodoOrDie from "unplugin-todo-or-die/astro";

export default defineConfig({
	integrations: [
		TodoOrDie({
			/* options */
		}),
	],
});
```

</details>

## 🖥️ Credits

Original version (ruby): https://github.com/searls/todo_or_die

## 📝 License

[MIT](./LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)

unplugin-todo-or-die

unplugin-todo-or-die Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

unplugin-todo-or-die

unplugin-todo-or-die Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README