@sibyllinesoft/arbiter 0.1.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/README.md +222 -0
- package/dist/cli.js +28718 -0
- package/dist/templates/plopfiles/__tests__/build-systems.test.ts +730 -0
- package/dist/templates/plopfiles/__tests__/e2e.test.ts +451 -0
- package/dist/templates/plopfiles/__tests__/generation.test.ts +384 -0
- package/dist/templates/plopfiles/__tests__/linting.test.ts +854 -0
- package/dist/templates/plopfiles/__tests__/modules.test.ts +278 -0
- package/dist/templates/plopfiles/__tests__/smoke.test.ts +619 -0
- package/dist/templates/plopfiles/__tests__/templates.test.ts +341 -0
- package/dist/templates/plopfiles/_modules/backends/go-chi/module.js +43 -0
- package/dist/templates/plopfiles/_modules/backends/go-chi/templates/.air.toml.hbs +30 -0
- package/dist/templates/plopfiles/_modules/backends/go-chi/templates/cmd/server/main.go.hbs +50 -0
- package/dist/templates/plopfiles/_modules/backends/go-chi/templates/go.mod.hbs +9 -0
- package/dist/templates/plopfiles/_modules/backends/go-chi/templates/internal/handlers/health.go.hbs +51 -0
- package/dist/templates/plopfiles/_modules/backends/kotlin-ktor/module.js +38 -0
- package/dist/templates/plopfiles/_modules/backends/kotlin-ktor/templates/build.gradle.kts.hbs +37 -0
- package/dist/templates/plopfiles/_modules/backends/kotlin-ktor/templates/settings.gradle.kts.hbs +1 -0
- package/dist/templates/plopfiles/_modules/backends/kotlin-ktor/templates/src/main/kotlin/Application.kt.hbs +44 -0
- package/dist/templates/plopfiles/_modules/backends/kotlin-ktor/templates/src/main/kotlin/routes/Health.kt.hbs +41 -0
- package/dist/templates/plopfiles/_modules/backends/kotlin-ktor/templates/src/main/resources/logback.xml.hbs +11 -0
- package/dist/templates/plopfiles/_modules/backends/node-express/module.js +54 -0
- package/dist/templates/plopfiles/_modules/backends/node-express/templates/src/index.ts.hbs +37 -0
- package/dist/templates/plopfiles/_modules/backends/node-express/templates/src/routes/health.ts.hbs +21 -0
- package/dist/templates/plopfiles/_modules/backends/node-express/templates/tsconfig.json.hbs +18 -0
- package/dist/templates/plopfiles/_modules/backends/node-hono/module.js +56 -0
- package/dist/templates/plopfiles/_modules/backends/node-hono/templates/src/index.ts.hbs +30 -0
- package/dist/templates/plopfiles/_modules/backends/node-hono/templates/src/routes/health.ts.hbs +64 -0
- package/dist/templates/plopfiles/_modules/backends/node-hono/templates/src/routes/index.ts.hbs +38 -0
- package/dist/templates/plopfiles/_modules/backends/node-hono/templates/tsconfig.json.hbs +20 -0
- package/dist/templates/plopfiles/_modules/backends/node-hono/templates/typedoc.json.hbs +25 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/module.js +65 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/templates/app/__init__.py.hbs +1 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/templates/app/config.py.hbs +28 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/templates/app/main.py.hbs +40 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/templates/app/routers/__init__.py.hbs +1 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/templates/app/routers/health.py.hbs +24 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/templates/pyproject.toml.hbs +40 -0
- package/dist/templates/plopfiles/_modules/backends/python-fastapi/templates/requirements.txt.hbs +6 -0
- package/dist/templates/plopfiles/_modules/backends/rust-axum/module.js +44 -0
- package/dist/templates/plopfiles/_modules/backends/rust-axum/templates/Cargo.toml.hbs +23 -0
- package/dist/templates/plopfiles/_modules/backends/rust-axum/templates/src/health.rs.hbs +41 -0
- package/dist/templates/plopfiles/_modules/backends/rust-axum/templates/src/main.rs.hbs +57 -0
- package/dist/templates/plopfiles/_modules/cloud/aws/module.js +33 -0
- package/dist/templates/plopfiles/_modules/cloud/aws/templates/aws-alb.tf.hbs +92 -0
- package/dist/templates/plopfiles/_modules/cloud/aws/templates/aws-ecs.tf.hbs +84 -0
- package/dist/templates/plopfiles/_modules/cloud/aws/templates/aws-iam.tf.hbs +60 -0
- package/dist/templates/plopfiles/_modules/cloud/aws/templates/aws-vpc.tf.hbs +106 -0
- package/dist/templates/plopfiles/_modules/cloud/aws/templates/aws.tf.hbs +56 -0
- package/dist/templates/plopfiles/_modules/cloud/azure/module.js +31 -0
- package/dist/templates/plopfiles/_modules/cloud/azure/templates/azure-container-apps.tf.hbs +99 -0
- package/dist/templates/plopfiles/_modules/cloud/azure/templates/azure.tf.hbs +54 -0
- package/dist/templates/plopfiles/_modules/cloud/cloudflare/module.js +43 -0
- package/dist/templates/plopfiles/_modules/cloud/cloudflare/templates/src/types.d.ts.hbs +6 -0
- package/dist/templates/plopfiles/_modules/cloud/cloudflare/templates/src/worker.ts.hbs +51 -0
- package/dist/templates/plopfiles/_modules/cloud/cloudflare/templates/wrangler.toml.hbs +36 -0
- package/dist/templates/plopfiles/_modules/cloud/gcp/module.js +31 -0
- package/dist/templates/plopfiles/_modules/cloud/gcp/templates/gcp-cloudrun.tf.hbs +89 -0
- package/dist/templates/plopfiles/_modules/cloud/gcp/templates/gcp.tf.hbs +62 -0
- package/dist/templates/plopfiles/_modules/cloud/supabase/module.js +51 -0
- package/dist/templates/plopfiles/_modules/cloud/supabase/templates/src/lib/supabase.ts.hbs +25 -0
- package/dist/templates/plopfiles/_modules/cloud/supabase/templates/src/types/supabase.ts.hbs +52 -0
- package/dist/templates/plopfiles/_modules/cloud/supabase/templates/supabase/config.toml.hbs +71 -0
- package/dist/templates/plopfiles/_modules/cloud/supabase/templates/supabase/functions/hello/index.ts.hbs +34 -0
- package/dist/templates/plopfiles/_modules/cloud/supabase/templates/supabase/migrations/00000000000000_init.sql.hbs +60 -0
- package/dist/templates/plopfiles/_modules/composer.js +180 -0
- package/dist/templates/plopfiles/_modules/databases/postgres-drizzle/drizzle.config.ts.hbs +10 -0
- package/dist/templates/plopfiles/_modules/databases/postgres-drizzle/module.js +53 -0
- package/dist/templates/plopfiles/_modules/databases/postgres-drizzle/templates/index.ts.hbs +15 -0
- package/dist/templates/plopfiles/_modules/databases/postgres-drizzle/templates/schema.ts.hbs +21 -0
- package/dist/templates/plopfiles/_modules/desktop/electron/module.js +51 -0
- package/dist/templates/plopfiles/_modules/desktop/electron/templates/forge.config.ts.hbs +38 -0
- package/dist/templates/plopfiles/_modules/desktop/electron/templates/package.json.hbs +22 -0
- package/dist/templates/plopfiles/_modules/desktop/electron/templates/src/main.ts.hbs +48 -0
- package/dist/templates/plopfiles/_modules/desktop/electron/templates/src/preload.ts.hbs +18 -0
- package/dist/templates/plopfiles/_modules/desktop/electron/templates/tsconfig.json.hbs +14 -0
- package/dist/templates/plopfiles/_modules/desktop/tauri/module.js +38 -0
- package/dist/templates/plopfiles/_modules/desktop/tauri/templates/src-tauri/Cargo.toml.hbs +20 -0
- package/dist/templates/plopfiles/_modules/desktop/tauri/templates/src-tauri/build.rs.hbs +3 -0
- package/dist/templates/plopfiles/_modules/desktop/tauri/templates/src-tauri/src/main.rs.hbs +30 -0
- package/dist/templates/plopfiles/_modules/desktop/tauri/templates/src-tauri/tauri.conf.json.hbs +44 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/module.js +61 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/architecture/components.md.hbs +37 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/architecture/overview.md.hbs +43 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/contributing/development.md.hbs +164 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/contributing/guidelines.md.hbs +50 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/getting-started/configuration.md.hbs +37 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/getting-started/installation.md.hbs +53 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/getting-started/quickstart.md.hbs +39 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/index.md.hbs +44 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/javascripts/extra.js.hbs +23 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/stylesheets/extra.css.hbs +51 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/mkdocs.yml.hbs +141 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/requirements-docs.txt.hbs +15 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/scripts/aggregate-docs.mjs.hbs +188 -0
- package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/scripts/gen_ref_pages.py.hbs +54 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/module.js +60 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/index.html.hbs +13 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/nginx.conf.hbs +31 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/postcss.config.js.hbs +6 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/src/App.tsx.hbs +12 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/src/index.css.hbs +25 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/src/lib/api.ts.hbs +52 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/src/main.tsx.hbs +18 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/src/pages/Home.tsx.hbs +31 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/tailwind.config.js.hbs +8 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/tsconfig.json.hbs +25 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/tsconfig.node.json.hbs +10 -0
- package/dist/templates/plopfiles/_modules/frontends/react-vite/templates/vite.config.ts.hbs +21 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/module.js +51 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/index.html.hbs +13 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/postcss.config.js.hbs +6 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/src/App.tsx.hbs +12 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/src/index.css.hbs +3 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/src/index.tsx.hbs +21 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/src/lib/api.ts.hbs +52 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/src/pages/Home.tsx.hbs +34 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/tailwind.config.js.hbs +8 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/tsconfig.json.hbs +24 -0
- package/dist/templates/plopfiles/_modules/frontends/solid-vite/templates/vite.config.ts.hbs +21 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/module.js +54 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/index.html.hbs +13 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/postcss.config.js.hbs +6 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/src/App.vue.hbs +9 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/src/index.css.hbs +3 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/src/lib/api.ts.hbs +52 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/src/main.ts.hbs +14 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/src/pages/Home.vue.hbs +27 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/src/router.ts.hbs +13 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/tailwind.config.js.hbs +8 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/tsconfig.json.hbs +25 -0
- package/dist/templates/plopfiles/_modules/frontends/vue-vite/templates/vite.config.ts.hbs +21 -0
- package/dist/templates/plopfiles/_modules/infra/docker-compose/module.js +52 -0
- package/dist/templates/plopfiles/_modules/infra/docker-compose/templates/Dockerfile.backend.hbs +32 -0
- package/dist/templates/plopfiles/_modules/infra/docker-compose/templates/Dockerfile.frontend.hbs +31 -0
- package/dist/templates/plopfiles/_modules/infra/docker-compose/templates/docker-compose.yml.hbs +97 -0
- package/dist/templates/plopfiles/_modules/infra/github-actions/module.js +24 -0
- package/dist/templates/plopfiles/_modules/infra/github-actions/templates/.github/workflows/ci.yml.hbs +78 -0
- package/dist/templates/plopfiles/_modules/infra/github-actions/templates/.github/workflows/deploy.yml.hbs +60 -0
- package/dist/templates/plopfiles/_modules/infra/just/module.js +26 -0
- package/dist/templates/plopfiles/_modules/infra/just/templates/justfile.hbs +205 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/module.js +30 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/base/deployment.yaml.hbs +48 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/base/ingress.yaml.hbs +23 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/base/kustomization.yaml.hbs +11 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/base/service.yaml.hbs +15 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/overlays/dev/deployment-patch.yaml.hbs +17 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/overlays/dev/kustomization.yaml.hbs +15 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/overlays/prod/deployment-patch.yaml.hbs +17 -0
- package/dist/templates/plopfiles/_modules/infra/kubernetes/templates/k8s/overlays/prod/kustomization.yaml.hbs +15 -0
- package/dist/templates/plopfiles/_modules/infra/pulumi/module.js +30 -0
- package/dist/templates/plopfiles/_modules/infra/pulumi/templates/.gitignore.hbs +5 -0
- package/dist/templates/plopfiles/_modules/infra/pulumi/templates/Pulumi.dev.yaml.hbs +3 -0
- package/dist/templates/plopfiles/_modules/infra/pulumi/templates/Pulumi.yaml.hbs +7 -0
- package/dist/templates/plopfiles/_modules/infra/pulumi/templates/index.ts.hbs +26 -0
- package/dist/templates/plopfiles/_modules/infra/pulumi/templates/package.json.hbs +12 -0
- package/dist/templates/plopfiles/_modules/infra/pulumi/templates/tsconfig.json.hbs +16 -0
- package/dist/templates/plopfiles/_modules/infra/terraform/module.js +31 -0
- package/dist/templates/plopfiles/_modules/infra/terraform/templates/.gitignore.hbs +12 -0
- package/dist/templates/plopfiles/_modules/infra/terraform/templates/main.tf.hbs +34 -0
- package/dist/templates/plopfiles/_modules/infra/terraform/templates/outputs.tf.hbs +15 -0
- package/dist/templates/plopfiles/_modules/infra/terraform/templates/terraform.tfvars.example.hbs +6 -0
- package/dist/templates/plopfiles/_modules/infra/terraform/templates/variables.tf.hbs +30 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/module.js +38 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/build.gradle.kts.hbs +102 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/proguard-rules.pro.hbs +20 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/AndroidManifest.xml.hbs +25 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/kotlin/com/example/app/ApiClient.kt.hbs +38 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/kotlin/com/example/app/App.kt.hbs +116 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/kotlin/com/example/app/MainActivity.kt.hbs +28 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/kotlin/com/example/app/ui/theme/Color.kt.hbs +11 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/kotlin/com/example/app/ui/theme/Theme.kt.hbs +55 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/kotlin/com/example/app/ui/theme/Type.kt.hbs +31 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/res/values/strings.xml.hbs +3 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/app/src/main/res/values/themes.xml.hbs +4 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/build.gradle.kts.hbs +6 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/gradle.properties.hbs +4 -0
- package/dist/templates/plopfiles/_modules/mobile/android-kotlin/templates/settings.gradle.kts.hbs +18 -0
- package/dist/templates/plopfiles/_modules/mobile/flutter/module.js +36 -0
- package/dist/templates/plopfiles/_modules/mobile/flutter/templates/.env.hbs +1 -0
- package/dist/templates/plopfiles/_modules/mobile/flutter/templates/lib/main.dart.hbs +29 -0
- package/dist/templates/plopfiles/_modules/mobile/flutter/templates/lib/screens/home_screen.dart.hbs +88 -0
- package/dist/templates/plopfiles/_modules/mobile/flutter/templates/lib/services/api_service.dart.hbs +61 -0
- package/dist/templates/plopfiles/_modules/mobile/flutter/templates/pubspec.yaml.hbs +25 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/module.js +39 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/App.swift.hbs +10 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/Assets.xcassets/AccentColor.colorset/Contents.json.hbs +11 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/Assets.xcassets/AppIcon.appiconset/Contents.json.hbs +13 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/Assets.xcassets/Contents.json.hbs +6 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/ContentView.swift.hbs +13 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/Services/APIClient.swift.hbs +58 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/Views/DetailsView.swift.hbs +22 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App/Views/HomeView.swift.hbs +62 -0
- package/dist/templates/plopfiles/_modules/mobile/ios-swift/templates/App.xcodeproj/project.pbxproj.hbs +363 -0
- package/dist/templates/plopfiles/_modules/mobile/react-native/module.js +36 -0
- package/dist/templates/plopfiles/_modules/mobile/react-native/templates/app/_layout.tsx.hbs +16 -0
- package/dist/templates/plopfiles/_modules/mobile/react-native/templates/app/index.tsx.hbs +66 -0
- package/dist/templates/plopfiles/_modules/mobile/react-native/templates/app.json.hbs +37 -0
- package/dist/templates/plopfiles/_modules/mobile/react-native/templates/package.json.hbs +29 -0
- package/dist/templates/plopfiles/_modules/mobile/react-native/templates/src/lib/api.ts.hbs +52 -0
- package/dist/templates/plopfiles/_modules/mobile/react-native/templates/tsconfig.json.hbs +11 -0
- package/dist/templates/plopfiles/_modules/quality/biome/module.js +44 -0
- package/dist/templates/plopfiles/_modules/quality/biome/templates/biome.json.hbs +126 -0
- package/dist/templates/plopfiles/_modules/quality/clippy/module.js +40 -0
- package/dist/templates/plopfiles/_modules/quality/clippy/templates/clippy.toml.hbs +29 -0
- package/dist/templates/plopfiles/_modules/quality/clippy/templates/rustfmt.toml.hbs +44 -0
- package/dist/templates/plopfiles/_modules/quality/golangci-lint/module.js +40 -0
- package/dist/templates/plopfiles/_modules/quality/golangci-lint/templates/.golangci.yml.hbs +199 -0
- package/dist/templates/plopfiles/_modules/quality/ruff/module.js +43 -0
- package/dist/templates/plopfiles/_modules/quality/ruff/templates/mypy.ini.hbs +48 -0
- package/dist/templates/plopfiles/_modules/quality/ruff/templates/ruff.toml.hbs +111 -0
- package/dist/templates/plopfiles/_modules/storybook/react-storybook/module.js +54 -0
- package/dist/templates/plopfiles/_modules/storybook/react-storybook/templates/.storybook/main.ts.hbs +44 -0
- package/dist/templates/plopfiles/_modules/storybook/react-storybook/templates/.storybook/preview.ts.hbs +68 -0
- package/dist/templates/plopfiles/_modules/storybook/react-storybook/templates/src/stories/Button.stories.tsx.hbs +158 -0
- package/dist/templates/plopfiles/_modules/types.ts +98 -0
- package/dist/templates/plopfiles/full-stack/plopfile.js +132 -0
- package/dist/templates/plopfiles/full-stack/templates/gitignore.hbs +44 -0
- package/dist/templates/plopfiles/full-stack/templates/package.json.hbs +21 -0
- package/dist/templates/plopfiles/presets/cli-go/module.js +43 -0
- package/dist/templates/plopfiles/presets/cli-go/templates/README.md.hbs +42 -0
- package/dist/templates/plopfiles/presets/cli-go/templates/config.json.hbs +9 -0
- package/dist/templates/plopfiles/presets/cli-node/module.js +45 -0
- package/dist/templates/plopfiles/presets/cli-node/templates/README.md.hbs +42 -0
- package/dist/templates/plopfiles/presets/cli-node/templates/config.json.hbs +9 -0
- package/dist/templates/plopfiles/presets/cli-python/module.js +43 -0
- package/dist/templates/plopfiles/presets/cli-python/templates/README.md.hbs +42 -0
- package/dist/templates/plopfiles/presets/cli-python/templates/config.json.hbs +9 -0
- package/dist/templates/plopfiles/presets/cli-rust/module.js +43 -0
- package/dist/templates/plopfiles/presets/cli-rust/templates/README.md.hbs +42 -0
- package/dist/templates/plopfiles/presets/cli-rust/templates/config.json.hbs +9 -0
- package/dist/templates/plopfiles/presets/loader.js +125 -0
- package/dist/templates/plopfiles/typescript-service/plopfile.js +186 -0
- package/dist/templates/plopfiles/typescript-service/templates/Dockerfile.hbs +29 -0
- package/dist/templates/plopfiles/typescript-service/templates/README.md.hbs +85 -0
- package/dist/templates/plopfiles/typescript-service/templates/config.ts.hbs +15 -0
- package/dist/templates/plopfiles/typescript-service/templates/db/index.ts.hbs +19 -0
- package/dist/templates/plopfiles/typescript-service/templates/db/schema.ts.hbs +16 -0
- package/dist/templates/plopfiles/typescript-service/templates/index.ts.hbs +89 -0
- package/dist/templates/plopfiles/typescript-service/templates/package.json.hbs +36 -0
- package/dist/templates/plopfiles/typescript-service/templates/routes/health.ts.hbs +61 -0
- package/dist/templates/plopfiles/typescript-service/templates/routes/index.ts.hbs +35 -0
- package/dist/templates/plopfiles/typescript-service/templates/tsconfig.json.hbs +24 -0
- package/dist/templates/plopfiles/typescript-service/templates/types.ts.hbs +28 -0
- package/dist/templates/typescript/component.module.css.tpl +6 -0
- package/dist/templates/typescript/component.test.tsx.tpl +9 -0
- package/dist/templates/typescript/component.tsx.tpl +17 -0
- package/dist/templates/typescript/component.types.ts.tpl +3 -0
- package/dist/templates/typescript/project/nextjs/app/globals.css.tpl +10 -0
- package/dist/templates/typescript/project/nextjs/app/layout.tsx.tpl +15 -0
- package/dist/templates/typescript/project/nextjs/app/page.tsx.tpl +8 -0
- package/dist/templates/typescript/project/nextjs/babel.config.js.tpl +8 -0
- package/dist/templates/typescript/project/nextjs/jest.config.js.tpl +10 -0
- package/dist/templates/typescript/project/nextjs/jest.setup.ts.tpl +6 -0
- package/dist/templates/typescript/project/nextjs/next-env.d.ts.tpl +5 -0
- package/dist/templates/typescript/project/nextjs/next.config.js.tpl +9 -0
- package/dist/templates/typescript/project/nextjs/package.json.tpl +1 -0
- package/dist/templates/typescript/project/nextjs/tsconfig.json.tpl +1 -0
- package/dist/templates/typescript/project/vite/App.css.tpl +8 -0
- package/dist/templates/typescript/project/vite/App.tsx.tpl +17 -0
- package/dist/templates/typescript/project/vite/index.css.tpl +8 -0
- package/dist/templates/typescript/project/vite/index.html.tpl +13 -0
- package/dist/templates/typescript/project/vite/main.tsx.tpl +10 -0
- package/dist/templates/typescript/project/vite/package.json.tpl +1 -0
- package/dist/templates/typescript/project/vite/test-setup.ts.tpl +1 -0
- package/dist/templates/typescript/project/vite/tsconfig.build.json.tpl +1 -0
- package/dist/templates/typescript/project/vite/tsconfig.json.tpl +1 -0
- package/dist/templates/typescript/project/vite/tsconfig.node.json.tpl +1 -0
- package/dist/templates/typescript/project/vite/vite.config.ts.tpl +18 -0
- package/dist/templates/typescript/service.api.ts.tpl +27 -0
- package/dist/templates/typescript/service.class.ts.tpl +28 -0
- package/dist/templates/typescript/service.handler.ts.tpl +42 -0
- package/dist/templates/typescript/service.schema.ts.tpl +16 -0
- package/package.json +95 -0
- package/templates/typescript/component.module.css.tpl +6 -0
- package/templates/typescript/component.test.tsx.tpl +9 -0
- package/templates/typescript/component.tsx.tpl +17 -0
- package/templates/typescript/component.types.ts.tpl +3 -0
- package/templates/typescript/project/nextjs/app/globals.css.tpl +10 -0
- package/templates/typescript/project/nextjs/app/layout.tsx.tpl +15 -0
- package/templates/typescript/project/nextjs/app/page.tsx.tpl +8 -0
- package/templates/typescript/project/nextjs/babel.config.js.tpl +8 -0
- package/templates/typescript/project/nextjs/jest.config.js.tpl +10 -0
- package/templates/typescript/project/nextjs/jest.setup.ts.tpl +6 -0
- package/templates/typescript/project/nextjs/next-env.d.ts.tpl +5 -0
- package/templates/typescript/project/nextjs/next.config.js.tpl +9 -0
- package/templates/typescript/project/nextjs/package.json.tpl +1 -0
- package/templates/typescript/project/nextjs/tsconfig.json.tpl +1 -0
- package/templates/typescript/project/vite/App.css.tpl +8 -0
- package/templates/typescript/project/vite/App.tsx.tpl +17 -0
- package/templates/typescript/project/vite/index.css.tpl +8 -0
- package/templates/typescript/project/vite/index.html.tpl +13 -0
- package/templates/typescript/project/vite/main.tsx.tpl +10 -0
- package/templates/typescript/project/vite/package.json.tpl +1 -0
- package/templates/typescript/project/vite/test-setup.ts.tpl +1 -0
- package/templates/typescript/project/vite/tsconfig.build.json.tpl +1 -0
- package/templates/typescript/project/vite/tsconfig.json.tpl +1 -0
- package/templates/typescript/project/vite/tsconfig.node.json.tpl +1 -0
- package/templates/typescript/project/vite/vite.config.ts.tpl +18 -0
- package/templates/typescript/service.api.ts.tpl +27 -0
- package/templates/typescript/service.class.ts.tpl +28 -0
- package/templates/typescript/service.handler.ts.tpl +42 -0
- package/templates/typescript/service.schema.ts.tpl +16 -0
package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/architecture/components.md.hbs
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Components
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This document describes the key components of {{titleCase name}}.
|
|
6
|
+
|
|
7
|
+
{{#if modules}}
|
|
8
|
+
{{#each modules}}
|
|
9
|
+
## {{titleCase this}}
|
|
10
|
+
|
|
11
|
+
The {{this}} component provides core functionality.
|
|
12
|
+
|
|
13
|
+
### Responsibilities
|
|
14
|
+
|
|
15
|
+
- Primary feature implementation
|
|
16
|
+
- Integration with other components
|
|
17
|
+
|
|
18
|
+
### Usage
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { {{camelCase this}} } from '{{../name}}/{{this}}';
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
{{/each}}
|
|
25
|
+
{{else}}
|
|
26
|
+
## Core
|
|
27
|
+
|
|
28
|
+
The main application component.
|
|
29
|
+
|
|
30
|
+
## API
|
|
31
|
+
|
|
32
|
+
REST API endpoints and handlers.
|
|
33
|
+
|
|
34
|
+
## Data
|
|
35
|
+
|
|
36
|
+
Database models and repositories.
|
|
37
|
+
{{/if}}
|
package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/architecture/overview.md.hbs
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Architecture Overview
|
|
2
|
+
|
|
3
|
+
## System Design
|
|
4
|
+
|
|
5
|
+
{{titleCase name}} follows a modular architecture designed for scalability and maintainability.
|
|
6
|
+
|
|
7
|
+
```mermaid
|
|
8
|
+
graph TB
|
|
9
|
+
A[Client] --> B[API Gateway]
|
|
10
|
+
B --> C[Services]
|
|
11
|
+
C --> D[Database]
|
|
12
|
+
C --> E[Cache]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Components
|
|
16
|
+
|
|
17
|
+
{{#if modules}}
|
|
18
|
+
{{#each modules}}
|
|
19
|
+
### {{titleCase this}}
|
|
20
|
+
|
|
21
|
+
Module responsible for {{this}} functionality.
|
|
22
|
+
|
|
23
|
+
{{/each}}
|
|
24
|
+
{{else}}
|
|
25
|
+
### Core Module
|
|
26
|
+
|
|
27
|
+
The main application logic.
|
|
28
|
+
|
|
29
|
+
### API Layer
|
|
30
|
+
|
|
31
|
+
RESTful API endpoints.
|
|
32
|
+
|
|
33
|
+
### Data Layer
|
|
34
|
+
|
|
35
|
+
Database and caching.
|
|
36
|
+
{{/if}}
|
|
37
|
+
|
|
38
|
+
## Design Principles
|
|
39
|
+
|
|
40
|
+
1. **Modularity** - Each component is self-contained
|
|
41
|
+
2. **Testability** - All components are unit testable
|
|
42
|
+
3. **Scalability** - Horizontal scaling support
|
|
43
|
+
4. **Observability** - Built-in metrics and logging
|
package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/contributing/development.md.hbs
ADDED
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# Development Setup
|
|
2
|
+
|
|
3
|
+
## Prerequisites
|
|
4
|
+
|
|
5
|
+
- Node.js 18+ or Bun 1.0+
|
|
6
|
+
- Git
|
|
7
|
+
- Python 3.10+ (for docs)
|
|
8
|
+
{{#if useDocker}}
|
|
9
|
+
- Docker & Docker Compose
|
|
10
|
+
{{/if}}
|
|
11
|
+
|
|
12
|
+
## Getting Started
|
|
13
|
+
|
|
14
|
+
### 1. Clone the Repository
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
git clone https://github.com/{{author}}/{{name}}.git
|
|
18
|
+
cd {{name}}
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### 2. Install Dependencies
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
{{#if useBun}}
|
|
25
|
+
bun install
|
|
26
|
+
{{else}}
|
|
27
|
+
npm install
|
|
28
|
+
{{/if}}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### 3. Set Up Environment
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
cp .env.example .env
|
|
35
|
+
# Edit .env with your values
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### 4. Start Development Server
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
{{#if useBun}}
|
|
42
|
+
bun run dev
|
|
43
|
+
{{else}}
|
|
44
|
+
npm run dev
|
|
45
|
+
{{/if}}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Code Quality
|
|
49
|
+
|
|
50
|
+
### Linting
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# Check for issues
|
|
54
|
+
{{#if useBun}}
|
|
55
|
+
bun run lint
|
|
56
|
+
{{else}}
|
|
57
|
+
npm run lint
|
|
58
|
+
{{/if}}
|
|
59
|
+
|
|
60
|
+
# Auto-fix issues
|
|
61
|
+
{{#if useBun}}
|
|
62
|
+
bun run lint:fix
|
|
63
|
+
{{else}}
|
|
64
|
+
npm run lint:fix
|
|
65
|
+
{{/if}}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Formatting
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
{{#if useBun}}
|
|
72
|
+
bun run format
|
|
73
|
+
{{else}}
|
|
74
|
+
npm run format
|
|
75
|
+
{{/if}}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Type Checking
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
{{#if useBun}}
|
|
82
|
+
bun run typecheck
|
|
83
|
+
{{else}}
|
|
84
|
+
npm run typecheck
|
|
85
|
+
{{/if}}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Testing
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
# Run all tests
|
|
92
|
+
{{#if useBun}}
|
|
93
|
+
bun test
|
|
94
|
+
{{else}}
|
|
95
|
+
npm test
|
|
96
|
+
{{/if}}
|
|
97
|
+
|
|
98
|
+
# Run with coverage
|
|
99
|
+
{{#if useBun}}
|
|
100
|
+
bun test --coverage
|
|
101
|
+
{{else}}
|
|
102
|
+
npm run test:coverage
|
|
103
|
+
{{/if}}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Documentation
|
|
107
|
+
|
|
108
|
+
### Build Docs
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
# Install Python dependencies
|
|
112
|
+
pip install -r requirements-docs.txt
|
|
113
|
+
|
|
114
|
+
# Serve locally
|
|
115
|
+
mkdocs serve
|
|
116
|
+
|
|
117
|
+
# Build for production
|
|
118
|
+
mkdocs build
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### API Documentation
|
|
122
|
+
|
|
123
|
+
API documentation is auto-generated from source code comments.
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
{{#if useBun}}
|
|
127
|
+
bun run docs:backend
|
|
128
|
+
{{else}}
|
|
129
|
+
npm run docs:backend
|
|
130
|
+
{{/if}}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Project Structure
|
|
134
|
+
|
|
135
|
+
```
|
|
136
|
+
{{name}}/
|
|
137
|
+
├── .arbiter/ # Arbiter spec files
|
|
138
|
+
├── backend/ # Backend service
|
|
139
|
+
├── frontend/ # Frontend app
|
|
140
|
+
├── docs/ # Documentation
|
|
141
|
+
├── scripts/ # Build scripts
|
|
142
|
+
└── tests/ # Integration tests
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## IDE Setup
|
|
146
|
+
|
|
147
|
+
### VS Code
|
|
148
|
+
|
|
149
|
+
Recommended extensions:
|
|
150
|
+
|
|
151
|
+
- Biome (for JS/TS)
|
|
152
|
+
- Tailwind CSS IntelliSense
|
|
153
|
+
- TypeScript Vue Plugin (if using Vue)
|
|
154
|
+
|
|
155
|
+
### Settings
|
|
156
|
+
|
|
157
|
+
Add to `.vscode/settings.json`:
|
|
158
|
+
|
|
159
|
+
```json
|
|
160
|
+
{
|
|
161
|
+
"editor.defaultFormatter": "biomejs.biome",
|
|
162
|
+
"editor.formatOnSave": true
|
|
163
|
+
}
|
|
164
|
+
```
|
package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/contributing/guidelines.md.hbs
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Contributing Guidelines
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to {{titleCase name}}!
|
|
4
|
+
|
|
5
|
+
## Code of Conduct
|
|
6
|
+
|
|
7
|
+
Please read and follow our [Code of Conduct](https://github.com/{{author}}/{{name}}/blob/main/CODE_OF_CONDUCT.md).
|
|
8
|
+
|
|
9
|
+
## How to Contribute
|
|
10
|
+
|
|
11
|
+
### Reporting Bugs
|
|
12
|
+
|
|
13
|
+
1. Check existing issues first
|
|
14
|
+
2. Use the bug report template
|
|
15
|
+
3. Provide reproduction steps
|
|
16
|
+
|
|
17
|
+
### Suggesting Features
|
|
18
|
+
|
|
19
|
+
1. Open a discussion first
|
|
20
|
+
2. Describe the use case
|
|
21
|
+
3. Consider implementation impact
|
|
22
|
+
|
|
23
|
+
### Pull Requests
|
|
24
|
+
|
|
25
|
+
1. Fork the repository
|
|
26
|
+
2. Create a feature branch
|
|
27
|
+
3. Follow coding standards
|
|
28
|
+
4. Write tests
|
|
29
|
+
5. Update documentation
|
|
30
|
+
6. Submit PR
|
|
31
|
+
|
|
32
|
+
## Coding Standards
|
|
33
|
+
|
|
34
|
+
- Use TypeScript strict mode
|
|
35
|
+
- Follow ESLint/Biome rules
|
|
36
|
+
- Write JSDoc comments
|
|
37
|
+
- Keep functions small
|
|
38
|
+
- Write meaningful commit messages
|
|
39
|
+
|
|
40
|
+
## Commit Messages
|
|
41
|
+
|
|
42
|
+
Follow [Conventional Commits](https://www.conventionalcommits.org/):
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
feat: add new feature
|
|
46
|
+
fix: resolve bug
|
|
47
|
+
docs: update documentation
|
|
48
|
+
test: add tests
|
|
49
|
+
refactor: restructure code
|
|
50
|
+
```
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Configuration
|
|
2
|
+
|
|
3
|
+
## Environment Variables
|
|
4
|
+
|
|
5
|
+
| Variable | Description | Default |
|
|
6
|
+
|----------|-------------|---------|
|
|
7
|
+
{{#each envVars}}
|
|
8
|
+
| `{{@key}}` | Configuration value | `{{this}}` |
|
|
9
|
+
{{/each}}
|
|
10
|
+
{{#unless envVars}}
|
|
11
|
+
| `NODE_ENV` | Environment mode | `development` |
|
|
12
|
+
| `PORT` | Server port | `3000` |
|
|
13
|
+
{{/unless}}
|
|
14
|
+
|
|
15
|
+
## Configuration File
|
|
16
|
+
|
|
17
|
+
Create a `{{name}}.config.js` file in your project root:
|
|
18
|
+
|
|
19
|
+
```javascript
|
|
20
|
+
export default {
|
|
21
|
+
// Your configuration here
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## TypeScript Support
|
|
26
|
+
|
|
27
|
+
For TypeScript projects, use `{{name}}.config.ts`:
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import type { Config } from '{{name}}';
|
|
31
|
+
|
|
32
|
+
const config: Config = {
|
|
33
|
+
// Type-safe configuration
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
export default config;
|
|
37
|
+
```
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Installation
|
|
2
|
+
|
|
3
|
+
## Prerequisites
|
|
4
|
+
|
|
5
|
+
- Node.js 18+ (or Bun 1.0+)
|
|
6
|
+
- Git
|
|
7
|
+
|
|
8
|
+
## Quick Install
|
|
9
|
+
|
|
10
|
+
=== "npm"
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install {{name}}
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
=== "pnpm"
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pnpm add {{name}}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
=== "bun"
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
bun add {{name}}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## From Source
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
git clone https://github.com/{{author}}/{{name}}.git
|
|
32
|
+
cd {{name}}
|
|
33
|
+
{{#if useBun}}
|
|
34
|
+
bun install
|
|
35
|
+
{{else}}
|
|
36
|
+
npm install
|
|
37
|
+
{{/if}}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Verify Installation
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
{{#if useBun}}
|
|
44
|
+
bun run --version
|
|
45
|
+
{{else}}
|
|
46
|
+
npm run --version
|
|
47
|
+
{{/if}}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Next Steps
|
|
51
|
+
|
|
52
|
+
- [Quick Start Guide](quickstart.md)
|
|
53
|
+
- [Configuration](configuration.md)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Quick Start
|
|
2
|
+
|
|
3
|
+
Get up and running with {{titleCase name}} in minutes.
|
|
4
|
+
|
|
5
|
+
## Basic Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Start development server
|
|
9
|
+
{{#if useBun}}
|
|
10
|
+
bun run dev
|
|
11
|
+
{{else}}
|
|
12
|
+
npm run dev
|
|
13
|
+
{{/if}}
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
// Example usage
|
|
20
|
+
import { {{camelCase name}} } from '{{name}}';
|
|
21
|
+
|
|
22
|
+
const app = {{camelCase name}}();
|
|
23
|
+
app.start();
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Configuration
|
|
27
|
+
|
|
28
|
+
Create a configuration file:
|
|
29
|
+
|
|
30
|
+
```yaml
|
|
31
|
+
# config.yaml
|
|
32
|
+
name: {{name}}
|
|
33
|
+
environment: development
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## What's Next?
|
|
37
|
+
|
|
38
|
+
- [Configuration Guide](configuration.md) - Customize your setup
|
|
39
|
+
- [Architecture Overview](../architecture/overview.md) - Understand how it works
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# {{titleCase name}}
|
|
2
|
+
|
|
3
|
+
Welcome to the {{titleCase name}} documentation.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
{{description}}
|
|
8
|
+
|
|
9
|
+
## Quick Links
|
|
10
|
+
|
|
11
|
+
- [Getting Started](getting-started/installation.md) - Install and configure {{titleCase name}}
|
|
12
|
+
- [Architecture](architecture/overview.md) - Understand the system design
|
|
13
|
+
- [API Reference](reference/) - Detailed API documentation
|
|
14
|
+
- [Contributing](contributing/guidelines.md) - Help improve {{titleCase name}}
|
|
15
|
+
|
|
16
|
+
## Features
|
|
17
|
+
|
|
18
|
+
{{#if capabilities}}
|
|
19
|
+
{{#each capabilities}}
|
|
20
|
+
- **{{titleCase this}}** - Core capability
|
|
21
|
+
{{/each}}
|
|
22
|
+
{{else}}
|
|
23
|
+
- Feature-rich and extensible
|
|
24
|
+
- Well-documented API
|
|
25
|
+
- Easy to configure
|
|
26
|
+
{{/if}}
|
|
27
|
+
|
|
28
|
+
## Project Structure
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
{{name}}/
|
|
32
|
+
{{#if modules}}
|
|
33
|
+
{{#each modules}}
|
|
34
|
+
├── {{this}}/ # {{titleCase this}} module
|
|
35
|
+
{{/each}}
|
|
36
|
+
{{/if}}
|
|
37
|
+
├── docs/ # Documentation
|
|
38
|
+
└── README.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Getting Help
|
|
42
|
+
|
|
43
|
+
- [GitHub Issues](https://github.com/{{author}}/{{name}}/issues) - Report bugs or request features
|
|
44
|
+
- [Discussions](https://github.com/{{author}}/{{name}}/discussions) - Ask questions and share ideas
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
// Custom JavaScript for {{name}} documentation
|
|
2
|
+
|
|
3
|
+
// Add copy button feedback
|
|
4
|
+
document.addEventListener("DOMContentLoaded", () => {
|
|
5
|
+
// Enhanced code copy functionality
|
|
6
|
+
document.querySelectorAll(".highlight button.md-clipboard").forEach((button) => {
|
|
7
|
+
button.addEventListener("click", () => {
|
|
8
|
+
const tooltip = button.querySelector(".md-clipboard__message");
|
|
9
|
+
if (tooltip) {
|
|
10
|
+
tooltip.textContent = "Copied!";
|
|
11
|
+
setTimeout(() => {
|
|
12
|
+
tooltip.textContent = "";
|
|
13
|
+
}, 2000);
|
|
14
|
+
}
|
|
15
|
+
});
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
// Add external link icons
|
|
19
|
+
document.querySelectorAll('a[href^="http"]:not([href*="{{name}}"])').forEach((link) => {
|
|
20
|
+
link.setAttribute("target", "_blank");
|
|
21
|
+
link.setAttribute("rel", "noopener noreferrer");
|
|
22
|
+
});
|
|
23
|
+
});
|
package/dist/templates/plopfiles/_modules/docs/mkdocs/templates/docs/stylesheets/extra.css.hbs
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/* Custom styles for {{name}} documentation */
|
|
2
|
+
|
|
3
|
+
:root {
|
|
4
|
+
--md-primary-fg-color: #5c6bc0;
|
|
5
|
+
--md-primary-fg-color--light: #8e99a4;
|
|
6
|
+
--md-primary-fg-color--dark: #3949ab;
|
|
7
|
+
--md-accent-fg-color: #7c4dff;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
/* Code block improvements */
|
|
11
|
+
.highlight code {
|
|
12
|
+
font-family: "JetBrains Mono", "Fira Code", monospace;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/* Better inline code */
|
|
16
|
+
code {
|
|
17
|
+
padding: 0.2em 0.4em;
|
|
18
|
+
border-radius: 3px;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
/* Table improvements */
|
|
22
|
+
.md-typeset table:not([class]) {
|
|
23
|
+
display: table;
|
|
24
|
+
width: 100%;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/* Admonition icons */
|
|
28
|
+
.md-typeset .admonition.tip,
|
|
29
|
+
.md-typeset details.tip {
|
|
30
|
+
border-color: #00bfa5;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/* Better heading spacing */
|
|
34
|
+
.md-typeset h2 {
|
|
35
|
+
margin-top: 1.5em;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
.md-typeset h3 {
|
|
39
|
+
margin-top: 1.25em;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/* API reference styling */
|
|
43
|
+
.doc-heading {
|
|
44
|
+
font-family: "JetBrains Mono", monospace;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/* Mermaid diagram styling */
|
|
48
|
+
.mermaid {
|
|
49
|
+
text-align: center;
|
|
50
|
+
margin: 2em 0;
|
|
51
|
+
}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
site_name: {{titleCase name}} Documentation
|
|
2
|
+
site_description: Documentation for {{name}}
|
|
3
|
+
site_author: {{author}}
|
|
4
|
+
site_url: https://{{name}}.github.io/docs
|
|
5
|
+
|
|
6
|
+
repo_name: {{name}}
|
|
7
|
+
repo_url: https://github.com/{{author}}/{{name}}
|
|
8
|
+
edit_uri: edit/main/docs/
|
|
9
|
+
|
|
10
|
+
theme:
|
|
11
|
+
name: material
|
|
12
|
+
palette:
|
|
13
|
+
# Light mode
|
|
14
|
+
- media: "(prefers-color-scheme: light)"
|
|
15
|
+
scheme: default
|
|
16
|
+
primary: indigo
|
|
17
|
+
accent: indigo
|
|
18
|
+
toggle:
|
|
19
|
+
icon: material/brightness-7
|
|
20
|
+
name: Switch to dark mode
|
|
21
|
+
# Dark mode
|
|
22
|
+
- media: "(prefers-color-scheme: dark)"
|
|
23
|
+
scheme: slate
|
|
24
|
+
primary: indigo
|
|
25
|
+
accent: indigo
|
|
26
|
+
toggle:
|
|
27
|
+
icon: material/brightness-4
|
|
28
|
+
name: Switch to light mode
|
|
29
|
+
features:
|
|
30
|
+
- navigation.instant
|
|
31
|
+
- navigation.tracking
|
|
32
|
+
- navigation.tabs
|
|
33
|
+
- navigation.tabs.sticky
|
|
34
|
+
- navigation.sections
|
|
35
|
+
- navigation.expand
|
|
36
|
+
- navigation.path
|
|
37
|
+
- navigation.indexes
|
|
38
|
+
- navigation.top
|
|
39
|
+
- search.suggest
|
|
40
|
+
- search.highlight
|
|
41
|
+
- content.tabs.link
|
|
42
|
+
- content.code.copy
|
|
43
|
+
- content.code.annotate
|
|
44
|
+
icon:
|
|
45
|
+
repo: fontawesome/brands/github
|
|
46
|
+
|
|
47
|
+
plugins:
|
|
48
|
+
- search
|
|
49
|
+
- monorepo
|
|
50
|
+
- awesome-pages
|
|
51
|
+
- git-revision-date-localized:
|
|
52
|
+
enable_creation_date: true
|
|
53
|
+
type: timeago
|
|
54
|
+
- minify:
|
|
55
|
+
minify_html: true
|
|
56
|
+
- mkdocstrings:
|
|
57
|
+
handlers:
|
|
58
|
+
python:
|
|
59
|
+
options:
|
|
60
|
+
show_source: true
|
|
61
|
+
show_root_heading: true
|
|
62
|
+
- gen-files:
|
|
63
|
+
scripts:
|
|
64
|
+
- scripts/gen_ref_pages.py
|
|
65
|
+
- literate-nav:
|
|
66
|
+
nav_file: SUMMARY.md
|
|
67
|
+
- section-index
|
|
68
|
+
|
|
69
|
+
markdown_extensions:
|
|
70
|
+
- abbr
|
|
71
|
+
- admonition
|
|
72
|
+
- attr_list
|
|
73
|
+
- def_list
|
|
74
|
+
- footnotes
|
|
75
|
+
- md_in_html
|
|
76
|
+
- tables
|
|
77
|
+
- toc:
|
|
78
|
+
permalink: true
|
|
79
|
+
- pymdownx.arithmatex:
|
|
80
|
+
generic: true
|
|
81
|
+
- pymdownx.betterem:
|
|
82
|
+
smart_enable: all
|
|
83
|
+
- pymdownx.caret
|
|
84
|
+
- pymdownx.details
|
|
85
|
+
- pymdownx.emoji:
|
|
86
|
+
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
87
|
+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
88
|
+
- pymdownx.highlight:
|
|
89
|
+
anchor_linenums: true
|
|
90
|
+
line_spans: __span
|
|
91
|
+
pygments_lang_class: true
|
|
92
|
+
- pymdownx.inlinehilite
|
|
93
|
+
- pymdownx.keys
|
|
94
|
+
- pymdownx.magiclink:
|
|
95
|
+
repo_url_shorthand: true
|
|
96
|
+
user: {{author}}
|
|
97
|
+
repo: {{name}}
|
|
98
|
+
- pymdownx.mark
|
|
99
|
+
- pymdownx.smartsymbols
|
|
100
|
+
- pymdownx.superfences:
|
|
101
|
+
custom_fences:
|
|
102
|
+
- name: mermaid
|
|
103
|
+
class: mermaid
|
|
104
|
+
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
105
|
+
- pymdownx.tabbed:
|
|
106
|
+
alternate_style: true
|
|
107
|
+
- pymdownx.tasklist:
|
|
108
|
+
custom_checkbox: true
|
|
109
|
+
- pymdownx.tilde
|
|
110
|
+
|
|
111
|
+
nav:
|
|
112
|
+
- Home: index.md
|
|
113
|
+
- Getting Started:
|
|
114
|
+
- Installation: getting-started/installation.md
|
|
115
|
+
- Quick Start: getting-started/quickstart.md
|
|
116
|
+
- Configuration: getting-started/configuration.md
|
|
117
|
+
- Architecture:
|
|
118
|
+
- Overview: architecture/overview.md
|
|
119
|
+
- Components: architecture/components.md
|
|
120
|
+
- API Reference: reference/
|
|
121
|
+
- Contributing:
|
|
122
|
+
- Guidelines: contributing/guidelines.md
|
|
123
|
+
- Development: contributing/development.md
|
|
124
|
+
{{#each subprojects}}
|
|
125
|
+
- "!include ./{{this}}/mkdocs.yml"
|
|
126
|
+
{{/each}}
|
|
127
|
+
|
|
128
|
+
extra:
|
|
129
|
+
social:
|
|
130
|
+
- icon: fontawesome/brands/github
|
|
131
|
+
link: https://github.com/{{author}}/{{name}}
|
|
132
|
+
generator: false
|
|
133
|
+
analytics:
|
|
134
|
+
provider: google
|
|
135
|
+
property: G-XXXXXXXXXX
|
|
136
|
+
|
|
137
|
+
extra_css:
|
|
138
|
+
- stylesheets/extra.css
|
|
139
|
+
|
|
140
|
+
extra_javascript:
|
|
141
|
+
- javascripts/extra.js
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# MkDocs and plugins
|
|
2
|
+
mkdocs>=1.5.0
|
|
3
|
+
mkdocs-material>=9.5.0
|
|
4
|
+
mkdocs-monorepo-plugin>=1.0.0
|
|
5
|
+
mkdocs-awesome-pages-plugin>=2.9.0
|
|
6
|
+
mkdocs-git-revision-date-localized-plugin>=1.2.0
|
|
7
|
+
mkdocs-minify-plugin>=0.7.0
|
|
8
|
+
mkdocstrings[python]>=0.24.0
|
|
9
|
+
mkdocs-gen-files>=0.5.0
|
|
10
|
+
mkdocs-literate-nav>=0.6.0
|
|
11
|
+
mkdocs-section-index>=0.3.0
|
|
12
|
+
|
|
13
|
+
# Additional utilities
|
|
14
|
+
pymdown-extensions>=10.0
|
|
15
|
+
pygments>=2.17.0
|