ads-fe 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +99 -0
- package/dist/cli.js +545 -0
- package/dist/meta.js +93 -0
- package/package.json +43 -0
- package/skill.md +66 -0
- package/skills/core/SKILL.md +66 -0
- package/skills/core/references/app-development.md +45 -0
- package/skills/core/references/git.md +66 -0
- package/skills/core/references/monorepo.md +124 -0
- package/skills/element-plus-vue3/LICENSE.md +405 -0
- package/skills/element-plus-vue3/LICENSE.txt +202 -0
- package/skills/element-plus-vue3/SKILL.md +218 -0
- package/skills/element-plus-vue3/SYNC.md +5 -0
- package/skills/element-plus-vue3/api/component-api.md +94 -0
- package/skills/element-plus-vue3/api/global-config.md +89 -0
- package/skills/element-plus-vue3/api/props-and-events.md +101 -0
- package/skills/element-plus-vue3/examples/components/button.md +99 -0
- package/skills/element-plus-vue3/examples/components/date-picker.md +115 -0
- package/skills/element-plus-vue3/examples/components/dialog.md +106 -0
- package/skills/element-plus-vue3/examples/components/form.md +127 -0
- package/skills/element-plus-vue3/examples/components/input.md +123 -0
- package/skills/element-plus-vue3/examples/components/message.md +93 -0
- package/skills/element-plus-vue3/examples/components/overview.md +59 -0
- package/skills/element-plus-vue3/examples/components/select.md +133 -0
- package/skills/element-plus-vue3/examples/components/table.md +166 -0
- package/skills/element-plus-vue3/examples/guide/design.md +68 -0
- package/skills/element-plus-vue3/examples/guide/global-config.md +95 -0
- package/skills/element-plus-vue3/examples/guide/i18n.md +95 -0
- package/skills/element-plus-vue3/examples/guide/installation.md +110 -0
- package/skills/element-plus-vue3/examples/guide/quick-start.md +103 -0
- package/skills/element-plus-vue3/examples/guide/theme.md +78 -0
- package/skills/element-plus-vue3/templates/component-usage.md +92 -0
- package/skills/element-plus-vue3/templates/installation.md +82 -0
- package/skills/element-plus-vue3/templates/project-setup.md +83 -0
- package/skills/node/LICENSE.md +21 -0
- package/skills/node/SKILL.md +94 -0
- package/skills/node/SYNC.md +5 -0
- package/skills/node/rules/assets/graceful-server.test.ts +88 -0
- package/skills/node/rules/assets/graceful-server.ts +80 -0
- package/skills/node/rules/async-patterns.md +136 -0
- package/skills/node/rules/caching.md +198 -0
- package/skills/node/rules/environment.md +253 -0
- package/skills/node/rules/error-handling.md +164 -0
- package/skills/node/rules/flaky-tests.md +439 -0
- package/skills/node/rules/graceful-shutdown.md +204 -0
- package/skills/node/rules/logging.md +205 -0
- package/skills/node/rules/modules.md +105 -0
- package/skills/node/rules/node-modules-exploration.md +172 -0
- package/skills/node/rules/performance.md +130 -0
- package/skills/node/rules/profiling.md +183 -0
- package/skills/node/rules/streams.md +213 -0
- package/skills/node/rules/stuck-processes-and-tests.md +124 -0
- package/skills/node/rules/testing.md +218 -0
- package/skills/node/rules/typescript.md +262 -0
- package/skills/node/tile.json +11 -0
- package/skills/nuxt/GENERATION.md +5 -0
- package/skills/nuxt/LICENSE.md +21 -0
- package/skills/nuxt/SKILL.md +55 -0
- package/skills/nuxt/SYNC.md +5 -0
- package/skills/nuxt/references/advanced-hooks.md +289 -0
- package/skills/nuxt/references/advanced-layers.md +299 -0
- package/skills/nuxt/references/advanced-module-authoring.md +554 -0
- package/skills/nuxt/references/best-practices-data-fetching.md +357 -0
- package/skills/nuxt/references/best-practices-ssr.md +355 -0
- package/skills/nuxt/references/core-cli.md +263 -0
- package/skills/nuxt/references/core-config.md +162 -0
- package/skills/nuxt/references/core-data-fetching.md +236 -0
- package/skills/nuxt/references/core-deployment.md +224 -0
- package/skills/nuxt/references/core-directory-structure.md +269 -0
- package/skills/nuxt/references/core-modules.md +292 -0
- package/skills/nuxt/references/core-routing.md +226 -0
- package/skills/nuxt/references/features-components-autoimport.md +328 -0
- package/skills/nuxt/references/features-components.md +264 -0
- package/skills/nuxt/references/features-composables.md +276 -0
- package/skills/nuxt/references/features-server.md +265 -0
- package/skills/nuxt/references/features-state.md +194 -0
- package/skills/nuxt/references/rendering-modes.md +237 -0
- package/skills/pinia/GENERATION.md +5 -0
- package/skills/pinia/LICENSE.md +21 -0
- package/skills/pinia/SKILL.md +59 -0
- package/skills/pinia/SYNC.md +5 -0
- package/skills/pinia/references/advanced-hmr.md +61 -0
- package/skills/pinia/references/advanced-nuxt.md +119 -0
- package/skills/pinia/references/advanced-ssr.md +121 -0
- package/skills/pinia/references/best-practices-outside-component.md +115 -0
- package/skills/pinia/references/best-practices-testing.md +212 -0
- package/skills/pinia/references/core-stores.md +389 -0
- package/skills/pinia/references/features-composables.md +114 -0
- package/skills/pinia/references/features-composing-stores.md +134 -0
- package/skills/pinia/references/features-plugins.md +203 -0
- package/skills/pnpm/GENERATION.md +5 -0
- package/skills/pnpm/LICENSE.md +21 -0
- package/skills/pnpm/SKILL.md +42 -0
- package/skills/pnpm/SYNC.md +5 -0
- package/skills/pnpm/references/best-practices-ci.md +285 -0
- package/skills/pnpm/references/best-practices-migration.md +291 -0
- package/skills/pnpm/references/best-practices-performance.md +284 -0
- package/skills/pnpm/references/core-cli.md +229 -0
- package/skills/pnpm/references/core-config.md +188 -0
- package/skills/pnpm/references/core-store.md +179 -0
- package/skills/pnpm/references/core-workspaces.md +205 -0
- package/skills/pnpm/references/features-aliases.md +168 -0
- package/skills/pnpm/references/features-catalogs.md +159 -0
- package/skills/pnpm/references/features-hooks.md +233 -0
- package/skills/pnpm/references/features-overrides.md +184 -0
- package/skills/pnpm/references/features-patches.md +201 -0
- package/skills/pnpm/references/features-peer-deps.md +250 -0
- package/skills/slidev/LICENSE.md +21 -0
- package/skills/slidev/README.md +61 -0
- package/skills/slidev/SKILL.md +189 -0
- package/skills/slidev/SYNC.md +5 -0
- package/skills/slidev/references/animation-click-marker.md +37 -0
- package/skills/slidev/references/animation-drawing.md +68 -0
- package/skills/slidev/references/animation-rough-marker.md +53 -0
- package/skills/slidev/references/api-slide-hooks.md +37 -0
- package/skills/slidev/references/build-og-image.md +36 -0
- package/skills/slidev/references/build-pdf.md +40 -0
- package/skills/slidev/references/build-remote-assets.md +34 -0
- package/skills/slidev/references/build-seo-meta.md +43 -0
- package/skills/slidev/references/code-groups.md +64 -0
- package/skills/slidev/references/code-import-snippet.md +55 -0
- package/skills/slidev/references/code-line-highlighting.md +50 -0
- package/skills/slidev/references/code-line-numbers.md +46 -0
- package/skills/slidev/references/code-magic-move.md +57 -0
- package/skills/slidev/references/code-max-height.md +37 -0
- package/skills/slidev/references/code-twoslash.md +42 -0
- package/skills/slidev/references/core-animations.md +196 -0
- package/skills/slidev/references/core-cli.md +140 -0
- package/skills/slidev/references/core-components.md +197 -0
- package/skills/slidev/references/core-exporting.md +148 -0
- package/skills/slidev/references/core-frontmatter.md +195 -0
- package/skills/slidev/references/core-global-context.md +155 -0
- package/skills/slidev/references/core-headmatter.md +188 -0
- package/skills/slidev/references/core-hosting.md +152 -0
- package/skills/slidev/references/core-layouts.md +286 -0
- package/skills/slidev/references/core-syntax.md +155 -0
- package/skills/slidev/references/diagram-latex.md +55 -0
- package/skills/slidev/references/diagram-mermaid.md +44 -0
- package/skills/slidev/references/diagram-plantuml.md +45 -0
- package/skills/slidev/references/editor-monaco-run.md +44 -0
- package/skills/slidev/references/editor-monaco-write.md +24 -0
- package/skills/slidev/references/editor-monaco.md +50 -0
- package/skills/slidev/references/editor-prettier.md +40 -0
- package/skills/slidev/references/editor-side.md +23 -0
- package/skills/slidev/references/editor-vscode.md +55 -0
- package/skills/slidev/references/layout-canvas-size.md +25 -0
- package/skills/slidev/references/layout-draggable.md +57 -0
- package/skills/slidev/references/layout-global-layers.md +50 -0
- package/skills/slidev/references/layout-slots.md +75 -0
- package/skills/slidev/references/layout-transform.md +33 -0
- package/skills/slidev/references/layout-zoom.md +39 -0
- package/skills/slidev/references/presenter-notes-ruby.md +35 -0
- package/skills/slidev/references/presenter-recording.md +30 -0
- package/skills/slidev/references/presenter-remote.md +40 -0
- package/skills/slidev/references/presenter-timer.md +34 -0
- package/skills/slidev/references/style-direction.md +34 -0
- package/skills/slidev/references/style-icons.md +46 -0
- package/skills/slidev/references/style-scoped.md +50 -0
- package/skills/slidev/references/syntax-block-frontmatter.md +39 -0
- package/skills/slidev/references/syntax-comark.md +51 -0
- package/skills/slidev/references/syntax-frontmatter-merging.md +49 -0
- package/skills/slidev/references/syntax-importing-slides.md +60 -0
- package/skills/slidev/references/tool-eject-theme.md +27 -0
- package/skills/tsdown/LICENSE.md +22 -0
- package/skills/tsdown/README.md +77 -0
- package/skills/tsdown/SKILL.md +416 -0
- package/skills/tsdown/SYNC.md +5 -0
- package/skills/tsdown/references/README.md +139 -0
- package/skills/tsdown/references/advanced-benchmark.md +8 -0
- package/skills/tsdown/references/advanced-ci.md +89 -0
- package/skills/tsdown/references/advanced-hooks.md +363 -0
- package/skills/tsdown/references/advanced-plugins.md +381 -0
- package/skills/tsdown/references/advanced-programmatic.md +378 -0
- package/skills/tsdown/references/advanced-rolldown-options.md +117 -0
- package/skills/tsdown/references/guide-getting-started.md +183 -0
- package/skills/tsdown/references/guide-introduction.md +42 -0
- package/skills/tsdown/references/guide-migrate-from-tsup.md +199 -0
- package/skills/tsdown/references/option-cjs-default.md +98 -0
- package/skills/tsdown/references/option-cleaning.md +275 -0
- package/skills/tsdown/references/option-config-file.md +291 -0
- package/skills/tsdown/references/option-css.md +301 -0
- package/skills/tsdown/references/option-dependencies.md +385 -0
- package/skills/tsdown/references/option-dts.md +251 -0
- package/skills/tsdown/references/option-entry.md +211 -0
- package/skills/tsdown/references/option-exe.md +120 -0
- package/skills/tsdown/references/option-lint.md +127 -0
- package/skills/tsdown/references/option-log-level.md +91 -0
- package/skills/tsdown/references/option-minification.md +177 -0
- package/skills/tsdown/references/option-output-directory.md +272 -0
- package/skills/tsdown/references/option-output-format.md +183 -0
- package/skills/tsdown/references/option-package-exports.md +320 -0
- package/skills/tsdown/references/option-platform.md +256 -0
- package/skills/tsdown/references/option-root.md +88 -0
- package/skills/tsdown/references/option-shims.md +299 -0
- package/skills/tsdown/references/option-sourcemap.md +301 -0
- package/skills/tsdown/references/option-target.md +222 -0
- package/skills/tsdown/references/option-tree-shaking.md +335 -0
- package/skills/tsdown/references/option-unbundle.md +310 -0
- package/skills/tsdown/references/option-watch-mode.md +261 -0
- package/skills/tsdown/references/recipe-react.md +338 -0
- package/skills/tsdown/references/recipe-solid.md +42 -0
- package/skills/tsdown/references/recipe-svelte.md +54 -0
- package/skills/tsdown/references/recipe-vue.md +387 -0
- package/skills/tsdown/references/recipe-wasm.md +125 -0
- package/skills/tsdown/references/reference-cli.md +472 -0
- package/skills/turborepo/LICENSE.md +7 -0
- package/skills/turborepo/SKILL.md +951 -0
- package/skills/turborepo/SYNC.md +5 -0
- package/skills/turborepo/command/turborepo.md +70 -0
- package/skills/turborepo/references/best-practices/RULE.md +241 -0
- package/skills/turborepo/references/best-practices/dependencies.md +246 -0
- package/skills/turborepo/references/best-practices/packages.md +335 -0
- package/skills/turborepo/references/best-practices/structure.md +297 -0
- package/skills/turborepo/references/boundaries/RULE.md +126 -0
- package/skills/turborepo/references/caching/RULE.md +153 -0
- package/skills/turborepo/references/caching/gotchas.md +190 -0
- package/skills/turborepo/references/caching/remote-cache.md +127 -0
- package/skills/turborepo/references/ci/RULE.md +79 -0
- package/skills/turborepo/references/ci/github-actions.md +162 -0
- package/skills/turborepo/references/ci/patterns.md +145 -0
- package/skills/turborepo/references/ci/vercel.md +103 -0
- package/skills/turborepo/references/cli/RULE.md +100 -0
- package/skills/turborepo/references/cli/commands.md +297 -0
- package/skills/turborepo/references/configuration/RULE.md +235 -0
- package/skills/turborepo/references/configuration/global-options.md +239 -0
- package/skills/turborepo/references/configuration/gotchas.md +368 -0
- package/skills/turborepo/references/configuration/tasks.md +325 -0
- package/skills/turborepo/references/environment/RULE.md +123 -0
- package/skills/turborepo/references/environment/gotchas.md +175 -0
- package/skills/turborepo/references/environment/modes.md +101 -0
- package/skills/turborepo/references/filtering/RULE.md +148 -0
- package/skills/turborepo/references/filtering/patterns.md +152 -0
- package/skills/turborepo/references/watch/RULE.md +99 -0
- package/skills/vite/GENERATION.md +5 -0
- package/skills/vite/LICENSE.md +21 -0
- package/skills/vite/SKILL.md +72 -0
- package/skills/vite/SYNC.md +5 -0
- package/skills/vite/references/build-and-ssr.md +164 -0
- package/skills/vite/references/core-config.md +162 -0
- package/skills/vite/references/core-features.md +205 -0
- package/skills/vite/references/core-plugin-api.md +235 -0
- package/skills/vite/references/environment-api.md +108 -0
- package/skills/vite/references/rolldown-migration.md +157 -0
- package/skills/vitepress/GENERATION.md +5 -0
- package/skills/vitepress/LICENSE.md +21 -0
- package/skills/vitepress/SKILL.md +65 -0
- package/skills/vitepress/SYNC.md +5 -0
- package/skills/vitepress/references/advanced-i18n.md +299 -0
- package/skills/vitepress/references/advanced-ssr.md +228 -0
- package/skills/vitepress/references/core-cli.md +119 -0
- package/skills/vitepress/references/core-config.md +189 -0
- package/skills/vitepress/references/core-markdown.md +277 -0
- package/skills/vitepress/references/core-routing.md +169 -0
- package/skills/vitepress/references/features-code-blocks.md +243 -0
- package/skills/vitepress/references/features-data-loading.md +220 -0
- package/skills/vitepress/references/features-dynamic-routes.md +235 -0
- package/skills/vitepress/references/features-vue.md +224 -0
- package/skills/vitepress/references/recipes-deploy.md +240 -0
- package/skills/vitepress/references/theme-config.md +315 -0
- package/skills/vitepress/references/theme-custom.md +269 -0
- package/skills/vitepress/references/theme-customization.md +290 -0
- package/skills/vitest/GENERATION.md +5 -0
- package/skills/vitest/LICENSE.md +21 -0
- package/skills/vitest/SKILL.md +52 -0
- package/skills/vitest/SYNC.md +5 -0
- package/skills/vitest/references/advanced-environments.md +264 -0
- package/skills/vitest/references/advanced-projects.md +300 -0
- package/skills/vitest/references/advanced-type-testing.md +237 -0
- package/skills/vitest/references/advanced-vi.md +249 -0
- package/skills/vitest/references/core-cli.md +166 -0
- package/skills/vitest/references/core-config.md +174 -0
- package/skills/vitest/references/core-describe.md +193 -0
- package/skills/vitest/references/core-expect.md +219 -0
- package/skills/vitest/references/core-hooks.md +244 -0
- package/skills/vitest/references/core-test-api.md +233 -0
- package/skills/vitest/references/features-concurrency.md +250 -0
- package/skills/vitest/references/features-context.md +238 -0
- package/skills/vitest/references/features-coverage.md +207 -0
- package/skills/vitest/references/features-filtering.md +211 -0
- package/skills/vitest/references/features-mocking.md +265 -0
- package/skills/vitest/references/features-snapshots.md +207 -0
- package/skills/vue/GENERATION.md +5 -0
- package/skills/vue/LICENSE.md +21 -0
- package/skills/vue/SKILL.md +84 -0
- package/skills/vue/SYNC.md +5 -0
- package/skills/vue/references/advanced-patterns.md +314 -0
- package/skills/vue/references/core-new-apis.md +264 -0
- package/skills/vue/references/script-setup-macros.md +204 -0
- package/skills/vue-best-practices/LICENSE.md +21 -0
- package/skills/vue-best-practices/SKILL.md +154 -0
- package/skills/vue-best-practices/SYNC.md +5 -0
- package/skills/vue-best-practices/references/animation-class-based-technique.md +254 -0
- package/skills/vue-best-practices/references/animation-state-driven-technique.md +291 -0
- package/skills/vue-best-practices/references/component-async.md +97 -0
- package/skills/vue-best-practices/references/component-data-flow.md +307 -0
- package/skills/vue-best-practices/references/component-fallthrough-attrs.md +174 -0
- package/skills/vue-best-practices/references/component-keep-alive.md +137 -0
- package/skills/vue-best-practices/references/component-slots.md +216 -0
- package/skills/vue-best-practices/references/component-suspense.md +228 -0
- package/skills/vue-best-practices/references/component-teleport.md +108 -0
- package/skills/vue-best-practices/references/component-transition-group.md +128 -0
- package/skills/vue-best-practices/references/component-transition.md +125 -0
- package/skills/vue-best-practices/references/composables.md +290 -0
- package/skills/vue-best-practices/references/directives.md +162 -0
- package/skills/vue-best-practices/references/perf-avoid-component-abstraction-in-lists.md +159 -0
- package/skills/vue-best-practices/references/perf-v-once-v-memo-directives.md +182 -0
- package/skills/vue-best-practices/references/perf-virtualize-large-lists.md +187 -0
- package/skills/vue-best-practices/references/plugins.md +166 -0
- package/skills/vue-best-practices/references/reactivity.md +344 -0
- package/skills/vue-best-practices/references/render-functions.md +201 -0
- package/skills/vue-best-practices/references/sfc.md +310 -0
- package/skills/vue-best-practices/references/state-management.md +135 -0
- package/skills/vue-best-practices/references/updated-hook-performance.md +187 -0
- package/skills/vue-router-best-practices/LICENSE.md +21 -0
- package/skills/vue-router-best-practices/SKILL.md +23 -0
- package/skills/vue-router-best-practices/SYNC.md +5 -0
- package/skills/vue-router-best-practices/reference/router-beforeenter-no-param-trigger.md +167 -0
- package/skills/vue-router-best-practices/reference/router-beforerouteenter-no-this.md +176 -0
- package/skills/vue-router-best-practices/reference/router-guard-async-await-pattern.md +227 -0
- package/skills/vue-router-best-practices/reference/router-navigation-guard-infinite-loop.md +187 -0
- package/skills/vue-router-best-practices/reference/router-navigation-guard-next-deprecated.md +150 -0
- package/skills/vue-router-best-practices/reference/router-param-change-no-lifecycle.md +181 -0
- package/skills/vue-router-best-practices/reference/router-simple-routing-cleanup.md +209 -0
- package/skills/vue-router-best-practices/reference/router-use-vue-router-for-production.md +183 -0
- package/skills/vue-testing-best-practices/LICENSE.md +21 -0
- package/skills/vue-testing-best-practices/SKILL.md +29 -0
- package/skills/vue-testing-best-practices/SYNC.md +5 -0
- package/skills/vue-testing-best-practices/reference/async-component-testing.md +163 -0
- package/skills/vue-testing-best-practices/reference/teleport-testing-complexity.md +158 -0
- package/skills/vue-testing-best-practices/reference/testing-async-await-flushpromises.md +175 -0
- package/skills/vue-testing-best-practices/reference/testing-browser-vs-node-runners.md +208 -0
- package/skills/vue-testing-best-practices/reference/testing-component-blackbox-approach.md +144 -0
- package/skills/vue-testing-best-practices/reference/testing-composables-helper-wrapper.md +238 -0
- package/skills/vue-testing-best-practices/reference/testing-e2e-playwright-recommended.md +242 -0
- package/skills/vue-testing-best-practices/reference/testing-no-snapshot-only.md +197 -0
- package/skills/vue-testing-best-practices/reference/testing-pinia-store-setup.md +228 -0
- package/skills/vue-testing-best-practices/reference/testing-suspense-async-components.md +229 -0
- package/skills/vue-testing-best-practices/reference/testing-vitest-recommended-for-vue.md +204 -0
- package/skills/vueuse-functions/LICENSE.md +21 -0
- package/skills/vueuse-functions/SKILL.md +419 -0
- package/skills/vueuse-functions/SYNC.md +5 -0
- package/skills/vueuse-functions/references/computedAsync.md +195 -0
- package/skills/vueuse-functions/references/computedEager.md +62 -0
- package/skills/vueuse-functions/references/computedInject.md +137 -0
- package/skills/vueuse-functions/references/computedWithControl.md +98 -0
- package/skills/vueuse-functions/references/createEventHook.md +86 -0
- package/skills/vueuse-functions/references/createGenericProjection.md +25 -0
- package/skills/vueuse-functions/references/createGlobalState.md +95 -0
- package/skills/vueuse-functions/references/createInjectionState.md +226 -0
- package/skills/vueuse-functions/references/createProjection.md +31 -0
- package/skills/vueuse-functions/references/createRef.md +54 -0
- package/skills/vueuse-functions/references/createReusableTemplate.md +361 -0
- package/skills/vueuse-functions/references/createSharedComposable.md +42 -0
- package/skills/vueuse-functions/references/createTemplatePromise.md +306 -0
- package/skills/vueuse-functions/references/createUnrefFn.md +51 -0
- package/skills/vueuse-functions/references/extendRef.md +76 -0
- package/skills/vueuse-functions/references/from.md +80 -0
- package/skills/vueuse-functions/references/get.md +30 -0
- package/skills/vueuse-functions/references/injectLocal.md +35 -0
- package/skills/vueuse-functions/references/isDefined.md +31 -0
- package/skills/vueuse-functions/references/logicAnd.md +40 -0
- package/skills/vueuse-functions/references/logicNot.md +36 -0
- package/skills/vueuse-functions/references/logicOr.md +40 -0
- package/skills/vueuse-functions/references/makeDestructurable.md +41 -0
- package/skills/vueuse-functions/references/onClickOutside.md +228 -0
- package/skills/vueuse-functions/references/onElementRemoval.md +88 -0
- package/skills/vueuse-functions/references/onKeyStroke.md +212 -0
- package/skills/vueuse-functions/references/onLongPress.md +235 -0
- package/skills/vueuse-functions/references/onStartTyping.md +53 -0
- package/skills/vueuse-functions/references/provideLocal.md +37 -0
- package/skills/vueuse-functions/references/reactify.md +144 -0
- package/skills/vueuse-functions/references/reactifyObject.md +62 -0
- package/skills/vueuse-functions/references/reactiveComputed.md +34 -0
- package/skills/vueuse-functions/references/reactiveOmit.md +86 -0
- package/skills/vueuse-functions/references/reactivePick.md +106 -0
- package/skills/vueuse-functions/references/refAutoReset.md +46 -0
- package/skills/vueuse-functions/references/refDebounced.md +81 -0
- package/skills/vueuse-functions/references/refDefault.md +36 -0
- package/skills/vueuse-functions/references/refManualReset.md +48 -0
- package/skills/vueuse-functions/references/refThrottled.md +99 -0
- package/skills/vueuse-functions/references/refWithControl.md +146 -0
- package/skills/vueuse-functions/references/set.md +30 -0
- package/skills/vueuse-functions/references/syncRef.md +195 -0
- package/skills/vueuse-functions/references/syncRefs.md +128 -0
- package/skills/vueuse-functions/references/templateRef.md +86 -0
- package/skills/vueuse-functions/references/toObserver.md +38 -0
- package/skills/vueuse-functions/references/toReactive.md +41 -0
- package/skills/vueuse-functions/references/toRef.md +74 -0
- package/skills/vueuse-functions/references/toRefs.md +78 -0
- package/skills/vueuse-functions/references/tryOnBeforeMount.md +34 -0
- package/skills/vueuse-functions/references/tryOnBeforeUnmount.md +32 -0
- package/skills/vueuse-functions/references/tryOnMounted.md +34 -0
- package/skills/vueuse-functions/references/tryOnScopeDispose.md +31 -0
- package/skills/vueuse-functions/references/tryOnUnmounted.md +32 -0
- package/skills/vueuse-functions/references/unrefElement.md +54 -0
- package/skills/vueuse-functions/references/until.md +161 -0
- package/skills/vueuse-functions/references/useAbs.md +31 -0
- package/skills/vueuse-functions/references/useActiveElement.md +86 -0
- package/skills/vueuse-functions/references/useAnimate.md +180 -0
- package/skills/vueuse-functions/references/useArrayDifference.md +84 -0
- package/skills/vueuse-functions/references/useArrayEvery.md +59 -0
- package/skills/vueuse-functions/references/useArrayFilter.md +63 -0
- package/skills/vueuse-functions/references/useArrayFind.md +50 -0
- package/skills/vueuse-functions/references/useArrayFindIndex.md +59 -0
- package/skills/vueuse-functions/references/useArrayFindLast.md +52 -0
- package/skills/vueuse-functions/references/useArrayIncludes.md +63 -0
- package/skills/vueuse-functions/references/useArrayJoin.md +74 -0
- package/skills/vueuse-functions/references/useArrayMap.md +59 -0
- package/skills/vueuse-functions/references/useArrayReduce.md +81 -0
- package/skills/vueuse-functions/references/useArraySome.md +59 -0
- package/skills/vueuse-functions/references/useArrayUnique.md +76 -0
- package/skills/vueuse-functions/references/useAsyncQueue.md +136 -0
- package/skills/vueuse-functions/references/useAsyncState.md +185 -0
- package/skills/vueuse-functions/references/useAsyncValidator.md +70 -0
- package/skills/vueuse-functions/references/useAuth.md +123 -0
- package/skills/vueuse-functions/references/useAverage.md +36 -0
- package/skills/vueuse-functions/references/useAxios.md +325 -0
- package/skills/vueuse-functions/references/useBase64.md +136 -0
- package/skills/vueuse-functions/references/useBattery.md +80 -0
- package/skills/vueuse-functions/references/useBluetooth.md +174 -0
- package/skills/vueuse-functions/references/useBreakpoints.md +176 -0
- package/skills/vueuse-functions/references/useBroadcastChannel.md +73 -0
- package/skills/vueuse-functions/references/useBrowserLocation.md +56 -0
- package/skills/vueuse-functions/references/useCached.md +52 -0
- package/skills/vueuse-functions/references/useCeil.md +31 -0
- package/skills/vueuse-functions/references/useChangeCase.md +79 -0
- package/skills/vueuse-functions/references/useClamp.md +85 -0
- package/skills/vueuse-functions/references/useClipboard.md +122 -0
- package/skills/vueuse-functions/references/useClipboardItems.md +93 -0
- package/skills/vueuse-functions/references/useCloned.md +91 -0
- package/skills/vueuse-functions/references/useColorMode.md +172 -0
- package/skills/vueuse-functions/references/useConfirmDialog.md +159 -0
- package/skills/vueuse-functions/references/useCookies.md +162 -0
- package/skills/vueuse-functions/references/useCountdown.md +105 -0
- package/skills/vueuse-functions/references/useCounter.md +86 -0
- package/skills/vueuse-functions/references/useCssSupports.md +33 -0
- package/skills/vueuse-functions/references/useCssVar.md +50 -0
- package/skills/vueuse-functions/references/useCurrentElement.md +61 -0
- package/skills/vueuse-functions/references/useCycleList.md +75 -0
- package/skills/vueuse-functions/references/useDark.md +142 -0
- package/skills/vueuse-functions/references/useDateFormat.md +145 -0
- package/skills/vueuse-functions/references/useDebounceFn.md +100 -0
- package/skills/vueuse-functions/references/useDebouncedRefHistory.md +40 -0
- package/skills/vueuse-functions/references/useDeviceMotion.md +80 -0
- package/skills/vueuse-functions/references/useDeviceOrientation.md +64 -0
- package/skills/vueuse-functions/references/useDevicePixelRatio.md +47 -0
- package/skills/vueuse-functions/references/useDevicesList.md +89 -0
- package/skills/vueuse-functions/references/useDisplayMedia.md +67 -0
- package/skills/vueuse-functions/references/useDocumentVisibility.md +44 -0
- package/skills/vueuse-functions/references/useDraggable.md +289 -0
- package/skills/vueuse-functions/references/useDrauu.md +65 -0
- package/skills/vueuse-functions/references/useDropZone.md +83 -0
- package/skills/vueuse-functions/references/useElementBounding.md +131 -0
- package/skills/vueuse-functions/references/useElementByPoint.md +46 -0
- package/skills/vueuse-functions/references/useElementHover.md +79 -0
- package/skills/vueuse-functions/references/useElementSize.md +79 -0
- package/skills/vueuse-functions/references/useElementVisibility.md +163 -0
- package/skills/vueuse-functions/references/useEventBus.md +101 -0
- package/skills/vueuse-functions/references/useEventListener.md +226 -0
- package/skills/vueuse-functions/references/useEventSource.md +204 -0
- package/skills/vueuse-functions/references/useExtractedObservable.md +198 -0
- package/skills/vueuse-functions/references/useEyeDropper.md +72 -0
- package/skills/vueuse-functions/references/useFavicon.md +69 -0
- package/skills/vueuse-functions/references/useFetch.md +546 -0
- package/skills/vueuse-functions/references/useFileDialog.md +91 -0
- package/skills/vueuse-functions/references/useFileSystemAccess.md +161 -0
- package/skills/vueuse-functions/references/useFirestore.md +129 -0
- package/skills/vueuse-functions/references/useFloor.md +31 -0
- package/skills/vueuse-functions/references/useFocus.md +99 -0
- package/skills/vueuse-functions/references/useFocusTrap.md +245 -0
- package/skills/vueuse-functions/references/useFocusWithin.md +57 -0
- package/skills/vueuse-functions/references/useFps.md +28 -0
- package/skills/vueuse-functions/references/useFullscreen.md +74 -0
- package/skills/vueuse-functions/references/useFuse.md +75 -0
- package/skills/vueuse-functions/references/useGamepad.md +176 -0
- package/skills/vueuse-functions/references/useGeolocation.md +63 -0
- package/skills/vueuse-functions/references/useIDBKeyval.md +93 -0
- package/skills/vueuse-functions/references/useIdle.md +88 -0
- package/skills/vueuse-functions/references/useImage.md +90 -0
- package/skills/vueuse-functions/references/useInfiniteScroll.md +156 -0
- package/skills/vueuse-functions/references/useIntersectionObserver.md +117 -0
- package/skills/vueuse-functions/references/useInterval.md +112 -0
- package/skills/vueuse-functions/references/useIntervalFn.md +50 -0
- package/skills/vueuse-functions/references/useIpcRenderer.md +144 -0
- package/skills/vueuse-functions/references/useIpcRendererInvoke.md +58 -0
- package/skills/vueuse-functions/references/useIpcRendererOn.md +52 -0
- package/skills/vueuse-functions/references/useJwt.md +57 -0
- package/skills/vueuse-functions/references/useKeyModifier.md +87 -0
- package/skills/vueuse-functions/references/useLastChanged.md +63 -0
- package/skills/vueuse-functions/references/useLocalStorage.md +41 -0
- package/skills/vueuse-functions/references/useMagicKeys.md +245 -0
- package/skills/vueuse-functions/references/useManualRefHistory.md +204 -0
- package/skills/vueuse-functions/references/useMath.md +47 -0
- package/skills/vueuse-functions/references/useMax.md +36 -0
- package/skills/vueuse-functions/references/useMediaControls.md +201 -0
- package/skills/vueuse-functions/references/useMediaQuery.md +53 -0
- package/skills/vueuse-functions/references/useMemoize.md +175 -0
- package/skills/vueuse-functions/references/useMemory.md +70 -0
- package/skills/vueuse-functions/references/useMin.md +36 -0
- package/skills/vueuse-functions/references/useMounted.md +38 -0
- package/skills/vueuse-functions/references/useMouse.md +113 -0
- package/skills/vueuse-functions/references/useMouseInElement.md +132 -0
- package/skills/vueuse-functions/references/useMousePressed.md +116 -0
- package/skills/vueuse-functions/references/useMutationObserver.md +60 -0
- package/skills/vueuse-functions/references/useNProgress.md +78 -0
- package/skills/vueuse-functions/references/useNavigatorLanguage.md +57 -0
- package/skills/vueuse-functions/references/useNetwork.md +106 -0
- package/skills/vueuse-functions/references/useNow.md +83 -0
- package/skills/vueuse-functions/references/useObjectUrl.md +55 -0
- package/skills/vueuse-functions/references/useObservable.md +91 -0
- package/skills/vueuse-functions/references/useOffsetPagination.md +199 -0
- package/skills/vueuse-functions/references/useOnline.md +41 -0
- package/skills/vueuse-functions/references/usePageLeave.md +43 -0
- package/skills/vueuse-functions/references/useParallax.md +58 -0
- package/skills/vueuse-functions/references/useParentElement.md +54 -0
- package/skills/vueuse-functions/references/usePerformanceObserver.md +48 -0
- package/skills/vueuse-functions/references/usePermission.md +78 -0
- package/skills/vueuse-functions/references/usePointer.md +91 -0
- package/skills/vueuse-functions/references/usePointerLock.md +59 -0
- package/skills/vueuse-functions/references/usePointerSwipe.md +80 -0
- package/skills/vueuse-functions/references/usePrecision.md +49 -0
- package/skills/vueuse-functions/references/usePreferredColorScheme.md +42 -0
- package/skills/vueuse-functions/references/usePreferredContrast.md +42 -0
- package/skills/vueuse-functions/references/usePreferredDark.md +41 -0
- package/skills/vueuse-functions/references/usePreferredLanguages.md +41 -0
- package/skills/vueuse-functions/references/usePreferredReducedMotion.md +42 -0
- package/skills/vueuse-functions/references/usePreferredReducedTransparency.md +42 -0
- package/skills/vueuse-functions/references/usePrevious.md +40 -0
- package/skills/vueuse-functions/references/useProjection.md +38 -0
- package/skills/vueuse-functions/references/useQRCode.md +53 -0
- package/skills/vueuse-functions/references/useRTDB.md +83 -0
- package/skills/vueuse-functions/references/useRafFn.md +68 -0
- package/skills/vueuse-functions/references/useRefHistory.md +285 -0
- package/skills/vueuse-functions/references/useResizeObserver.md +108 -0
- package/skills/vueuse-functions/references/useRound.md +31 -0
- package/skills/vueuse-functions/references/useRouteHash.md +27 -0
- package/skills/vueuse-functions/references/useRouteParams.md +38 -0
- package/skills/vueuse-functions/references/useRouteQuery.md +79 -0
- package/skills/vueuse-functions/references/useSSRWidth.md +47 -0
- package/skills/vueuse-functions/references/useScreenOrientation.md +98 -0
- package/skills/vueuse-functions/references/useScreenSafeArea.md +60 -0
- package/skills/vueuse-functions/references/useScriptTag.md +116 -0
- package/skills/vueuse-functions/references/useScroll.md +238 -0
- package/skills/vueuse-functions/references/useScrollLock.md +66 -0
- package/skills/vueuse-functions/references/useSessionStorage.md +41 -0
- package/skills/vueuse-functions/references/useShare.md +67 -0
- package/skills/vueuse-functions/references/useSortable.md +276 -0
- package/skills/vueuse-functions/references/useSorted.md +90 -0
- package/skills/vueuse-functions/references/useSpeechRecognition.md +90 -0
- package/skills/vueuse-functions/references/useSpeechSynthesis.md +101 -0
- package/skills/vueuse-functions/references/useStepper.md +137 -0
- package/skills/vueuse-functions/references/useStorage.md +278 -0
- package/skills/vueuse-functions/references/useStorageAsync.md +136 -0
- package/skills/vueuse-functions/references/useStyleTag.md +131 -0
- package/skills/vueuse-functions/references/useSubject.md +77 -0
- package/skills/vueuse-functions/references/useSubscription.md +33 -0
- package/skills/vueuse-functions/references/useSum.md +36 -0
- package/skills/vueuse-functions/references/useSupported.md +29 -0
- package/skills/vueuse-functions/references/useSwipe.md +75 -0
- package/skills/vueuse-functions/references/useTemplateRefsList.md +37 -0
- package/skills/vueuse-functions/references/useTextDirection.md +75 -0
- package/skills/vueuse-functions/references/useTextSelection.md +43 -0
- package/skills/vueuse-functions/references/useTextareaAutosize.md +94 -0
- package/skills/vueuse-functions/references/useThrottleFn.md +57 -0
- package/skills/vueuse-functions/references/useThrottledRefHistory.md +47 -0
- package/skills/vueuse-functions/references/useTimeAgo.md +154 -0
- package/skills/vueuse-functions/references/useTimeAgoIntl.md +117 -0
- package/skills/vueuse-functions/references/useTimeout.md +113 -0
- package/skills/vueuse-functions/references/useTimeoutFn.md +51 -0
- package/skills/vueuse-functions/references/useTimeoutPoll.md +47 -0
- package/skills/vueuse-functions/references/useTimestamp.md +93 -0
- package/skills/vueuse-functions/references/useTitle.md +115 -0
- package/skills/vueuse-functions/references/useToNumber.md +54 -0
- package/skills/vueuse-functions/references/useToString.md +34 -0
- package/skills/vueuse-functions/references/useToggle.md +103 -0
- package/skills/vueuse-functions/references/useTransition.md +265 -0
- package/skills/vueuse-functions/references/useTrunc.md +33 -0
- package/skills/vueuse-functions/references/useUrlSearchParams.md +121 -0
- package/skills/vueuse-functions/references/useUserMedia.md +96 -0
- package/skills/vueuse-functions/references/useVModel.md +182 -0
- package/skills/vueuse-functions/references/useVModels.md +67 -0
- package/skills/vueuse-functions/references/useVibrate.md +86 -0
- package/skills/vueuse-functions/references/useVirtualList.md +182 -0
- package/skills/vueuse-functions/references/useWakeLock.md +51 -0
- package/skills/vueuse-functions/references/useWebNotification.md +175 -0
- package/skills/vueuse-functions/references/useWebSocket.md +299 -0
- package/skills/vueuse-functions/references/useWebWorker.md +60 -0
- package/skills/vueuse-functions/references/useWebWorkerFn.md +102 -0
- package/skills/vueuse-functions/references/useWindowFocus.md +46 -0
- package/skills/vueuse-functions/references/useWindowScroll.md +46 -0
- package/skills/vueuse-functions/references/useWindowSize.md +78 -0
- package/skills/vueuse-functions/references/useZoomFactor.md +53 -0
- package/skills/vueuse-functions/references/useZoomLevel.md +53 -0
- package/skills/vueuse-functions/references/watchArray.md +53 -0
- package/skills/vueuse-functions/references/watchAtMost.md +63 -0
- package/skills/vueuse-functions/references/watchDebounced.md +101 -0
- package/skills/vueuse-functions/references/watchDeep.md +54 -0
- package/skills/vueuse-functions/references/watchExtractedObservable.md +192 -0
- package/skills/vueuse-functions/references/watchIgnorable.md +120 -0
- package/skills/vueuse-functions/references/watchImmediate.md +44 -0
- package/skills/vueuse-functions/references/watchOnce.md +41 -0
- package/skills/vueuse-functions/references/watchPausable.md +86 -0
- package/skills/vueuse-functions/references/watchThrottled.md +108 -0
- package/skills/vueuse-functions/references/watchTriggerable.md +98 -0
- package/skills/vueuse-functions/references/watchWithFilter.md +54 -0
- package/skills/vueuse-functions/references/whenever.md +108 -0
- package/skills/web-design-guidelines/SKILL.md +39 -0
- package/skills/web-design-guidelines/SYNC.md +5 -0
|
@@ -0,0 +1,416 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: tsdown
|
|
3
|
+
description: Bundle TypeScript and JavaScript libraries with blazing-fast speed powered by Rolldown. Use when building libraries, generating type declarations, bundling for multiple formats, or migrating from tsup.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# tsdown - The Elegant Library Bundler
|
|
7
|
+
|
|
8
|
+
Blazing-fast bundler for TypeScript/JavaScript libraries powered by Rolldown and Oxc.
|
|
9
|
+
|
|
10
|
+
## Runtime Requirement
|
|
11
|
+
|
|
12
|
+
`tsdown` requires **Node.js 22.18.0 or higher to run** (build-time only). However, the bundled output can target much lower Node.js versions via the [`target`](references/option-target.md) option, so libraries built with tsdown are **not locked to Node.js 22+ at runtime**.
|
|
13
|
+
|
|
14
|
+
If your package needs to support Node.js 18 / 20:
|
|
15
|
+
|
|
16
|
+
- **Build with Node.js 22+ in CI** (e.g. set `target: 'node18'` or `target: 'node20'`).
|
|
17
|
+
- **Test the built output (or the packed tarball) on the lower Node.js versions** you intend to support — e.g. using a matrix job that runs the published package's tests on Node.js 18 / 20 / 22.
|
|
18
|
+
|
|
19
|
+
## When to Use
|
|
20
|
+
|
|
21
|
+
- Building TypeScript/JavaScript libraries for npm
|
|
22
|
+
- Generating TypeScript declaration files (.d.ts)
|
|
23
|
+
- Bundling for multiple formats (ESM, CJS, IIFE, UMD)
|
|
24
|
+
- Optimizing bundles with tree shaking and minification
|
|
25
|
+
- Migrating from tsup with minimal changes
|
|
26
|
+
- Building React, Vue, Solid, or Svelte component libraries
|
|
27
|
+
|
|
28
|
+
## Quick Start
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# Install
|
|
32
|
+
pnpm add -D tsdown
|
|
33
|
+
|
|
34
|
+
# Basic usage
|
|
35
|
+
npx tsdown
|
|
36
|
+
|
|
37
|
+
# With config file
|
|
38
|
+
npx tsdown --config tsdown.config.ts
|
|
39
|
+
|
|
40
|
+
# Watch mode
|
|
41
|
+
npx tsdown --watch
|
|
42
|
+
|
|
43
|
+
# Migrate from tsup
|
|
44
|
+
npx tsdown-migrate
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Basic Configuration
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
import { defineConfig } from 'tsdown'
|
|
51
|
+
|
|
52
|
+
export default defineConfig({
|
|
53
|
+
entry: ['./src/index.ts'],
|
|
54
|
+
format: ['esm', 'cjs'],
|
|
55
|
+
dts: true,
|
|
56
|
+
clean: true,
|
|
57
|
+
})
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Core References
|
|
61
|
+
|
|
62
|
+
| Topic | Description | Reference |
|
|
63
|
+
|-------|-------------|-----------|
|
|
64
|
+
| Getting Started | Installation, first bundle, CLI basics | [guide-getting-started](references/guide-getting-started.md) |
|
|
65
|
+
| Configuration File | Config file formats, multiple configs, workspace | [option-config-file](references/option-config-file.md) |
|
|
66
|
+
| CLI Reference | All CLI commands and options | [reference-cli](references/reference-cli.md) |
|
|
67
|
+
| Migrate from tsup | Migration guide and compatibility notes | [guide-migrate-from-tsup](references/guide-migrate-from-tsup.md) |
|
|
68
|
+
| Plugins | Rolldown, Rollup, Unplugin support | [advanced-plugins](references/advanced-plugins.md) |
|
|
69
|
+
|
|
70
|
+
> For comprehensive migration assistance with complete option mappings, install the dedicated [`tsdown-migrate`](../tsdown-migrate/SKILL.md) skill: `npx skills add rolldown/tsdown --skill tsdown-migrate`
|
|
71
|
+
| Hooks | Lifecycle hooks for custom logic | [advanced-hooks](references/advanced-hooks.md) |
|
|
72
|
+
| Programmatic API | Build from Node.js scripts | [advanced-programmatic](references/advanced-programmatic.md) |
|
|
73
|
+
| Rolldown Options | Pass options directly to Rolldown | [advanced-rolldown-options](references/advanced-rolldown-options.md) |
|
|
74
|
+
| CI Environment | CI detection, `'ci-only'` / `'local-only'` values | [advanced-ci](references/advanced-ci.md) |
|
|
75
|
+
|
|
76
|
+
## Build Options
|
|
77
|
+
|
|
78
|
+
| Option | Usage | Reference |
|
|
79
|
+
|--------|-------|-----------|
|
|
80
|
+
| Entry points | `entry: ['src/*.ts', '!**/*.test.ts']` | [option-entry](references/option-entry.md) |
|
|
81
|
+
| Output formats | `format: ['esm', 'cjs', 'iife', 'umd']` | [option-output-format](references/option-output-format.md) |
|
|
82
|
+
| Output directory | `outDir: 'dist'`, `outExtensions` | [option-output-directory](references/option-output-directory.md) |
|
|
83
|
+
| Type declarations | `dts: true`, `dts: { sourcemap, compilerOptions, vue }` | [option-dts](references/option-dts.md) |
|
|
84
|
+
| Target environment | `target: 'es2020'`, `target: 'esnext'` | [option-target](references/option-target.md) |
|
|
85
|
+
| Platform | `platform: 'node'`, `platform: 'browser'` | [option-platform](references/option-platform.md) |
|
|
86
|
+
| Tree shaking | `treeshake: true`, custom options | [option-tree-shaking](references/option-tree-shaking.md) |
|
|
87
|
+
| Minification | `minify: true`, `minify: 'dce-only'` | [option-minification](references/option-minification.md) |
|
|
88
|
+
| Source maps | `sourcemap: true`, `'inline'`, `'hidden'` | [option-sourcemap](references/option-sourcemap.md) |
|
|
89
|
+
| Watch mode | `watch: true`, watch options | [option-watch-mode](references/option-watch-mode.md) |
|
|
90
|
+
| Cleaning | `clean: true`, clean patterns | [option-cleaning](references/option-cleaning.md) |
|
|
91
|
+
| Log level | `logLevel: 'silent'`, `failOnWarn: false` | [option-log-level](references/option-log-level.md) |
|
|
92
|
+
|
|
93
|
+
## Dependency Handling
|
|
94
|
+
|
|
95
|
+
| Feature | Usage | Reference |
|
|
96
|
+
|---------|-------|-----------|
|
|
97
|
+
| Never bundle | `deps: { neverBundle: ['react', /^@myorg\//] }` | [option-dependencies](references/option-dependencies.md) |
|
|
98
|
+
| Always bundle | `deps: { alwaysBundle: ['dep-to-bundle'] }` | [option-dependencies](references/option-dependencies.md) |
|
|
99
|
+
| Only bundle | `deps: { onlyBundle: ['cac', 'bumpp'] }` - Whitelist | [option-dependencies](references/option-dependencies.md) |
|
|
100
|
+
| Skip node_modules | `deps: { skipNodeModulesBundle: true }` | [option-dependencies](references/option-dependencies.md) |
|
|
101
|
+
| Auto external | Automatic dependency/peer/optional externalization | [option-dependencies](references/option-dependencies.md) |
|
|
102
|
+
|
|
103
|
+
## Output Enhancement
|
|
104
|
+
|
|
105
|
+
| Feature | Usage | Reference |
|
|
106
|
+
|---------|-------|-----------|
|
|
107
|
+
| Shims | `shims: true` - Add ESM/CJS compatibility | [option-shims](references/option-shims.md) |
|
|
108
|
+
| CJS default | `cjsDefault: true` (default) / `false` | [option-cjs-default](references/option-cjs-default.md) |
|
|
109
|
+
| Package exports | `exports: true` - Auto-generate exports field | [option-package-exports](references/option-package-exports.md) |
|
|
110
|
+
| CSS handling | **[experimental]** `css: { ... }` — full pipeline with preprocessors, Lightning CSS, PostCSS, CSS modules, code splitting; requires `@tsdown/css` | [option-css](references/option-css.md) |
|
|
111
|
+
| CSS modules | `css: { modules: { localsConvention: 'camelCase' } }` — scoped class names for `.module.css` files | [option-css](references/option-css.md) |
|
|
112
|
+
| CSS inject | `css: { inject: true }` — preserve CSS imports in JS output | [option-css](references/option-css.md) |
|
|
113
|
+
| Unbundle mode | `unbundle: true` - Preserve directory structure | [option-unbundle](references/option-unbundle.md) |
|
|
114
|
+
| Root directory | `root: 'src'` - Control output directory mapping | [option-root](references/option-root.md) |
|
|
115
|
+
| Executable | **[experimental]** `exe: true` - Bundle as standalone executable, cross-platform via `@tsdown/exe` | [option-exe](references/option-exe.md) |
|
|
116
|
+
| Package validation | `publint: true`, `attw: true` - Validate package | [option-lint](references/option-lint.md) |
|
|
117
|
+
|
|
118
|
+
## Framework & Runtime Support
|
|
119
|
+
|
|
120
|
+
| Framework | Guide | Reference |
|
|
121
|
+
|-----------|-------|-----------|
|
|
122
|
+
| React | JSX transform, React Compiler | [recipe-react](references/recipe-react.md) |
|
|
123
|
+
| Vue | SFC support, JSX | [recipe-vue](references/recipe-vue.md) |
|
|
124
|
+
| Solid | SolidJS JSX transform | [recipe-solid](references/recipe-solid.md) |
|
|
125
|
+
| Svelte | Svelte component libraries (source distribution recommended) | [recipe-svelte](references/recipe-svelte.md) |
|
|
126
|
+
| WASM | WebAssembly modules via `rolldown-plugin-wasm` | [recipe-wasm](references/recipe-wasm.md) |
|
|
127
|
+
|
|
128
|
+
## Common Patterns
|
|
129
|
+
|
|
130
|
+
### Basic Library Bundle
|
|
131
|
+
|
|
132
|
+
```ts
|
|
133
|
+
export default defineConfig({
|
|
134
|
+
entry: ['src/index.ts'],
|
|
135
|
+
format: ['esm', 'cjs'],
|
|
136
|
+
dts: true,
|
|
137
|
+
clean: true,
|
|
138
|
+
})
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Multiple Entry Points
|
|
142
|
+
|
|
143
|
+
```ts
|
|
144
|
+
export default defineConfig({
|
|
145
|
+
entry: {
|
|
146
|
+
index: 'src/index.ts',
|
|
147
|
+
utils: 'src/utils.ts',
|
|
148
|
+
cli: 'src/cli.ts',
|
|
149
|
+
},
|
|
150
|
+
format: ['esm', 'cjs'],
|
|
151
|
+
dts: true,
|
|
152
|
+
})
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Browser Library (IIFE/UMD)
|
|
156
|
+
|
|
157
|
+
```ts
|
|
158
|
+
export default defineConfig({
|
|
159
|
+
entry: ['src/index.ts'],
|
|
160
|
+
format: ['iife'],
|
|
161
|
+
globalName: 'MyLib',
|
|
162
|
+
platform: 'browser',
|
|
163
|
+
minify: true,
|
|
164
|
+
})
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### React Component Library
|
|
168
|
+
|
|
169
|
+
```ts
|
|
170
|
+
export default defineConfig({
|
|
171
|
+
entry: ['src/index.tsx'],
|
|
172
|
+
format: ['esm', 'cjs'],
|
|
173
|
+
dts: true,
|
|
174
|
+
deps: {
|
|
175
|
+
neverBundle: ['react', 'react-dom'],
|
|
176
|
+
},
|
|
177
|
+
inputOptions: {
|
|
178
|
+
jsx: { runtime: 'automatic' },
|
|
179
|
+
},
|
|
180
|
+
})
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Preserve Directory Structure
|
|
184
|
+
|
|
185
|
+
```ts
|
|
186
|
+
export default defineConfig({
|
|
187
|
+
entry: ['src/**/*.ts', '!**/*.test.ts'],
|
|
188
|
+
unbundle: true, // Preserve file structure
|
|
189
|
+
format: ['esm'],
|
|
190
|
+
dts: true,
|
|
191
|
+
})
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### CI-Aware Configuration
|
|
195
|
+
|
|
196
|
+
```ts
|
|
197
|
+
export default defineConfig({
|
|
198
|
+
entry: ['src/index.ts'],
|
|
199
|
+
format: ['esm', 'cjs'],
|
|
200
|
+
dts: true,
|
|
201
|
+
failOnWarn: 'ci-only', // opt-in: fail on warnings in CI
|
|
202
|
+
publint: 'ci-only',
|
|
203
|
+
attw: 'ci-only',
|
|
204
|
+
})
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### WASM Support
|
|
208
|
+
|
|
209
|
+
```ts
|
|
210
|
+
import { wasm } from 'rolldown-plugin-wasm'
|
|
211
|
+
import { defineConfig } from 'tsdown'
|
|
212
|
+
|
|
213
|
+
export default defineConfig({
|
|
214
|
+
entry: ['src/index.ts'],
|
|
215
|
+
plugins: [wasm()],
|
|
216
|
+
})
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Library with CSS and Sass
|
|
220
|
+
|
|
221
|
+
```ts
|
|
222
|
+
export default defineConfig({
|
|
223
|
+
entry: ['src/index.ts'],
|
|
224
|
+
format: ['esm', 'cjs'],
|
|
225
|
+
dts: true,
|
|
226
|
+
target: 'chrome100',
|
|
227
|
+
css: {
|
|
228
|
+
preprocessorOptions: {
|
|
229
|
+
scss: {
|
|
230
|
+
additionalData: `@use "src/styles/variables" as *;`,
|
|
231
|
+
},
|
|
232
|
+
},
|
|
233
|
+
},
|
|
234
|
+
})
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Standalone Executable
|
|
238
|
+
|
|
239
|
+
```ts
|
|
240
|
+
export default defineConfig({
|
|
241
|
+
entry: ['src/cli.ts'],
|
|
242
|
+
exe: true,
|
|
243
|
+
})
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Cross-Platform Executable (requires `@tsdown/exe`)
|
|
247
|
+
|
|
248
|
+
```ts
|
|
249
|
+
export default defineConfig({
|
|
250
|
+
entry: ['src/cli.ts'],
|
|
251
|
+
exe: {
|
|
252
|
+
targets: [
|
|
253
|
+
{ platform: 'linux', arch: 'x64', nodeVersion: '25.7.0' },
|
|
254
|
+
{ platform: 'darwin', arch: 'arm64', nodeVersion: '25.7.0' },
|
|
255
|
+
{ platform: 'win', arch: 'x64', nodeVersion: '25.7.0' },
|
|
256
|
+
],
|
|
257
|
+
},
|
|
258
|
+
})
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### Advanced with Hooks
|
|
262
|
+
|
|
263
|
+
```ts
|
|
264
|
+
export default defineConfig({
|
|
265
|
+
entry: ['src/index.ts'],
|
|
266
|
+
format: ['esm', 'cjs'],
|
|
267
|
+
dts: true,
|
|
268
|
+
hooks: {
|
|
269
|
+
'build:before': async (context) => {
|
|
270
|
+
console.log('Building...')
|
|
271
|
+
},
|
|
272
|
+
'build:done': async (context) => {
|
|
273
|
+
console.log('Build complete!')
|
|
274
|
+
},
|
|
275
|
+
},
|
|
276
|
+
})
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
## Configuration Features
|
|
280
|
+
|
|
281
|
+
### Multiple Configs
|
|
282
|
+
|
|
283
|
+
Export an array for multiple build configurations:
|
|
284
|
+
|
|
285
|
+
```ts
|
|
286
|
+
export default defineConfig([
|
|
287
|
+
{
|
|
288
|
+
entry: ['src/index.ts'],
|
|
289
|
+
format: ['esm', 'cjs'],
|
|
290
|
+
dts: true,
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
entry: ['src/cli.ts'],
|
|
294
|
+
format: ['esm'],
|
|
295
|
+
platform: 'node',
|
|
296
|
+
},
|
|
297
|
+
])
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### Conditional Config
|
|
301
|
+
|
|
302
|
+
Use functions for dynamic configuration:
|
|
303
|
+
|
|
304
|
+
```ts
|
|
305
|
+
export default defineConfig((options) => {
|
|
306
|
+
const isDev = options.watch
|
|
307
|
+
return {
|
|
308
|
+
entry: ['src/index.ts'],
|
|
309
|
+
format: ['esm', 'cjs'],
|
|
310
|
+
minify: !isDev,
|
|
311
|
+
sourcemap: isDev,
|
|
312
|
+
}
|
|
313
|
+
})
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### Workspace/Monorepo
|
|
317
|
+
|
|
318
|
+
Use glob patterns to build multiple packages:
|
|
319
|
+
|
|
320
|
+
```ts
|
|
321
|
+
export default defineConfig({
|
|
322
|
+
workspace: 'packages/*',
|
|
323
|
+
entry: ['src/index.ts'],
|
|
324
|
+
format: ['esm', 'cjs'],
|
|
325
|
+
dts: true,
|
|
326
|
+
})
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
## CLI Quick Reference
|
|
330
|
+
|
|
331
|
+
```bash
|
|
332
|
+
# Basic commands
|
|
333
|
+
tsdown # Build once
|
|
334
|
+
tsdown --watch # Watch mode
|
|
335
|
+
tsdown --config custom.ts # Custom config
|
|
336
|
+
npx tsdown-migrate # Migrate from tsup
|
|
337
|
+
|
|
338
|
+
# Output options
|
|
339
|
+
tsdown --format esm,cjs # Multiple formats
|
|
340
|
+
tsdown -d lib # Custom output directory (--out-dir)
|
|
341
|
+
tsdown --minify # Enable minification
|
|
342
|
+
tsdown --dts # Generate declarations
|
|
343
|
+
tsdown --exe # Bundle as standalone executable
|
|
344
|
+
tsdown --unbundle # Bundleless mode
|
|
345
|
+
|
|
346
|
+
# Entry options
|
|
347
|
+
tsdown src/index.ts # Single entry
|
|
348
|
+
tsdown src/*.ts # Glob patterns
|
|
349
|
+
tsdown src/a.ts src/b.ts # Multiple entries
|
|
350
|
+
|
|
351
|
+
# Workspace / Monorepo
|
|
352
|
+
tsdown -W # Enable workspace mode
|
|
353
|
+
tsdown -W -F my-package # Filter specific package
|
|
354
|
+
tsdown --filter /^pkg-/ # Filter by regex
|
|
355
|
+
|
|
356
|
+
# Development
|
|
357
|
+
tsdown --watch # Watch mode
|
|
358
|
+
tsdown --sourcemap # Generate source maps
|
|
359
|
+
tsdown --clean # Clean output directory
|
|
360
|
+
tsdown --from-vite # Reuse Vite config
|
|
361
|
+
tsdown --tsconfig tsconfig.build.json # Custom tsconfig
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
## Best Practices
|
|
365
|
+
|
|
366
|
+
1. **Always generate type declarations** for TypeScript libraries:
|
|
367
|
+
```ts
|
|
368
|
+
{ dts: true }
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
2. **Externalize dependencies** to avoid bundling unnecessary code:
|
|
372
|
+
```ts
|
|
373
|
+
{ deps: { neverBundle: [/^react/, /^@myorg\//] } }
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
3. **Use tree shaking** for optimal bundle size:
|
|
377
|
+
```ts
|
|
378
|
+
{ treeshake: true }
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
4. **Enable minification** for production builds:
|
|
382
|
+
```ts
|
|
383
|
+
{ minify: true }
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
5. **Add shims** for better ESM/CJS compatibility:
|
|
387
|
+
```ts
|
|
388
|
+
{ shims: true } // Adds __dirname, __filename, etc.
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
6. **Auto-generate package.json exports**:
|
|
392
|
+
```ts
|
|
393
|
+
{ exports: true } // Creates proper exports field
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
7. **Use watch mode** during development:
|
|
397
|
+
```bash
|
|
398
|
+
tsdown --watch
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
8. **Preserve structure** for utilities with many files:
|
|
402
|
+
```ts
|
|
403
|
+
{ unbundle: true } // Keep directory structure
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
9. **Validate packages** in CI before publishing:
|
|
407
|
+
```ts
|
|
408
|
+
{ publint: 'ci-only', attw: 'ci-only' }
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
## Resources
|
|
412
|
+
|
|
413
|
+
- Documentation: https://tsdown.dev
|
|
414
|
+
- GitHub: https://github.com/rolldown/tsdown
|
|
415
|
+
- Rolldown: https://rolldown.rs
|
|
416
|
+
- Migration Guide: https://tsdown.dev/guide/migrate-from-tsup
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# tsdown Skill References
|
|
2
|
+
|
|
3
|
+
This directory contains detailed reference documentation for the tsdown skill.
|
|
4
|
+
|
|
5
|
+
## Created Files (35 total)
|
|
6
|
+
|
|
7
|
+
### Core Guides (3)
|
|
8
|
+
- ✅ `guide-getting-started.md` - Installation, first bundle, CLI basics
|
|
9
|
+
- ✅ `guide-migrate-from-tsup.md` - Migration guide from tsup
|
|
10
|
+
- ✅ `guide-introduction.md` - Introduction and key features
|
|
11
|
+
|
|
12
|
+
### Configuration Options (20)
|
|
13
|
+
- ✅ `option-config-file.md` - Config file formats, loaders, workspace
|
|
14
|
+
- ✅ `option-entry.md` - Entry point configuration with globs
|
|
15
|
+
- ✅ `option-output-format.md` - Output formats (ESM, CJS, IIFE, UMD)
|
|
16
|
+
- ✅ `option-output-directory.md` - Output directory and extensions
|
|
17
|
+
- ✅ `option-dts.md` - TypeScript declaration generation
|
|
18
|
+
- ✅ `option-target.md` - Target environment (ES2020, ESNext, etc.)
|
|
19
|
+
- ✅ `option-platform.md` - Platform (node, browser, neutral)
|
|
20
|
+
- ✅ `option-dependencies.md` - External and inline dependencies
|
|
21
|
+
- ✅ `option-sourcemap.md` - Source map generation
|
|
22
|
+
- ✅ `option-minification.md` - Minification (`boolean | 'dce-only' | MinifyOptions`)
|
|
23
|
+
- ✅ `option-tree-shaking.md` - Tree shaking configuration
|
|
24
|
+
- ✅ `option-cleaning.md` - Output directory cleaning
|
|
25
|
+
- ✅ `option-watch-mode.md` - Watch mode configuration
|
|
26
|
+
- ✅ `option-shims.md` - ESM/CJS compatibility shims
|
|
27
|
+
- ✅ `option-package-exports.md` - Auto-generate package.json exports
|
|
28
|
+
- ✅ `option-css.md` - CSS handling (experimental, full pipeline: preprocessors, Lightning CSS, PostCSS, code splitting)
|
|
29
|
+
- ✅ `option-unbundle.md` - Preserve directory structure
|
|
30
|
+
- ✅ `option-cjs-default.md` - CommonJS default export handling
|
|
31
|
+
- ✅ `option-log-level.md` - Logging configuration
|
|
32
|
+
- ✅ `option-lint.md` - Package validation (publint & attw)
|
|
33
|
+
|
|
34
|
+
### Executable (1)
|
|
35
|
+
- ✅ `option-exe.md` - Standalone executable bundling (Node.js SEA)
|
|
36
|
+
|
|
37
|
+
### Advanced Topics (6)
|
|
38
|
+
- ✅ `advanced-plugins.md` - Rolldown, Rollup, Unplugin support
|
|
39
|
+
- ✅ `advanced-hooks.md` - Lifecycle hooks system
|
|
40
|
+
- ✅ `advanced-programmatic.md` - Node.js API usage
|
|
41
|
+
- ✅ `advanced-rolldown-options.md` - Pass options to Rolldown
|
|
42
|
+
- ✅ `advanced-ci.md` - CI environment detection and CI-aware options
|
|
43
|
+
|
|
44
|
+
### Advanced (continued)
|
|
45
|
+
- ✅ `advanced-benchmark.md` - Performance benchmarks
|
|
46
|
+
|
|
47
|
+
### Framework Recipes (5)
|
|
48
|
+
- ✅ `recipe-react.md` - React library setup with JSX
|
|
49
|
+
- ✅ `recipe-vue.md` - Vue library setup with SFC
|
|
50
|
+
- ✅ `recipe-solid.md` - Solid.js library setup
|
|
51
|
+
- ✅ `recipe-svelte.md` - Svelte component libraries
|
|
52
|
+
- ✅ `recipe-wasm.md` - WASM module support
|
|
53
|
+
|
|
54
|
+
### Reference (1)
|
|
55
|
+
- ✅ `reference-cli.md` - Complete CLI command reference
|
|
56
|
+
|
|
57
|
+
## Coverage Status
|
|
58
|
+
|
|
59
|
+
**Created:** 35 files (100% complete)
|
|
60
|
+
|
|
61
|
+
## Current Skill Features
|
|
62
|
+
|
|
63
|
+
The tsdown skill now includes comprehensive coverage of:
|
|
64
|
+
|
|
65
|
+
### ✅ Core Functionality
|
|
66
|
+
- Getting started and installation
|
|
67
|
+
- Entry points and glob patterns
|
|
68
|
+
- Output formats (ESM, CJS, IIFE, UMD)
|
|
69
|
+
- TypeScript declarations
|
|
70
|
+
- Configuration file setup
|
|
71
|
+
- CLI reference
|
|
72
|
+
|
|
73
|
+
### ✅ Build Options
|
|
74
|
+
- Target environment configuration
|
|
75
|
+
- Platform selection
|
|
76
|
+
- Dependency management
|
|
77
|
+
- Source maps
|
|
78
|
+
- Minification
|
|
79
|
+
- Tree shaking
|
|
80
|
+
- Output cleaning
|
|
81
|
+
- Watch mode
|
|
82
|
+
|
|
83
|
+
### ✅ Advanced Features
|
|
84
|
+
- Plugins (Rolldown, Rollup, Unplugin)
|
|
85
|
+
- Lifecycle hooks
|
|
86
|
+
- ESM/CJS shims
|
|
87
|
+
- Package exports generation
|
|
88
|
+
- Package validation (publint, attw)
|
|
89
|
+
- Programmatic API (Node.js)
|
|
90
|
+
- Output directory customization
|
|
91
|
+
- CSS handling and modules
|
|
92
|
+
- Unbundle mode
|
|
93
|
+
- CI environment detection and CI-aware options
|
|
94
|
+
|
|
95
|
+
### ✅ Framework & Runtime Support
|
|
96
|
+
- React with JSX/TSX
|
|
97
|
+
- React Compiler integration
|
|
98
|
+
- Vue with SFC support
|
|
99
|
+
- Vue type generation (vue-tsc)
|
|
100
|
+
- WASM module bundling (rolldown-plugin-wasm)
|
|
101
|
+
|
|
102
|
+
### ✅ Migration
|
|
103
|
+
- Complete migration guide from tsup
|
|
104
|
+
- Compatibility notes
|
|
105
|
+
|
|
106
|
+
## Usage
|
|
107
|
+
|
|
108
|
+
The skill is now ready for use with comprehensive coverage of core features. Additional files can be added incrementally as needed.
|
|
109
|
+
|
|
110
|
+
## File Naming Convention
|
|
111
|
+
|
|
112
|
+
Files are prefixed by category:
|
|
113
|
+
- `guide-*` - Getting started guides and tutorials
|
|
114
|
+
- `option-*` - Configuration options
|
|
115
|
+
- `advanced-*` - Advanced topics (plugins, hooks, programmatic API)
|
|
116
|
+
- `recipe-*` - Framework-specific recipes
|
|
117
|
+
- `reference-*` - CLI and API reference
|
|
118
|
+
|
|
119
|
+
## Creating New Reference Files
|
|
120
|
+
|
|
121
|
+
When creating new reference files:
|
|
122
|
+
|
|
123
|
+
1. **Read source documentation** from `/docs` directory
|
|
124
|
+
2. **Simplify for AI consumption** - concise, actionable content
|
|
125
|
+
3. **Include code examples** - practical, copy-paste ready
|
|
126
|
+
4. **Add cross-references** - link to related options
|
|
127
|
+
5. **Follow naming convention** - use appropriate prefix
|
|
128
|
+
6. **Keep it focused** - one topic per file
|
|
129
|
+
|
|
130
|
+
## Updating Existing Files
|
|
131
|
+
|
|
132
|
+
When documentation changes:
|
|
133
|
+
|
|
134
|
+
1. Check git diff: `git diff <sha>..HEAD -- docs/`
|
|
135
|
+
2. Update affected reference files
|
|
136
|
+
3. Update SKILL.md if needed
|
|
137
|
+
4. Update GENERATION.md with new SHA
|
|
138
|
+
|
|
139
|
+
See `skills/GENERATION.md` for detailed update instructions.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Benchmark
|
|
2
|
+
|
|
3
|
+
tsdown delivers exceptional performance:
|
|
4
|
+
|
|
5
|
+
- **~2x faster** than tsup for standard builds
|
|
6
|
+
- **Up to 8x faster** for TypeScript declaration generation
|
|
7
|
+
|
|
8
|
+
For detailed comparisons, see [bundler-benchmark](https://gugustinette.github.io/bundler-benchmark/).
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# CI Environment Support
|
|
2
|
+
|
|
3
|
+
Automatically detect CI environments and toggle features based on local vs CI builds.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
tsdown uses the [`is-in-ci`](https://www.npmjs.com/package/is-in-ci) package to detect CI environments. This covers GitHub Actions, GitLab CI, Jenkins, CircleCI, Travis CI, and more.
|
|
8
|
+
|
|
9
|
+
## CI-Aware Values
|
|
10
|
+
|
|
11
|
+
Several options accept CI-aware string values:
|
|
12
|
+
|
|
13
|
+
| Value | Behavior |
|
|
14
|
+
|-------|----------|
|
|
15
|
+
| `true` | Always enabled |
|
|
16
|
+
| `false` | Always disabled |
|
|
17
|
+
| `'ci-only'` | Enabled only in CI, disabled locally |
|
|
18
|
+
| `'local-only'` | Enabled only locally, disabled in CI |
|
|
19
|
+
|
|
20
|
+
## Supported Options
|
|
21
|
+
|
|
22
|
+
These options accept CI-aware values:
|
|
23
|
+
|
|
24
|
+
- `dts` - TypeScript declaration file generation
|
|
25
|
+
- `publint` - Package lint validation
|
|
26
|
+
- `attw` - "Are the types wrong" validation
|
|
27
|
+
- `report` - Bundle size reporting
|
|
28
|
+
- `exports` - Auto-generate `package.json` exports
|
|
29
|
+
- `unused` - Unused dependency check
|
|
30
|
+
- `devtools` - DevTools integration
|
|
31
|
+
- `failOnWarn` - Fail on warnings (defaults to `false`)
|
|
32
|
+
|
|
33
|
+
## Usage
|
|
34
|
+
|
|
35
|
+
### String Form
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
export default defineConfig({
|
|
39
|
+
dts: 'local-only', // Skip DTS in CI for faster builds
|
|
40
|
+
publint: 'ci-only', // Only run publint in CI
|
|
41
|
+
failOnWarn: 'ci-only', // Fail on warnings in CI only (opt-in)
|
|
42
|
+
})
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Object Form
|
|
46
|
+
|
|
47
|
+
When an option takes a configuration object, set `enabled` to a CI-aware value:
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
export default defineConfig({
|
|
51
|
+
publint: {
|
|
52
|
+
enabled: 'ci-only',
|
|
53
|
+
level: 'error',
|
|
54
|
+
},
|
|
55
|
+
attw: {
|
|
56
|
+
enabled: 'ci-only',
|
|
57
|
+
profile: 'node16',
|
|
58
|
+
},
|
|
59
|
+
})
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Config Function
|
|
63
|
+
|
|
64
|
+
The config function receives a `ci` boolean in its context:
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
export default defineConfig((_, { ci }) => ({
|
|
68
|
+
minify: ci,
|
|
69
|
+
sourcemap: !ci,
|
|
70
|
+
}))
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Typical CI Configuration
|
|
74
|
+
|
|
75
|
+
```ts
|
|
76
|
+
export default defineConfig({
|
|
77
|
+
entry: 'src/index.ts',
|
|
78
|
+
format: ['esm', 'cjs'],
|
|
79
|
+
dts: true,
|
|
80
|
+
failOnWarn: 'ci-only',
|
|
81
|
+
publint: 'ci-only',
|
|
82
|
+
attw: 'ci-only',
|
|
83
|
+
})
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Related Options
|
|
87
|
+
|
|
88
|
+
- [Package Validation](option-lint.md) - publint and attw configuration
|
|
89
|
+
- [Log Level](option-log-level.md) - `failOnWarn` option details
|