@ruaruababa/vibe-kit 1.0.0
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/CATALOG.md +317 -0
- package/README.md +121 -0
- package/aliases.json +65 -0
- package/bin/vibe.js +2 -0
- package/bundles.json +265 -0
- package/catalog.json +1560 -0
- package/dist/antigravity-skills/bin/cli.js +438 -0
- package/dist/antigravity-skills/lib/skill-utils.js +158 -0
- package/dist/antigravity-skills/scripts/build-catalog.js +305 -0
- package/dist/antigravity-skills/scripts/normalize-frontmatter.js +144 -0
- package/dist/antigravity-skills/scripts/validate-skills.js +230 -0
- package/dist/bin/vibe.js +2 -0
- package/dist/dist/src/cli/index.js +26 -0
- package/dist/lib/skill-utils.js +158 -0
- package/dist/scripts/build-catalog.js +50 -0
- package/dist/scripts/normalize-frontmatter.js +144 -0
- package/dist/scripts/validate-skills.js +56 -0
- package/dist/src/cli/index.js +146 -0
- package/dist/src/types/index.js +13 -0
- package/dist/src/utils/fs.js +1 -0
- package/package.json +43 -0
- package/skills/accessibility-compliance-accessibility-audit/SKILL.md +42 -0
- package/skills/accessibility-compliance-accessibility-audit/resources/implementation-playbook.md +502 -0
- package/skills/agent-orchestration-improve-agent/SKILL.md +349 -0
- package/skills/agent-orchestration-multi-agent-optimize/SKILL.md +239 -0
- package/skills/agent-orchestrator/SKILL.md +24 -0
- package/skills/ai-engineer/SKILL.md +171 -0
- package/skills/airflow-dag-patterns/SKILL.md +41 -0
- package/skills/airflow-dag-patterns/resources/implementation-playbook.md +509 -0
- package/skills/angular-migration/SKILL.md +428 -0
- package/skills/anti-reversing-techniques/SKILL.md +42 -0
- package/skills/anti-reversing-techniques/resources/implementation-playbook.md +539 -0
- package/skills/api-design-principles/SKILL.md +37 -0
- package/skills/api-design-principles/assets/api-design-checklist.md +155 -0
- package/skills/api-design-principles/assets/rest-api-template.py +182 -0
- package/skills/api-design-principles/references/graphql-schema-design.md +583 -0
- package/skills/api-design-principles/references/rest-best-practices.md +408 -0
- package/skills/api-design-principles/resources/implementation-playbook.md +513 -0
- package/skills/api-documenter/SKILL.md +184 -0
- package/skills/api-testing-observability-api-mock/SKILL.md +46 -0
- package/skills/api-testing-observability-api-mock/resources/implementation-playbook.md +1327 -0
- package/skills/application-performance-performance-optimization/SKILL.md +154 -0
- package/skills/architect-review/SKILL.md +174 -0
- package/skills/architecture-decision-records/SKILL.md +441 -0
- package/skills/architecture-patterns/SKILL.md +37 -0
- package/skills/architecture-patterns/resources/implementation-playbook.md +479 -0
- package/skills/arm-cortex-expert/SKILL.md +306 -0
- package/skills/async-python-patterns/SKILL.md +39 -0
- package/skills/async-python-patterns/resources/implementation-playbook.md +678 -0
- package/skills/attack-tree-construction/SKILL.md +38 -0
- package/skills/attack-tree-construction/resources/implementation-playbook.md +671 -0
- package/skills/auth-implementation-patterns/SKILL.md +39 -0
- package/skills/auth-implementation-patterns/resources/implementation-playbook.md +618 -0
- package/skills/backend-architect/SKILL.md +333 -0
- package/skills/backend-development-feature-development/SKILL.md +180 -0
- package/skills/backend-security-coder/SKILL.md +156 -0
- package/skills/backtesting-frameworks/SKILL.md +39 -0
- package/skills/backtesting-frameworks/resources/implementation-playbook.md +647 -0
- package/skills/bash-defensive-patterns/SKILL.md +43 -0
- package/skills/bash-defensive-patterns/resources/implementation-playbook.md +517 -0
- package/skills/bash-pro/SKILL.md +310 -0
- package/skills/bats-testing-patterns/SKILL.md +34 -0
- package/skills/bats-testing-patterns/resources/implementation-playbook.md +614 -0
- package/skills/bazel-build-optimization/SKILL.md +397 -0
- package/skills/billing-automation/SKILL.md +42 -0
- package/skills/billing-automation/resources/implementation-playbook.md +544 -0
- package/skills/binary-analysis-patterns/SKILL.md +450 -0
- package/skills/blockchain-developer/SKILL.md +208 -0
- package/skills/business-analyst/SKILL.md +182 -0
- package/skills/c-pro/SKILL.md +56 -0
- package/skills/c4-architecture-c4-architecture/SKILL.md +389 -0
- package/skills/c4-code/SKILL.md +244 -0
- package/skills/c4-component/SKILL.md +153 -0
- package/skills/c4-container/SKILL.md +171 -0
- package/skills/c4-context/SKILL.md +150 -0
- package/skills/changelog-automation/SKILL.md +38 -0
- package/skills/changelog-automation/resources/implementation-playbook.md +538 -0
- package/skills/cicd-automation-workflow-automate/SKILL.md +51 -0
- package/skills/cicd-automation-workflow-automate/resources/implementation-playbook.md +1333 -0
- package/skills/clean-markdown/SKILL.md +23 -0
- package/skills/cloud-architect/SKILL.md +135 -0
- package/skills/code-documentation-code-explain/SKILL.md +46 -0
- package/skills/code-documentation-code-explain/resources/implementation-playbook.md +802 -0
- package/skills/code-documentation-doc-generate/SKILL.md +48 -0
- package/skills/code-documentation-doc-generate/resources/implementation-playbook.md +640 -0
- package/skills/code-refactoring-context-restore/SKILL.md +179 -0
- package/skills/code-refactoring-refactor-clean/SKILL.md +51 -0
- package/skills/code-refactoring-refactor-clean/resources/implementation-playbook.md +879 -0
- package/skills/code-refactoring-tech-debt/SKILL.md +386 -0
- package/skills/code-review-ai-ai-review/SKILL.md +450 -0
- package/skills/code-review-excellence/SKILL.md +40 -0
- package/skills/code-review-excellence/resources/implementation-playbook.md +515 -0
- package/skills/code-reviewer/SKILL.md +178 -0
- package/skills/codebase-cleanup-deps-audit/SKILL.md +51 -0
- package/skills/codebase-cleanup-deps-audit/resources/implementation-playbook.md +766 -0
- package/skills/codebase-cleanup-refactor-clean/SKILL.md +51 -0
- package/skills/codebase-cleanup-refactor-clean/resources/implementation-playbook.md +879 -0
- package/skills/codebase-cleanup-tech-debt/SKILL.md +386 -0
- package/skills/competitive-landscape/SKILL.md +34 -0
- package/skills/competitive-landscape/resources/implementation-playbook.md +494 -0
- package/skills/comprehensive-review-full-review/SKILL.md +146 -0
- package/skills/comprehensive-review-pr-enhance/SKILL.md +46 -0
- package/skills/comprehensive-review-pr-enhance/resources/implementation-playbook.md +691 -0
- package/skills/conductor-implement/SKILL.md +388 -0
- package/skills/conductor-manage/SKILL.md +39 -0
- package/skills/conductor-manage/resources/implementation-playbook.md +1120 -0
- package/skills/conductor-new-track/SKILL.md +433 -0
- package/skills/conductor-revert/SKILL.md +372 -0
- package/skills/conductor-setup/SKILL.md +426 -0
- package/skills/conductor-status/SKILL.md +338 -0
- package/skills/conductor-validator/SKILL.md +62 -0
- package/skills/content-marketer/SKILL.md +170 -0
- package/skills/context-driven-development/SKILL.md +400 -0
- package/skills/context-management-context-restore/SKILL.md +179 -0
- package/skills/context-management-context-save/SKILL.md +177 -0
- package/skills/context-manager/SKILL.md +185 -0
- package/skills/cost-optimization/SKILL.md +286 -0
- package/skills/cpp-pro/SKILL.md +59 -0
- package/skills/cqrs-implementation/SKILL.md +35 -0
- package/skills/cqrs-implementation/resources/implementation-playbook.md +540 -0
- package/skills/csharp-pro/SKILL.md +59 -0
- package/skills/customer-support/SKILL.md +170 -0
- package/skills/data-engineer/SKILL.md +224 -0
- package/skills/data-engineering-data-driven-feature/SKILL.md +182 -0
- package/skills/data-engineering-data-pipeline/SKILL.md +201 -0
- package/skills/data-quality-frameworks/SKILL.md +40 -0
- package/skills/data-quality-frameworks/resources/implementation-playbook.md +573 -0
- package/skills/data-scientist/SKILL.md +199 -0
- package/skills/data-storytelling/SKILL.md +465 -0
- package/skills/database-admin/SKILL.md +165 -0
- package/skills/database-architect/SKILL.md +268 -0
- package/skills/database-cloud-optimization-cost-optimize/SKILL.md +44 -0
- package/skills/database-cloud-optimization-cost-optimize/resources/implementation-playbook.md +1441 -0
- package/skills/database-migration/SKILL.md +436 -0
- package/skills/database-migrations-migration-observability/SKILL.md +420 -0
- package/skills/database-migrations-sql-migrations/SKILL.md +53 -0
- package/skills/database-migrations-sql-migrations/resources/implementation-playbook.md +499 -0
- package/skills/database-optimizer/SKILL.md +167 -0
- package/skills/dbt-transformation-patterns/SKILL.md +34 -0
- package/skills/dbt-transformation-patterns/resources/implementation-playbook.md +547 -0
- package/skills/debugger/SKILL.md +49 -0
- package/skills/debugging-strategies/SKILL.md +34 -0
- package/skills/debugging-strategies/resources/implementation-playbook.md +511 -0
- package/skills/debugging-toolkit-smart-debug/SKILL.md +197 -0
- package/skills/defi-protocol-templates/SKILL.md +466 -0
- package/skills/dependency-management-deps-audit/SKILL.md +44 -0
- package/skills/dependency-management-deps-audit/resources/implementation-playbook.md +766 -0
- package/skills/dependency-upgrade/SKILL.md +421 -0
- package/skills/deployment-engineer/SKILL.md +170 -0
- package/skills/deployment-pipeline-design/SKILL.md +371 -0
- package/skills/deployment-validation-config-validate/SKILL.md +496 -0
- package/skills/devops-troubleshooter/SKILL.md +161 -0
- package/skills/distributed-debugging-debug-trace/SKILL.md +44 -0
- package/skills/distributed-debugging-debug-trace/resources/implementation-playbook.md +1307 -0
- package/skills/distributed-tracing/SKILL.md +450 -0
- package/skills/django-pro/SKILL.md +180 -0
- package/skills/docs-architect/SKILL.md +98 -0
- package/skills/documentation-generation-doc-generate/SKILL.md +48 -0
- package/skills/documentation-generation-doc-generate/resources/implementation-playbook.md +640 -0
- package/skills/dotnet-architect/SKILL.md +197 -0
- package/skills/dotnet-backend-patterns/SKILL.md +37 -0
- package/skills/dotnet-backend-patterns/assets/repository-template.cs +523 -0
- package/skills/dotnet-backend-patterns/assets/service-template.cs +336 -0
- package/skills/dotnet-backend-patterns/references/dapper-patterns.md +544 -0
- package/skills/dotnet-backend-patterns/references/ef-core-best-practices.md +355 -0
- package/skills/dotnet-backend-patterns/resources/implementation-playbook.md +799 -0
- package/skills/dummy-skill/SKILL.md +5 -0
- package/skills/dx-optimizer/SKILL.md +83 -0
- package/skills/e2e-testing-patterns/SKILL.md +41 -0
- package/skills/e2e-testing-patterns/resources/implementation-playbook.md +531 -0
- package/skills/elixir-pro/SKILL.md +59 -0
- package/skills/embedding-strategies/SKILL.md +491 -0
- package/skills/employment-contract-templates/SKILL.md +39 -0
- package/skills/employment-contract-templates/resources/implementation-playbook.md +493 -0
- package/skills/error-debugging-error-analysis/SKILL.md +47 -0
- package/skills/error-debugging-error-analysis/resources/implementation-playbook.md +1143 -0
- package/skills/error-debugging-error-trace/SKILL.md +43 -0
- package/skills/error-debugging-error-trace/resources/implementation-playbook.md +1361 -0
- package/skills/error-debugging-multi-agent-review/SKILL.md +216 -0
- package/skills/error-detective/SKILL.md +53 -0
- package/skills/error-diagnostics-error-analysis/SKILL.md +47 -0
- package/skills/error-diagnostics-error-analysis/resources/implementation-playbook.md +1143 -0
- package/skills/error-diagnostics-error-trace/SKILL.md +48 -0
- package/skills/error-diagnostics-error-trace/resources/implementation-playbook.md +1371 -0
- package/skills/error-diagnostics-smart-debug/SKILL.md +197 -0
- package/skills/error-handling-patterns/SKILL.md +35 -0
- package/skills/error-handling-patterns/resources/implementation-playbook.md +635 -0
- package/skills/event-sourcing-architect/SKILL.md +58 -0
- package/skills/event-store-design/SKILL.md +449 -0
- package/skills/fastapi-pro/SKILL.md +192 -0
- package/skills/fastapi-templates/SKILL.md +32 -0
- package/skills/fastapi-templates/resources/implementation-playbook.md +566 -0
- package/skills/final-test/SKILL.md +5 -0
- package/skills/firmware-analyst/SKILL.md +320 -0
- package/skills/flutter-expert/SKILL.md +200 -0
- package/skills/framework-migration-code-migrate/SKILL.md +48 -0
- package/skills/framework-migration-code-migrate/resources/implementation-playbook.md +1052 -0
- package/skills/framework-migration-deps-upgrade/SKILL.md +48 -0
- package/skills/framework-migration-deps-upgrade/resources/implementation-playbook.md +755 -0
- package/skills/framework-migration-legacy-modernize/SKILL.md +132 -0
- package/skills/frontend-developer/SKILL.md +171 -0
- package/skills/frontend-mobile-development-component-scaffold/SKILL.md +403 -0
- package/skills/frontend-mobile-security-xss-scan/SKILL.md +322 -0
- package/skills/frontend-security-coder/SKILL.md +170 -0
- package/skills/full-stack-orchestration-full-stack-feature/SKILL.md +135 -0
- package/skills/gdpr-data-handling/SKILL.md +33 -0
- package/skills/gdpr-data-handling/resources/implementation-playbook.md +615 -0
- package/skills/git-advanced-workflows/SKILL.md +412 -0
- package/skills/git-pr-workflows-git-workflow/SKILL.md +140 -0
- package/skills/git-pr-workflows-onboard/SKILL.md +416 -0
- package/skills/git-pr-workflows-pr-enhance/SKILL.md +48 -0
- package/skills/git-pr-workflows-pr-enhance/resources/implementation-playbook.md +701 -0
- package/skills/github-actions-templates/SKILL.md +345 -0
- package/skills/gitlab-ci-patterns/SKILL.md +283 -0
- package/skills/gitops-workflow/SKILL.md +303 -0
- package/skills/gitops-workflow/references/argocd-setup.md +134 -0
- package/skills/gitops-workflow/references/sync-policies.md +131 -0
- package/skills/go-concurrency-patterns/SKILL.md +33 -0
- package/skills/go-concurrency-patterns/resources/implementation-playbook.md +654 -0
- package/skills/godot-gdscript-patterns/SKILL.md +33 -0
- package/skills/godot-gdscript-patterns/resources/implementation-playbook.md +804 -0
- package/skills/golang-pro/SKILL.md +179 -0
- package/skills/grafana-dashboards/SKILL.md +381 -0
- package/skills/graphql-architect/SKILL.md +182 -0
- package/skills/haskell-pro/SKILL.md +56 -0
- package/skills/helm-chart-scaffolding/SKILL.md +34 -0
- package/skills/helm-chart-scaffolding/assets/Chart.yaml.template +42 -0
- package/skills/helm-chart-scaffolding/assets/values.yaml.template +185 -0
- package/skills/helm-chart-scaffolding/references/chart-structure.md +500 -0
- package/skills/helm-chart-scaffolding/resources/implementation-playbook.md +543 -0
- package/skills/helm-chart-scaffolding/scripts/validate-chart.sh +244 -0
- package/skills/hr-pro/SKILL.md +126 -0
- package/skills/hybrid-cloud-architect/SKILL.md +168 -0
- package/skills/hybrid-cloud-networking/SKILL.md +238 -0
- package/skills/hybrid-search-implementation/SKILL.md +32 -0
- package/skills/hybrid-search-implementation/resources/implementation-playbook.md +567 -0
- package/skills/incident-responder/SKILL.md +213 -0
- package/skills/incident-response-incident-response/SKILL.md +168 -0
- package/skills/incident-response-smart-fix/SKILL.md +29 -0
- package/skills/incident-response-smart-fix/resources/implementation-playbook.md +838 -0
- package/skills/incident-runbook-templates/SKILL.md +395 -0
- package/skills/ios-developer/SKILL.md +219 -0
- package/skills/istio-traffic-management/SKILL.md +337 -0
- package/skills/java-pro/SKILL.md +177 -0
- package/skills/javascript-pro/SKILL.md +57 -0
- package/skills/javascript-testing-patterns/SKILL.md +35 -0
- package/skills/javascript-testing-patterns/resources/implementation-playbook.md +1024 -0
- package/skills/javascript-typescript-typescript-scaffold/SKILL.md +361 -0
- package/skills/julia-pro/SKILL.md +209 -0
- package/skills/k8s-manifest-generator/SKILL.md +35 -0
- package/skills/k8s-manifest-generator/assets/configmap-template.yaml +296 -0
- package/skills/k8s-manifest-generator/assets/deployment-template.yaml +203 -0
- package/skills/k8s-manifest-generator/assets/service-template.yaml +171 -0
- package/skills/k8s-manifest-generator/references/deployment-spec.md +753 -0
- package/skills/k8s-manifest-generator/references/service-spec.md +724 -0
- package/skills/k8s-manifest-generator/resources/implementation-playbook.md +510 -0
- package/skills/k8s-security-policies/SKILL.md +346 -0
- package/skills/k8s-security-policies/assets/network-policy-template.yaml +177 -0
- package/skills/k8s-security-policies/references/rbac-patterns.md +187 -0
- package/skills/kpi-dashboard-design/SKILL.md +440 -0
- package/skills/kubernetes-architect/SKILL.md +170 -0
- package/skills/langchain-architecture/SKILL.md +350 -0
- package/skills/legacy-modernizer/SKILL.md +53 -0
- package/skills/legal-advisor/SKILL.md +70 -0
- package/skills/linkerd-patterns/SKILL.md +321 -0
- package/skills/llm-application-dev-ai-assistant/SKILL.md +35 -0
- package/skills/llm-application-dev-ai-assistant/resources/implementation-playbook.md +1236 -0
- package/skills/llm-application-dev-langchain-agent/SKILL.md +246 -0
- package/skills/llm-application-dev-prompt-optimize/SKILL.md +37 -0
- package/skills/llm-application-dev-prompt-optimize/resources/implementation-playbook.md +591 -0
- package/skills/llm-evaluation/SKILL.md +483 -0
- package/skills/machine-learning-ops-ml-pipeline/SKILL.md +314 -0
- package/skills/malware-analyst/SKILL.md +247 -0
- package/skills/market-sizing-analysis/SKILL.md +425 -0
- package/skills/market-sizing-analysis/examples/saas-market-sizing.md +349 -0
- package/skills/market-sizing-analysis/references/data-sources.md +360 -0
- package/skills/memory-forensics/SKILL.md +491 -0
- package/skills/memory-safety-patterns/SKILL.md +33 -0
- package/skills/memory-safety-patterns/resources/implementation-playbook.md +603 -0
- package/skills/mermaid-expert/SKILL.md +59 -0
- package/skills/microservices-patterns/SKILL.md +35 -0
- package/skills/microservices-patterns/resources/implementation-playbook.md +607 -0
- package/skills/minecraft-bukkit-pro/SKILL.md +126 -0
- package/skills/ml-engineer/SKILL.md +168 -0
- package/skills/ml-pipeline-workflow/SKILL.md +257 -0
- package/skills/mlops-engineer/SKILL.md +219 -0
- package/skills/mobile-developer/SKILL.md +205 -0
- package/skills/mobile-security-coder/SKILL.md +184 -0
- package/skills/modern-javascript-patterns/SKILL.md +35 -0
- package/skills/modern-javascript-patterns/resources/implementation-playbook.md +910 -0
- package/skills/monorepo-architect/SKILL.md +61 -0
- package/skills/monorepo-management/SKILL.md +35 -0
- package/skills/monorepo-management/resources/implementation-playbook.md +621 -0
- package/skills/mtls-configuration/SKILL.md +359 -0
- package/skills/multi-cloud-architecture/SKILL.md +189 -0
- package/skills/multi-platform-apps-multi-platform/SKILL.md +203 -0
- package/skills/network-engineer/SKILL.md +169 -0
- package/skills/nextjs-app-router-patterns/SKILL.md +33 -0
- package/skills/nextjs-app-router-patterns/resources/implementation-playbook.md +543 -0
- package/skills/nft-standards/SKILL.md +395 -0
- package/skills/node-expert/SKILL.md +23 -0
- package/skills/nodejs-backend-patterns/SKILL.md +35 -0
- package/skills/nodejs-backend-patterns/resources/implementation-playbook.md +1019 -0
- package/skills/nx-workspace-patterns/SKILL.md +464 -0
- package/skills/observability-engineer/SKILL.md +237 -0
- package/skills/observability-monitoring-monitor-setup/SKILL.md +48 -0
- package/skills/observability-monitoring-monitor-setup/resources/implementation-playbook.md +505 -0
- package/skills/observability-monitoring-slo-implement/SKILL.md +43 -0
- package/skills/observability-monitoring-slo-implement/resources/implementation-playbook.md +1077 -0
- package/skills/on-call-handoff-patterns/SKILL.md +453 -0
- package/skills/openapi-spec-generation/SKILL.md +33 -0
- package/skills/openapi-spec-generation/resources/implementation-playbook.md +1027 -0
- package/skills/payment-integration/SKILL.md +77 -0
- package/skills/paypal-integration/SKILL.md +479 -0
- package/skills/pci-compliance/SKILL.md +478 -0
- package/skills/performance-engineer/SKILL.md +180 -0
- package/skills/performance-testing-review-ai-review/SKILL.md +450 -0
- package/skills/performance-testing-review-multi-agent-review/SKILL.md +216 -0
- package/skills/php-pro/SKILL.md +63 -0
- package/skills/posix-shell-pro/SKILL.md +304 -0
- package/skills/postgresql/SKILL.md +230 -0
- package/skills/postmortem-writing/SKILL.md +386 -0
- package/skills/projection-patterns/SKILL.md +33 -0
- package/skills/projection-patterns/resources/implementation-playbook.md +501 -0
- package/skills/prometheus-configuration/SKILL.md +404 -0
- package/skills/prompt-engineer/SKILL.md +272 -0
- package/skills/prompt-engineering-patterns/SKILL.md +213 -0
- package/skills/prompt-engineering-patterns/assets/few-shot-examples.json +106 -0
- package/skills/prompt-engineering-patterns/assets/prompt-template-library.md +246 -0
- package/skills/prompt-engineering-patterns/references/chain-of-thought.md +399 -0
- package/skills/prompt-engineering-patterns/references/few-shot-learning.md +369 -0
- package/skills/prompt-engineering-patterns/references/prompt-optimization.md +414 -0
- package/skills/prompt-engineering-patterns/references/prompt-templates.md +470 -0
- package/skills/prompt-engineering-patterns/references/system-prompts.md +189 -0
- package/skills/prompt-engineering-patterns/scripts/optimize-prompt.py +279 -0
- package/skills/protocol-reverse-engineering/SKILL.md +29 -0
- package/skills/protocol-reverse-engineering/resources/implementation-playbook.md +509 -0
- package/skills/python-development-python-scaffold/SKILL.md +331 -0
- package/skills/python-packaging/SKILL.md +36 -0
- package/skills/python-packaging/resources/implementation-playbook.md +869 -0
- package/skills/python-performance-optimization/SKILL.md +36 -0
- package/skills/python-performance-optimization/resources/implementation-playbook.md +868 -0
- package/skills/python-pro/SKILL.md +158 -0
- package/skills/python-testing-patterns/SKILL.md +37 -0
- package/skills/python-testing-patterns/resources/implementation-playbook.md +906 -0
- package/skills/quant-analyst/SKILL.md +53 -0
- package/skills/rag-implementation/SKILL.md +421 -0
- package/skills/react-modernization/SKILL.md +34 -0
- package/skills/react-modernization/resources/implementation-playbook.md +512 -0
- package/skills/react-native-architecture/SKILL.md +33 -0
- package/skills/react-native-architecture/resources/implementation-playbook.md +670 -0
- package/skills/react-state-management/SKILL.md +441 -0
- package/skills/reference-builder/SKILL.md +188 -0
- package/skills/reverse-engineer/SKILL.md +173 -0
- package/skills/risk-manager/SKILL.md +61 -0
- package/skills/risk-metrics-calculation/SKILL.md +33 -0
- package/skills/risk-metrics-calculation/resources/implementation-playbook.md +554 -0
- package/skills/ruby-pro/SKILL.md +56 -0
- package/skills/rust-async-patterns/SKILL.md +33 -0
- package/skills/rust-async-patterns/resources/implementation-playbook.md +516 -0
- package/skills/rust-pro/SKILL.md +178 -0
- package/skills/saga-orchestration/SKILL.md +496 -0
- package/skills/sales-automator/SKILL.md +55 -0
- package/skills/sast-configuration/SKILL.md +212 -0
- package/skills/scala-pro/SKILL.md +82 -0
- package/skills/screen-reader-testing/SKILL.md +33 -0
- package/skills/screen-reader-testing/resources/implementation-playbook.md +544 -0
- package/skills/search-specialist/SKILL.md +80 -0
- package/skills/secrets-management/SKILL.md +364 -0
- package/skills/security-auditor/SKILL.md +169 -0
- package/skills/security-compliance-compliance-check/SKILL.md +55 -0
- package/skills/security-compliance-compliance-check/resources/implementation-playbook.md +963 -0
- package/skills/security-requirement-extraction/SKILL.md +33 -0
- package/skills/security-requirement-extraction/resources/implementation-playbook.md +676 -0
- package/skills/security-scanning-security-dependencies/SKILL.md +43 -0
- package/skills/security-scanning-security-dependencies/resources/implementation-playbook.md +544 -0
- package/skills/security-scanning-security-hardening/SKILL.md +147 -0
- package/skills/security-scanning-security-sast/SKILL.md +495 -0
- package/skills/seo-authority-builder/SKILL.md +136 -0
- package/skills/seo-cannibalization-detector/SKILL.md +123 -0
- package/skills/seo-content-auditor/SKILL.md +83 -0
- package/skills/seo-content-planner/SKILL.md +108 -0
- package/skills/seo-content-refresher/SKILL.md +118 -0
- package/skills/seo-content-writer/SKILL.md +96 -0
- package/skills/seo-keyword-strategist/SKILL.md +95 -0
- package/skills/seo-meta-optimizer/SKILL.md +92 -0
- package/skills/seo-snippet-hunter/SKILL.md +114 -0
- package/skills/seo-structure-architect/SKILL.md +108 -0
- package/skills/service-mesh-expert/SKILL.md +58 -0
- package/skills/service-mesh-observability/SKILL.md +395 -0
- package/skills/shellcheck-configuration/SKILL.md +466 -0
- package/skills/similarity-search-patterns/SKILL.md +33 -0
- package/skills/similarity-search-patterns/resources/implementation-playbook.md +557 -0
- package/skills/slo-implementation/SKILL.md +341 -0
- package/skills/solidity-security/SKILL.md +34 -0
- package/skills/solidity-security/resources/implementation-playbook.md +524 -0
- package/skills/spark-optimization/SKILL.md +427 -0
- package/skills/sql-optimization-patterns/SKILL.md +35 -0
- package/skills/sql-optimization-patterns/resources/implementation-playbook.md +504 -0
- package/skills/sql-pro/SKILL.md +173 -0
- package/skills/startup-analyst/SKILL.md +328 -0
- package/skills/startup-business-analyst-business-case/SKILL.md +487 -0
- package/skills/startup-business-analyst-financial-projections/SKILL.md +353 -0
- package/skills/startup-business-analyst-market-opportunity/SKILL.md +240 -0
- package/skills/startup-financial-modeling/SKILL.md +467 -0
- package/skills/startup-metrics-framework/SKILL.md +34 -0
- package/skills/startup-metrics-framework/resources/implementation-playbook.md +500 -0
- package/skills/stride-analysis-patterns/SKILL.md +33 -0
- package/skills/stride-analysis-patterns/resources/implementation-playbook.md +655 -0
- package/skills/stripe-integration/SKILL.md +454 -0
- package/skills/systems-programming-rust-project/SKILL.md +440 -0
- package/skills/tailwind-design-system/SKILL.md +33 -0
- package/skills/tailwind-design-system/resources/implementation-playbook.md +665 -0
- package/skills/tdd-orchestrator/SKILL.md +205 -0
- package/skills/tdd-workflows-tdd-cycle/SKILL.md +221 -0
- package/skills/tdd-workflows-tdd-green/SKILL.md +73 -0
- package/skills/tdd-workflows-tdd-green/resources/implementation-playbook.md +870 -0
- package/skills/tdd-workflows-tdd-red/SKILL.md +164 -0
- package/skills/tdd-workflows-tdd-refactor/SKILL.md +187 -0
- package/skills/team-collaboration-issue/SKILL.md +37 -0
- package/skills/team-collaboration-issue/resources/implementation-playbook.md +640 -0
- package/skills/team-collaboration-standup-notes/SKILL.md +44 -0
- package/skills/team-collaboration-standup-notes/resources/implementation-playbook.md +768 -0
- package/skills/team-composition-analysis/SKILL.md +413 -0
- package/skills/temporal-python-pro/SKILL.md +370 -0
- package/skills/temporal-python-testing/SKILL.md +170 -0
- package/skills/temporal-python-testing/resources/integration-testing.md +455 -0
- package/skills/temporal-python-testing/resources/local-setup.md +553 -0
- package/skills/temporal-python-testing/resources/replay-testing.md +462 -0
- package/skills/temporal-python-testing/resources/unit-testing.md +328 -0
- package/skills/terraform-module-library/SKILL.md +261 -0
- package/skills/terraform-module-library/references/aws-modules.md +63 -0
- package/skills/terraform-specialist/SKILL.md +166 -0
- package/skills/test-automator/SKILL.md +224 -0
- package/skills/threat-mitigation-mapping/SKILL.md +33 -0
- package/skills/threat-mitigation-mapping/resources/implementation-playbook.md +744 -0
- package/skills/threat-modeling-expert/SKILL.md +60 -0
- package/skills/track-management/SKILL.md +38 -0
- package/skills/track-management/resources/implementation-playbook.md +591 -0
- package/skills/turborepo-caching/SKILL.md +419 -0
- package/skills/tutorial-engineer/SKILL.md +139 -0
- package/skills/typescript-advanced-types/SKILL.md +35 -0
- package/skills/typescript-advanced-types/resources/implementation-playbook.md +716 -0
- package/skills/typescript-pro/SKILL.md +55 -0
- package/skills/ui-minimal/SKILL.md +23 -0
- package/skills/ui-ux-designer/SKILL.md +209 -0
- package/skills/ui-visual-validator/SKILL.md +214 -0
- package/skills/unit-testing-test-generate/SKILL.md +319 -0
- package/skills/unity-developer/SKILL.md +230 -0
- package/skills/unity-ecs-patterns/SKILL.md +33 -0
- package/skills/unity-ecs-patterns/resources/implementation-playbook.md +625 -0
- package/skills/uv-package-manager/SKILL.md +37 -0
- package/skills/uv-package-manager/resources/implementation-playbook.md +830 -0
- package/skills/vector-database-engineer/SKILL.md +60 -0
- package/skills/vector-index-tuning/SKILL.md +42 -0
- package/skills/vector-index-tuning/resources/implementation-playbook.md +507 -0
- package/skills/wcag-audit-patterns/SKILL.md +41 -0
- package/skills/wcag-audit-patterns/resources/implementation-playbook.md +541 -0
- package/skills/web3-testing/SKILL.md +427 -0
- package/skills/workflow-orchestration-patterns/SKILL.md +333 -0
- package/skills/workflow-patterns/SKILL.md +38 -0
- package/skills/workflow-patterns/resources/implementation-playbook.md +621 -0
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: php-pro
|
|
3
|
+
description: Write idiomatic PHP code with generators, iterators, SPL data
|
|
4
|
+
structures, and modern OOP features. Use PROACTIVELY for high-performance PHP
|
|
5
|
+
applications.
|
|
6
|
+
metadata:
|
|
7
|
+
model: inherit
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Use this skill when
|
|
11
|
+
|
|
12
|
+
- Working on php pro tasks or workflows
|
|
13
|
+
- Needing guidance, best practices, or checklists for php pro
|
|
14
|
+
|
|
15
|
+
## Do not use this skill when
|
|
16
|
+
|
|
17
|
+
- The task is unrelated to php pro
|
|
18
|
+
- You need a different domain or tool outside this scope
|
|
19
|
+
|
|
20
|
+
## Instructions
|
|
21
|
+
|
|
22
|
+
- Clarify goals, constraints, and required inputs.
|
|
23
|
+
- Apply relevant best practices and validate outcomes.
|
|
24
|
+
- Provide actionable steps and verification.
|
|
25
|
+
- If detailed examples are required, open `resources/implementation-playbook.md`.
|
|
26
|
+
|
|
27
|
+
You are a PHP expert specializing in modern PHP development with focus on performance and idiomatic patterns.
|
|
28
|
+
|
|
29
|
+
## Focus Areas
|
|
30
|
+
|
|
31
|
+
- Generators and iterators for memory-efficient data processing
|
|
32
|
+
- SPL data structures (SplQueue, SplStack, SplHeap, ArrayObject)
|
|
33
|
+
- Modern PHP 8+ features (match expressions, enums, attributes, constructor property promotion)
|
|
34
|
+
- Type system mastery (union types, intersection types, never type, mixed type)
|
|
35
|
+
- Advanced OOP patterns (traits, late static binding, magic methods, reflection)
|
|
36
|
+
- Memory management and reference handling
|
|
37
|
+
- Stream contexts and filters for I/O operations
|
|
38
|
+
- Performance profiling and optimization techniques
|
|
39
|
+
|
|
40
|
+
## Approach
|
|
41
|
+
|
|
42
|
+
1. Start with built-in PHP functions before writing custom implementations
|
|
43
|
+
2. Use generators for large datasets to minimize memory footprint
|
|
44
|
+
3. Apply strict typing and leverage type inference
|
|
45
|
+
4. Use SPL data structures when they provide clear performance benefits
|
|
46
|
+
5. Profile performance bottlenecks before optimizing
|
|
47
|
+
6. Handle errors with exceptions and proper error levels
|
|
48
|
+
7. Write self-documenting code with meaningful names
|
|
49
|
+
8. Test edge cases and error conditions thoroughly
|
|
50
|
+
|
|
51
|
+
## Output
|
|
52
|
+
|
|
53
|
+
- Memory-efficient code using generators and iterators appropriately
|
|
54
|
+
- Type-safe implementations with full type coverage
|
|
55
|
+
- Performance-optimized solutions with measured improvements
|
|
56
|
+
- Clean architecture following SOLID principles
|
|
57
|
+
- Secure code preventing injection and validation vulnerabilities
|
|
58
|
+
- Well-structured namespaces and autoloading setup
|
|
59
|
+
- PSR-compliant code following community standards
|
|
60
|
+
- Comprehensive error handling with custom exceptions
|
|
61
|
+
- Production-ready code with proper logging and monitoring hooks
|
|
62
|
+
|
|
63
|
+
Prefer PHP standard library and built-in functions over third-party packages. Use external dependencies sparingly and only when necessary. Focus on working code over explanations.
|
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: posix-shell-pro
|
|
3
|
+
description: Expert in strict POSIX sh scripting for maximum portability across
|
|
4
|
+
Unix-like systems. Specializes in shell scripts that run on any
|
|
5
|
+
POSIX-compliant shell (dash, ash, sh, bash --posix).
|
|
6
|
+
metadata:
|
|
7
|
+
model: sonnet
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Use this skill when
|
|
11
|
+
|
|
12
|
+
- Working on posix shell pro tasks or workflows
|
|
13
|
+
- Needing guidance, best practices, or checklists for posix shell pro
|
|
14
|
+
|
|
15
|
+
## Do not use this skill when
|
|
16
|
+
|
|
17
|
+
- The task is unrelated to posix shell pro
|
|
18
|
+
- You need a different domain or tool outside this scope
|
|
19
|
+
|
|
20
|
+
## Instructions
|
|
21
|
+
|
|
22
|
+
- Clarify goals, constraints, and required inputs.
|
|
23
|
+
- Apply relevant best practices and validate outcomes.
|
|
24
|
+
- Provide actionable steps and verification.
|
|
25
|
+
- If detailed examples are required, open `resources/implementation-playbook.md`.
|
|
26
|
+
|
|
27
|
+
## Focus Areas
|
|
28
|
+
|
|
29
|
+
- Strict POSIX compliance for maximum portability
|
|
30
|
+
- Shell-agnostic scripting that works on any Unix-like system
|
|
31
|
+
- Defensive programming with portable error handling
|
|
32
|
+
- Safe argument parsing without bash-specific features
|
|
33
|
+
- Portable file operations and resource management
|
|
34
|
+
- Cross-platform compatibility (Linux, BSD, Solaris, AIX, macOS)
|
|
35
|
+
- Testing with dash, ash, and POSIX mode validation
|
|
36
|
+
- Static analysis with ShellCheck in POSIX mode
|
|
37
|
+
- Minimalist approach using only POSIX-specified features
|
|
38
|
+
- Compatibility with legacy systems and embedded environments
|
|
39
|
+
|
|
40
|
+
## POSIX Constraints
|
|
41
|
+
|
|
42
|
+
- No arrays (use positional parameters or delimited strings)
|
|
43
|
+
- No `[[` conditionals (use `[` test command only)
|
|
44
|
+
- No process substitution `<()` or `>()`
|
|
45
|
+
- No brace expansion `{1..10}`
|
|
46
|
+
- No `local` keyword (use function-scoped variables carefully)
|
|
47
|
+
- No `declare`, `typeset`, or `readonly` for variable attributes
|
|
48
|
+
- No `+=` operator for string concatenation
|
|
49
|
+
- No `${var//pattern/replacement}` substitution
|
|
50
|
+
- No associative arrays or hash tables
|
|
51
|
+
- No `source` command (use `.` for sourcing files)
|
|
52
|
+
|
|
53
|
+
## Approach
|
|
54
|
+
|
|
55
|
+
- Always use `#!/bin/sh` shebang for POSIX shell
|
|
56
|
+
- Use `set -eu` for error handling (no `pipefail` in POSIX)
|
|
57
|
+
- Quote all variable expansions: `"$var"` never `$var`
|
|
58
|
+
- Use `[ ]` for all conditional tests, never `[[`
|
|
59
|
+
- Implement argument parsing with `while` and `case` (no `getopts` for long options)
|
|
60
|
+
- Create temporary files safely with `mktemp` and cleanup traps
|
|
61
|
+
- Use `printf` instead of `echo` for all output (echo behavior varies)
|
|
62
|
+
- Use `. script.sh` instead of `source script.sh` for sourcing
|
|
63
|
+
- Implement error handling with explicit `|| exit 1` checks
|
|
64
|
+
- Design scripts to be idempotent and support dry-run modes
|
|
65
|
+
- Use `IFS` manipulation carefully and restore original value
|
|
66
|
+
- Validate inputs with `[ -n "$var" ]` and `[ -z "$var" ]` tests
|
|
67
|
+
- End option parsing with `--` and use `rm -rf -- "$dir"` for safety
|
|
68
|
+
- Use command substitution `$()` instead of backticks for readability
|
|
69
|
+
- Implement structured logging with timestamps using `date`
|
|
70
|
+
- Test scripts with dash/ash to verify POSIX compliance
|
|
71
|
+
|
|
72
|
+
## Compatibility & Portability
|
|
73
|
+
|
|
74
|
+
- Use `#!/bin/sh` to invoke the system's POSIX shell
|
|
75
|
+
- Test on multiple shells: dash (Debian/Ubuntu default), ash (Alpine/BusyBox), bash --posix
|
|
76
|
+
- Avoid GNU-specific options; use POSIX-specified flags only
|
|
77
|
+
- Handle platform differences: `uname -s` for OS detection
|
|
78
|
+
- Use `command -v` instead of `which` (more portable)
|
|
79
|
+
- Check for command availability: `command -v cmd >/dev/null 2>&1 || exit 1`
|
|
80
|
+
- Provide portable implementations for missing utilities
|
|
81
|
+
- Use `[ -e "$file" ]` for existence checks (works on all systems)
|
|
82
|
+
- Avoid `/dev/stdin`, `/dev/stdout` (not universally available)
|
|
83
|
+
- Use explicit redirection instead of `&>` (bash-specific)
|
|
84
|
+
|
|
85
|
+
## Readability & Maintainability
|
|
86
|
+
|
|
87
|
+
- Use descriptive variable names in UPPER_CASE for exports, lower_case for locals
|
|
88
|
+
- Add section headers with comment blocks for organization
|
|
89
|
+
- Keep functions under 50 lines; extract complex logic
|
|
90
|
+
- Use consistent indentation (spaces only, typically 2 or 4)
|
|
91
|
+
- Document function purpose and parameters in comments
|
|
92
|
+
- Use meaningful names: `validate_input` not `check`
|
|
93
|
+
- Add comments for non-obvious POSIX workarounds
|
|
94
|
+
- Group related functions with descriptive headers
|
|
95
|
+
- Extract repeated code into functions
|
|
96
|
+
- Use blank lines to separate logical sections
|
|
97
|
+
|
|
98
|
+
## Safety & Security Patterns
|
|
99
|
+
|
|
100
|
+
- Quote all variable expansions to prevent word splitting
|
|
101
|
+
- Validate file permissions before operations: `[ -r "$file" ] || exit 1`
|
|
102
|
+
- Sanitize user input before using in commands
|
|
103
|
+
- Validate numeric input: `case $num in *[!0-9]*) exit 1 ;; esac`
|
|
104
|
+
- Never use `eval` on untrusted input
|
|
105
|
+
- Use `--` to separate options from arguments: `rm -- "$file"`
|
|
106
|
+
- Validate required variables: `[ -n "$VAR" ] || { echo "VAR required" >&2; exit 1; }`
|
|
107
|
+
- Check exit codes explicitly: `cmd || { echo "failed" >&2; exit 1; }`
|
|
108
|
+
- Use `trap` for cleanup: `trap 'rm -f "$tmpfile"' EXIT INT TERM`
|
|
109
|
+
- Set restrictive umask for sensitive files: `umask 077`
|
|
110
|
+
- Log security-relevant operations to syslog or file
|
|
111
|
+
- Validate file paths don't contain unexpected characters
|
|
112
|
+
- Use full paths for commands in security-critical scripts: `/bin/rm` not `rm`
|
|
113
|
+
|
|
114
|
+
## Performance Optimization
|
|
115
|
+
|
|
116
|
+
- Use shell built-ins over external commands when possible
|
|
117
|
+
- Avoid spawning subshells in loops: use `while read` not `for i in $(cat)`
|
|
118
|
+
- Cache command results in variables instead of repeated execution
|
|
119
|
+
- Use `case` for multiple string comparisons (faster than repeated `if`)
|
|
120
|
+
- Process files line-by-line for large files
|
|
121
|
+
- Use `expr` or `$(( ))` for arithmetic (POSIX supports `$(( ))`)
|
|
122
|
+
- Minimize external command calls in tight loops
|
|
123
|
+
- Use `grep -q` when you only need true/false (faster than capturing output)
|
|
124
|
+
- Batch similar operations together
|
|
125
|
+
- Use here-documents for multi-line strings instead of multiple echo calls
|
|
126
|
+
|
|
127
|
+
## Documentation Standards
|
|
128
|
+
|
|
129
|
+
- Implement `-h` flag for help (avoid `--help` without proper parsing)
|
|
130
|
+
- Include usage message showing synopsis and options
|
|
131
|
+
- Document required vs optional arguments clearly
|
|
132
|
+
- List exit codes: 0=success, 1=error, specific codes for specific failures
|
|
133
|
+
- Document prerequisites and required commands
|
|
134
|
+
- Add header comment with script purpose and author
|
|
135
|
+
- Include examples of common usage patterns
|
|
136
|
+
- Document environment variables used by script
|
|
137
|
+
- Provide troubleshooting guidance for common issues
|
|
138
|
+
- Note POSIX compliance in documentation
|
|
139
|
+
|
|
140
|
+
## Working Without Arrays
|
|
141
|
+
|
|
142
|
+
Since POSIX sh lacks arrays, use these patterns:
|
|
143
|
+
|
|
144
|
+
- **Positional Parameters**: `set -- item1 item2 item3; for arg; do echo "$arg"; done`
|
|
145
|
+
- **Delimited Strings**: `items="a:b:c"; IFS=:; set -- $items; IFS=' '`
|
|
146
|
+
- **Newline-Separated**: `items="a\nb\nc"; while IFS= read -r item; do echo "$item"; done <<EOF`
|
|
147
|
+
- **Counters**: `i=0; while [ $i -lt 10 ]; do i=$((i+1)); done`
|
|
148
|
+
- **Field Splitting**: Use `cut`, `awk`, or parameter expansion for string splitting
|
|
149
|
+
|
|
150
|
+
## Portable Conditionals
|
|
151
|
+
|
|
152
|
+
Use `[ ]` test command with POSIX operators:
|
|
153
|
+
|
|
154
|
+
- **File Tests**: `[ -e file ]` exists, `[ -f file ]` regular file, `[ -d dir ]` directory
|
|
155
|
+
- **String Tests**: `[ -z "$str" ]` empty, `[ -n "$str" ]` not empty, `[ "$a" = "$b" ]` equal
|
|
156
|
+
- **Numeric Tests**: `[ "$a" -eq "$b" ]` equal, `[ "$a" -lt "$b" ]` less than
|
|
157
|
+
- **Logical**: `[ cond1 ] && [ cond2 ]` AND, `[ cond1 ] || [ cond2 ]` OR
|
|
158
|
+
- **Negation**: `[ ! -f file ]` not a file
|
|
159
|
+
- **Pattern Matching**: Use `case` not `[[ =~ ]]`
|
|
160
|
+
|
|
161
|
+
## CI/CD Integration
|
|
162
|
+
|
|
163
|
+
- **Matrix testing**: Test across dash, ash, bash --posix, yash on Linux, macOS, Alpine
|
|
164
|
+
- **Container testing**: Use alpine:latest (ash), debian:stable (dash) for reproducible tests
|
|
165
|
+
- **Pre-commit hooks**: Configure checkbashisms, shellcheck -s sh, shfmt -ln posix
|
|
166
|
+
- **GitHub Actions**: Use shellcheck-problem-matchers with POSIX mode
|
|
167
|
+
- **Cross-platform validation**: Test on Linux, macOS, FreeBSD, NetBSD
|
|
168
|
+
- **BusyBox testing**: Validate on BusyBox environments for embedded systems
|
|
169
|
+
- **Automated releases**: Tag versions and generate portable distribution packages
|
|
170
|
+
- **Coverage tracking**: Ensure test coverage across all POSIX shells
|
|
171
|
+
- Example workflow: `shellcheck -s sh *.sh && shfmt -ln posix -d *.sh && checkbashisms *.sh`
|
|
172
|
+
|
|
173
|
+
## Embedded Systems & Limited Environments
|
|
174
|
+
|
|
175
|
+
- **BusyBox compatibility**: Test with BusyBox's limited ash implementation
|
|
176
|
+
- **Alpine Linux**: Default shell is BusyBox ash, not bash
|
|
177
|
+
- **Resource constraints**: Minimize memory usage, avoid spawning excessive processes
|
|
178
|
+
- **Missing utilities**: Provide fallbacks when common tools unavailable (`mktemp`, `seq`)
|
|
179
|
+
- **Read-only filesystems**: Handle scenarios where `/tmp` may be restricted
|
|
180
|
+
- **No coreutils**: Some environments lack GNU coreutils extensions
|
|
181
|
+
- **Signal handling**: Limited signal support in minimal environments
|
|
182
|
+
- **Startup scripts**: Init scripts must be POSIX for maximum compatibility
|
|
183
|
+
- Example: Check for mktemp: `command -v mktemp >/dev/null 2>&1 || mktemp() { ... }`
|
|
184
|
+
|
|
185
|
+
## Migration from Bash to POSIX sh
|
|
186
|
+
|
|
187
|
+
- **Assessment**: Run `checkbashisms` to identify bash-specific constructs
|
|
188
|
+
- **Array elimination**: Convert arrays to delimited strings or positional parameters
|
|
189
|
+
- **Conditional updates**: Replace `[[` with `[` and adjust regex to `case` patterns
|
|
190
|
+
- **Local variables**: Remove `local` keyword, use function prefixes instead
|
|
191
|
+
- **Process substitution**: Replace `<()` with temporary files or pipes
|
|
192
|
+
- **Parameter expansion**: Use `sed`/`awk` for complex string manipulation
|
|
193
|
+
- **Testing strategy**: Incremental conversion with continuous validation
|
|
194
|
+
- **Documentation**: Note any POSIX limitations or workarounds
|
|
195
|
+
- **Gradual migration**: Convert one function at a time, test thoroughly
|
|
196
|
+
- **Fallback support**: Maintain dual implementations during transition if needed
|
|
197
|
+
|
|
198
|
+
## Quality Checklist
|
|
199
|
+
|
|
200
|
+
- Scripts pass ShellCheck with `-s sh` flag (POSIX mode)
|
|
201
|
+
- Code is formatted consistently with shfmt using `-ln posix`
|
|
202
|
+
- Test on multiple shells: dash, ash, bash --posix, yash
|
|
203
|
+
- All variable expansions are properly quoted
|
|
204
|
+
- No bash-specific features used (arrays, `[[`, `local`, etc.)
|
|
205
|
+
- Error handling covers all failure modes
|
|
206
|
+
- Temporary resources cleaned up with EXIT trap
|
|
207
|
+
- Scripts provide clear usage information
|
|
208
|
+
- Input validation prevents injection attacks
|
|
209
|
+
- Scripts portable across Unix-like systems (Linux, BSD, Solaris, macOS, Alpine)
|
|
210
|
+
- BusyBox compatibility validated for embedded use cases
|
|
211
|
+
- No GNU-specific extensions or flags used
|
|
212
|
+
|
|
213
|
+
## Output
|
|
214
|
+
|
|
215
|
+
- POSIX-compliant shell scripts maximizing portability
|
|
216
|
+
- Test suites using shellspec or bats-core validating across dash, ash, yash
|
|
217
|
+
- CI/CD configurations for multi-shell matrix testing
|
|
218
|
+
- Portable implementations of common patterns with fallbacks
|
|
219
|
+
- Documentation on POSIX limitations and workarounds with examples
|
|
220
|
+
- Migration guides for converting bash scripts to POSIX sh incrementally
|
|
221
|
+
- Cross-platform compatibility matrices (Linux, BSD, macOS, Solaris, Alpine)
|
|
222
|
+
- Performance benchmarks comparing different POSIX shells
|
|
223
|
+
- Fallback implementations for missing utilities (mktemp, seq, timeout)
|
|
224
|
+
- BusyBox-compatible scripts for embedded and container environments
|
|
225
|
+
- Package distributions for various platforms without bash dependency
|
|
226
|
+
|
|
227
|
+
## Essential Tools
|
|
228
|
+
|
|
229
|
+
### Static Analysis & Formatting
|
|
230
|
+
- **ShellCheck**: Static analyzer with `-s sh` for POSIX mode validation
|
|
231
|
+
- **shfmt**: Shell formatter with `-ln posix` option for POSIX syntax
|
|
232
|
+
- **checkbashisms**: Detects bash-specific constructs in scripts (from devscripts)
|
|
233
|
+
- **Semgrep**: SAST with POSIX-specific security rules
|
|
234
|
+
- **CodeQL**: Security scanning for shell scripts
|
|
235
|
+
|
|
236
|
+
### POSIX Shell Implementations for Testing
|
|
237
|
+
- **dash**: Debian Almquist Shell - lightweight, strict POSIX compliance (primary test target)
|
|
238
|
+
- **ash**: Almquist Shell - BusyBox default, embedded systems
|
|
239
|
+
- **yash**: Yet Another Shell - strict POSIX conformance validation
|
|
240
|
+
- **posh**: Policy-compliant Ordinary Shell - Debian policy compliance
|
|
241
|
+
- **osh**: Oil Shell - modern POSIX-compatible shell with better error messages
|
|
242
|
+
- **bash --posix**: GNU Bash in POSIX mode for compatibility testing
|
|
243
|
+
|
|
244
|
+
### Testing Frameworks
|
|
245
|
+
- **bats-core**: Bash testing framework (works with POSIX sh)
|
|
246
|
+
- **shellspec**: BDD-style testing that supports POSIX sh
|
|
247
|
+
- **shunit2**: xUnit-style framework with POSIX sh support
|
|
248
|
+
- **sharness**: Test framework used by Git (POSIX-compatible)
|
|
249
|
+
|
|
250
|
+
## Common Pitfalls to Avoid
|
|
251
|
+
|
|
252
|
+
- Using `[[` instead of `[` (bash-specific)
|
|
253
|
+
- Using arrays (not in POSIX sh)
|
|
254
|
+
- Using `local` keyword (bash/ksh extension)
|
|
255
|
+
- Using `echo` without `printf` (behavior varies across implementations)
|
|
256
|
+
- Using `source` instead of `.` for sourcing scripts
|
|
257
|
+
- Using bash-specific parameter expansion: `${var//pattern/replacement}`
|
|
258
|
+
- Using process substitution `<()` or `>()`
|
|
259
|
+
- Using `function` keyword (ksh/bash syntax)
|
|
260
|
+
- Using `$RANDOM` variable (not in POSIX)
|
|
261
|
+
- Using `read -a` for arrays (bash-specific)
|
|
262
|
+
- Using `set -o pipefail` (bash-specific)
|
|
263
|
+
- Using `&>` for redirection (use `>file 2>&1`)
|
|
264
|
+
|
|
265
|
+
## Advanced Techniques
|
|
266
|
+
|
|
267
|
+
- **Error Trapping**: `trap 'echo "Error at line $LINENO" >&2; exit 1' EXIT; trap - EXIT` on success
|
|
268
|
+
- **Safe Temp Files**: `tmpfile=$(mktemp) || exit 1; trap 'rm -f "$tmpfile"' EXIT INT TERM`
|
|
269
|
+
- **Simulating Arrays**: `set -- item1 item2 item3; for arg; do process "$arg"; done`
|
|
270
|
+
- **Field Parsing**: `IFS=:; while read -r user pass uid gid; do ...; done < /etc/passwd`
|
|
271
|
+
- **String Replacement**: `echo "$str" | sed 's/old/new/g'` or use parameter expansion `${str%suffix}`
|
|
272
|
+
- **Default Values**: `value=${var:-default}` assigns default if var unset or null
|
|
273
|
+
- **Portable Functions**: Avoid `function` keyword, use `func_name() { ... }`
|
|
274
|
+
- **Subshell Isolation**: `(cd dir && cmd)` changes directory without affecting parent
|
|
275
|
+
- **Here-documents**: `cat <<'EOF'` with quotes prevents variable expansion
|
|
276
|
+
- **Command Existence**: `command -v cmd >/dev/null 2>&1 && echo "found" || echo "missing"`
|
|
277
|
+
|
|
278
|
+
## POSIX-Specific Best Practices
|
|
279
|
+
|
|
280
|
+
- Always quote variable expansions: `"$var"` not `$var`
|
|
281
|
+
- Use `[ ]` with proper spacing: `[ "$a" = "$b" ]` not `["$a"="$b"]`
|
|
282
|
+
- Use `=` for string comparison, not `==` (bash extension)
|
|
283
|
+
- Use `.` for sourcing, not `source`
|
|
284
|
+
- Use `printf` for all output, avoid `echo -e` or `echo -n`
|
|
285
|
+
- Use `$(( ))` for arithmetic, not `let` or `declare -i`
|
|
286
|
+
- Use `case` for pattern matching, not `[[ =~ ]]`
|
|
287
|
+
- Test scripts with `sh -n script.sh` to check syntax
|
|
288
|
+
- Use `command -v` not `type` or `which` for portability
|
|
289
|
+
- Explicitly handle all error conditions with `|| exit 1`
|
|
290
|
+
|
|
291
|
+
## References & Further Reading
|
|
292
|
+
|
|
293
|
+
### POSIX Standards & Specifications
|
|
294
|
+
- [POSIX Shell Command Language](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html) - Official POSIX.1-2024 specification
|
|
295
|
+
- [POSIX Utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html) - Complete list of POSIX-mandated utilities
|
|
296
|
+
- [Autoconf Portable Shell Programming](https://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell) - Comprehensive portability guide from GNU
|
|
297
|
+
|
|
298
|
+
### Portability & Best Practices
|
|
299
|
+
- [Rich's sh (POSIX shell) tricks](http://www.etalabs.net/sh_tricks.html) - Advanced POSIX shell techniques
|
|
300
|
+
- [Suckless Shell Style Guide](https://suckless.org/coding_style/) - Minimalist POSIX sh patterns
|
|
301
|
+
- [FreeBSD Porter's Handbook - Shell](https://docs.freebsd.org/en/books/porters-handbook/makefiles/#porting-shlibs) - BSD portability considerations
|
|
302
|
+
|
|
303
|
+
### Tools & Testing
|
|
304
|
+
- [checkbashisms](https://manpages.debian.org/testing/devscripts/checkbashisms.1.en.html) - Detect bash-specific constructs
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: postgresql
|
|
3
|
+
description: Design a PostgreSQL-specific schema. Covers best-practices, data types, indexing, constraints, performance patterns, and advanced features
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# PostgreSQL Table Design
|
|
7
|
+
|
|
8
|
+
## Use this skill when
|
|
9
|
+
|
|
10
|
+
- Designing a schema for PostgreSQL
|
|
11
|
+
- Selecting data types and constraints
|
|
12
|
+
- Planning indexes, partitions, or RLS policies
|
|
13
|
+
- Reviewing tables for scale and maintainability
|
|
14
|
+
|
|
15
|
+
## Do not use this skill when
|
|
16
|
+
|
|
17
|
+
- You are targeting a non-PostgreSQL database
|
|
18
|
+
- You only need query tuning without schema changes
|
|
19
|
+
- You require a DB-agnostic modeling guide
|
|
20
|
+
|
|
21
|
+
## Instructions
|
|
22
|
+
|
|
23
|
+
1. Capture entities, access patterns, and scale targets (rows, QPS, retention).
|
|
24
|
+
2. Choose data types and constraints that enforce invariants.
|
|
25
|
+
3. Add indexes for real query paths and validate with `EXPLAIN`.
|
|
26
|
+
4. Plan partitioning or RLS where required by scale or access control.
|
|
27
|
+
5. Review migration impact and apply changes safely.
|
|
28
|
+
|
|
29
|
+
## Safety
|
|
30
|
+
|
|
31
|
+
- Avoid destructive DDL on production without backups and a rollback plan.
|
|
32
|
+
- Use migrations and staging validation before applying schema changes.
|
|
33
|
+
|
|
34
|
+
## Core Rules
|
|
35
|
+
|
|
36
|
+
- Define a **PRIMARY KEY** for reference tables (users, orders, etc.). Not always needed for time-series/event/log data. When used, prefer `BIGINT GENERATED ALWAYS AS IDENTITY`; use `UUID` only when global uniqueness/opacity is needed.
|
|
37
|
+
- **Normalize first (to 3NF)** to eliminate data redundancy and update anomalies; denormalize **only** for measured, high-ROI reads where join performance is proven problematic. Premature denormalization creates maintenance burden.
|
|
38
|
+
- Add **NOT NULL** everywhere it’s semantically required; use **DEFAULT**s for common values.
|
|
39
|
+
- Create **indexes for access paths you actually query**: PK/unique (auto), **FK columns (manual!)**, frequent filters/sorts, and join keys.
|
|
40
|
+
- Prefer **TIMESTAMPTZ** for event time; **NUMERIC** for money; **TEXT** for strings; **BIGINT** for integer values, **DOUBLE PRECISION** for floats (or `NUMERIC` for exact decimal arithmetic).
|
|
41
|
+
|
|
42
|
+
## PostgreSQL “Gotchas”
|
|
43
|
+
|
|
44
|
+
- **Identifiers**: unquoted → lowercased. Avoid quoted/mixed-case names. Convention: use `snake_case` for table/column names.
|
|
45
|
+
- **Unique + NULLs**: UNIQUE allows multiple NULLs. Use `UNIQUE (...) NULLS NOT DISTINCT` (PG15+) to restrict to one NULL.
|
|
46
|
+
- **FK indexes**: PostgreSQL **does not** auto-index FK columns. Add them.
|
|
47
|
+
- **No silent coercions**: length/precision overflows error out (no truncation). Example: inserting 999 into `NUMERIC(2,0)` fails with error, unlike some databases that silently truncate or round.
|
|
48
|
+
- **Sequences/identity have gaps** (normal; don't "fix"). Rollbacks, crashes, and concurrent transactions create gaps in ID sequences (1, 2, 5, 6...). This is expected behavior—don't try to make IDs consecutive.
|
|
49
|
+
- **Heap storage**: no clustered PK by default (unlike SQL Server/MySQL InnoDB); `CLUSTER` is one-off reorganization, not maintained on subsequent inserts. Row order on disk is insertion order unless explicitly clustered.
|
|
50
|
+
- **MVCC**: updates/deletes leave dead tuples; vacuum handles them—design to avoid hot wide-row churn.
|
|
51
|
+
|
|
52
|
+
## Data Types
|
|
53
|
+
|
|
54
|
+
- **IDs**: `BIGINT GENERATED ALWAYS AS IDENTITY` preferred (`GENERATED BY DEFAULT` also fine); `UUID` when merging/federating/used in a distributed system or for opaque IDs. Generate with `uuidv7()` (preferred if using PG18+) or `gen_random_uuid()` (if using an older PG version).
|
|
55
|
+
- **Integers**: prefer `BIGINT` unless storage space is critical; `INTEGER` for smaller ranges; avoid `SMALLINT` unless constrained.
|
|
56
|
+
- **Floats**: prefer `DOUBLE PRECISION` over `REAL` unless storage space is critical. Use `NUMERIC` for exact decimal arithmetic.
|
|
57
|
+
- **Strings**: prefer `TEXT`; if length limits needed, use `CHECK (LENGTH(col) <= n)` instead of `VARCHAR(n)`; avoid `CHAR(n)`. Use `BYTEA` for binary data. Large strings/binary (>2KB default threshold) automatically stored in TOAST with compression. TOAST storage: `PLAIN` (no TOAST), `EXTENDED` (compress + out-of-line), `EXTERNAL` (out-of-line, no compress), `MAIN` (compress, keep in-line if possible). Default `EXTENDED` usually optimal. Control with `ALTER TABLE tbl ALTER COLUMN col SET STORAGE strategy` and `ALTER TABLE tbl SET (toast_tuple_target = 4096)` for threshold. Case-insensitive: for locale/accent handling use non-deterministic collations; for plain ASCII use expression indexes on `LOWER(col)` (preferred unless column needs case-insensitive PK/FK/UNIQUE) or `CITEXT`.
|
|
58
|
+
- **Money**: `NUMERIC(p,s)` (never float).
|
|
59
|
+
- **Time**: `TIMESTAMPTZ` for timestamps; `DATE` for date-only; `INTERVAL` for durations. Avoid `TIMESTAMP` (without timezone). Use `now()` for transaction start time, `clock_timestamp()` for current wall-clock time.
|
|
60
|
+
- **Booleans**: `BOOLEAN` with `NOT NULL` constraint unless tri-state values are required.
|
|
61
|
+
- **Enums**: `CREATE TYPE ... AS ENUM` for small, stable sets (e.g. US states, days of week). For business-logic-driven and evolving values (e.g. order statuses) → use TEXT (or INT) + CHECK or lookup table.
|
|
62
|
+
- **Arrays**: `TEXT[]`, `INTEGER[]`, etc. Use for ordered lists where you query elements. Index with **GIN** for containment (`@>`, `<@`) and overlap (`&&`) queries. Access: `arr[1]` (1-indexed), `arr[1:3]` (slicing). Good for tags, categories; avoid for relations—use junction tables instead. Literal syntax: `'{val1,val2}'` or `ARRAY[val1,val2]`.
|
|
63
|
+
- **Range types**: `daterange`, `numrange`, `tstzrange` for intervals. Support overlap (`&&`), containment (`@>`), operators. Index with **GiST**. Good for scheduling, versioning, numeric ranges. Pick a bounds scheme and use it consistently; prefer `[)` (inclusive/exclusive) by default.
|
|
64
|
+
- **Network types**: `INET` for IP addresses, `CIDR` for network ranges, `MACADDR` for MAC addresses. Support network operators (`<<`, `>>`, `&&`).
|
|
65
|
+
- **Geometric types**: `POINT`, `LINE`, `POLYGON`, `CIRCLE` for 2D spatial data. Index with **GiST**. Consider **PostGIS** for advanced spatial features.
|
|
66
|
+
- **Text search**: `TSVECTOR` for full-text search documents, `TSQUERY` for search queries. Index `tsvector` with **GIN**. Always specify language: `to_tsvector('english', col)` and `to_tsquery('english', 'query')`. Never use single-argument versions. This applies to both index expressions and queries.
|
|
67
|
+
- **Domain types**: `CREATE DOMAIN email AS TEXT CHECK (VALUE ~ '^[^@]+@[^@]+$')` for reusable custom types with validation. Enforces constraints across tables.
|
|
68
|
+
- **Composite types**: `CREATE TYPE address AS (street TEXT, city TEXT, zip TEXT)` for structured data within columns. Access with `(col).field` syntax.
|
|
69
|
+
- **JSONB**: preferred over JSON; index with **GIN**. Use only for optional/semi-structured attrs. ONLY use JSON if the original ordering of the contents MUST be preserved.
|
|
70
|
+
- **Vector types**: `vector` type by `pgvector` for vector similarity search for embeddings.
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
### Do not use the following data types
|
|
74
|
+
- DO NOT use `timestamp` (without time zone); DO use `timestamptz` instead.
|
|
75
|
+
- DO NOT use `char(n)` or `varchar(n)`; DO use `text` instead.
|
|
76
|
+
- DO NOT use `money` type; DO use `numeric` instead.
|
|
77
|
+
- DO NOT use `timetz` type; DO use `timestamptz` instead.
|
|
78
|
+
- DO NOT use `timestamptz(0)` or any other precision specification; DO use `timestamptz` instead
|
|
79
|
+
- DO NOT use `serial` type; DO use `generated always as identity` instead.
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
## Table Types
|
|
83
|
+
|
|
84
|
+
- **Regular**: default; fully durable, logged.
|
|
85
|
+
- **TEMPORARY**: session-scoped, auto-dropped, not logged. Faster for scratch work.
|
|
86
|
+
- **UNLOGGED**: persistent but not crash-safe. Faster writes; good for caches/staging.
|
|
87
|
+
|
|
88
|
+
## Row-Level Security
|
|
89
|
+
|
|
90
|
+
Enable with `ALTER TABLE tbl ENABLE ROW LEVEL SECURITY`. Create policies: `CREATE POLICY user_access ON orders FOR SELECT TO app_users USING (user_id = current_user_id())`. Built-in user-based access control at the row level.
|
|
91
|
+
|
|
92
|
+
## Constraints
|
|
93
|
+
|
|
94
|
+
- **PK**: implicit UNIQUE + NOT NULL; creates a B-tree index.
|
|
95
|
+
- **FK**: specify `ON DELETE/UPDATE` action (`CASCADE`, `RESTRICT`, `SET NULL`, `SET DEFAULT`). Add explicit index on referencing column—speeds up joins and prevents locking issues on parent deletes/updates. Use `DEFERRABLE INITIALLY DEFERRED` for circular FK dependencies checked at transaction end.
|
|
96
|
+
- **UNIQUE**: creates a B-tree index; allows multiple NULLs unless `NULLS NOT DISTINCT` (PG15+). Standard behavior: `(1, NULL)` and `(1, NULL)` are allowed. With `NULLS NOT DISTINCT`: only one `(1, NULL)` allowed. Prefer `NULLS NOT DISTINCT` unless you specifically need duplicate NULLs.
|
|
97
|
+
- **CHECK**: row-local constraints; NULL values pass the check (three-valued logic). Example: `CHECK (price > 0)` allows NULL prices. Combine with `NOT NULL` to enforce: `price NUMERIC NOT NULL CHECK (price > 0)`.
|
|
98
|
+
- **EXCLUDE**: prevents overlapping values using operators. `EXCLUDE USING gist (room_id WITH =, booking_period WITH &&)` prevents double-booking rooms. Requires appropriate index type (often GiST).
|
|
99
|
+
|
|
100
|
+
## Indexing
|
|
101
|
+
|
|
102
|
+
- **B-tree**: default for equality/range queries (`=`, `<`, `>`, `BETWEEN`, `ORDER BY`)
|
|
103
|
+
- **Composite**: order matters—index used if equality on leftmost prefix (`WHERE a = ? AND b > ?` uses index on `(a,b)`, but `WHERE b = ?` does not). Put most selective/frequently filtered columns first.
|
|
104
|
+
- **Covering**: `CREATE INDEX ON tbl (id) INCLUDE (name, email)` - includes non-key columns for index-only scans without visiting table.
|
|
105
|
+
- **Partial**: for hot subsets (`WHERE status = 'active'` → `CREATE INDEX ON tbl (user_id) WHERE status = 'active'`). Any query with `status = 'active'` can use this index.
|
|
106
|
+
- **Expression**: for computed search keys (`CREATE INDEX ON tbl (LOWER(email))`). Expression must match exactly in WHERE clause: `WHERE LOWER(email) = 'user@example.com'`.
|
|
107
|
+
- **GIN**: JSONB containment/existence, arrays (`@>`, `?`), full-text search (`@@`)
|
|
108
|
+
- **GiST**: ranges, geometry, exclusion constraints
|
|
109
|
+
- **BRIN**: very large, naturally ordered data (time-series)—minimal storage overhead. Effective when row order on disk correlates with indexed column (insertion order or after `CLUSTER`).
|
|
110
|
+
|
|
111
|
+
## Partitioning
|
|
112
|
+
|
|
113
|
+
- Use for very large tables (>100M rows) where queries consistently filter on partition key (often time/date).
|
|
114
|
+
- Alternate use: use for tables where data maintenance tasks dictates e.g. data pruned or bulk replaced periodically
|
|
115
|
+
- **RANGE**: common for time-series (`PARTITION BY RANGE (created_at)`). Create partitions: `CREATE TABLE logs_2024_01 PARTITION OF logs FOR VALUES FROM ('2024-01-01') TO ('2024-02-01')`. **TimescaleDB** automates time-based or ID-based partitioning with retention policies and compression.
|
|
116
|
+
- **LIST**: for discrete values (`PARTITION BY LIST (region)`). Example: `FOR VALUES IN ('us-east', 'us-west')`.
|
|
117
|
+
- **HASH**: for even distribution when no natural key (`PARTITION BY HASH (user_id)`). Creates N partitions with modulus.
|
|
118
|
+
- **Constraint exclusion**: requires `CHECK` constraints on partitions for query planner to prune. Auto-created for declarative partitioning (PG10+).
|
|
119
|
+
- Prefer declarative partitioning or hypertables. Do NOT use table inheritance.
|
|
120
|
+
- **Limitations**: no global UNIQUE constraints—include partition key in PK/UNIQUE. FKs from partitioned tables not supported; use triggers.
|
|
121
|
+
|
|
122
|
+
## Special Considerations
|
|
123
|
+
|
|
124
|
+
### Update-Heavy Tables
|
|
125
|
+
|
|
126
|
+
- **Separate hot/cold columns**—put frequently updated columns in separate table to minimize bloat.
|
|
127
|
+
- **Use `fillfactor=90`** to leave space for HOT updates that avoid index maintenance.
|
|
128
|
+
- **Avoid updating indexed columns**—prevents beneficial HOT updates.
|
|
129
|
+
- **Partition by update patterns**—separate frequently updated rows in a different partition from stable data.
|
|
130
|
+
|
|
131
|
+
### Insert-Heavy Workloads
|
|
132
|
+
|
|
133
|
+
- **Minimize indexes**—only create what you query; every index slows inserts.
|
|
134
|
+
- **Use `COPY` or multi-row `INSERT`** instead of single-row inserts.
|
|
135
|
+
- **UNLOGGED tables** for rebuildable staging data—much faster writes.
|
|
136
|
+
- **Defer index creation** for bulk loads—>drop index, load data, recreate indexes.
|
|
137
|
+
- **Partition by time/hash** to distribute load. **TimescaleDB** automates partitioning and compression of insert-heavy data.
|
|
138
|
+
- **Use a natural key for primary key** such as a (timestamp, device_id) if enforcing global uniqueness is important many insert-heavy tables don't need a primary key at all.
|
|
139
|
+
- If you do need a surrogate key, **Prefer `BIGINT GENERATED ALWAYS AS IDENTITY` over `UUID`**.
|
|
140
|
+
|
|
141
|
+
### Upsert-Friendly Design
|
|
142
|
+
|
|
143
|
+
- **Requires UNIQUE index** on conflict target columns—`ON CONFLICT (col1, col2)` needs exact matching unique index (partial indexes don't work).
|
|
144
|
+
- **Use `EXCLUDED.column`** to reference would-be-inserted values; only update columns that actually changed to reduce write overhead.
|
|
145
|
+
- **`DO NOTHING` faster** than `DO UPDATE` when no actual update needed.
|
|
146
|
+
|
|
147
|
+
### Safe Schema Evolution
|
|
148
|
+
|
|
149
|
+
- **Transactional DDL**: most DDL operations can run in transactions and be rolled back—`BEGIN; ALTER TABLE...; ROLLBACK;` for safe testing.
|
|
150
|
+
- **Concurrent index creation**: `CREATE INDEX CONCURRENTLY` avoids blocking writes but can't run in transactions.
|
|
151
|
+
- **Volatile defaults cause rewrites**: adding `NOT NULL` columns with volatile defaults (e.g., `now()`, `gen_random_uuid()`) rewrites entire table. Non-volatile defaults are fast.
|
|
152
|
+
- **Drop constraints before columns**: `ALTER TABLE DROP CONSTRAINT` then `DROP COLUMN` to avoid dependency issues.
|
|
153
|
+
- **Function signature changes**: `CREATE OR REPLACE` with different arguments creates overloads, not replacements. DROP old version if no overload desired.
|
|
154
|
+
|
|
155
|
+
## Generated Columns
|
|
156
|
+
|
|
157
|
+
- `... GENERATED ALWAYS AS (<expr>) STORED` for computed, indexable fields. PG18+ adds `VIRTUAL` columns (computed on read, not stored).
|
|
158
|
+
|
|
159
|
+
## Extensions
|
|
160
|
+
|
|
161
|
+
- **`pgcrypto`**: `crypt()` for password hashing.
|
|
162
|
+
- **`uuid-ossp`**: alternative UUID functions; prefer `pgcrypto` for new projects.
|
|
163
|
+
- **`pg_trgm`**: fuzzy text search with `%` operator, `similarity()` function. Index with GIN for `LIKE '%pattern%'` acceleration.
|
|
164
|
+
- **`citext`**: case-insensitive text type. Prefer expression indexes on `LOWER(col)` unless you need case-insensitive constraints.
|
|
165
|
+
- **`btree_gin`/`btree_gist`**: enable mixed-type indexes (e.g., GIN index on both JSONB and text columns).
|
|
166
|
+
- **`hstore`**: key-value pairs; mostly superseded by JSONB but useful for simple string mappings.
|
|
167
|
+
- **`timescaledb`**: essential for time-series—automated partitioning, retention, compression, continuous aggregates.
|
|
168
|
+
- **`postgis`**: comprehensive geospatial support beyond basic geometric types—essential for location-based applications.
|
|
169
|
+
- **`pgvector`**: vector similarity search for embeddings.
|
|
170
|
+
- **`pgaudit`**: audit logging for all database activity.
|
|
171
|
+
|
|
172
|
+
## JSONB Guidance
|
|
173
|
+
|
|
174
|
+
- Prefer `JSONB` with **GIN** index.
|
|
175
|
+
- Default: `CREATE INDEX ON tbl USING GIN (jsonb_col);` → accelerates:
|
|
176
|
+
- **Containment** `jsonb_col @> '{"k":"v"}'`
|
|
177
|
+
- **Key existence** `jsonb_col ? 'k'`, **any/all keys** `?\|`, `?&`
|
|
178
|
+
- **Path containment** on nested docs
|
|
179
|
+
- **Disjunction** `jsonb_col @> ANY(ARRAY['{"status":"active"}', '{"status":"pending"}'])`
|
|
180
|
+
- Heavy `@>` workloads: consider opclass `jsonb_path_ops` for smaller/faster containment-only indexes:
|
|
181
|
+
- `CREATE INDEX ON tbl USING GIN (jsonb_col jsonb_path_ops);`
|
|
182
|
+
- **Trade-off**: loses support for key existence (`?`, `?|`, `?&`) queries—only supports containment (`@>`)
|
|
183
|
+
- Equality/range on a specific scalar field: extract and index with B-tree (generated column or expression):
|
|
184
|
+
- `ALTER TABLE tbl ADD COLUMN price INT GENERATED ALWAYS AS ((jsonb_col->>'price')::INT) STORED;`
|
|
185
|
+
- `CREATE INDEX ON tbl (price);`
|
|
186
|
+
- Prefer queries like `WHERE price BETWEEN 100 AND 500` (uses B-tree) over `WHERE (jsonb_col->>'price')::INT BETWEEN 100 AND 500` without index.
|
|
187
|
+
- Arrays inside JSONB: use GIN + `@>` for containment (e.g., tags). Consider `jsonb_path_ops` if only doing containment.
|
|
188
|
+
- Keep core relations in tables; use JSONB for optional/variable attributes.
|
|
189
|
+
- Use constraints to limit allowed JSONB values in a column e.g. `config JSONB NOT NULL CHECK(jsonb_typeof(config) = 'object')`
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
## Examples
|
|
193
|
+
|
|
194
|
+
### Users
|
|
195
|
+
|
|
196
|
+
```sql
|
|
197
|
+
CREATE TABLE users (
|
|
198
|
+
user_id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
|
|
199
|
+
email TEXT NOT NULL UNIQUE,
|
|
200
|
+
name TEXT NOT NULL,
|
|
201
|
+
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
202
|
+
);
|
|
203
|
+
CREATE UNIQUE INDEX ON users (LOWER(email));
|
|
204
|
+
CREATE INDEX ON users (created_at);
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Orders
|
|
208
|
+
|
|
209
|
+
```sql
|
|
210
|
+
CREATE TABLE orders (
|
|
211
|
+
order_id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
|
|
212
|
+
user_id BIGINT NOT NULL REFERENCES users(user_id),
|
|
213
|
+
status TEXT NOT NULL DEFAULT 'PENDING' CHECK (status IN ('PENDING','PAID','CANCELED')),
|
|
214
|
+
total NUMERIC(10,2) NOT NULL CHECK (total > 0),
|
|
215
|
+
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
216
|
+
);
|
|
217
|
+
CREATE INDEX ON orders (user_id);
|
|
218
|
+
CREATE INDEX ON orders (created_at);
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### JSONB
|
|
222
|
+
|
|
223
|
+
```sql
|
|
224
|
+
CREATE TABLE profiles (
|
|
225
|
+
user_id BIGINT PRIMARY KEY REFERENCES users(user_id),
|
|
226
|
+
attrs JSONB NOT NULL DEFAULT '{}',
|
|
227
|
+
theme TEXT GENERATED ALWAYS AS (attrs->>'theme') STORED
|
|
228
|
+
);
|
|
229
|
+
CREATE INDEX profiles_attrs_gin ON profiles USING GIN (attrs);
|
|
230
|
+
```
|