docs: ass docs

.gitignore

@@ -3,3 +3,6 @@ node_modules
 dist
 *.log
 .vercel
+
+docs/.vitepress/dist
+docs/.vitepress/cache

.prettierrc.cjs

@@ -1,7 +1,7 @@
 const config = require('@yutengjing/prettier-config');
 
 config.overrides.push({
-    files: 'src/options.ts',
+    files: ['src/options.ts', 'docs/configuration.md'],
     options: {
         // https://github.com/hosseinmd/prettier-plugin-jsdoc/issues/225
         plugins: [],

README.md

@@ -4,7 +4,7 @@
 
 Detect duplicate packaged dependencies
 
-![effect](docs/effect.png)
+![effect](./docs/images/effect.png)
 
 ## Installation
 

docs/.vitepress/config.ts

@@ -0,0 +1,26 @@
+import { defineConfig } from 'vitepress';
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    title: 'unplugin-detect-duplicated-deps',
+    description: 'detect duplicate packaged dependencies',
+    themeConfig: {
+        // https://vitepress.dev/reference/default-theme-config
+        nav: [{ text: 'Home', link: '/' }],
+
+        sidebar: [
+            {
+                items: [
+                    { text: 'Introduction', link: '/introduction.md' },
+                    { text: 'Getting Started', link: '/getting-started.md' },
+                    { text: 'Configuration', link: '/configuration.md' },
+                ],
+            },
+        ],
+
+        socialLinks: [
+            { icon: 'github', link: 'https://github.com/tjx666/unplugin-detect-duplicated-deps' },
+            { icon: 'twitter', link: 'https://twitter.com/YuTengjing' },
+        ],
+    },
+});

docs/.vitepress/theme/custom.css

@@ -0,0 +1,7 @@
+#VPContent div.VPHero.VPHomeHero .name {
+    white-space: nowrap;
+}
+
+#VPContent ._introduction > div > p > a {
+    display: inline-block;
+}

docs/.vitepress/theme/index.ts

@@ -0,0 +1,18 @@
+// https://vitepress.dev/guide/custom-theme
+import type { Theme } from 'vitepress';
+import DefaultTheme from 'vitepress/theme';
+import { h } from 'vue';
+import './style.css';
+import './custom.css';
+
+export default {
+    extends: DefaultTheme,
+    Layout: () => {
+        return h(DefaultTheme.Layout, null, {
+            // https://vitepress.dev/guide/extending-default-theme#layout-slots
+        });
+    },
+    // enhanceApp({ app, router, siteData }) {
+    //     // ...
+    // },
+} satisfies Theme;

docs/.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+

docs/configuration.md

