aico-cli 2.1.7 → 2.1.23
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/bin/cli/README.md +1 -1
- package/bin/cli/cli.js +8672 -3345
- package/bin/cli/package.json +1 -1
- package/bin/cli/sdk-tools.d.ts +41 -5
- package/dist/chunks/simple-config.mjs +1 -1
- package/package.json +2 -2
- package/templates/skills/antfu/SKILL.md +222 -0
- package/templates/skills/antfu/references/antfu-eslint-config.md +328 -0
- package/templates/skills/antfu/references/app-development.md +60 -0
- package/templates/skills/antfu/references/github-actions.md +68 -0
- package/templates/skills/antfu/references/gitignore.md +29 -0
- package/templates/skills/antfu/references/library-development.md +85 -0
- package/templates/skills/antfu/references/monorepo.md +126 -0
- package/templates/skills/antfu/references/vscode-extensions.md +34 -0
- package/templates/skills/nuxt/GENERATION.md +5 -0
- package/templates/skills/nuxt/SKILL.md +55 -0
- package/templates/skills/nuxt/references/advanced-hooks.md +289 -0
- package/templates/skills/nuxt/references/advanced-layers.md +299 -0
- package/templates/skills/nuxt/references/advanced-module-authoring.md +554 -0
- package/templates/skills/nuxt/references/best-practices-data-fetching.md +357 -0
- package/templates/skills/nuxt/references/best-practices-ssr.md +355 -0
- package/templates/skills/nuxt/references/core-cli.md +263 -0
- package/templates/skills/nuxt/references/core-config.md +162 -0
- package/templates/skills/nuxt/references/core-data-fetching.md +236 -0
- package/templates/skills/nuxt/references/core-deployment.md +224 -0
- package/templates/skills/nuxt/references/core-directory-structure.md +269 -0
- package/templates/skills/nuxt/references/core-modules.md +292 -0
- package/templates/skills/nuxt/references/core-routing.md +226 -0
- package/templates/skills/nuxt/references/features-components-autoimport.md +328 -0
- package/templates/skills/nuxt/references/features-components.md +264 -0
- package/templates/skills/nuxt/references/features-composables.md +276 -0
- package/templates/skills/nuxt/references/features-server.md +265 -0
- package/templates/skills/nuxt/references/features-state.md +194 -0
- package/templates/skills/nuxt/references/rendering-modes.md +237 -0
- package/templates/skills/pinia/GENERATION.md +5 -0
- package/templates/skills/pinia/SKILL.md +59 -0
- package/templates/skills/pinia/references/advanced-hmr.md +61 -0
- package/templates/skills/pinia/references/advanced-nuxt.md +119 -0
- package/templates/skills/pinia/references/advanced-ssr.md +121 -0
- package/templates/skills/pinia/references/best-practices-outside-component.md +115 -0
- package/templates/skills/pinia/references/best-practices-testing.md +212 -0
- package/templates/skills/pinia/references/core-stores.md +389 -0
- package/templates/skills/pinia/references/features-composables.md +114 -0
- package/templates/skills/pinia/references/features-composing-stores.md +134 -0
- package/templates/skills/pinia/references/features-plugins.md +203 -0
- package/templates/skills/pnpm/GENERATION.md +5 -0
- package/templates/skills/pnpm/SKILL.md +42 -0
- package/templates/skills/pnpm/references/best-practices-ci.md +285 -0
- package/templates/skills/pnpm/references/best-practices-migration.md +291 -0
- package/templates/skills/pnpm/references/best-practices-performance.md +284 -0
- package/templates/skills/pnpm/references/core-cli.md +229 -0
- package/templates/skills/pnpm/references/core-config.md +188 -0
- package/templates/skills/pnpm/references/core-store.md +179 -0
- package/templates/skills/pnpm/references/core-workspaces.md +205 -0
- package/templates/skills/pnpm/references/features-aliases.md +168 -0
- package/templates/skills/pnpm/references/features-catalogs.md +159 -0
- package/templates/skills/pnpm/references/features-hooks.md +233 -0
- package/templates/skills/pnpm/references/features-overrides.md +184 -0
- package/templates/skills/pnpm/references/features-patches.md +201 -0
- package/templates/skills/pnpm/references/features-peer-deps.md +250 -0
- package/templates/skills/slidev/LICENSE.md +21 -0
- package/templates/skills/slidev/README.md +61 -0
- package/templates/skills/slidev/SKILL.md +183 -0
- package/templates/skills/slidev/SYNC.md +5 -0
- package/templates/skills/slidev/references/animation-click-marker.md +37 -0
- package/templates/skills/slidev/references/animation-drawing.md +68 -0
- package/templates/skills/slidev/references/animation-rough-marker.md +53 -0
- package/templates/skills/slidev/references/api-slide-hooks.md +37 -0
- package/templates/skills/slidev/references/build-og-image.md +36 -0
- package/templates/skills/slidev/references/build-pdf.md +40 -0
- package/templates/skills/slidev/references/build-remote-assets.md +34 -0
- package/templates/skills/slidev/references/build-seo-meta.md +43 -0
- package/templates/skills/slidev/references/code-groups.md +64 -0
- package/templates/skills/slidev/references/code-import-snippet.md +55 -0
- package/templates/skills/slidev/references/code-line-highlighting.md +50 -0
- package/templates/skills/slidev/references/code-line-numbers.md +46 -0
- package/templates/skills/slidev/references/code-magic-move.md +57 -0
- package/templates/skills/slidev/references/code-max-height.md +37 -0
- package/templates/skills/slidev/references/code-twoslash.md +42 -0
- package/templates/skills/slidev/references/core-animations.md +196 -0
- package/templates/skills/slidev/references/core-cli.md +140 -0
- package/templates/skills/slidev/references/core-components.md +197 -0
- package/templates/skills/slidev/references/core-exporting.md +148 -0
- package/templates/skills/slidev/references/core-frontmatter.md +195 -0
- package/templates/skills/slidev/references/core-global-context.md +155 -0
- package/templates/skills/slidev/references/core-headmatter.md +188 -0
- package/templates/skills/slidev/references/core-hosting.md +152 -0
- package/templates/skills/slidev/references/core-layouts.md +286 -0
- package/templates/skills/slidev/references/core-syntax.md +155 -0
- package/templates/skills/slidev/references/diagram-latex.md +55 -0
- package/templates/skills/slidev/references/diagram-mermaid.md +44 -0
- package/templates/skills/slidev/references/diagram-plantuml.md +45 -0
- package/templates/skills/slidev/references/editor-monaco-run.md +44 -0
- package/templates/skills/slidev/references/editor-monaco-write.md +24 -0
- package/templates/skills/slidev/references/editor-monaco.md +50 -0
- package/templates/skills/slidev/references/editor-prettier.md +40 -0
- package/templates/skills/slidev/references/editor-side.md +23 -0
- package/templates/skills/slidev/references/editor-vscode.md +55 -0
- package/templates/skills/slidev/references/layout-canvas-size.md +25 -0
- package/templates/skills/slidev/references/layout-draggable.md +57 -0
- package/templates/skills/slidev/references/layout-global-layers.md +50 -0
- package/templates/skills/slidev/references/layout-slots.md +75 -0
- package/templates/skills/slidev/references/layout-transform.md +33 -0
- package/templates/skills/slidev/references/layout-zoom.md +39 -0
- package/templates/skills/slidev/references/presenter-notes-ruby.md +35 -0
- package/templates/skills/slidev/references/presenter-recording.md +30 -0
- package/templates/skills/slidev/references/presenter-remote.md +40 -0
- package/templates/skills/slidev/references/presenter-timer.md +34 -0
- package/templates/skills/slidev/references/style-direction.md +34 -0
- package/templates/skills/slidev/references/style-icons.md +46 -0
- package/templates/skills/slidev/references/style-scoped.md +50 -0
- package/templates/skills/slidev/references/syntax-block-frontmatter.md +39 -0
- package/templates/skills/slidev/references/syntax-frontmatter-merging.md +49 -0
- package/templates/skills/slidev/references/syntax-importing-slides.md +60 -0
- package/templates/skills/slidev/references/syntax-mdc.md +51 -0
- package/templates/skills/slidev/references/tool-eject-theme.md +27 -0
- package/templates/skills/tech-whitepaper/SKILL.md +102 -15
- package/templates/skills/tsdown/GENERATION.md +5 -0
- package/templates/skills/tsdown/SKILL.md +59 -0
- package/templates/skills/tsdown/references/advanced-hooks.md +87 -0
- package/templates/skills/tsdown/references/advanced-plugins.md +97 -0
- package/templates/skills/tsdown/references/advanced-programmatic.md +78 -0
- package/templates/skills/tsdown/references/advanced-rolldown-options.md +114 -0
- package/templates/skills/tsdown/references/core-cli.md +116 -0
- package/templates/skills/tsdown/references/core-config.md +86 -0
- package/templates/skills/tsdown/references/core-entry.md +74 -0
- package/templates/skills/tsdown/references/features-optimization.md +83 -0
- package/templates/skills/tsdown/references/features-shims.md +92 -0
- package/templates/skills/tsdown/references/features-unbundle.md +63 -0
- package/templates/skills/tsdown/references/features-watch.md +60 -0
- package/templates/skills/tsdown/references/options-dependencies.md +88 -0
- package/templates/skills/tsdown/references/options-dts.md +104 -0
- package/templates/skills/tsdown/references/options-output.md +124 -0
- package/templates/skills/tsdown/references/options-package-exports.md +114 -0
- package/templates/skills/tsdown/references/recipes-frameworks.md +109 -0
- package/templates/skills/tsdown/references/recipes-migration.md +84 -0
- package/templates/skills/turborepo/LICENSE.md +7 -0
- package/templates/skills/turborepo/SKILL.md +914 -0
- package/templates/skills/turborepo/SYNC.md +5 -0
- package/templates/skills/turborepo/command/turborepo.md +70 -0
- package/templates/skills/turborepo/references/best-practices/README.md +241 -0
- package/templates/skills/turborepo/references/best-practices/dependencies.md +246 -0
- package/templates/skills/turborepo/references/best-practices/packages.md +335 -0
- package/templates/skills/turborepo/references/best-practices/structure.md +269 -0
- package/templates/skills/turborepo/references/boundaries/README.md +126 -0
- package/templates/skills/turborepo/references/caching/README.md +107 -0
- package/templates/skills/turborepo/references/caching/gotchas.md +169 -0
- package/templates/skills/turborepo/references/caching/remote-cache.md +127 -0
- package/templates/skills/turborepo/references/ci/README.md +79 -0
- package/templates/skills/turborepo/references/ci/github-actions.md +162 -0
- package/templates/skills/turborepo/references/ci/patterns.md +145 -0
- package/templates/skills/turborepo/references/ci/vercel.md +103 -0
- package/templates/skills/turborepo/references/cli/README.md +100 -0
- package/templates/skills/turborepo/references/cli/commands.md +297 -0
- package/templates/skills/turborepo/references/configuration/README.md +211 -0
- package/templates/skills/turborepo/references/configuration/global-options.md +195 -0
- package/templates/skills/turborepo/references/configuration/gotchas.md +348 -0
- package/templates/skills/turborepo/references/configuration/tasks.md +285 -0
- package/templates/skills/turborepo/references/environment/README.md +96 -0
- package/templates/skills/turborepo/references/environment/gotchas.md +145 -0
- package/templates/skills/turborepo/references/environment/modes.md +101 -0
- package/templates/skills/turborepo/references/filtering/README.md +148 -0
- package/templates/skills/turborepo/references/filtering/patterns.md +152 -0
- package/templates/skills/turborepo/references/watch/README.md +99 -0
- package/templates/skills/unocss/GENERATION.md +5 -0
- package/templates/skills/unocss/SKILL.md +64 -0
- package/templates/skills/unocss/references/core-config.md +187 -0
- package/templates/skills/unocss/references/core-extracting.md +137 -0
- package/templates/skills/unocss/references/core-layers.md +104 -0
- package/templates/skills/unocss/references/core-rules.md +166 -0
- package/templates/skills/unocss/references/core-safelist.md +105 -0
- package/templates/skills/unocss/references/core-shortcuts.md +89 -0
- package/templates/skills/unocss/references/core-theme.md +172 -0
- package/templates/skills/unocss/references/core-variants.md +175 -0
- package/templates/skills/unocss/references/integrations-nuxt.md +199 -0
- package/templates/skills/unocss/references/integrations-vite.md +283 -0
- package/templates/skills/unocss/references/preset-attributify.md +142 -0
- package/templates/skills/unocss/references/preset-icons.md +184 -0
- package/templates/skills/unocss/references/preset-mini.md +158 -0
- package/templates/skills/unocss/references/preset-rem-to-px.md +97 -0
- package/templates/skills/unocss/references/preset-tagify.md +134 -0
- package/templates/skills/unocss/references/preset-typography.md +95 -0
- package/templates/skills/unocss/references/preset-web-fonts.md +91 -0
- package/templates/skills/unocss/references/preset-wind3.md +194 -0
- package/templates/skills/unocss/references/preset-wind4.md +247 -0
- package/templates/skills/unocss/references/transformer-attributify-jsx.md +156 -0
- package/templates/skills/unocss/references/transformer-compile-class.md +128 -0
- package/templates/skills/unocss/references/transformer-directives.md +157 -0
- package/templates/skills/unocss/references/transformer-variant-group.md +97 -0
- package/templates/skills/vite/GENERATION.md +5 -0
- package/templates/skills/vite/SKILL.md +50 -0
- package/templates/skills/vite/references/advanced-api.md +218 -0
- package/templates/skills/vite/references/advanced-backend.md +164 -0
- package/templates/skills/vite/references/advanced-performance.md +168 -0
- package/templates/skills/vite/references/advanced-plugin-api.md +258 -0
- package/templates/skills/vite/references/build-library.md +172 -0
- package/templates/skills/vite/references/build-production.md +220 -0
- package/templates/skills/vite/references/build-ssr.md +194 -0
- package/templates/skills/vite/references/core-cli.md +137 -0
- package/templates/skills/vite/references/core-config.md +176 -0
- package/templates/skills/vite/references/core-features.md +170 -0
- package/templates/skills/vite/references/core-plugins.md +154 -0
- package/templates/skills/vite/references/features-assets.md +138 -0
- package/templates/skills/vite/references/features-css.md +215 -0
- package/templates/skills/vite/references/features-dep-bundling.md +148 -0
- package/templates/skills/vite/references/features-env.md +161 -0
- package/templates/skills/vite/references/features-glob-import.md +161 -0
- package/templates/skills/vite/references/features-hmr.md +200 -0
- package/templates/skills/vite/references/features-workers.md +115 -0
- package/templates/skills/vitepress/GENERATION.md +5 -0
- package/templates/skills/vitepress/SKILL.md +65 -0
- package/templates/skills/vitepress/references/advanced-i18n.md +299 -0
- package/templates/skills/vitepress/references/advanced-ssr.md +228 -0
- package/templates/skills/vitepress/references/core-cli.md +119 -0
- package/templates/skills/vitepress/references/core-config.md +189 -0
- package/templates/skills/vitepress/references/core-markdown.md +277 -0
- package/templates/skills/vitepress/references/core-routing.md +169 -0
- package/templates/skills/vitepress/references/features-code-blocks.md +243 -0
- package/templates/skills/vitepress/references/features-data-loading.md +220 -0
- package/templates/skills/vitepress/references/features-dynamic-routes.md +235 -0
- package/templates/skills/vitepress/references/features-vue.md +224 -0
- package/templates/skills/vitepress/references/recipes-deploy.md +240 -0
- package/templates/skills/vitepress/references/theme-config.md +315 -0
- package/templates/skills/vitepress/references/theme-custom.md +269 -0
- package/templates/skills/vitepress/references/theme-customization.md +290 -0
- package/templates/skills/vitest/GENERATION.md +5 -0
- package/templates/skills/vitest/SKILL.md +52 -0
- package/templates/skills/vitest/references/advanced-environments.md +264 -0
- package/templates/skills/vitest/references/advanced-projects.md +300 -0
- package/templates/skills/vitest/references/advanced-type-testing.md +237 -0
- package/templates/skills/vitest/references/advanced-vi.md +249 -0
- package/templates/skills/vitest/references/core-cli.md +166 -0
- package/templates/skills/vitest/references/core-config.md +174 -0
- package/templates/skills/vitest/references/core-describe.md +193 -0
- package/templates/skills/vitest/references/core-expect.md +219 -0
- package/templates/skills/vitest/references/core-hooks.md +244 -0
- package/templates/skills/vitest/references/core-test-api.md +233 -0
- package/templates/skills/vitest/references/features-concurrency.md +250 -0
- package/templates/skills/vitest/references/features-context.md +238 -0
- package/templates/skills/vitest/references/features-coverage.md +207 -0
- package/templates/skills/vitest/references/features-filtering.md +211 -0
- package/templates/skills/vitest/references/features-mocking.md +265 -0
- package/templates/skills/vitest/references/features-snapshots.md +207 -0
- package/templates/skills/vue/GENERATION.md +5 -0
- package/templates/skills/vue/SKILL.md +63 -0
- package/templates/skills/vue/references/advanced-async-suspense.md +246 -0
- package/templates/skills/vue/references/advanced-provide-inject.md +174 -0
- package/templates/skills/vue/references/components-emits.md +139 -0
- package/templates/skills/vue/references/components-lifecycle.md +192 -0
- package/templates/skills/vue/references/components-props.md +211 -0
- package/templates/skills/vue/references/components-slots.md +201 -0
- package/templates/skills/vue/references/components-v-model.md +183 -0
- package/templates/skills/vue/references/core-reactivity.md +289 -0
- package/templates/skills/vue/references/features-composables.md +262 -0
- package/templates/skills/vue/references/features-directives.md +224 -0
- package/templates/skills/vue/references/features-script-setup.md +247 -0
- package/templates/skills/vue/references/features-template-refs.md +212 -0
- package/templates/skills/vue/references/features-typescript.md +274 -0
- package/templates/skills/vue-best-practices/LICENSE.md +21 -0
- package/templates/skills/vue-best-practices/SKILL.md +38 -0
- package/templates/skills/vue-best-practices/SYNC.md +5 -0
- package/templates/skills/vue-best-practices/rules/codeactions-save-performance.md +79 -0
- package/templates/skills/vue-best-practices/rules/data-attributes-config.md +74 -0
- package/templates/skills/vue-best-practices/rules/deep-watch-numeric.md +97 -0
- package/templates/skills/vue-best-practices/rules/define-model-update-event.md +79 -0
- package/templates/skills/vue-best-practices/rules/duplicate-plugin-detection.md +102 -0
- package/templates/skills/vue-best-practices/rules/extract-component-props.md +57 -0
- package/templates/skills/vue-best-practices/rules/fallthrough-attributes.md +63 -0
- package/templates/skills/vue-best-practices/rules/hmr-vue-ssr.md +124 -0
- package/templates/skills/vue-best-practices/rules/module-resolution-bundler.md +81 -0
- package/templates/skills/vue-best-practices/rules/pinia-store-mocking.md +159 -0
- package/templates/skills/vue-best-practices/rules/script-setup-jsdoc.md +85 -0
- package/templates/skills/vue-best-practices/rules/strict-css-modules.md +68 -0
- package/templates/skills/vue-best-practices/rules/volar-3-breaking-changes.md +65 -0
- package/templates/skills/vue-best-practices/rules/vue-directive-comments.md +73 -0
- package/templates/skills/vue-best-practices/rules/vue-router-typed-params.md +81 -0
- package/templates/skills/vue-best-practices/rules/vue-tsc-strict-templates.md +69 -0
- package/templates/skills/vue-best-practices/rules/with-defaults-union-types.md +102 -0
- package/templates/skills/vueuse-functions/LICENSE.md +21 -0
- package/templates/skills/vueuse-functions/SKILL.md +418 -0
- package/templates/skills/vueuse-functions/SYNC.md +5 -0
- package/templates/skills/vueuse-functions/references/computedAsync.md +159 -0
- package/templates/skills/vueuse-functions/references/computedEager.md +62 -0
- package/templates/skills/vueuse-functions/references/computedInject.md +86 -0
- package/templates/skills/vueuse-functions/references/computedWithControl.md +100 -0
- package/templates/skills/vueuse-functions/references/createEventHook.md +86 -0
- package/templates/skills/vueuse-functions/references/createGenericProjection.md +25 -0
- package/templates/skills/vueuse-functions/references/createGlobalState.md +95 -0
- package/templates/skills/vueuse-functions/references/createInjectionState.md +215 -0
- package/templates/skills/vueuse-functions/references/createProjection.md +31 -0
- package/templates/skills/vueuse-functions/references/createRef.md +54 -0
- package/templates/skills/vueuse-functions/references/createReusableTemplate.md +357 -0
- package/templates/skills/vueuse-functions/references/createSharedComposable.md +42 -0
- package/templates/skills/vueuse-functions/references/createTemplatePromise.md +259 -0
- package/templates/skills/vueuse-functions/references/createUnrefFn.md +51 -0
- package/templates/skills/vueuse-functions/references/extendRef.md +76 -0
- package/templates/skills/vueuse-functions/references/from.md +48 -0
- package/templates/skills/vueuse-functions/references/get.md +30 -0
- package/templates/skills/vueuse-functions/references/injectLocal.md +35 -0
- package/templates/skills/vueuse-functions/references/isDefined.md +31 -0
- package/templates/skills/vueuse-functions/references/logicAnd.md +40 -0
- package/templates/skills/vueuse-functions/references/logicNot.md +36 -0
- package/templates/skills/vueuse-functions/references/logicOr.md +40 -0
- package/templates/skills/vueuse-functions/references/makeDestructurable.md +41 -0
- package/templates/skills/vueuse-functions/references/onClickOutside.md +187 -0
- package/templates/skills/vueuse-functions/references/onElementRemoval.md +64 -0
- package/templates/skills/vueuse-functions/references/onKeyStroke.md +176 -0
- package/templates/skills/vueuse-functions/references/onLongPress.md +170 -0
- package/templates/skills/vueuse-functions/references/onStartTyping.md +43 -0
- package/templates/skills/vueuse-functions/references/provideLocal.md +37 -0
- package/templates/skills/vueuse-functions/references/reactify.md +144 -0
- package/templates/skills/vueuse-functions/references/reactifyObject.md +61 -0
- package/templates/skills/vueuse-functions/references/reactiveComputed.md +34 -0
- package/templates/skills/vueuse-functions/references/reactiveOmit.md +86 -0
- package/templates/skills/vueuse-functions/references/reactivePick.md +106 -0
- package/templates/skills/vueuse-functions/references/refAutoReset.md +44 -0
- package/templates/skills/vueuse-functions/references/refDebounced.md +81 -0
- package/templates/skills/vueuse-functions/references/refDefault.md +36 -0
- package/templates/skills/vueuse-functions/references/refManualReset.md +44 -0
- package/templates/skills/vueuse-functions/references/refThrottled.md +99 -0
- package/templates/skills/vueuse-functions/references/refWithControl.md +146 -0
- package/templates/skills/vueuse-functions/references/set.md +30 -0
- package/templates/skills/vueuse-functions/references/syncRef.md +195 -0
- package/templates/skills/vueuse-functions/references/syncRefs.md +128 -0
- package/templates/skills/vueuse-functions/references/templateRef.md +86 -0
- package/templates/skills/vueuse-functions/references/toObserver.md +38 -0
- package/templates/skills/vueuse-functions/references/toReactive.md +41 -0
- package/templates/skills/vueuse-functions/references/toRef.md +75 -0
- package/templates/skills/vueuse-functions/references/toRefs.md +81 -0
- package/templates/skills/vueuse-functions/references/tryOnBeforeMount.md +34 -0
- package/templates/skills/vueuse-functions/references/tryOnBeforeUnmount.md +32 -0
- package/templates/skills/vueuse-functions/references/tryOnMounted.md +34 -0
- package/templates/skills/vueuse-functions/references/tryOnScopeDispose.md +31 -0
- package/templates/skills/vueuse-functions/references/tryOnUnmounted.md +32 -0
- package/templates/skills/vueuse-functions/references/unrefElement.md +54 -0
- package/templates/skills/vueuse-functions/references/until.md +165 -0
- package/templates/skills/vueuse-functions/references/useAbs.md +31 -0
- package/templates/skills/vueuse-functions/references/useActiveElement.md +65 -0
- package/templates/skills/vueuse-functions/references/useAnimate.md +140 -0
- package/templates/skills/vueuse-functions/references/useArrayDifference.md +84 -0
- package/templates/skills/vueuse-functions/references/useArrayEvery.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayFilter.md +63 -0
- package/templates/skills/vueuse-functions/references/useArrayFind.md +50 -0
- package/templates/skills/vueuse-functions/references/useArrayFindIndex.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayFindLast.md +52 -0
- package/templates/skills/vueuse-functions/references/useArrayIncludes.md +63 -0
- package/templates/skills/vueuse-functions/references/useArrayJoin.md +74 -0
- package/templates/skills/vueuse-functions/references/useArrayMap.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayReduce.md +81 -0
- package/templates/skills/vueuse-functions/references/useArraySome.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayUnique.md +76 -0
- package/templates/skills/vueuse-functions/references/useAsyncQueue.md +87 -0
- package/templates/skills/vueuse-functions/references/useAsyncState.md +140 -0
- package/templates/skills/vueuse-functions/references/useAsyncValidator.md +70 -0
- package/templates/skills/vueuse-functions/references/useAuth.md +114 -0
- package/templates/skills/vueuse-functions/references/useAverage.md +36 -0
- package/templates/skills/vueuse-functions/references/useAxios.md +292 -0
- package/templates/skills/vueuse-functions/references/useBase64.md +88 -0
- package/templates/skills/vueuse-functions/references/useBattery.md +67 -0
- package/templates/skills/vueuse-functions/references/useBluetooth.md +161 -0
- package/templates/skills/vueuse-functions/references/useBreakpoints.md +128 -0
- package/templates/skills/vueuse-functions/references/useBroadcastChannel.md +74 -0
- package/templates/skills/vueuse-functions/references/useBrowserLocation.md +83 -0
- package/templates/skills/vueuse-functions/references/useCached.md +53 -0
- package/templates/skills/vueuse-functions/references/useCeil.md +31 -0
- package/templates/skills/vueuse-functions/references/useChangeCase.md +79 -0
- package/templates/skills/vueuse-functions/references/useClamp.md +51 -0
- package/templates/skills/vueuse-functions/references/useClipboard.md +99 -0
- package/templates/skills/vueuse-functions/references/useClipboardItems.md +93 -0
- package/templates/skills/vueuse-functions/references/useCloned.md +91 -0
- package/templates/skills/vueuse-functions/references/useColorMode.md +171 -0
- package/templates/skills/vueuse-functions/references/useConfirmDialog.md +159 -0
- package/templates/skills/vueuse-functions/references/useCookies.md +162 -0
- package/templates/skills/vueuse-functions/references/useCountdown.md +102 -0
- package/templates/skills/vueuse-functions/references/useCounter.md +86 -0
- package/templates/skills/vueuse-functions/references/useCssVar.md +50 -0
- package/templates/skills/vueuse-functions/references/useCurrentElement.md +61 -0
- package/templates/skills/vueuse-functions/references/useCycleList.md +75 -0
- package/templates/skills/vueuse-functions/references/useDark.md +142 -0
- package/templates/skills/vueuse-functions/references/useDateFormat.md +145 -0
- package/templates/skills/vueuse-functions/references/useDebounceFn.md +100 -0
- package/templates/skills/vueuse-functions/references/useDebouncedRefHistory.md +40 -0
- package/templates/skills/vueuse-functions/references/useDeviceMotion.md +87 -0
- package/templates/skills/vueuse-functions/references/useDeviceOrientation.md +62 -0
- package/templates/skills/vueuse-functions/references/useDevicePixelRatio.md +44 -0
- package/templates/skills/vueuse-functions/references/useDevicesList.md +90 -0
- package/templates/skills/vueuse-functions/references/useDisplayMedia.md +71 -0
- package/templates/skills/vueuse-functions/references/useDocumentVisibility.md +45 -0
- package/templates/skills/vueuse-functions/references/useDraggable.md +210 -0
- package/templates/skills/vueuse-functions/references/useDrauu.md +65 -0
- package/templates/skills/vueuse-functions/references/useDropZone.md +83 -0
- package/templates/skills/vueuse-functions/references/useElementBounding.md +131 -0
- package/templates/skills/vueuse-functions/references/useElementByPoint.md +45 -0
- package/templates/skills/vueuse-functions/references/useElementHover.md +79 -0
- package/templates/skills/vueuse-functions/references/useElementSize.md +78 -0
- package/templates/skills/vueuse-functions/references/useElementVisibility.md +126 -0
- package/templates/skills/vueuse-functions/references/useEventBus.md +101 -0
- package/templates/skills/vueuse-functions/references/useEventListener.md +184 -0
- package/templates/skills/vueuse-functions/references/useEventSource.md +204 -0
- package/templates/skills/vueuse-functions/references/useExtractedObservable.md +185 -0
- package/templates/skills/vueuse-functions/references/useEyeDropper.md +71 -0
- package/templates/skills/vueuse-functions/references/useFavicon.md +67 -0
- package/templates/skills/vueuse-functions/references/useFetch.md +546 -0
- package/templates/skills/vueuse-functions/references/useFileDialog.md +91 -0
- package/templates/skills/vueuse-functions/references/useFileSystemAccess.md +162 -0
- package/templates/skills/vueuse-functions/references/useFirestore.md +104 -0
- package/templates/skills/vueuse-functions/references/useFloor.md +31 -0
- package/templates/skills/vueuse-functions/references/useFocus.md +99 -0
- package/templates/skills/vueuse-functions/references/useFocusTrap.md +245 -0
- package/templates/skills/vueuse-functions/references/useFocusWithin.md +57 -0
- package/templates/skills/vueuse-functions/references/useFps.md +28 -0
- package/templates/skills/vueuse-functions/references/useFullscreen.md +75 -0
- package/templates/skills/vueuse-functions/references/useFuse.md +107 -0
- package/templates/skills/vueuse-functions/references/useGamepad.md +223 -0
- package/templates/skills/vueuse-functions/references/useGeolocation.md +86 -0
- package/templates/skills/vueuse-functions/references/useIDBKeyval.md +93 -0
- package/templates/skills/vueuse-functions/references/useIdle.md +89 -0
- package/templates/skills/vueuse-functions/references/useImage.md +86 -0
- package/templates/skills/vueuse-functions/references/useInfiniteScroll.md +157 -0
- package/templates/skills/vueuse-functions/references/useIntersectionObserver.md +118 -0
- package/templates/skills/vueuse-functions/references/useInterval.md +69 -0
- package/templates/skills/vueuse-functions/references/useIntervalFn.md +50 -0
- package/templates/skills/vueuse-functions/references/useIpcRenderer.md +118 -0
- package/templates/skills/vueuse-functions/references/useIpcRendererInvoke.md +58 -0
- package/templates/skills/vueuse-functions/references/useIpcRendererOn.md +52 -0
- package/templates/skills/vueuse-functions/references/useJwt.md +57 -0
- package/templates/skills/vueuse-functions/references/useKeyModifier.md +87 -0
- package/templates/skills/vueuse-functions/references/useLastChanged.md +63 -0
- package/templates/skills/vueuse-functions/references/useLocalStorage.md +41 -0
- package/templates/skills/vueuse-functions/references/useMagicKeys.md +217 -0
- package/templates/skills/vueuse-functions/references/useManualRefHistory.md +204 -0
- package/templates/skills/vueuse-functions/references/useMath.md +47 -0
- package/templates/skills/vueuse-functions/references/useMax.md +36 -0
- package/templates/skills/vueuse-functions/references/useMediaControls.md +571 -0
- package/templates/skills/vueuse-functions/references/useMediaQuery.md +53 -0
- package/templates/skills/vueuse-functions/references/useMemoize.md +175 -0
- package/templates/skills/vueuse-functions/references/useMemory.md +56 -0
- package/templates/skills/vueuse-functions/references/useMin.md +36 -0
- package/templates/skills/vueuse-functions/references/useMounted.md +38 -0
- package/templates/skills/vueuse-functions/references/useMouse.md +114 -0
- package/templates/skills/vueuse-functions/references/useMouseInElement.md +123 -0
- package/templates/skills/vueuse-functions/references/useMousePressed.md +112 -0
- package/templates/skills/vueuse-functions/references/useMutationObserver.md +62 -0
- package/templates/skills/vueuse-functions/references/useNProgress.md +78 -0
- package/templates/skills/vueuse-functions/references/useNavigatorLanguage.md +57 -0
- package/templates/skills/vueuse-functions/references/useNetwork.md +106 -0
- package/templates/skills/vueuse-functions/references/useNow.md +75 -0
- package/templates/skills/vueuse-functions/references/useObjectUrl.md +55 -0
- package/templates/skills/vueuse-functions/references/useObservable.md +67 -0
- package/templates/skills/vueuse-functions/references/useOffsetPagination.md +199 -0
- package/templates/skills/vueuse-functions/references/useOnline.md +41 -0
- package/templates/skills/vueuse-functions/references/usePageLeave.md +42 -0
- package/templates/skills/vueuse-functions/references/useParallax.md +58 -0
- package/templates/skills/vueuse-functions/references/useParentElement.md +54 -0
- package/templates/skills/vueuse-functions/references/usePerformanceObserver.md +48 -0
- package/templates/skills/vueuse-functions/references/usePermission.md +78 -0
- package/templates/skills/vueuse-functions/references/usePointer.md +89 -0
- package/templates/skills/vueuse-functions/references/usePointerLock.md +60 -0
- package/templates/skills/vueuse-functions/references/usePointerSwipe.md +80 -0
- package/templates/skills/vueuse-functions/references/usePrecision.md +49 -0
- package/templates/skills/vueuse-functions/references/usePreferredColorScheme.md +42 -0
- package/templates/skills/vueuse-functions/references/usePreferredContrast.md +42 -0
- package/templates/skills/vueuse-functions/references/usePreferredDark.md +41 -0
- package/templates/skills/vueuse-functions/references/usePreferredLanguages.md +41 -0
- package/templates/skills/vueuse-functions/references/usePreferredReducedMotion.md +42 -0
- package/templates/skills/vueuse-functions/references/usePreferredReducedTransparency.md +42 -0
- package/templates/skills/vueuse-functions/references/usePrevious.md +40 -0
- package/templates/skills/vueuse-functions/references/useProjection.md +38 -0
- package/templates/skills/vueuse-functions/references/useQRCode.md +53 -0
- package/templates/skills/vueuse-functions/references/useRTDB.md +70 -0
- package/templates/skills/vueuse-functions/references/useRafFn.md +68 -0
- package/templates/skills/vueuse-functions/references/useRefHistory.md +292 -0
- package/templates/skills/vueuse-functions/references/useResizeObserver.md +110 -0
- package/templates/skills/vueuse-functions/references/useRound.md +31 -0
- package/templates/skills/vueuse-functions/references/useRouteHash.md +27 -0
- package/templates/skills/vueuse-functions/references/useRouteParams.md +38 -0
- package/templates/skills/vueuse-functions/references/useRouteQuery.md +38 -0
- package/templates/skills/vueuse-functions/references/useSSRWidth.md +47 -0
- package/templates/skills/vueuse-functions/references/useScreenOrientation.md +96 -0
- package/templates/skills/vueuse-functions/references/useScreenSafeArea.md +60 -0
- package/templates/skills/vueuse-functions/references/useScriptTag.md +116 -0
- package/templates/skills/vueuse-functions/references/useScroll.md +238 -0
- package/templates/skills/vueuse-functions/references/useScrollLock.md +66 -0
- package/templates/skills/vueuse-functions/references/useSessionStorage.md +41 -0
- package/templates/skills/vueuse-functions/references/useShare.md +68 -0
- package/templates/skills/vueuse-functions/references/useSortable.md +177 -0
- package/templates/skills/vueuse-functions/references/useSorted.md +90 -0
- package/templates/skills/vueuse-functions/references/useSpeechRecognition.md +94 -0
- package/templates/skills/vueuse-functions/references/useSpeechSynthesis.md +105 -0
- package/templates/skills/vueuse-functions/references/useStepper.md +137 -0
- package/templates/skills/vueuse-functions/references/useStorage.md +219 -0
- package/templates/skills/vueuse-functions/references/useStorageAsync.md +134 -0
- package/templates/skills/vueuse-functions/references/useStyleTag.md +131 -0
- package/templates/skills/vueuse-functions/references/useSubject.md +52 -0
- package/templates/skills/vueuse-functions/references/useSubscription.md +33 -0
- package/templates/skills/vueuse-functions/references/useSum.md +36 -0
- package/templates/skills/vueuse-functions/references/useSupported.md +29 -0
- package/templates/skills/vueuse-functions/references/useSwipe.md +75 -0
- package/templates/skills/vueuse-functions/references/useTemplateRefsList.md +37 -0
- package/templates/skills/vueuse-functions/references/useTextDirection.md +75 -0
- package/templates/skills/vueuse-functions/references/useTextSelection.md +40 -0
- package/templates/skills/vueuse-functions/references/useTextareaAutosize.md +97 -0
- package/templates/skills/vueuse-functions/references/useThrottleFn.md +57 -0
- package/templates/skills/vueuse-functions/references/useThrottledRefHistory.md +47 -0
- package/templates/skills/vueuse-functions/references/useTimeAgo.md +152 -0
- package/templates/skills/vueuse-functions/references/useTimeAgoIntl.md +116 -0
- package/templates/skills/vueuse-functions/references/useTimeout.md +75 -0
- package/templates/skills/vueuse-functions/references/useTimeoutFn.md +51 -0
- package/templates/skills/vueuse-functions/references/useTimeoutPoll.md +47 -0
- package/templates/skills/vueuse-functions/references/useTimestamp.md +85 -0
- package/templates/skills/vueuse-functions/references/useTitle.md +113 -0
- package/templates/skills/vueuse-functions/references/useToNumber.md +54 -0
- package/templates/skills/vueuse-functions/references/useToString.md +34 -0
- package/templates/skills/vueuse-functions/references/useToggle.md +56 -0
- package/templates/skills/vueuse-functions/references/useTransition.md +265 -0
- package/templates/skills/vueuse-functions/references/useTrunc.md +33 -0
- package/templates/skills/vueuse-functions/references/useUrlSearchParams.md +121 -0
- package/templates/skills/vueuse-functions/references/useUserMedia.md +1138 -0
- package/templates/skills/vueuse-functions/references/useVModel.md +116 -0
- package/templates/skills/vueuse-functions/references/useVModels.md +67 -0
- package/templates/skills/vueuse-functions/references/useVibrate.md +83 -0
- package/templates/skills/vueuse-functions/references/useVirtualList.md +184 -0
- package/templates/skills/vueuse-functions/references/useWakeLock.md +50 -0
- package/templates/skills/vueuse-functions/references/useWebNotification.md +177 -0
- package/templates/skills/vueuse-functions/references/useWebSocket.md +268 -0
- package/templates/skills/vueuse-functions/references/useWebWorker.md +60 -0
- package/templates/skills/vueuse-functions/references/useWebWorkerFn.md +102 -0
- package/templates/skills/vueuse-functions/references/useWindowFocus.md +46 -0
- package/templates/skills/vueuse-functions/references/useWindowScroll.md +62 -0
- package/templates/skills/vueuse-functions/references/useWindowSize.md +76 -0
- package/templates/skills/vueuse-functions/references/useZoomFactor.md +53 -0
- package/templates/skills/vueuse-functions/references/useZoomLevel.md +53 -0
- package/templates/skills/vueuse-functions/references/watchArray.md +53 -0
- package/templates/skills/vueuse-functions/references/watchAtMost.md +54 -0
- package/templates/skills/vueuse-functions/references/watchDebounced.md +72 -0
- package/templates/skills/vueuse-functions/references/watchDeep.md +54 -0
- package/templates/skills/vueuse-functions/references/watchExtractedObservable.md +167 -0
- package/templates/skills/vueuse-functions/references/watchIgnorable.md +120 -0
- package/templates/skills/vueuse-functions/references/watchImmediate.md +44 -0
- package/templates/skills/vueuse-functions/references/watchOnce.md +41 -0
- package/templates/skills/vueuse-functions/references/watchPausable.md +86 -0
- package/templates/skills/vueuse-functions/references/watchThrottled.md +73 -0
- package/templates/skills/vueuse-functions/references/watchTriggerable.md +97 -0
- package/templates/skills/vueuse-functions/references/watchWithFilter.md +55 -0
- package/templates/skills/vueuse-functions/references/whenever.md +100 -0
- package/templates/skills/web-design-guidelines/SKILL.md +39 -0
- package/templates/skills/web-design-guidelines/SYNC.md +5 -0
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pnpm-cli-commands
|
|
3
|
+
description: Essential pnpm commands for package management, running scripts, and workspace operations
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# pnpm CLI Commands
|
|
7
|
+
|
|
8
|
+
pnpm provides a comprehensive CLI for package management with commands similar to npm/yarn but with unique features.
|
|
9
|
+
|
|
10
|
+
## Installation Commands
|
|
11
|
+
|
|
12
|
+
### Install all dependencies
|
|
13
|
+
```bash
|
|
14
|
+
pnpm install
|
|
15
|
+
# or
|
|
16
|
+
pnpm i
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Add a dependency
|
|
20
|
+
```bash
|
|
21
|
+
# Production dependency
|
|
22
|
+
pnpm add <pkg>
|
|
23
|
+
|
|
24
|
+
# Dev dependency
|
|
25
|
+
pnpm add -D <pkg>
|
|
26
|
+
pnpm add --save-dev <pkg>
|
|
27
|
+
|
|
28
|
+
# Optional dependency
|
|
29
|
+
pnpm add -O <pkg>
|
|
30
|
+
|
|
31
|
+
# Global package
|
|
32
|
+
pnpm add -g <pkg>
|
|
33
|
+
|
|
34
|
+
# Specific version
|
|
35
|
+
pnpm add <pkg>@<version>
|
|
36
|
+
pnpm add <pkg>@next
|
|
37
|
+
pnpm add <pkg>@^1.0.0
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Remove a dependency
|
|
41
|
+
```bash
|
|
42
|
+
pnpm remove <pkg>
|
|
43
|
+
pnpm rm <pkg>
|
|
44
|
+
pnpm uninstall <pkg>
|
|
45
|
+
pnpm un <pkg>
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Update dependencies
|
|
49
|
+
```bash
|
|
50
|
+
# Update all
|
|
51
|
+
pnpm update
|
|
52
|
+
pnpm up
|
|
53
|
+
|
|
54
|
+
# Update specific package
|
|
55
|
+
pnpm update <pkg>
|
|
56
|
+
|
|
57
|
+
# Update to latest (ignore semver)
|
|
58
|
+
pnpm update --latest
|
|
59
|
+
pnpm up -L
|
|
60
|
+
|
|
61
|
+
# Interactive update
|
|
62
|
+
pnpm update --interactive
|
|
63
|
+
pnpm up -i
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Script Commands
|
|
67
|
+
|
|
68
|
+
### Run scripts
|
|
69
|
+
```bash
|
|
70
|
+
pnpm run <script>
|
|
71
|
+
# or shorthand
|
|
72
|
+
pnpm <script>
|
|
73
|
+
|
|
74
|
+
# Pass arguments to script
|
|
75
|
+
pnpm run build -- --watch
|
|
76
|
+
|
|
77
|
+
# Run script if exists (no error if missing)
|
|
78
|
+
pnpm run --if-present build
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Execute binaries
|
|
82
|
+
```bash
|
|
83
|
+
# Run local binary
|
|
84
|
+
pnpm exec <command>
|
|
85
|
+
|
|
86
|
+
# Example
|
|
87
|
+
pnpm exec eslint .
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### dlx - Run without installing
|
|
91
|
+
```bash
|
|
92
|
+
# Like npx but for pnpm
|
|
93
|
+
pnpm dlx <pkg>
|
|
94
|
+
|
|
95
|
+
# Examples
|
|
96
|
+
pnpm dlx create-vite my-app
|
|
97
|
+
pnpm dlx degit user/repo my-project
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Workspace Commands
|
|
101
|
+
|
|
102
|
+
### Run in all packages
|
|
103
|
+
```bash
|
|
104
|
+
# Run script in all workspace packages
|
|
105
|
+
pnpm -r run <script>
|
|
106
|
+
pnpm --recursive run <script>
|
|
107
|
+
|
|
108
|
+
# Run in specific packages
|
|
109
|
+
pnpm --filter <pattern> run <script>
|
|
110
|
+
|
|
111
|
+
# Examples
|
|
112
|
+
pnpm --filter "./packages/**" run build
|
|
113
|
+
pnpm --filter "!./packages/internal/**" run test
|
|
114
|
+
pnpm --filter "@myorg/*" run lint
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Filter patterns
|
|
118
|
+
```bash
|
|
119
|
+
# By package name
|
|
120
|
+
pnpm --filter <pkg-name> <command>
|
|
121
|
+
pnpm --filter "@scope/pkg" build
|
|
122
|
+
|
|
123
|
+
# By directory
|
|
124
|
+
pnpm --filter "./packages/core" test
|
|
125
|
+
|
|
126
|
+
# Dependencies of a package
|
|
127
|
+
pnpm --filter "...@scope/app" build
|
|
128
|
+
|
|
129
|
+
# Dependents of a package
|
|
130
|
+
pnpm --filter "@scope/core..." test
|
|
131
|
+
|
|
132
|
+
# Changed packages since commit/branch
|
|
133
|
+
pnpm --filter "...[origin/main]" build
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Other Useful Commands
|
|
137
|
+
|
|
138
|
+
### Link packages
|
|
139
|
+
```bash
|
|
140
|
+
# Link global package
|
|
141
|
+
pnpm link --global
|
|
142
|
+
pnpm link -g
|
|
143
|
+
|
|
144
|
+
# Use linked package
|
|
145
|
+
pnpm link --global <pkg>
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Patch packages
|
|
149
|
+
```bash
|
|
150
|
+
# Create patch for a package
|
|
151
|
+
pnpm patch <pkg>@<version>
|
|
152
|
+
|
|
153
|
+
# After editing, commit the patch
|
|
154
|
+
pnpm patch-commit <path>
|
|
155
|
+
|
|
156
|
+
# Remove a patch
|
|
157
|
+
pnpm patch-remove <pkg>
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Store management
|
|
161
|
+
```bash
|
|
162
|
+
# Show store path
|
|
163
|
+
pnpm store path
|
|
164
|
+
|
|
165
|
+
# Remove unreferenced packages
|
|
166
|
+
pnpm store prune
|
|
167
|
+
|
|
168
|
+
# Check store integrity
|
|
169
|
+
pnpm store status
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Other commands
|
|
173
|
+
```bash
|
|
174
|
+
# Clean install (like npm ci)
|
|
175
|
+
pnpm install --frozen-lockfile
|
|
176
|
+
|
|
177
|
+
# List installed packages
|
|
178
|
+
pnpm list
|
|
179
|
+
pnpm ls
|
|
180
|
+
|
|
181
|
+
# Why is package installed?
|
|
182
|
+
pnpm why <pkg>
|
|
183
|
+
|
|
184
|
+
# Outdated packages
|
|
185
|
+
pnpm outdated
|
|
186
|
+
|
|
187
|
+
# Audit for vulnerabilities
|
|
188
|
+
pnpm audit
|
|
189
|
+
|
|
190
|
+
# Rebuild native modules
|
|
191
|
+
pnpm rebuild
|
|
192
|
+
|
|
193
|
+
# Import from npm/yarn lockfile
|
|
194
|
+
pnpm import
|
|
195
|
+
|
|
196
|
+
# Create tarball
|
|
197
|
+
pnpm pack
|
|
198
|
+
|
|
199
|
+
# Publish package
|
|
200
|
+
pnpm publish
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Useful Flags
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
# Ignore scripts
|
|
207
|
+
pnpm install --ignore-scripts
|
|
208
|
+
|
|
209
|
+
# Prefer offline (use cache)
|
|
210
|
+
pnpm install --prefer-offline
|
|
211
|
+
|
|
212
|
+
# Strict peer dependencies
|
|
213
|
+
pnpm install --strict-peer-dependencies
|
|
214
|
+
|
|
215
|
+
# Production only
|
|
216
|
+
pnpm install --prod
|
|
217
|
+
pnpm install -P
|
|
218
|
+
|
|
219
|
+
# No optional dependencies
|
|
220
|
+
pnpm install --no-optional
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
<!--
|
|
224
|
+
Source references:
|
|
225
|
+
- https://pnpm.io/cli/install
|
|
226
|
+
- https://pnpm.io/cli/add
|
|
227
|
+
- https://pnpm.io/cli/run
|
|
228
|
+
- https://pnpm.io/filtering
|
|
229
|
+
-->
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pnpm-configuration
|
|
3
|
+
description: Configuration options via pnpm-workspace.yaml and .npmrc settings
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# pnpm Configuration
|
|
7
|
+
|
|
8
|
+
pnpm uses two main configuration files: `pnpm-workspace.yaml` for workspace and pnpm-specific settings, and `.npmrc` for npm-compatible and pnpm-specific settings.
|
|
9
|
+
|
|
10
|
+
## pnpm-workspace.yaml
|
|
11
|
+
|
|
12
|
+
The recommended location for pnpm-specific configurations. Place at project root.
|
|
13
|
+
|
|
14
|
+
```yaml
|
|
15
|
+
# Define workspace packages
|
|
16
|
+
packages:
|
|
17
|
+
- 'packages/*'
|
|
18
|
+
- 'apps/*'
|
|
19
|
+
- '!**/test/**' # Exclude pattern
|
|
20
|
+
|
|
21
|
+
# Catalog for shared dependency versions
|
|
22
|
+
catalog:
|
|
23
|
+
react: ^18.2.0
|
|
24
|
+
typescript: ~5.3.0
|
|
25
|
+
|
|
26
|
+
# Named catalogs for different dependency groups
|
|
27
|
+
catalogs:
|
|
28
|
+
react17:
|
|
29
|
+
react: ^17.0.2
|
|
30
|
+
react-dom: ^17.0.2
|
|
31
|
+
react18:
|
|
32
|
+
react: ^18.2.0
|
|
33
|
+
react-dom: ^18.2.0
|
|
34
|
+
|
|
35
|
+
# Override resolutions (preferred location)
|
|
36
|
+
overrides:
|
|
37
|
+
lodash: ^4.17.21
|
|
38
|
+
'foo@^1.0.0>bar': ^2.0.0
|
|
39
|
+
|
|
40
|
+
# pnpm settings (alternative to .npmrc)
|
|
41
|
+
settings:
|
|
42
|
+
auto-install-peers: true
|
|
43
|
+
strict-peer-dependencies: false
|
|
44
|
+
link-workspace-packages: true
|
|
45
|
+
prefer-workspace-packages: true
|
|
46
|
+
shared-workspace-lockfile: true
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## .npmrc Settings
|
|
50
|
+
|
|
51
|
+
pnpm reads settings from `.npmrc` files. Create at project root or user home.
|
|
52
|
+
|
|
53
|
+
### Common pnpm Settings
|
|
54
|
+
|
|
55
|
+
```ini
|
|
56
|
+
# Automatically install peer dependencies
|
|
57
|
+
auto-install-peers=true
|
|
58
|
+
|
|
59
|
+
# Fail on peer dependency issues
|
|
60
|
+
strict-peer-dependencies=false
|
|
61
|
+
|
|
62
|
+
# Hoist patterns for dependencies
|
|
63
|
+
public-hoist-pattern[]=*types*
|
|
64
|
+
public-hoist-pattern[]=*eslint*
|
|
65
|
+
shamefully-hoist=false
|
|
66
|
+
|
|
67
|
+
# Store location
|
|
68
|
+
store-dir=~/.pnpm-store
|
|
69
|
+
|
|
70
|
+
# Virtual store location
|
|
71
|
+
virtual-store-dir=node_modules/.pnpm
|
|
72
|
+
|
|
73
|
+
# Lockfile settings
|
|
74
|
+
lockfile=true
|
|
75
|
+
prefer-frozen-lockfile=true
|
|
76
|
+
|
|
77
|
+
# Side effects cache (speeds up rebuilds)
|
|
78
|
+
side-effects-cache=true
|
|
79
|
+
|
|
80
|
+
# Registry settings
|
|
81
|
+
registry=https://registry.npmjs.org/
|
|
82
|
+
@myorg:registry=https://npm.myorg.com/
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Workspace Settings
|
|
86
|
+
|
|
87
|
+
```ini
|
|
88
|
+
# Link workspace packages
|
|
89
|
+
link-workspace-packages=true
|
|
90
|
+
|
|
91
|
+
# Prefer workspace packages over registry
|
|
92
|
+
prefer-workspace-packages=true
|
|
93
|
+
|
|
94
|
+
# Single lockfile for all packages
|
|
95
|
+
shared-workspace-lockfile=true
|
|
96
|
+
|
|
97
|
+
# Save prefix for workspace dependencies
|
|
98
|
+
save-workspace-protocol=rolling
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Node.js Settings
|
|
102
|
+
|
|
103
|
+
```ini
|
|
104
|
+
# Use specific Node.js version
|
|
105
|
+
use-node-version=20.10.0
|
|
106
|
+
|
|
107
|
+
# Node.js version file
|
|
108
|
+
node-version-file=.nvmrc
|
|
109
|
+
|
|
110
|
+
# Manage Node.js versions
|
|
111
|
+
manage-package-manager-versions=true
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Security Settings
|
|
115
|
+
|
|
116
|
+
```ini
|
|
117
|
+
# Ignore specific scripts
|
|
118
|
+
ignore-scripts=false
|
|
119
|
+
|
|
120
|
+
# Allow specific build scripts
|
|
121
|
+
onlyBuiltDependencies[]=esbuild
|
|
122
|
+
onlyBuiltDependencies[]=sharp
|
|
123
|
+
|
|
124
|
+
# Package extensions for missing peer deps
|
|
125
|
+
package-extensions[foo@1].peerDependencies.bar=*
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Configuration Hierarchy
|
|
129
|
+
|
|
130
|
+
Settings are read in order (later overrides earlier):
|
|
131
|
+
|
|
132
|
+
1. `/etc/npmrc` - Global config
|
|
133
|
+
2. `~/.npmrc` - User config
|
|
134
|
+
3. `<project>/.npmrc` - Project config
|
|
135
|
+
4. Environment variables: `npm_config_<key>=<value>`
|
|
136
|
+
5. `pnpm-workspace.yaml` settings field
|
|
137
|
+
|
|
138
|
+
## Environment Variables
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
# Set config via env
|
|
142
|
+
npm_config_registry=https://registry.npmjs.org/
|
|
143
|
+
|
|
144
|
+
# pnpm-specific env vars
|
|
145
|
+
PNPM_HOME=~/.local/share/pnpm
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Package.json Fields
|
|
149
|
+
|
|
150
|
+
pnpm reads specific fields from `package.json`:
|
|
151
|
+
|
|
152
|
+
```json
|
|
153
|
+
{
|
|
154
|
+
"pnpm": {
|
|
155
|
+
"overrides": {
|
|
156
|
+
"lodash": "^4.17.21"
|
|
157
|
+
},
|
|
158
|
+
"peerDependencyRules": {
|
|
159
|
+
"ignoreMissing": ["@babel/*"],
|
|
160
|
+
"allowedVersions": {
|
|
161
|
+
"react": "17 || 18"
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"neverBuiltDependencies": ["fsevents"],
|
|
165
|
+
"onlyBuiltDependencies": ["esbuild"],
|
|
166
|
+
"allowedDeprecatedVersions": {
|
|
167
|
+
"request": "*"
|
|
168
|
+
},
|
|
169
|
+
"patchedDependencies": {
|
|
170
|
+
"express@4.18.2": "patches/express@4.18.2.patch"
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## Key Differences from npm/yarn
|
|
177
|
+
|
|
178
|
+
1. **Strict by default**: No phantom dependencies
|
|
179
|
+
2. **Workspace protocol**: `workspace:*` for local packages
|
|
180
|
+
3. **Catalogs**: Centralized version management
|
|
181
|
+
4. **Content-addressable store**: Shared across projects
|
|
182
|
+
|
|
183
|
+
<!--
|
|
184
|
+
Source references:
|
|
185
|
+
- https://pnpm.io/pnpm-workspace_yaml
|
|
186
|
+
- https://pnpm.io/npmrc
|
|
187
|
+
- https://pnpm.io/package_json
|
|
188
|
+
-->
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pnpm-store
|
|
3
|
+
description: Content-addressable storage system that makes pnpm fast and disk-efficient
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# pnpm Store
|
|
7
|
+
|
|
8
|
+
pnpm uses a content-addressable store to save disk space and speed up installations. All packages are stored once globally and hard-linked to project `node_modules`.
|
|
9
|
+
|
|
10
|
+
## How It Works
|
|
11
|
+
|
|
12
|
+
1. **Global Store**: Packages are downloaded once to a central store
|
|
13
|
+
2. **Hard Links**: Projects link to store instead of copying files
|
|
14
|
+
3. **Content-Addressable**: Files are stored by content hash, deduplicating identical files
|
|
15
|
+
|
|
16
|
+
### Storage Layout
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
~/.pnpm-store/ # Global store (default location)
|
|
20
|
+
└── v3/
|
|
21
|
+
└── files/
|
|
22
|
+
└── <hash>/ # Files stored by content hash
|
|
23
|
+
|
|
24
|
+
project/
|
|
25
|
+
└── node_modules/
|
|
26
|
+
├── .pnpm/ # Virtual store (hard links to global store)
|
|
27
|
+
│ ├── lodash@4.17.21/
|
|
28
|
+
│ │ └── node_modules/
|
|
29
|
+
│ │ └── lodash/
|
|
30
|
+
│ └── express@4.18.2/
|
|
31
|
+
│ └── node_modules/
|
|
32
|
+
│ ├── express/
|
|
33
|
+
│ └── <deps>/ # Flat structure for dependencies
|
|
34
|
+
├── lodash -> .pnpm/lodash@4.17.21/node_modules/lodash
|
|
35
|
+
└── express -> .pnpm/express@4.18.2/node_modules/express
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Store Commands
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Show store location
|
|
42
|
+
pnpm store path
|
|
43
|
+
|
|
44
|
+
# Remove unreferenced packages
|
|
45
|
+
pnpm store prune
|
|
46
|
+
|
|
47
|
+
# Check store integrity
|
|
48
|
+
pnpm store status
|
|
49
|
+
|
|
50
|
+
# Add package to store without installing
|
|
51
|
+
pnpm store add <pkg>
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Configuration
|
|
55
|
+
|
|
56
|
+
### Store Location
|
|
57
|
+
|
|
58
|
+
```ini
|
|
59
|
+
# .npmrc
|
|
60
|
+
store-dir=~/.pnpm-store
|
|
61
|
+
|
|
62
|
+
# Or use environment variable
|
|
63
|
+
PNPM_HOME=~/.local/share/pnpm
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Virtual Store
|
|
67
|
+
|
|
68
|
+
The virtual store (`.pnpm` in `node_modules`) contains symlinks to the global store:
|
|
69
|
+
|
|
70
|
+
```ini
|
|
71
|
+
# Customize virtual store location
|
|
72
|
+
virtual-store-dir=node_modules/.pnpm
|
|
73
|
+
|
|
74
|
+
# Alternative flat layout
|
|
75
|
+
node-linker=hoisted
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Disk Space Benefits
|
|
79
|
+
|
|
80
|
+
pnpm saves significant disk space:
|
|
81
|
+
|
|
82
|
+
- **Deduplication**: Same package version stored once across all projects
|
|
83
|
+
- **Content deduplication**: Identical files across different packages stored once
|
|
84
|
+
- **Hard links**: No copying, just linking
|
|
85
|
+
|
|
86
|
+
### Check disk usage
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# Compare actual vs apparent size
|
|
90
|
+
du -sh node_modules # Apparent size
|
|
91
|
+
du -sh --apparent-size node_modules # With hard links counted
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Node Linker Modes
|
|
95
|
+
|
|
96
|
+
Configure how `node_modules` is structured:
|
|
97
|
+
|
|
98
|
+
```ini
|
|
99
|
+
# Default: Symlinked structure (recommended)
|
|
100
|
+
node-linker=isolated
|
|
101
|
+
|
|
102
|
+
# Flat node_modules (npm-like, for compatibility)
|
|
103
|
+
node-linker=hoisted
|
|
104
|
+
|
|
105
|
+
# PnP mode (experimental, like Yarn PnP)
|
|
106
|
+
node-linker=pnp
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Isolated Mode (Default)
|
|
110
|
+
|
|
111
|
+
- Strict dependency resolution
|
|
112
|
+
- No phantom dependencies
|
|
113
|
+
- Packages can only access declared dependencies
|
|
114
|
+
|
|
115
|
+
### Hoisted Mode
|
|
116
|
+
|
|
117
|
+
- Flat `node_modules` like npm
|
|
118
|
+
- For compatibility with tools that don't support symlinks
|
|
119
|
+
- Loses strictness benefits
|
|
120
|
+
|
|
121
|
+
## Side Effects Cache
|
|
122
|
+
|
|
123
|
+
Cache build outputs for native modules:
|
|
124
|
+
|
|
125
|
+
```ini
|
|
126
|
+
# Enable side effects caching
|
|
127
|
+
side-effects-cache=true
|
|
128
|
+
|
|
129
|
+
# Store side effects in project (instead of global store)
|
|
130
|
+
side-effects-cache-readonly=true
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Shared Store Across Machines
|
|
134
|
+
|
|
135
|
+
For CI/CD, you can share the store:
|
|
136
|
+
|
|
137
|
+
```yaml
|
|
138
|
+
# GitHub Actions example
|
|
139
|
+
- uses: pnpm/action-setup@v4
|
|
140
|
+
with:
|
|
141
|
+
run_install: false
|
|
142
|
+
|
|
143
|
+
- name: Get pnpm store directory
|
|
144
|
+
shell: bash
|
|
145
|
+
run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
|
146
|
+
|
|
147
|
+
- uses: actions/cache@v4
|
|
148
|
+
with:
|
|
149
|
+
path: ${{ env.STORE_PATH }}
|
|
150
|
+
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## Troubleshooting
|
|
154
|
+
|
|
155
|
+
### Store corruption
|
|
156
|
+
```bash
|
|
157
|
+
# Verify and fix store
|
|
158
|
+
pnpm store status
|
|
159
|
+
pnpm store prune
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Hard link issues (network drives, Docker)
|
|
163
|
+
```ini
|
|
164
|
+
# Use copying instead of hard links
|
|
165
|
+
package-import-method=copy
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### Permission issues
|
|
169
|
+
```bash
|
|
170
|
+
# Fix store permissions
|
|
171
|
+
chmod -R u+w ~/.pnpm-store
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
<!--
|
|
175
|
+
Source references:
|
|
176
|
+
- https://pnpm.io/symlinked-node-modules-structure
|
|
177
|
+
- https://pnpm.io/cli/store
|
|
178
|
+
- https://pnpm.io/npmrc#store-dir
|
|
179
|
+
-->
|