@@ -0,0 +1,63 @@
+# Configuration
+
+view latest [source code](https://github.com/tjx666/unplugin-detect-duplicated-deps/blob/main/src/options.ts)
+
+````ts
+export interface Options {
+  /**
+   * Config the duplicated dependencies which will be ignored, you can pass `*` as version to ignore all versions
+   *
+   * @example
+   * ```javascript
+   *  {
+   *      axios: ['0.17.4', '1.4.0']
+   *  }
+   *  ```
+   * @default {}
+   */
+  ignore?: Record<string, string[]>;
+
+  /**
+   * Disable show package size can improve build speed because we get package size by api of https://bundlephobia.com/
+   *
+   * @default true
+   */
+  showPkgSize?: boolean;
+
+  /**
+   * Whether report the duplicated deps depended by another dep under node_modules
+   *
+   * @default true
+   */
+  deep?: boolean;
+
+  /**
+   * Enable this to make build failed when exists duplicated deps
+   *
+   * @default false
+   */
+  throwErrorWhenDuplicated?: boolean;
+
+  /**
+   * Custom the error message when exists duplicated deps
+   *
+   * @example
+   *
+   * ```txt
+   * packageToVersionsMap structure:
+   *
+   * Map(2) {
+   *     '@pixi/utils' => Map(2) {
+   *       '7.0.0' => Set(1) { 'tests/fixtures/mono/packages/pkg2/index.js' },
+   *       '7.2.4' => Set(1) { 'tests/fixtures/mono/packages/pkg1/index.js' }
+   *     },
+   *     'axios' => Map(2) {
+   *       '0.27.2' => Set(1) { 'tests/fixtures/mono/packages/pkg2/index.js' },
+   *       '1.4.0' => Set(1) { 'tests/fixtures/mono/packages/pkg1/index.js' }
+   *     }
+   * }
+   * ```
+   */
+  customErrorMessage?: (packageToVersionsMap: Map<string, Map<string, Set<string>>>) => string;
+}
+````

docs/getting-started.md

@@ -0,0 +1,39 @@
+# Getting Started
+
+## Installation
+
+```sh
+pnpm -D add unplugin-detect-duplicated-deps
+```
+
+If you are using Yarn, NPM or Bun
+
+```sh
+yarn add -D unplugin-detect-duplicated-deps
+npm add -D unplugin-detect-duplicated-deps
+bun add -D unplugin-detect-duplicated-deps
+```
+
+## Add to config file
+
+### Vit
+
+```ts
+// vite.config.ts
+import UnpluginDetectDuplicatedDeps from 'unplugin-detect-duplicated-deps/vite';
+
+export default defineConfig({
+  plugins: [UnpluginDetectDuplicatedDeps()],
+});
+```
+
+### Rollup
+
+```ts
+// rollup.config.js
+import UnpluginDetectDuplicatedDeps from 'unplugin-detect-duplicated-deps/rollup';
+
+export default {
+  plugins: [UnpluginDetectDuplicatedDeps()],
+};
+```

docs/index.md

@@ -0,0 +1,24 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: 'unplugin-detect-duplicated-deps'
+  # text: "detect duplicate packaged dependencies"
+  tagline: detect duplicate packaged dependencies
+  actions:
+    - theme: brand
+      text: Getting Started
+      link: /getting-started.md
+    - theme: alt
+      text: View on Github
+      link: https://github.com/tjx666/unplugin-detect-duplicated-deps
+
+features:
+  - title: Locate duplicate dependencies
+    details: Help you reduce bundle size
+  - title: Show package size
+    details: Visually demonstrate the impact on project bundle
+  - title: Use as build checker
+    details: Timely discover and resolve introduced new duplicated dependencies
+---

docs/introduction.md

@@ -0,0 +1,11 @@
+# About unplugin-detect-duplicated-deps
+
+[![npm](https://img.shields.io/npm/v/unplugin-detect-duplicated-deps.svg)](https://npmjs.com/package/unplugin-detect-duplicated-deps) [![downloads](https://img.shields.io/npm/dw/unplugin-detect-duplicated-deps)](https://npmjs.com/package/unplugin-detect-duplicated-deps) [![Unit Test](https://github.com/tjx666/unplugin-detect-duplicated-deps/actions/workflows/unit-test.yml/badge.svg)](https://github.com/tjx666/unplugin-detect-duplicated-deps/actions/workflows/unit-test.yml)
+
+**Detect duplicate packaged dependencies：**
+
+![effect](./images/effect.png)
+
+**Use as a build checker：**
+
+![build checker](./images/checker.png)

docs/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "docs",
+    "type": "module",
+    "dependencies": {
+        "vitepress": "1.0.0-rc.39",
+        "vue": "^3.4.15"
+    }
+}

package.json

@@ -80,7 +80,10 @@
         "dev": "tsup --watch",
         "test": "vitest --test-timeout=10000",
         "release": "bumpp && pnpm publish",
-        "prepublishOnly": "pnpm run build"
+        "prepublishOnly": "pnpm run build",
+        "docs:dev": "pnpm --filter docs exec vitepress dev .",
+        "docs:build": "pnpm --filter docs exec vitepress build .",
+        "docs:serve": "pnpm --filter docs exec vitepress serve ."
     },
     "dependencies": {
         "@rollup/pluginutils": "^5.1.0",
@@ -103,6 +106,7 @@
         "prettier": "^3.2.4",
         "tsup": "^8.0.1",
         "tsx": "^4.7.0",
+        "typedoc": "^0.25.7",
         "typescript": "^5.3.3",
         "vite": "^5.0.11",
         "vitest": "^1.2.1"