diff --git a/.github/workflows/deploy-netlify.yml b/.github/workflows/deploy-netlify.yml new file mode 100644 index 0000000..449a243 --- /dev/null +++ b/.github/workflows/deploy-netlify.yml @@ -0,0 +1,47 @@ +name: Deploy to Netlify + +on: + push: + branches: ["main"] + paths: + - "site/**" + - "docs/**" + - "mkdocs.yml" + - "requirements.docs.txt" + pull_request: + workflow_dispatch: + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 # Needed for git-revision-date-localized plugin + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + cache: 'pip' + + - name: Install MkDocs dependencies + run: pip install -r requirements.docs.txt + + - name: Build MkDocs documentation + run: mkdocs build + + - name: Deploy to Netlify + uses: nwtgck/actions-netlify@v3.0 + with: + publish-dir: './site' + production-branch: main + github-token: ${{ secrets.GITHUB_TOKEN }} + deploy-message: "Deploy from GitHub Actions" + enable-pull-request-comment: true + enable-commit-comment: true + overwrites-pull-request-comment: true + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} + timeout-minutes: 1 diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml deleted file mode 100644 index c02ee72..0000000 --- a/.github/workflows/deploy-pages.yml +++ /dev/null @@ -1,59 +0,0 @@ -name: deploy-pages - -on: - push: - branches: ["main"] - paths: - - "site/**" - - "docs/**" - - "mkdocs.yml" - - "requirements.docs.txt" - - workflow_dispatch: - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: "pages" - cancel-in-progress: false - -jobs: - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 # Needed for git-revision-date-localized plugin - - - name: Setup Python - uses: actions/setup-python@v4 - with: - python-version: '3.x' - cache: 'pip' - - - name: Install MkDocs dependencies - run: | - pip install -r requirements.docs.txt - - - name: Build MkDocs documentation - run: | - mkdocs build - - - name: Setup Pages - uses: actions/configure-pages@v5 - - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: './site' - - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/NETLIFY_MIGRATION_SUMMARY.md b/NETLIFY_MIGRATION_SUMMARY.md new file mode 100644 index 0000000..eaa0f81 --- /dev/null +++ b/NETLIFY_MIGRATION_SUMMARY.md @@ -0,0 +1,99 @@ +# Netlify Migration Implementation Summary + +This document summarizes the implementation of issue #86: "Migrate documentation from GitHub Pages to Netlify". + +## ✅ Completed Tasks + +### 1. GitHub Workflow Migration +- ✅ **Removed** `.github/workflows/deploy-pages.yml` (GitHub Pages workflow) +- ✅ **Added** `.github/workflows/deploy-netlify.yml` with: + - Uses `nwtgck/actions-netlify@v3.0` action + - Configured for pull request comments and commit status updates + - Set publish directory to `./site` (MkDocs output) + - Requires `NETLIFY_AUTH_TOKEN` and `NETLIFY_SITE_ID` secrets + +### 2. Netlify Configuration +- ✅ **Created** `netlify.toml` with: + - Build command: `mkdocs build` + - Publish directory: `site` + - Python version: 3.11 + - Redirects from old GitHub Pages URL to new Netlify URL + - Development server configuration + +### 3. URL Updates +- ✅ **Updated** `mkdocs.yml`: + - Changed `site_url` from `https://httpdss.github.io/struct/` to `https://structio.netlify.app/` + - Fixed `site_dir` from `site/docs` to `site` +- ✅ **Rebuilt** documentation to generate files with new URLs +- ✅ **Verified** all generated files now reference the new Netlify URL + +### 4. File Structure Changes +- ✅ **Regenerated** entire site structure with new Material theme +- ✅ **Updated** all HTML files to reference the new base URL +- ✅ **Updated** sitemap.xml with new URLs +- ✅ **Cleaned** old generated files and assets + +## 🔧 Technical Changes + +### New Files Added +- `.github/workflows/deploy-netlify.yml` - Netlify deployment workflow +- `netlify.toml` - Netlify build configuration +- Completely regenerated `site/` directory with Material theme + +### Files Modified +- `mkdocs.yml` - Updated site URL and fixed output directory + +### Files Removed +- `.github/workflows/deploy-pages.yml` - Old GitHub Pages workflow +- Old site assets (CSS, JS, etc.) replaced with Material theme assets + +## 🚀 Benefits Achieved + +1. **Enhanced Deployment**: Pull request previews with Netlify +2. **Better Performance**: Optimized build and deployment process +3. **Improved SEO**: Proper redirects from old URLs +4. **Modern Tooling**: Latest Material theme with enhanced features +5. **Flexibility**: More deployment options and configurations + +## 📋 Next Steps Required (Post-Merge) + +### Repository Secrets Configuration +The following secrets need to be added to the GitHub repository: + +1. **`NETLIFY_AUTH_TOKEN`** + - Generate from Netlify: Settings → User settings → Personal access tokens → Generate new token + - Scope: Full API access + +2. **`NETLIFY_SITE_ID`** + - Found in Netlify site settings: Site settings → General → Site information → Site ID + +### Netlify Site Setup +1. Create a new Netlify site (if not already done) +2. Configure the custom domain: `structio.netlify.app` +3. Enable branch deploys for pull request previews + +### DNS Configuration +- The redirects in `netlify.toml` will handle traffic from the old GitHub Pages URL +- No immediate DNS changes required + +## 🧪 Testing + +- ✅ Documentation builds successfully with `mkdocs build` +- ✅ All URLs updated to new Netlify domain +- ✅ No broken internal links detected +- ✅ Site structure properly generated + +## ⚠️ Important Notes + +1. **Secrets Required**: The workflow will fail until `NETLIFY_AUTH_TOKEN` and `NETLIFY_SITE_ID` are configured +2. **First Deployment**: The first deployment should be tested on this feature branch +3. **SEO Impact**: Redirects are configured to minimize SEO impact +4. **Backward Compatibility**: Old GitHub Pages URLs will redirect to new Netlify URLs + +## 📚 Documentation Impact + +- All generated documentation now references the new URL +- Internal documentation links remain relative (no changes needed) +- External references in README.md are relative (no changes needed) + +This implementation fully addresses all requirements from issue #86 and provides a modern, flexible documentation hosting solution. diff --git a/mkdocs.yml b/mkdocs.yml index 4d5bc26..25a344c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: STRUCT Documentation site_description: Automated Project Structure Generator -site_url: https://httpdss.github.io/struct/ +site_url: https://structio.netlify.app/ repo_url: https://github.com/httpdss/struct repo_name: httpdss/struct @@ -42,7 +42,7 @@ theme: custom_dir: overrides docs_dir: docs -site_dir: site/docs +site_dir: site # Navigation structure based on existing docs nav: diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 0000000..0d9c4c5 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,23 @@ +[build] + publish = "site" + command = "mkdocs build" + +[build.environment] + PYTHON_VERSION = "3.11" + +[[redirects]] + from = "https://httpdss.github.io/struct/*" + to = "https://structio.netlify.app/:splat" + status = 301 + force = true + +[[redirects]] + from = "https://httpdss.github.io/struct" + to = "https://structio.netlify.app/" + status = 301 + force = true + +[dev] + command = "mkdocs serve" + port = 8000 + publish = "site" diff --git a/site/404.html b/site/404.html new file mode 100644 index 0000000..1299a13 --- /dev/null +++ b/site/404.html @@ -0,0 +1,1173 @@ + + + + + + + + + + + + + + + + + + + + + STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/articles/index.html b/site/articles/index.html new file mode 100644 index 0000000..496ee56 --- /dev/null +++ b/site/articles/index.html @@ -0,0 +1,2097 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Articles and Tutorials - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Articles and Resources

+

Collection of articles, tutorials, and external resources about STRUCT.

+

Official Articles

+

Defining User Prompts on STRUCT: Harnessing GPT-4.1 for Scalable Project Scaffolding

+

Learn how to leverage GPT-4.1 to create intelligent project scaffolding with STRUCT. This article covers advanced prompting techniques and AI-driven project generation.

+

Topics covered:

+
    +
  • AI-powered template generation
    • +
  • Dynamic project structures
    • +
  • GPT-4.1 integration patterns
    • +
  • Scalable scaffolding strategies
    • +
+

Unlocking Developer Productivity with STRUCT: The Ultimate Open-Source Tool for Automated Project Structures

+

A comprehensive overview of STRUCT's capabilities and how it can boost developer productivity through automation.

+

Topics covered:

+
    +
  • Project structure automation
    • +
  • Developer workflow optimization
    • +
  • Open-source benefits
    • +
  • Real-world use cases
    • +
+

Automating Project Structures with STRUCT and GitHub Actions

+

Discover how to integrate STRUCT with GitHub Actions for automated project setup and maintenance across repositories.

+

Topics covered:

+
    +
  • GitHub Actions integration
    • +
  • CI/CD automation
    • +
  • Repository management
    • +
  • Workflow triggers
    • +
+

Advanced STRUCT Tips: Working with Template Variables and Jinja2 Filters

+

Deep dive into STRUCT's templating system, covering advanced variable usage and custom Jinja2 filters.

+

Topics covered:

+
    +
  • Template variable patterns
    • +
  • Custom Jinja2 filters
    • +
  • Dynamic content generation
    • +
  • Advanced templating techniques
    • +
+

Community Articles

+

Community contributions welcome! Submit a PR to add your STRUCT-related articles here.

+

Tutorials

+

Video Tutorials

+

Coming soon - video tutorials will be added as they become available.

+

Interactive Tutorials

+
    +
  • Getting Started Guide: Follow along with practical examples in the Quick Start documentation
    • +
  • Template Variables: Learn by example in the Template Variables guide
    • +
  • Advanced Configuration: Explore complex scenarios in YAML Configuration
    • +
+

Use Cases

+

DevOps and Infrastructure

+
    +
  • Terraform Module Generation: Standardize infrastructure code
    • +
  • Kubernetes Manifests: Generate consistent deployment configurations
    • +
  • CI/CD Pipeline Templates: Automate pipeline creation
    • +
  • Configuration Management: Maintain consistent environments
    • +
+

Application Development

+
    +
  • Microservice Scaffolding: Generate service boilerplate
    • +
  • API Project Templates: Standardize REST API structures
    • +
  • Frontend Framework Setup: Bootstrap React, Vue, or Angular projects
    • +
  • Database Schema Generation: Create consistent database structures
    • +
+

Documentation and Compliance

+
    +
  • Project Documentation: Generate README templates and docs
    • +
  • Compliance Templates: Ensure regulatory requirements
    • +
  • Security Configurations: Apply security best practices
    • +
  • Audit Trail Generation: Create trackable project structures
    • +
+

Presentations and Talks

+

Conference presentations and community talks about STRUCT will be listed here.

+

Research and Academic Papers

+

Academic research involving STRUCT or related concepts will be referenced here.

+

External Tools and Integrations

+

IDE Extensions

+
    +
  • VS Code YAML Extension: Enhanced editing with schema validation
    • +
  • IntelliJ YAML Support: Schema-aware editing and completion
    • +
+

CI/CD Integrations

+
    +
  • GitHub Actions: Pre-built actions for STRUCT workflows
    • +
  • GitLab CI: Integration examples and templates
    • +
  • Jenkins: Pipeline integration patterns
    • +
+

Complementary Tools

+
    +
  • Cookiecutter: Alternative project templating tool
    • +
  • Yeoman: JavaScript-focused scaffolding
    • +
  • Copilot: AI-powered code generation
    • +
+

Community Resources

+

Forums and Discussion

+
    +
  • GitHub Discussions: Official community forum
    • +
  • Stack Overflow: Questions tagged with struct-tool
    • +
+

Code Examples

+
    +
  • GitHub Examples Repository: Community-contributed examples
    • +
  • Gist Collections: Snippets and configurations
    • +
  • Docker Hub: Pre-built images and examples
    • +
+

Learning Paths

+

Beginner Path

+
    +
  1. Start with Installation
    2. +
  2. Follow the Quick Start guide
    3. +
  3. Explore Basic Usage
    4. +
  4. Learn YAML Configuration basics
    5. +
+

Intermediate Path

+
    +
  1. Master Template Variables
    2. +
  2. Understand File Handling strategies
    3. +
  3. Explore Custom Structures
    4. +
  4. Learn Mappings for data separation
    5. +
+

Advanced Path

+
    +
  1. Implement Hooks for automation
    2. +
  2. Set up GitHub Integration
    3. +
  3. Contribute to Development
    4. +
  4. Create complex multi-environment setups
    5. +
+

Contributing Content

+

We welcome contributions to this resource collection! Here's how you can help:

+

Adding Articles

+
    +
  1. Fork the repository
    2. +
  2. Add your article to the appropriate section
    3. +
  3. Include a brief description and key topics
    4. +
  4. Submit a pull request
    5. +
+

Suggesting Resources

+
    +
  • Open an issue with the "resource suggestion" label
    • +
  • Include the resource link and description
    • +
  • Explain why it would be valuable to the community
    • +
+

Writing Tutorials

+
    +
  • Create step-by-step guides with practical examples
    • +
  • Include code snippets and expected outputs
    • +
  • Test instructions thoroughly before submitting
    • +
+

Newsletter and Updates

+

Stay updated with the latest STRUCT developments:

+
    +
  • GitHub Releases: Watch the repository for release notifications
    • +
  • Community Updates: Follow project maintainers on social media
    • +
  • Blog Subscriptions: Subscribe to the official blog for updates
    • +
+

This page is regularly updated with new content. Bookmark it for future reference!

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/assets/images/favicon.png b/site/assets/images/favicon.png new file mode 100644 index 0000000..1cf13b9 Binary files /dev/null and b/site/assets/images/favicon.png differ diff --git a/site/assets/javascripts/bundle.50899def.min.js b/site/assets/javascripts/bundle.50899def.min.js new file mode 100644 index 0000000..44cbd28 --- /dev/null +++ b/site/assets/javascripts/bundle.50899def.min.js @@ -0,0 +1,15 @@ +"use strict";(()=>{var Wi=Object.create;var gr=Object.defineProperty;var Vi=Object.getOwnPropertyDescriptor;var Di=Object.getOwnPropertyNames,Vt=Object.getOwnPropertySymbols,zi=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,ao=Object.prototype.propertyIsEnumerable;var io=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,$=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&io(e,r,t[r]);if(Vt)for(var r of Vt(t))ao.call(t,r)&&io(e,r,t[r]);return e};var so=(e,t)=>{var r={};for(var o in e)yr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Vt)for(var o of Vt(e))t.indexOf(o)<0&&ao.call(e,o)&&(r[o]=e[o]);return r};var xr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Ni=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Di(t))!yr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=Vi(t,n))||o.enumerable});return e};var Lt=(e,t,r)=>(r=e!=null?Wi(zi(e)):{},Ni(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var co=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var lo=xr((Er,po)=>{(function(e,t){typeof Er=="object"&&typeof po!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function p(k){var ft=k.type,qe=k.tagName;return!!(qe==="INPUT"&&a[ft]&&!k.readOnly||qe==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function c(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(k){o=!1}function d(k){s(k.target)&&(o||p(k.target))&&c(k.target)}function y(k){s(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function L(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function ee(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,ee())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",L,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",y,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var qr=xr((dy,On)=>{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var $a=/["'&<>]/;On.exports=Pa;function Pa(e){var t=""+e,r=$a.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Rt=="object"&&typeof Yr=="object"?Yr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Rt=="object"?Rt.ClipboardJS=r():t.ClipboardJS=r()})(Rt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ui}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(D){try{return document.execCommand(D)}catch(A){return!1}}var d=function(A){var M=f()(A);return u("cut"),M},y=d;function L(D){var A=document.documentElement.getAttribute("dir")==="rtl",M=document.createElement("textarea");M.style.fontSize="12pt",M.style.border="0",M.style.padding="0",M.style.margin="0",M.style.position="absolute",M.style[A?"right":"left"]="-9999px";var F=window.pageYOffset||document.documentElement.scrollTop;return M.style.top="".concat(F,"px"),M.setAttribute("readonly",""),M.value=D,M}var X=function(A,M){var F=L(A);M.container.appendChild(F);var V=f()(F);return u("copy"),F.remove(),V},ee=function(A){var M=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},F="";return typeof A=="string"?F=X(A,M):A instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(A==null?void 0:A.type)?F=X(A.value,M):(F=f()(A),u("copy")),F},J=ee;function k(D){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(M){return typeof M}:k=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},k(D)}var ft=function(){var A=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},M=A.action,F=M===void 0?"copy":M,V=A.container,Y=A.target,$e=A.text;if(F!=="copy"&&F!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&k(Y)==="object"&&Y.nodeType===1){if(F==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(F==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if($e)return J($e,{container:V});if(Y)return F==="cut"?y(Y):J(Y,{container:V})},qe=ft;function Fe(D){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Fe=function(M){return typeof M}:Fe=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},Fe(D)}function ki(D,A){if(!(D instanceof A))throw new TypeError("Cannot call a class as a function")}function no(D,A){for(var M=0;M0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof V.action=="function"?V.action:this.defaultAction,this.target=typeof V.target=="function"?V.target:this.defaultTarget,this.text=typeof V.text=="function"?V.text:this.defaultText,this.container=Fe(V.container)==="object"?V.container:document.body}},{key:"listenClick",value:function(V){var Y=this;this.listener=c()(V,"click",function($e){return Y.onClick($e)})}},{key:"onClick",value:function(V){var Y=V.delegateTarget||V.currentTarget,$e=this.action(Y)||"copy",Wt=qe({action:$e,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Wt?"success":"error",{action:$e,text:Wt,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(V){return vr("action",V)}},{key:"defaultTarget",value:function(V){var Y=vr("target",V);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(V){return vr("text",V)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(V){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(V,Y)}},{key:"cut",value:function(V){return y(V)}},{key:"isSupported",value:function(){var V=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof V=="string"?[V]:V,$e=!!document.queryCommandSupported;return Y.forEach(function(Wt){$e=$e&&!!document.queryCommandSupported(Wt)}),$e}}]),M}(s()),Ui=Fi},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,d,y){var L=c.apply(this,arguments);return l.addEventListener(u,L,y),{destroy:function(){l.removeEventListener(u,L,y)}}}function p(l,f,u,d,y){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(L){return s(L,f,u,d,y)}))}function c(l,f,u,d){return function(y){y.delegateTarget=a(y.target,f),y.delegateTarget&&d.call(l,y)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,d,y){if(!u&&!d&&!y)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(y))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,d,y);if(a.nodeList(u))return l(u,d,y);if(a.string(u))return f(u,d,y);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,d,y){return u.addEventListener(d,y),{destroy:function(){u.removeEventListener(d,y)}}}function l(u,d,y){return Array.prototype.forEach.call(u,function(L){L.addEventListener(d,y)}),{destroy:function(){Array.prototype.forEach.call(u,function(L){L.removeEventListener(d,y)})}}}function f(u,d,y){return s(document.body,u,d,y)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function z(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||p(d,L)})},y&&(n[d]=y(n[d])))}function p(d,y){try{c(o[d](y))}catch(L){u(i[0][3],L)}}function c(d){d.value instanceof nt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){p("next",d)}function f(d){p("throw",d)}function u(d,y){d(y),i.shift(),i.length&&p(i[0][0],i[0][1])}}function uo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof he=="function"?he(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function H(e){return typeof e=="function"}function ut(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ut(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ue=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=he(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(L){t={error:L}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(H(l))try{l()}catch(L){i=L instanceof zt?L.errors:[L]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=he(f),d=u.next();!d.done;d=u.next()){var y=d.value;try{ho(y)}catch(L){i=i!=null?i:[],L instanceof zt?i=q(q([],z(i)),z(L.errors)):i.push(L)}}}catch(L){o={error:L}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ho(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Ue.EMPTY;function Nt(e){return e instanceof Ue||e&&"closed"in e&&H(e.remove)&&H(e.add)&&H(e.unsubscribe)}function ho(e){H(e)?e():e.unsubscribe()}var Pe={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var dt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Ue(function(){o.currentObservers=null,Qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new To(r,o)},t}(j);var To=function(e){oe(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){oe(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var _t={now:function(){return(_t.delegate||Date).now()},delegate:void 0};var At=function(e){oe(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=_t);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(gt);var Lo=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(yt);var kr=new Lo(Oo);var Mo=function(e){oe(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=vt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&o===r._scheduled&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(vt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(gt);var _o=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o;r?o=r.id:(o=this._scheduled,this._scheduled=void 0);var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(yt);var me=new _o(Mo);var S=new j(function(e){return e.complete()});function Kt(e){return e&&H(e.schedule)}function Hr(e){return e[e.length-1]}function Xe(e){return H(Hr(e))?e.pop():void 0}function ke(e){return Kt(Hr(e))?e.pop():void 0}function Yt(e,t){return typeof Hr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Bt(e){return H(e==null?void 0:e.then)}function Gt(e){return H(e[bt])}function Jt(e){return Symbol.asyncIterator&&H(e==null?void 0:e[Symbol.asyncIterator])}function Xt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Zt=Zi();function er(e){return H(e==null?void 0:e[Zt])}function tr(e){return fo(this,arguments,function(){var r,o,n,i;return Dt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function rr(e){return H(e==null?void 0:e.getReader)}function U(e){if(e instanceof j)return e;if(e!=null){if(Gt(e))return ea(e);if(xt(e))return ta(e);if(Bt(e))return ra(e);if(Jt(e))return Ao(e);if(er(e))return oa(e);if(rr(e))return na(e)}throw Xt(e)}function ea(e){return new j(function(t){var r=e[bt]();if(H(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function ta(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?Ve(t):Qo(function(){return new nr}))}}function jr(e){return e<=0?function(){return S}:E(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,d=0,y=!1,L=!1,X=function(){f==null||f.unsubscribe(),f=void 0},ee=function(){X(),l=u=void 0,y=L=!1},J=function(){var k=l;ee(),k==null||k.unsubscribe()};return E(function(k,ft){d++,!L&&!y&&X();var qe=u=u!=null?u:r();ft.add(function(){d--,d===0&&!L&&!y&&(f=Ur(J,p))}),qe.subscribe(ft),!l&&d>0&&(l=new at({next:function(Fe){return qe.next(Fe)},error:function(Fe){L=!0,X(),f=Ur(ee,n,Fe),qe.error(Fe)},complete:function(){y=!0,X(),f=Ur(ee,a),qe.complete()}}),U(k).subscribe(l))})(c)}}function Ur(e,t){for(var r=[],o=2;oe.next(document)),e}function P(e,t=document){return Array.from(t.querySelectorAll(e))}function R(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Ie(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var wa=O(h(document.body,"focusin"),h(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Ie()||document.body),G(1));function et(e){return wa.pipe(m(t=>e.contains(t)),K())}function Ht(e,t){return C(()=>O(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?kt(r=>Le(+!r*t)):le,Q(e.matches(":hover"))))}function Jo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Jo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Jo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),O(h(t,"load"),h(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),_(()=>document.head.removeChild(t)),Te(1))))}var Xo=new g,Ta=C(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Xo.next(t)))),v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ta.pipe(w(r=>r.observe(t)),v(r=>Xo.pipe(b(o=>o.target===t),_(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function Tt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Zo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function De(e){return{x:e.offsetLeft,y:e.offsetTop}}function en(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function tn(e){return O(h(window,"load"),h(window,"resize")).pipe(Me(0,me),m(()=>De(e)),Q(De(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function ze(e){return O(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe(Me(0,me),m(()=>pr(e)),Q(pr(e)))}var rn=new g,Sa=C(()=>I(new IntersectionObserver(e=>{for(let t of e)rn.next(t)},{threshold:0}))).pipe(v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function tt(e){return Sa.pipe(w(t=>t.observe(e)),v(t=>rn.pipe(b(({target:r})=>r===e),_(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function on(e,t=16){return ze(e).pipe(m(({y:r})=>{let o=ce(e),n=Tt(e);return r>=n.height-o.height-t}),K())}var lr={drawer:R("[data-md-toggle=drawer]"),search:R("[data-md-toggle=search]")};function nn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function Ne(e){let t=lr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function Oa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function La(){return O(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function an(){let e=h(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:nn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Ie();if(typeof o!="undefined")return!Oa(o,r)}return!0}),pe());return La().pipe(v(t=>t?S:e))}function ye(){return new URL(location.href)}function lt(e,t=!1){if(B("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function sn(){return new g}function cn(){return location.hash.slice(1)}function pn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Ma(e){return O(h(window,"hashchange"),e).pipe(m(cn),Q(cn()),b(t=>t.length>0),G(1))}function ln(e){return Ma(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function $t(e){let t=matchMedia(e);return ir(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function mn(){let e=matchMedia("print");return O(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function zr(e,t){return e.pipe(v(r=>r?t():S))}function Nr(e,t){return new j(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function je(e,t){return Nr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),G(1))}function fn(e,t){let r=new DOMParser;return Nr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),G(1))}function un(e,t){let r=new DOMParser;return Nr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),G(1))}function dn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function hn(){return O(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(dn),Q(dn()))}function bn(){return{width:innerWidth,height:innerHeight}}function vn(){return h(window,"resize",{passive:!0}).pipe(m(bn),Q(bn()))}function gn(){return N([hn(),vn()]).pipe(m(([e,t])=>({offset:e,size:t})),G(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(te("size")),n=N([o,r]).pipe(m(()=>De(e)));return N([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function _a(e){return h(e,"message",t=>t.data)}function Aa(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function yn(e,t=new Worker(e)){let r=_a(t),o=Aa(t),n=new g;n.subscribe(o);let i=o.pipe(Z(),ie(!0));return n.pipe(Z(),Re(r.pipe(W(i))),pe())}var Ca=R("#__config"),St=JSON.parse(Ca.textContent);St.base=`${new URL(St.base,ye())}`;function xe(){return St}function B(e){return St.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?St.translations[e].replace("#",t.toString()):St.translations[e]}function Se(e,t=document){return R(`[data-md-component=${e}]`,t)}function ae(e,t=document){return P(`[data-md-component=${e}]`,t)}function ka(e){let t=R(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>R(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function xn(e){if(!B("announce.dismiss")||!e.childElementCount)return S;if(!e.hidden){let t=R(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),ka(e).pipe(w(r=>t.next(r)),_(()=>t.complete()),m(r=>$({ref:e},r)))})}function Ha(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function En(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Ha(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))}function Pt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Tn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Sn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}var Ln=Lt(qr());function Qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,(0,Ln.default)(c))," "],[]).slice(0,-1),i=xe(),a=new URL(e.location,i.base);B("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=xe();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Mn(e){let t=e[0].score,r=[...e],o=xe(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreQr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>Qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function _n(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Kr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function An(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ra(e){var o;let t=xe(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Cn(e,t){var o;let r=xe();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ra)))}var Ia=0;function ja(e){let t=N([et(e),Ht(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Zo(e)).pipe(ne(ze),pt(1),He(t),m(()=>en(e)));return t.pipe(Ae(o=>o),v(()=>N([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function Fa(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ia++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(Z(),ie(!1)).subscribe(a);let s=a.pipe(kt(c=>Le(+!c*250,kr)),K(),v(c=>c?r:S),w(c=>c.id=n),pe());N([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>Ht(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),re(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),d=u.width/2;if(l.role==="tooltip")return{x:d,y:8+u.height};if(u.y>=f.height/2){let{height:y}=ce(l);return{x:d,y:-16-y}}else return{x:d,y:16+u.height}}));return N([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),re(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(R(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),ve(me),re(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),N([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ja(e).pipe(w(c=>i.next(c)),_(()=>i.complete()),m(c=>$({ref:e},c)))})}function mt(e,{viewport$:t},r=document.body){return Fa(e,{content$:new j(o=>{let n=e.title,i=wn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Ua(e,t){let r=C(()=>N([tn(e),ze(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function kn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(W(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),O(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Me(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),h(n,"mousedown").pipe(W(a),re(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Ie())==null||c.blur()}}),r.pipe(W(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Ua(e,t).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function Wa(e){return e.tagName==="CODE"?P(".c, .c1, .cm",e):[e]}function Va(e){let t=[];for(let r of Wa(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function Hn(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Va(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,Tn(p,i)),s.replaceWith(a.get(p)))}return a.size===0?S:C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=[];for(let[l,f]of a)c.push([R(".md-typeset",f),R(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?Hn(f,u):Hn(u,f)}),O(...[...a].map(([,l])=>kn(l,t,{target$:r}))).pipe(_(()=>s.complete()),pe())})}function $n(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return $n(t)}}function Pn(e,t){return C(()=>{let r=$n(e);return typeof r!="undefined"?fr(r,e,t):S})}var Rn=Lt(Br());var Da=0;function In(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return In(t)}}function za(e){return ge(e).pipe(m(({width:t})=>({scrollable:Tt(e).width>t})),te("scrollable"))}function jn(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(jr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Rn.default.isSupported()&&(e.closest(".copy")||B("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Da++}`;let l=Sn(c.id);c.insertBefore(l,e),B("content.tooltips")&&a.push(mt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=In(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||B("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(W(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:S)))}}return P(":scope > span[id]",e).length&&e.classList.add("md-code__content"),za(e).pipe(w(c=>n.next(c)),_(()=>n.complete()),m(c=>$({ref:e},c)),Re(...a))});return B("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function Na(e,{target$:t,print$:r}){let o=!0;return O(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),w(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Fn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Na(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}var Un=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs marker.marker.composition.class path,defs marker.marker.dependency.class path,defs marker.marker.extension.class path{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs marker.marker.aggregation.class path{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}[id^=entity] path,[id^=entity] rect{fill:var(--md-default-bg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs .marker.oneOrMore.er *,defs .marker.onlyOne.er *,defs .marker.zeroOrMore.er *,defs .marker.zeroOrOne.er *{stroke:var(--md-mermaid-edge-color)!important}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Gr,Qa=0;function Ka(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):I(void 0)}function Wn(e){return e.classList.remove("mermaid"),Gr||(Gr=Ka().pipe(w(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Un,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),G(1))),Gr.subscribe(()=>co(null,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Qa++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Gr.pipe(m(()=>({ref:e})))}var Vn=x("table");function Dn(e){return e.replaceWith(Vn),Vn.replaceWith(An(e)),I({ref:e})}function Ya(e){let t=e.find(r=>r.checked)||e[0];return O(...e.map(r=>h(r,"change").pipe(m(()=>R(`label[for="${r.id}"]`))))).pipe(Q(R(`label[for="${t.id}"]`)),m(r=>({active:r})))}function zn(e,{viewport$:t,target$:r}){let o=R(".tabbed-labels",e),n=P(":scope > input",e),i=Kr("prev");e.append(i);let a=Kr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(Z(),ie(!0));N([s,ge(e),tt(e)]).pipe(W(p),Me(1,me)).subscribe({next([{active:c},l]){let f=De(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=pr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),N([ze(o),ge(o)]).pipe(W(p)).subscribe(([c,l])=>{let f=Tt(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),O(h(i,"click").pipe(m(()=>-1)),h(a,"click").pipe(m(()=>1))).pipe(W(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(W(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=R(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(p),b(f=>!(f.metaKey||f.ctrlKey)),w(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return B("content.tabs.link")&&s.pipe(Ce(1),re(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let y of P("[data-tabs]"))for(let L of P(":scope > input",y)){let X=R(`label[for="${L.id}"]`);if(X!==c&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),L.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),s.pipe(W(p)).subscribe(()=>{for(let c of P("audio, video",e))c.pause()}),Ya(n).pipe(w(c=>s.next(c)),_(()=>s.complete()),m(c=>$({ref:e},c)))}).pipe(Ke(se))}function Nn(e,{viewport$:t,target$:r,print$:o}){return O(...P(".annotate:not(.highlight)",e).map(n=>Pn(n,{target$:r,print$:o})),...P("pre:not(.mermaid) > code",e).map(n=>jn(n,{target$:r,print$:o})),...P("pre.mermaid",e).map(n=>Wn(n)),...P("table:not([class])",e).map(n=>Dn(n)),...P("details",e).map(n=>Fn(n,{target$:r,print$:o})),...P("[data-tabs]",e).map(n=>zn(n,{viewport$:t,target$:r})),...P("[title]",e).filter(()=>B("content.tooltips")).map(n=>mt(n,{viewport$:t})))}function Ba(e,{alert$:t}){return t.pipe(v(r=>O(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function qn(e,t){let r=R(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ba(e,t).pipe(w(n=>o.next(n)),_(()=>o.complete()),m(n=>$({ref:e},n)))})}var Ga=0;function Ja(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?ze(o):I({x:0,y:0}),i=O(et(t),Ht(t)).pipe(K());return N([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=De(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Qn(e){let t=e.title;if(!t.length)return S;let r=`__tooltip_${Ga++}`,o=Pt(r,"inline"),n=R(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),O(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Me(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Ja(o,e).pipe(w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))}).pipe(Ke(se))}function Xa({viewport$:e}){if(!B("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Be(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=Ne("search");return N([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Kn(e,t){return C(()=>N([ge(e),Xa(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),G(1))}function Yn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(Z(),ie(!0));o.pipe(te("active"),He(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue(P("[title]",e)).pipe(b(()=>B("content.tooltips")),ne(a=>Qn(a)));return r.subscribe(o),t.pipe(W(n),m(a=>$({ref:e},a)),Re(i.pipe(W(n))))})}function Za(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),te("active"))}function Bn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?S:Za(o,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))})}function Gn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),te("bottom"))));return N([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function es(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(ne(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),G(1))}function Jn(e){let t=P("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=$t("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),re(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(ve(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),es(t).pipe(W(n.pipe(Ce(1))),ct(),w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))})}function Xn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(w(o=>r.next({value:o})),_(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Jr=Lt(Br());function ts(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Zn({alert$:e}){Jr.default.isSupported()&&new j(t=>{new Jr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||ts(R(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(w(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function ei(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function rs(e,t){let r=new Map;for(let o of P("url",e)){let n=R("loc",o),i=[ei(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of P("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(ei(new URL(s),t))}}return r}function ur(e){return un(new URL("sitemap.xml",e)).pipe(m(t=>rs(t,new URL(e))),de(()=>I(new Map)))}function os(e,t){if(!(e.target instanceof Element))return S;let r=e.target.closest("a");if(r===null)return S;if(r.target||e.metaKey||e.ctrlKey)return S;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):S}function ti(e){let t=new Map;for(let r of P(":scope > *",e.head))t.set(r.outerHTML,r);return t}function ri(e){for(let t of P("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function ns(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...B("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=ti(document);for(let[o,n]of ti(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return We(P("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new j(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),S}),Z(),ie(document))}function oi({location$:e,viewport$:t,progress$:r}){let o=xe();if(location.protocol==="file:")return S;let n=ur(o.base);I(document).subscribe(ri);let i=h(document.body,"click").pipe(He(n),v(([p,c])=>os(p,c)),pe()),a=h(window,"popstate").pipe(m(ye),pe());i.pipe(re(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),O(i,a).subscribe(e);let s=e.pipe(te("pathname"),v(p=>fn(p,{progress$:r}).pipe(de(()=>(lt(p,!0),S)))),v(ri),v(ns),pe());return O(s.pipe(re(e,(p,c)=>c)),s.pipe(v(()=>e),te("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),w(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",pn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(te("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ni=Lt(qr());function ii(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ni.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function It(e){return e.type===1}function dr(e){return e.type===3}function ai(e,t){let r=yn(e);return O(I(location.protocol!=="file:"),Ne("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:B("search.suggest")}}})),r}function si(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=Xr(n))==null?void 0:l.pathname;if(i===void 0)return;let a=ss(o.pathname,i);if(a===void 0)return;let s=ps(t.keys());if(!t.has(s))return;let p=Xr(a,s);if(!p||!t.has(p.href))return;let c=Xr(a,r);if(c)return c.hash=o.hash,c.search=o.search,c}function Xr(e,t){try{return new URL(e,t)}catch(r){return}}function ss(e,t){if(e.startsWith(t))return e.slice(t.length)}function cs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oS)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>h(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),re(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?S:(i.preventDefault(),I(new URL(p)))}}return S}),v(i=>ur(i).pipe(m(a=>{var s;return(s=si({selectedVersionSitemap:a,selectedVersionBaseURL:i,currentLocation:ye(),currentBaseURL:t.base}))!=null?s:i})))))).subscribe(n=>lt(n,!0)),N([r,o]).subscribe(([n,i])=>{R(".md-header__topic").appendChild(Cn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var s;let i=new URL(t.base),a=__md_get("__outdated",sessionStorage,i);if(a===null){a=!0;let p=((s=t.version)==null?void 0:s.default)||"latest";Array.isArray(p)||(p=[p]);e:for(let c of p)for(let l of n.aliases.concat(n.version))if(new RegExp(c,"i").test(l)){a=!1;break e}__md_set("__outdated",a,sessionStorage,i)}if(a)for(let p of ae("outdated"))p.hidden=!1})}function ls(e,{worker$:t}){let{searchParams:r}=ye();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),Ne("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=ye();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=O(t.pipe(Ae(It)),h(e,"keyup"),o).pipe(m(()=>e.value),K());return N([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),G(1))}function pi(e,{worker$:t}){let r=new g,o=r.pipe(Z(),ie(!0));N([t.pipe(Ae(It)),r],(i,a)=>a).pipe(te("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(te("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=R("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ls(e,{worker$:t}).pipe(w(i=>r.next(i)),_(()=>r.complete()),m(i=>$({ref:e},i)),G(1))}function li(e,{worker$:t,query$:r}){let o=new g,n=on(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=R(":scope > :first-child",e),s=R(":scope > :last-child",e);Ne("search").subscribe(l=>{s.setAttribute("role",l?"list":"presentation"),s.hidden=!l}),o.pipe(re(r),Wr(t.pipe(Ae(It)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(w(()=>s.innerHTML=""),v(({items:l})=>O(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Be(4),Dr(n),v(([f])=>f)))),m(Mn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(ne(l=>{let f=fe("details",l);return typeof f=="undefined"?S:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(w(l=>o.next(l)),_(()=>o.complete()),m(l=>$({ref:e},l)))}function ms(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=ye();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function mi(e,t){let r=new g,o=r.pipe(Z(),ie(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),ms(e,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))}function fi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=O(h(n,"keydown"),h(n,"focus")).pipe(ve(se),m(()=>n.value),K());return o.pipe(He(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(w(s=>o.next(s)),_(()=>o.complete()),m(()=>({ref:e})))}function ui(e,{index$:t,keyboard$:r}){let o=xe();try{let n=ai(o.search,t),i=Se("search-query",e),a=Se("search-result",e);h(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Ie();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of P(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...P(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Ie()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=pi(i,{worker$:n});return O(s,li(a,{worker$:n,query$:s})).pipe(Re(...ae("search-share",e).map(p=>mi(p,{query$:s})),...ae("search-suggest",e).map(p=>fi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ye}}function di(e,{index$:t,location$:r}){return N([t,r.pipe(Q(ye()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>ii(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function fs(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return N([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Zr(e,o){var n=o,{header$:t}=n,r=so(n,["header$"]);let i=R(".md-sidebar__scrollwrap",e),{y:a}=De(i);return C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=s.pipe(Me(0,me));return c.pipe(re(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of P(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2})}}}),ue(P("label[tabindex]",e)).pipe(ne(l=>h(l,"click").pipe(ve(se),m(()=>l),W(p)))).subscribe(l=>{let f=R(`[id="${l.htmlFor}"]`);R(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),fs(e,r).pipe(w(l=>s.next(l)),_(()=>s.complete()),m(l=>$({ref:e},l)))})}function hi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return st(je(`${r}/releases/latest`).pipe(de(()=>S),m(o=>({version:o.tag_name})),Ve({})),je(r).pipe(de(()=>S),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Ve({}))).pipe(m(([o,n])=>$($({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return je(r).pipe(m(o=>({repositories:o.public_repos})),Ve({}))}}function bi(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return st(je(`${r}/releases/permalink/latest`).pipe(de(()=>S),m(({tag_name:o})=>({version:o})),Ve({})),je(r).pipe(de(()=>S),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Ve({}))).pipe(m(([o,n])=>$($({},o),n)))}function vi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return hi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return bi(r,o)}return S}var us;function ds(e){return us||(us=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return S}return vi(e.href).pipe(w(o=>__md_set("__source",o,sessionStorage)))}).pipe(de(()=>S),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),G(1)))}function gi(e){let t=R(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(_n(o)),t.classList.add("md-source__repository--active")}),ds(e).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function hs(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),te("hidden"))}function yi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(B("navigation.tabs.sticky")?I({hidden:!1}):hs(e,t)).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function bs(e,{viewport$:t,header$:r}){let o=new Map,n=P(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(te("height"),m(({height:s})=>{let p=Se("main"),c=R(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(te("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),He(i),v(([p,c])=>t.pipe(Fr(([l,f],{offset:{y:u},size:d})=>{let y=u+d.height>=Math.floor(s.height);for(;f.length;){let[,L]=f[0];if(L-c=u&&!y)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Be(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(Z(),ie(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),B("toc.follow")){let s=O(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),He(o.pipe(ve(se))),re(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2,behavior:c})}}})}return B("navigation.tracking")&&t.pipe(W(a),te("offset"),_e(250),Ce(1),W(n.pipe(Ce(1))),ct({delay:250}),re(i)).subscribe(([,{prev:s}])=>{let p=ye(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),bs(e,{viewport$:t,header$:r}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function vs(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Be(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return N([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),W(o.pipe(Ce(1))),ie(!0),ct({delay:250}),m(a=>({hidden:a})))}function Ei(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(a),te("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),h(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),vs(e,{viewport$:t,main$:o,target$:n}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))}function wi({document$:e,viewport$:t}){e.pipe(v(()=>P(".md-ellipsis")),ne(r=>tt(r).pipe(W(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,B("content.tooltips")?mt(n,{viewport$:t}).pipe(W(e.pipe(Ce(1))),_(()=>n.removeAttribute("title"))):S})).subscribe(),B("content.tooltips")&&e.pipe(v(()=>P(".md-status")),ne(r=>mt(r,{viewport$:t}))).subscribe()}function Ti({document$:e,tablet$:t}){e.pipe(v(()=>P(".md-toggle--indeterminate")),w(r=>{r.indeterminate=!0,r.checked=!1}),ne(r=>h(r,"change").pipe(Vr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),re(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function gs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Si({document$:e}){e.pipe(v(()=>P("[data-md-scrollfix]")),w(t=>t.removeAttribute("data-md-scrollfix")),b(gs),ne(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Oi({viewport$:e,tablet$:t}){N([Ne("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),re(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ys(){return location.protocol==="file:"?wt(`${new URL("search/search_index.js",eo.base)}`).pipe(m(()=>__index),G(1)):je(new URL("search/search_index.json",eo.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Go(),Ft=sn(),Ot=ln(Ft),to=an(),Oe=gn(),hr=$t("(min-width: 60em)"),Mi=$t("(min-width: 76.25em)"),_i=mn(),eo=xe(),Ai=document.forms.namedItem("search")?ys():Ye,ro=new g;Zn({alert$:ro});var oo=new g;B("navigation.instant")&&oi({location$:Ft,viewport$:Oe,progress$:oo}).subscribe(ot);var Li;((Li=eo.version)==null?void 0:Li.provider)==="mike"&&ci({document$:ot});O(Ft,Ot).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});to.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&<(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&<(r);break;case"Enter":let o=Ie();o instanceof HTMLLabelElement&&o.click()}});wi({viewport$:Oe,document$:ot});Ti({document$:ot,tablet$:hr});Si({document$:ot});Oi({viewport$:Oe,tablet$:hr});var rt=Kn(Se("header"),{viewport$:Oe}),jt=ot.pipe(m(()=>Se("main")),v(e=>Gn(e,{viewport$:Oe,header$:rt})),G(1)),xs=O(...ae("consent").map(e=>En(e,{target$:Ot})),...ae("dialog").map(e=>qn(e,{alert$:ro})),...ae("palette").map(e=>Jn(e)),...ae("progress").map(e=>Xn(e,{progress$:oo})),...ae("search").map(e=>ui(e,{index$:Ai,keyboard$:to})),...ae("source").map(e=>gi(e))),Es=C(()=>O(...ae("announce").map(e=>xn(e)),...ae("content").map(e=>Nn(e,{viewport$:Oe,target$:Ot,print$:_i})),...ae("content").map(e=>B("search.highlight")?di(e,{index$:Ai,location$:Ft}):S),...ae("header").map(e=>Yn(e,{viewport$:Oe,header$:rt,main$:jt})),...ae("header-title").map(e=>Bn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?zr(Mi,()=>Zr(e,{viewport$:Oe,header$:rt,main$:jt})):zr(hr,()=>Zr(e,{viewport$:Oe,header$:rt,main$:jt}))),...ae("tabs").map(e=>yi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>xi(e,{viewport$:Oe,header$:rt,main$:jt,target$:Ot})),...ae("top").map(e=>Ei(e,{viewport$:Oe,header$:rt,main$:jt,target$:Ot})))),Ci=ot.pipe(v(()=>Es),Re(xs),G(1));Ci.subscribe();window.document$=ot;window.location$=Ft;window.target$=Ot;window.keyboard$=to;window.viewport$=Oe;window.tablet$=hr;window.screen$=Mi;window.print$=_i;window.alert$=ro;window.progress$=oo;window.component$=Ci;})(); +//# sourceMappingURL=bundle.50899def.min.js.map diff --git a/site/assets/javascripts/bundle.50899def.min.js.map b/site/assets/javascripts/bundle.50899def.min.js.map new file mode 100644 index 0000000..6130f72 --- /dev/null +++ b/site/assets/javascripts/bundle.50899def.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2025 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 60em)\")\nconst screen$ = watchMedia(\"(min-width: 76.25em)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n */\nexport class Subscription implements SubscriptionLike {\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param value The `next` value.\n */\n next(value: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param err The `error` exception.\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as ((value: T) => void) | undefined,\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent.\n * @param subscriber The stopped subscriber.\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @param subscribe The function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @param subscribe the subscriber function to be passed to the Observable constructor\n * @return A new observable.\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @param operator the operator defining the operation to take on the observable\n * @return A new observable with the Operator applied.\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param observerOrNext Either an {@link Observer} with some or all callback methods,\n * or the `next` handler that is called for each value emitted from the subscribed Observable.\n * @param error A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param complete A handler for a terminal event resulting from successful completion.\n * @return A subscription reference to the registered handlers.\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next A handler for each value emitted by the observable.\n * @return A promise that either resolves on observable completion or\n * rejects with the handled error.\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @return This instance of the observable.\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n *\n * @return The Observable result of all the operators having been called\n * in the order they were passed in.\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return Observable that this Subject casts to.\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param _bufferSize The size of the buffer to replay on subscription\n * @param _windowTime The amount of time the buffered items will stay buffered\n * @param _timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param state Some contextual data that the `work` function uses when called by the\n * Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is implicit\n * and defined by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param work A function representing a task, or some unit of work to be\n * executed by the Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is\n * implicit and defined by the Scheduler itself.\n * @param state Some contextual data that the `work` function uses when called\n * by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && id === scheduler._scheduled && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n let flushId;\n if (action) {\n flushId = action.id;\n } else {\n flushId = this._scheduled;\n this._scheduled = undefined;\n }\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an + + + + + + + + + + + +

This document provides a reference for the struct command-line interface (CLI).

+

Overview

+

The struct CLI allows you to generate project structures from YAML configuration files. It supports both built-in structure definitions and custom structures.

+

Basic Usage:

+
struct {info,validate,generate,list,generate-schema} ...
+
+

Global Options

+

These options are available for all commands:

+
    +
  • -h, --help: Show the help message and exit.
    • +
  • -l LOG, --log LOG: Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL).
    • +
  • -c CONFIG_FILE, --config-file CONFIG_FILE: Path to a configuration file.
    • +
  • -i LOG_FILE, --log-file LOG_FILE: Path to a log file.
    • +
+

Commands

+

info

+

Show information about a structure definition.

+

Usage:

+
struct info [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH] structure_definition
+
+

Arguments:

+
    +
  • structure_definition: Name of the structure definition.
    • +
  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
    • +
+

validate

+

Validate the YAML configuration file.

+

Usage:

+
struct validate [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] yaml_file
+
+

Arguments:

+
    +
  • yaml_file: Path to the YAML configuration file.
    • +
+

generate

+

Generate the project structure.

+

Usage:

+
struct generate [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH] [-n INPUT_STORE] [-d] [-v VARS] [-b BACKUP] [-f {overwrite,skip,append,rename,backup}] [-p GLOBAL_SYSTEM_PROMPT] [--non-interactive] [--mappings-file MAPPINGS_FILE] [-o {console,file}] structure_definition base_path
+
+

Arguments:

+
    +
  • structure_definition: Path to the YAML configuration file.
    • +
  • base_path: Base path where the structure will be created.
    • +
  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
    • +
  • -n INPUT_STORE, --input-store INPUT_STORE: Path to the input store.
    • +
  • -d, --dry-run: Perform a dry run without creating any files or directories.
    • +
  • -v VARS, --vars VARS: Template variables in the format KEY1=value1,KEY2=value2.
    • +
  • -b BACKUP, --backup BACKUP: Path to the backup folder.
    • +
  • -f {overwrite,skip,append,rename,backup}, --file-strategy {overwrite,skip,append,rename,backup}: Strategy for handling existing files.
    • +
  • -p GLOBAL_SYSTEM_PROMPT, --global-system-prompt GLOBAL_SYSTEM_PROMPT: Global system prompt for OpenAI.
    • +
  • --non-interactive: Run the command in non-interactive mode.
    • +
  • --mappings-file MAPPINGS_FILE: Path to a YAML file containing mappings to be used in templates (can be specified multiple times).
    • +
  • -o {console,file}, --output {console,file}: Output mode.
    • +
+

list

+

List available structures.

+

Usage:

+
struct list [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH]
+
+

Arguments:

+
    +
  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
    • +
+

generate-schema

+

Generate JSON schema for available structures.

+

Usage:

+
struct generate-schema [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH] [-o OUTPUT]
+
+

Arguments:

+
    +
  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
    • +
  • -o OUTPUT, --output OUTPUT: Output file path for the schema (default: stdout).
    • +
+

Examples

+

Basic Structure Generation

+

Generate a structure using a built-in definition:

+
struct generate python-basic ./my-project
+
+

Generate from a custom YAML file:

+
struct generate file://my-structure.yaml ./output-dir
+
+

Using Custom Structures

+

Generate with custom structure path:

+
struct generate -s ~/custom-structures python-api ./my-api
+
+

Template Variables

+

Pass template variables to the structure:

+
struct generate -v "project_name=MyApp,author=John Doe" file://structure.yaml ./output
+
+

Dry Run

+

Test structure generation without creating files:

+
struct generate -d file://structure.yaml ./output
+
+

File Strategies

+

Handle existing files with different strategies:

+
# Skip existing files
+struct generate -f skip file://structure.yaml ./output
+
+# Backup existing files
+struct generate -f backup -b ./backup file://structure.yaml ./output
+
+

Console Output

+

Output to console instead of creating files:

+
struct generate -o console file://structure.yaml ./output
+
+

Validation

+

Validate a YAML configuration before generation:

+
struct validate my-structure.yaml
+
+

List Available Structures

+

List all built-in structures:

+
struct list
+
+

List structures from custom path:

+
struct list -s ~/custom-structures
+
+

Get Structure Information

+

Get detailed information about a structure:

+
struct info python-basic
+
+

Generate Schema

+

Generate JSON schema and save to file:

+
struct generate-schema -o schema.json
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + + diff --git a/site/completion/index.html b/site/completion/index.html new file mode 100644 index 0000000..b88a176 --- /dev/null +++ b/site/completion/index.html @@ -0,0 +1,2038 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Command-Line Completion - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Command-Line Auto-Completion

+

STRUCT provides intelligent auto-completion for commands, options, and structure names using argcomplete. This makes discovering and using available structures much faster and more user-friendly.

+
+

New Feature: Structure Name Completion

+

STRUCT now automatically completes structure names when using struct generate, showing all 47+ available structures from both built-in and custom paths!

+
+

Quick Setup

+

For most users, this simple setup will enable full completion:

+
# Install (if not already installed)
+pip install argcomplete
+
+# Enable completion for current session
+eval "$(register-python-argcomplete struct)"
+
+# Make permanent - add to your ~/.zshrc or ~/.bashrc
+echo 'eval "$(register-python-argcomplete struct)"' >> ~/.zshrc
+
+

Detailed Installation

+

1. Install argcomplete

+
pip install argcomplete
+
+

2. Enable Global Completion (Optional)

+

This step is optional but can be done once per system:

+
activate-global-python-argcomplete
+
+

This command sets up global completion for all Python scripts that use argcomplete.

+

3. Register the Script

+

Add the following line to your shell's configuration file:

+

For Bash (.bashrc or .bash_profile):

+
eval "$(register-python-argcomplete struct)"
+
+

For Zsh (.zshrc):

+
eval "$(register-python-argcomplete struct)"
+
+

For Fish (.config/fish/config.fish):

+
register-python-argcomplete --shell fish struct | source
+
+

4. Reload Your Shell

+
# For Bash
+source ~/.bashrc
+
+# For Zsh
+source ~/.zshrc
+
+# For Fish
+source ~/.config/fish/config.fish
+
+

Usage

+

After completing the setup, you can use auto-completion by typing part of a command and pressing Tab:

+

Command Completion

+
struct <Tab>
+# Shows: generate, generate-schema, validate, info, list
+
+

Structure Name Completion ✨

+
# Complete structure names - shows all available structures!
+struct generate <Tab>
+# Shows: ansible-playbook, docker-files, github/workflows/codeql, project/nodejs, etc.
+
+# Partial completion works too
+struct generate git<Tab>
+# Shows: git-hooks, github/workflows/codeql, github/templates, etc.
+
+# Works with nested structures
+struct generate github/<Tab>
+# Shows: github/workflows/codeql, github/templates, github/prompts/generic, etc.
+
+

Custom Structure Paths

+
# Completion works with custom structure paths
+struct generate --structures-path /custom/path <Tab>
+# Shows structures from both custom path and built-in structures
+
+

Option Completion

+
struct generate --<Tab>
+# Shows: --log, --dry-run, --backup, --file-strategy, --structures-path, etc.
+
+struct generate --log <Tab>
+# Shows: DEBUG, INFO, WARNING, ERROR, CRITICAL
+
+

Advanced Configuration

+

Per-Project Completion

+

If you only want completion for specific projects, you can add completion to your project's virtual environment activation script:

+
# In your .venv/bin/activate file, add:
+eval "$(register-python-argcomplete struct)"
+
+

Custom Completion

+

You can create custom completion functions for specific use cases:

+
# Custom completion for structure names
+_struct_structures() {
+    local structures=$(struct list --names-only 2>/dev/null)
+    COMPREPLY=($(compgen -W "$structures" -- "${COMP_WORDS[COMP_CWORD]}"))
+}
+
+# Register custom completion
+complete -F _struct_structures struct-generate
+
+

Troubleshooting

+

Completion Not Working

+
    +
  1. Check argcomplete installation:
    2. +
+
python -c "import argcomplete; print('OK')"
+
+
    +
  1. Verify global activation:
    2. +
+
activate-global-python-argcomplete --user
+
+
    +
  1. +

    Check shell configuration: + Make sure the eval statement is in the correct shell configuration file.

    +
    2. +
  2. +

    Restart your shell: + Sometimes you need to completely restart your terminal.

    +
    3. +
+

Slow Completion

+

If completion is slow, you can enable caching:

+
export ARGCOMPLETE_USE_TEMPFILES=1
+
+

Add this to your shell configuration file for persistent caching.

+

Debug Completion

+

Enable debug mode to troubleshoot completion issues:

+
export _ARGCOMPLETE_DEBUG=1
+struct <Tab>
+
+

Platform-Specific Notes

+

macOS

+

On macOS, you might need to install bash-completion first:

+
# Using Homebrew
+brew install bash-completion
+
+# Then add to ~/.bash_profile:
+[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"
+
+

Windows

+

For Windows users using Git Bash or WSL, follow the same steps as Linux. For PowerShell, argcomplete support is limited.

+

Docker

+

When running STRUCT in Docker, completion won't work directly. However, you can create a wrapper script:

+
#!/bin/bash
+# struct-wrapper.sh
+docker run --rm -v $(pwd):/workdir ghcr.io/httpdss/struct:main "$@"
+
+

Then set up completion for the wrapper:

+
eval "$(register-python-argcomplete struct-wrapper.sh)"
+
+

Benefits of Auto-Completion

+
    +
  • Faster typing: Quickly complete command names and options
    • +
  • Discoverability: See available commands and options
    • +
  • Accuracy: Reduce typos and errors
    • +
  • Productivity: Spend less time looking up command syntax
    • +
+

Supported Completions

+

STRUCT provides intelligent completion for:

+
    +
  • Commands: generate, validate, list, info, generate-schema
    • +
  • Options: --log, --dry-run, --backup, --file-strategy, --structures-path, etc.
    • +
  • Structure names: All 47+ available built-in and custom structures
    • +
  • Built-in structures: ansible-playbook, docker-files, helm-chart, etc.
    • +
  • Nested structures: github/workflows/codeql, project/nodejs, terraform/apps/generic, etc.
    • +
  • Custom structures: From --structures-path directories
    • +
  • File paths: Local files and directories
    • +
  • Enum values: Log levels (DEBUG, INFO, etc.), file strategies (overwrite, skip, etc.)
    • +
+

How Structure Completion Works

+

The structure name completion feature:

+
    +
  1. Dynamically discovers all available structure files (.yaml files)
    2. +
  2. Scans multiple locations:
    3. +
  3. Built-in structures in struct_module/contribs/
    4. +
  4. Custom structures from --structures-path if specified
    5. +
  5. Returns clean names without .yaml extensions
    6. +
  6. Supports nested directories like github/workflows/codeql
    7. +
  7. Updates automatically when new structures are added
    8. +
+

Example Session

+
# Command completion
+$ struct <Tab>
+generate        generate-schema info           list           validate
+
+# Structure name completion (NEW!)
+$ struct generate <Tab>
+ansible-playbook     configs/codeowners    github/workflows/codeql  project/nodejs
+chef-cookbook        docker-files          helm-chart               terraform/apps/generic
+ci-cd-pipelines      git-hooks            kubernetes-manifests      vagrant-files
+
+# Partial completion
+$ struct generate proj<Tab>
+project/custom-structures  project/go      project/nodejs  project/ruby
+project/generic           project/java    project/python  project/rust
+
+# Nested structure completion
+$ struct generate github/<Tab>
+github/chatmodes/plan       github/prompts/react-form    github/workflows/codeql
+github/instructions/generic github/prompts/security-api  github/workflows/labeler
+github/prompts/generic      github/workflows/pre-commit  github/workflows/stale
+
+# Option completion
+$ struct generate --<Tab>
+--backup        --dry-run       --file-strategy --log
+--log-file      --mappings-file --structures-path --vars
+
+# Enum value completion
+$ struct generate --log <Tab>
+DEBUG    ERROR    INFO     WARNING  CRITICAL
+
+$ struct generate --file-strategy <Tab>
+append    backup    overwrite    rename    skip
+
+

This makes working with STRUCT much more efficient and user-friendly!

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/configuration/index.html b/site/configuration/index.html new file mode 100644 index 0000000..11b0abf --- /dev/null +++ b/site/configuration/index.html @@ -0,0 +1,1591 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + YAML Configuration - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

YAML Configuration

+

Configuration Properties

+

When defining your project structure in the YAML configuration file, you can use various properties to control the behavior of the script. Here are the available properties:

+
    +
  • skip: If set to true, the file or folder will be skipped and not created.
    • +
  • skip_if_exists: If set to true, the file or folder will be skipped if it already exists.
    • +
  • permissions: Set custom file permissions using a string representation of the octal value (e.g., '0777').
    • +
  • content: Define the content of the file directly in the YAML configuration.
    • +
  • file: Specify a local or remote file to include. Supported protocols include file://, http://, https://, github://, githubhttps://, githubssh://, s3://, and gs://.
    • +
+
+

Note: For local .yaml files, the file:// protocol is automatically added if not specified.

+
+

Example:

+
files:
+  - README.md:
+      skip: true
+      content: |
+        # {{@ project_name @}}
+        This is a template repository.
+  - script.sh:
+      skip_if_exists: true
+      permissions: '0777'
+      content: |
+        #!/bin/bash
+        echo "Hello, {{@ author_name @}}!"
+  - LICENSE:
+      file: https://raw.githubusercontent.com/nishanths/license/master/LICENSE
+  - remote_file.txt:
+      file: file:///path/to/local/file.txt
+  - github_file.py:
+      file: github://owner/repo/branch/path/to/file.py
+  - github_https_file.py:
+      file: githubhttps://owner/repo/branch/path/to/file.py
+  - github_ssh_file.py:
+      file: githubssh://owner/repo/branch/path/to/file.py
+  - s3_file.txt:
+      file: s3://bucket_name/key
+  - gcs_file.txt:
+      file: gs://bucket_name/key
+  - src/main.py:
+      content: |
+        print("Hello, World!")
+folders:
+  - .devops/modules/mod1:
+      struct: terraform/module
+  - .devops/modules/mod2:
+      struct: terraform/module
+      with:
+        module_name: mymod2
+  - ./:
+      struct:
+        - docker-files
+        - project/go
+variables:
+  - project_name:
+      description: "The name of the project"
+      default: "MyProject"
+      type: string
+  - author_name:
+      description: "The name of the author"
+      type: string
+      default: "John Doe"
+
+

These properties allow you to customize the behavior and content of the files and folders generated by the script, providing flexibility and control over your project structure.

+

Template Variables

+

You can use template variables in your configuration file by enclosing them in {{@ and @}}. For example, {{@ project_name @}} will be replaced with the value of the project_name variable at runtime. If this are not set when running the script, it will prompt you to enter the value interactively.

+

If you need to define blocks you can use starting block notation {%@ and end block notation %@}.

+

To define comments you can use the comment start notation {#@ and end comment notation @#}.

+

Default template variables

+
    +
  • file_name: The name of the file being processed.
    • +
  • file_directory: The name of the directory of file that is being processed.
    • +
+

Interactive template variables

+

If you don't provide a default value for a variable, the script will prompt you to enter the value interactively.

+

The struct defined should define the variable on a specific section of the YAML file. For example:

+
variables:
+  - author_name:
+      description: "The name of the author"
+      type: string
+      default: "John Doe"
+
+

as you can see, the author_name variable is defined on the variables section of the YAML file. it includes a description, type and default value which is used if the user doesn't provide a value interactively.

+

Custom Jinja2 filters

+
latest_release
+

This filter fetches the latest release version of a GitHub repository. It takes the repository name as an argument.

+
files:
+  - README.md:
+      content: |
+        # MyProject
+        Latest release: {{@ "httpdss/struct" | latest_release @}}
+
+

This uses PyGithub to fetch the latest release of the repository so setting the GITHUB_TOKEN environment variable will give you access to private repositories.

+

If there is an error in the process, the filter will return LATEST_RELEASE_ERROR.

+

NOTE: you can use this filter to get the latest release for a terraform provider. For example, to get the latest release of the aws provider, you can use {{@ "hashicorp/terraform-provider-aws" | latest_release @}} or datadog provider {{@ "DataDog/terraform-provider-datadog" | latest_release @}}.

+
slugify
+

This filter converts a string into a slug. It takes an optional argument to specify the separator character (default is -).

+
files:
+  - README.md:
+      content: |
+        # {{@ project_name @}}
+        This is a template repository.
+        slugify project_name: {{@ project_name | slugify @}}
+
+
default_branch
+

This filter fetches the default branch name of a GitHub repository. It takes the repository name as an argument.

+
files:
+  - README.md:
+      content: |
+        # MyProject
+        Default branch: {{@ "httpdss/struct" | default_branch @}}
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/contributing/index.html b/site/contributing/index.html new file mode 100644 index 0000000..bee431f --- /dev/null +++ b/site/contributing/index.html @@ -0,0 +1,1916 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Contributing - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Contributing to STRUCT

+

Thank you for your interest in contributing to STRUCT! We welcome contributions from the community and are pleased to have you join us.

+

🚀 Quick Start

+
    +
  1. Fork the repository on GitHub
    2. +
  2. Clone your fork locally
    3. +
  3. Create a feature branch from main
    4. +
  4. Make your changes and commit them
    5. +
  5. Push to your fork and submit a pull request
    6. +
+

📋 Development Setup

+

Prerequisites

+
    +
  • Python 3.8 or higher
    • +
  • Git
    • +
  • A text editor or IDE
    • +
+

Local Development

+

Clone the repository:

+
git clone https://github.com/httpdss/struct.git
+cd struct
+
+

Create a virtual environment:

+
python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+

Install in development mode:

+
pip install -e .
+pip install -r requirements.dev.txt
+
+

Run tests to ensure everything works:

+
pytest
+
+

🔧 Making Changes

+

Code Style

+
    +
  • Follow PEP 8 guidelines
    • +
  • Use 2 spaces for indentation in YAML files
    • +
  • Use 4 spaces for indentation in Python files
    • +
  • Write clear, descriptive commit messages
    • +
  • Add docstrings to new functions and classes
    • +
+

Testing

+
    +
  • Write tests for new functionality
    • +
  • Ensure all existing tests pass
    • +
  • Run the test suite: pytest
    • +
  • Check test coverage: pytest --cov=struct_module
    • +
+

Pull Request Guidelines

+
    +
  1. Create descriptive PR titles that summarize the change
    2. +
  2. Fill out the PR template completely
    3. +
  3. Link to related issues when applicable
    4. +
  4. Keep PRs focused - one feature/fix per PR
    5. +
  5. Update documentation if your changes affect user-facing functionality
    6. +
+

📝 Documentation

+

We use Markdown for documentation. When contributing:

+
    +
  • Update relevant documentation files
    • +
  • Add examples for new features
    • +
  • Keep language clear and concise
    • +
  • Follow the existing documentation structure
    • +
+

Documentation Structure

+
docs/
+├── index.md              # Main documentation index
+├── installation.md       # Installation instructions
+├── quickstart.md         # Quick start guide
+├── configuration.md      # YAML configuration reference
+├── template-variables.md # Template variable documentation
+├── file-handling.md      # File handling features
+├── custom-structures.md  # Creating custom structures
+├── hooks.md              # Pre/post hooks
+├── mappings.md           # External data mappings
+├── github-integration.md # GitHub Actions integration
+├── development.md        # Development setup
+├── completion.md         # CLI completion setup
+├── cli-reference.md      # Complete CLI reference
+├── schema.md             # YAML schema reference
+├── examples/             # Example configurations
+├── articles.md           # External articles and tutorials
+├── known-issues.md       # Known limitations
+├── contributing.md       # This file
+└── funding.md            # Funding information
+
+

🏗️ Contributing New Structures

+

STRUCT includes a collection of contrib structures in struct_module/contribs/. To add a new structure:

+
    +
  1. Create a new YAML file in the appropriate subdirectory
    2. +
  2. Follow naming conventions: use lowercase with hyphens
    3. +
  3. Test your structure with various scenarios
    4. +
  4. Add documentation explaining what the structure does
    5. +
  5. Include examples in your PR description
    6. +
+

Structure Guidelines

+
    +
  • Use descriptive file and folder names
    • +
  • Include appropriate comments in YAML
    • +
  • Follow the established patterns in existing structures
    • +
  • Test with different variable combinations
    • +
  • Ensure compatibility across platforms
    • +
+

🐛 Reporting Issues

+

Bug Reports

+

When reporting bugs, please include:

+
    +
  • OS and Python version
    • +
  • STRUCT version (struct --version)
    • +
  • Complete error message or traceback
    • +
  • Steps to reproduce the issue
    • +
  • Expected vs actual behavior
    • +
  • Sample configuration that reproduces the issue
    • +
+

Feature Requests

+

For feature requests:

+
    +
  • Describe the use case clearly
    • +
  • Explain the benefit to other users
    • +
  • Provide examples of how it would work
    • +
  • Consider implementation complexity
    • +
+

📊 Project Structure

+
struct/
+├── struct_module/           # Main Python package
+│   ├── commands/           # CLI command implementations
+│   ├── contribs/          # Contributed structure templates
+│   ├── __init__.py
+│   ├── main.py            # CLI entry point
+│   ├── file_item.py       # File handling logic
+│   ├── template_renderer.py # Jinja2 template rendering
+│   ├── content_fetcher.py # Remote content fetching
+│   ├── model_wrapper.py   # AI model integration
+│   └── utils.py           # Utility functions
+├── tests/                  # Test suite
+├── docs/                   # Documentation
+├── examples/              # Example configurations
+├── requirements.txt       # Production dependencies
+├── requirements.dev.txt   # Development dependencies
+├── setup.py              # Package configuration
+├── struct-schema.json    # JSON schema for validation
+└── README.md             # Project overview
+
+

🏷️ Issue Labels

+

We use labels to categorize issues:

+
    +
  • bug - Something isn't working
    • +
  • enhancement - New feature or request
    • +
  • documentation - Improvements to documentation
    • +
  • good first issue - Good for newcomers
    • +
  • help wanted - Extra attention is needed
    • +
  • question - Further information is requested
    • +
+

💬 Communication

+
    +
  • GitHub Issues - Bug reports and feature requests
    • +
  • GitHub Discussions - General questions and community support
    • +
  • Pull Requests - Code contributions and reviews
    • +
+

🙏 Recognition

+

All contributors will be recognized in our documentation and releases. We appreciate every contribution, whether it's:

+
    +
  • Code improvements
    • +
  • Bug reports
    • +
  • Documentation updates
    • +
  • Feature suggestions
    • +
  • Community support
    • +
+

📜 Code of Conduct

+

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

+

🤝 Getting Help

+

If you need help contributing:

+
    +
  1. Check existing documentation
    2. +
  2. Search existing issues
    3. +
  3. Create a new issue with the question label
    4. +
  4. Join our GitHub Discussions
    5. +
+

Thank you for contributing to STRUCT! 🎉

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/css/advanced.css b/site/css/advanced.css deleted file mode 100644 index c5e4ea2..0000000 --- a/site/css/advanced.css +++ /dev/null @@ -1,570 +0,0 @@ -/* STRUCT Advanced Components CSS - Phase 2 */ - -/* Search Functionality */ -.search-container { - position: relative; - max-width: 400px; - margin: 0 auto; -} - -.search-input { - width: 100%; - padding: var(--space-3) var(--space-4); - padding-left: var(--space-10); - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - color: var(--color-text-primary); - font-family: var(--font-sans); - font-size: var(--text-base); - transition: all var(--transition-fast); -} - -.search-input:focus { - outline: none; - border-color: var(--color-primary); - box-shadow: 0 0 0 3px rgba(0, 255, 136, 0.1); -} - -.search-icon { - position: absolute; - left: var(--space-3); - top: 50%; - transform: translateY(-50%); - color: var(--color-text-muted); - font-size: var(--text-lg); - pointer-events: none; -} - -.search-results { - position: absolute; - top: 100%; - left: 0; - right: 0; - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-md); - box-shadow: var(--shadow-lg); - z-index: var(--z-dropdown); - max-height: 400px; - overflow-y: auto; - margin-top: var(--space-2); -} - -.search-result-item { - padding: var(--space-4); - border-bottom: 1px solid var(--color-border); - cursor: pointer; - transition: background-color var(--transition-fast); -} - -.search-result-item:last-child { - border-bottom: none; -} - -.search-result-item:hover { - background-color: var(--color-bg-tertiary); -} - -.search-result-title { - font-size: var(--text-base); - font-weight: 600; - color: var(--color-text-primary); - margin-bottom: var(--space-1); -} - -.search-result-content { - font-size: var(--text-sm); - color: var(--color-text-secondary); - margin: 0; -} - -.search-no-results { - padding: var(--space-4); - text-align: center; - color: var(--color-text-muted); - font-style: italic; -} - -/* Advanced GitHub Stats */ -.github-stats-advanced { - margin: var(--space-12) 0; -} - -.stats-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); - gap: var(--space-4); - max-width: 1000px; - margin: 0 auto; -} - -.stat-card { - background: linear-gradient(135deg, var(--color-bg-secondary), var(--color-bg-tertiary)); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - padding: var(--space-6); - text-align: center; - transition: all var(--transition-normal); - position: relative; - overflow: hidden; -} - -.stat-card::before { - content: ''; - position: absolute; - top: 0; - left: -100%; - width: 100%; - height: 100%; - background: linear-gradient(90deg, transparent, rgba(0, 255, 136, 0.1), transparent); - transition: left 0.5s ease; -} - -.stat-card:hover::before { - left: 100%; -} - -.stat-card:hover { - transform: translateY(-4px); - border-color: var(--color-primary); - box-shadow: var(--shadow-xl); -} - -.stat-icon { - font-size: var(--text-3xl); - margin-bottom: var(--space-3); - display: block; -} - -.stat-value { - font-size: var(--text-2xl); - font-weight: 700; - color: var(--color-primary); - display: block; - margin-bottom: var(--space-2); -} - -.stat-label { - font-size: var(--text-sm); - color: var(--color-text-secondary); - text-transform: uppercase; - letter-spacing: 0.5px; - font-weight: 500; -} - -/* Contributors Showcase */ -.contributors-showcase { - background-color: var(--color-bg-secondary); - border-radius: var(--radius-lg); - padding: var(--space-8); - margin: var(--space-12) 0; -} - -.contributors-title { - text-align: center; - margin-bottom: var(--space-8); - color: var(--color-text-primary); -} - -.contributors-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); - gap: var(--space-4); - margin-bottom: var(--space-6); -} - -.contributor-card { - background-color: var(--color-bg-tertiary); - border: 1px solid var(--color-border); - border-radius: var(--radius-md); - padding: var(--space-4); - display: flex; - align-items: center; - gap: var(--space-3); - transition: all var(--transition-normal); - position: relative; -} - -.contributor-card:hover { - transform: translateY(-2px); - border-color: var(--color-primary); - box-shadow: var(--shadow-md); -} - -.contributor-avatar { - width: 48px; - height: 48px; - border-radius: var(--radius-full); - border: 2px solid var(--color-border); - transition: border-color var(--transition-fast); -} - -.contributor-card:hover .contributor-avatar { - border-color: var(--color-primary); -} - -.contributor-info { - flex: 1; -} - -.contributor-name { - font-size: var(--text-base); - font-weight: 600; - color: var(--color-text-primary); - margin-bottom: var(--space-1); -} - -.contributor-contributions { - font-size: var(--text-sm); - color: var(--color-text-secondary); - margin: 0; -} - -.contributor-link { - color: var(--color-text-muted); - font-size: var(--text-lg); - transition: color var(--transition-fast); -} - -.contributor-link:hover { - color: var(--color-primary); -} - -/* Project Showcase */ -.project-showcase { - margin: var(--space-12) 0; -} - -.showcase-title { - text-align: center; - margin-bottom: var(--space-8); - color: var(--color-text-primary); -} - -.showcase-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(280px, 1fr)); - gap: var(--space-6); -} - -.showcase-card { - background: linear-gradient(135deg, var(--color-bg-secondary), var(--color-bg-tertiary)); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - padding: var(--space-6); - text-align: center; - transition: all var(--transition-normal); - position: relative; - overflow: hidden; -} - -.showcase-card::after { - content: ''; - position: absolute; - top: 0; - left: 0; - right: 0; - height: 3px; - background: linear-gradient(90deg, var(--color-primary), var(--color-secondary)); - transform: scaleX(0); - transition: transform var(--transition-normal); -} - -.showcase-card:hover::after { - transform: scaleX(1); -} - -.showcase-card:hover { - transform: translateY(-8px); - box-shadow: var(--shadow-xl); -} - -.showcase-icon { - font-size: var(--text-4xl); - margin-bottom: var(--space-4); -} - -.showcase-name { - font-size: var(--text-xl); - font-weight: 600; - color: var(--color-text-primary); - margin-bottom: var(--space-3); -} - -.showcase-description { - color: var(--color-text-secondary); - margin-bottom: var(--space-4); - line-height: 1.6; -} - -.showcase-tags { - display: flex; - flex-wrap: wrap; - gap: var(--space-2); - justify-content: center; -} - -.showcase-tag { - background-color: var(--color-bg-primary); - color: var(--color-primary); - padding: var(--space-1) var(--space-2); - border-radius: var(--radius-sm); - font-size: var(--text-xs); - font-weight: 500; - text-transform: uppercase; - letter-spacing: 0.5px; -} - -/* Demo Modal */ -.demo-modal { - position: fixed; - top: 0; - left: 0; - width: 100%; - height: 100%; - background-color: rgba(0, 0, 0, 0.9); - z-index: var(--z-modal); - display: flex; - align-items: center; - justify-content: center; - opacity: 0; - visibility: hidden; - transition: all var(--transition-normal); -} - -.demo-modal.active { - opacity: 1; - visibility: visible; -} - -.demo-modal-content { - position: relative; - max-width: 90vw; - max-height: 90vh; - background-color: var(--color-bg-secondary); - border-radius: var(--radius-lg); - overflow: hidden; - box-shadow: var(--shadow-xl); -} - -.demo-modal-close { - position: absolute; - top: var(--space-4); - right: var(--space-4); - background: none; - border: none; - color: var(--color-text-primary); - font-size: var(--text-2xl); - cursor: pointer; - z-index: 1; - width: 40px; - height: 40px; - border-radius: var(--radius-full); - background-color: rgba(0, 0, 0, 0.5); - transition: all var(--transition-fast); -} - -.demo-modal-close:hover { - background-color: var(--color-primary); - color: var(--color-bg-primary); -} - -.demo-modal-video { - width: 100%; - height: auto; - display: block; -} - -.demo-modal-info { - padding: var(--space-6); - text-align: center; -} - -.demo-modal-info h3 { - color: var(--color-text-primary); - margin-bottom: var(--space-2); -} - -.demo-modal-info p { - color: var(--color-text-secondary); - font-size: var(--text-sm); -} - -/* Keyboard Shortcuts Modal */ -.shortcuts-modal { - position: fixed; - top: 0; - left: 0; - width: 100%; - height: 100%; - background-color: rgba(0, 0, 0, 0.8); - z-index: var(--z-modal); - display: flex; - align-items: center; - justify-content: center; - opacity: 0; - visibility: hidden; - transition: all var(--transition-normal); -} - -.shortcuts-modal.active { - opacity: 1; - visibility: visible; -} - -.shortcuts-content { - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - padding: var(--space-8); - max-width: 400px; - width: 90%; -} - -.shortcuts-content h3 { - text-align: center; - margin-bottom: var(--space-6); - color: var(--color-text-primary); -} - -.shortcuts-list { - display: flex; - flex-direction: column; - gap: var(--space-3); - margin-bottom: var(--space-6); -} - -.shortcut-item { - display: flex; - justify-content: space-between; - align-items: center; - padding: var(--space-2) 0; -} - -.shortcut-item kbd { - background-color: var(--color-bg-tertiary); - border: 1px solid var(--color-border); - border-radius: var(--radius-sm); - padding: var(--space-1) var(--space-2); - font-family: var(--font-mono); - font-size: var(--text-xs); - color: var(--color-text-primary); - margin: 0 var(--space-1); -} - -.shortcut-item span { - color: var(--color-text-secondary); - font-size: var(--text-sm); -} - -/* Enhanced Animations */ -.animate-on-scroll { - opacity: 0; - transform: translateY(30px); - transition: all 0.6s ease-out; -} - -.animate-on-scroll.animate-in { - opacity: 1; - transform: translateY(0); -} - -.stagger-item { - opacity: 0; - transform: translateY(20px); - transition: all 0.4s ease-out; -} - -.stagger-item.animate-in { - opacity: 1; - transform: translateY(0); -} - -/* Loading States */ -.skeleton { - background: linear-gradient(90deg, var(--color-bg-secondary) 25%, var(--color-bg-tertiary) 50%, var(--color-bg-secondary) 75%); - background-size: 200% 100%; - animation: loading 1.5s infinite; - border-radius: var(--radius-sm); -} - -.stat-card.loading .stat-icon, -.stat-card.loading .stat-value, -.stat-card.loading .stat-label { - background: linear-gradient(90deg, var(--color-bg-tertiary) 25%, var(--color-border) 50%, var(--color-bg-tertiary) 75%); - background-size: 200% 100%; - animation: loading 1.5s infinite; - color: transparent; - border-radius: var(--radius-sm); -} - -/* Progressive Enhancement */ -.no-js .search-container, -.no-js .shortcuts-modal, -.no-js .demo-modal { - display: none; -} - -.js-enabled .enhanced-only { - display: block; -} - -/* Mobile Optimizations */ -@media (max-width: 768px) { - .stats-grid { - grid-template-columns: repeat(2, 1fr); - gap: var(--space-3); - } - - .contributors-grid { - grid-template-columns: 1fr; - } - - .showcase-grid { - grid-template-columns: 1fr; - } - - .demo-modal-content { - max-width: 95vw; - margin: var(--space-4); - } - - .shortcuts-content { - max-width: 95vw; - padding: var(--space-6); - } - - .search-container { - max-width: 100%; - } -} - -/* High Contrast Mode Support */ -@media (prefers-contrast: high) { - .stat-card, - .contributor-card, - .showcase-card { - border-width: 2px; - } - - .search-input:focus { - border-width: 2px; - } -} - -/* Print Styles */ -@media print { - .search-container, - .demo-modal, - .shortcuts-modal { - display: none; - } - - .stat-card, - .contributor-card, - .showcase-card { - break-inside: avoid; - border: 1px solid #000; - } -} diff --git a/site/css/animations.css b/site/css/animations.css deleted file mode 100644 index b982ea7..0000000 --- a/site/css/animations.css +++ /dev/null @@ -1,475 +0,0 @@ -/* STRUCT Animations CSS */ - -/* Keyframe Animations */ -@keyframes fadeIn { - from { - opacity: 0; - transform: translateY(30px); - } - to { - opacity: 1; - transform: translateY(0); - } -} - -@keyframes slideUp { - from { - opacity: 0; - transform: translateY(20px); - } - to { - opacity: 1; - transform: translateY(0); - } -} - -@keyframes slideInLeft { - from { - opacity: 0; - transform: translateX(-30px); - } - to { - opacity: 1; - transform: translateX(0); - } -} - -@keyframes slideInRight { - from { - opacity: 0; - transform: translateX(30px); - } - to { - opacity: 1; - transform: translateX(0); - } -} - -@keyframes pulse { - 0%, 100% { - transform: scale(1); - } - 50% { - transform: scale(1.05); - } -} - -@keyframes glow { - 0%, 100% { - box-shadow: 0 0 20px rgba(0, 255, 136, 0.3); - } - 50% { - box-shadow: 0 0 30px rgba(0, 255, 136, 0.6); - } -} - -@keyframes gradient { - 0% { - background-position: 0% 50%; - } - 50% { - background-position: 100% 50%; - } - 100% { - background-position: 0% 50%; - } -} - -@keyframes typewriter { - from { - width: 0; - } - to { - width: 100%; - } -} - -@keyframes blink { - 0%, 50% { - opacity: 1; - } - 51%, 100% { - opacity: 0; - } -} - -@keyframes float { - 0%, 100% { - transform: translateY(0px); - } - 50% { - transform: translateY(-10px); - } -} - -@keyframes spin { - from { - transform: rotate(0deg); - } - to { - transform: rotate(360deg); - } -} - -@keyframes bounce { - 0%, 20%, 53%, 80%, 100% { - transform: translate3d(0, 0, 0); - } - 40%, 43% { - transform: translate3d(0, -15px, 0); - } - 70% { - transform: translate3d(0, -7px, 0); - } - 90% { - transform: translate3d(0, -2px, 0); - } -} - -@keyframes shake { - 0%, 100% { - transform: translateX(0); - } - 10%, 30%, 50%, 70%, 90% { - transform: translateX(-5px); - } - 20%, 40%, 60%, 80% { - transform: translateX(5px); - } -} - -@keyframes loading { - 0% { - background-position: 200% 0; - } - 100% { - background-position: -200% 0; - } -} - -/* Animation Classes */ -.fade-in { - animation: fadeIn 0.6s ease-out forwards; -} - -.slide-up { - animation: slideUp 0.4s ease-out forwards; -} - -.slide-in-left { - animation: slideInLeft 0.5s ease-out forwards; -} - -.slide-in-right { - animation: slideInRight 0.5s ease-out forwards; -} - -.pulse { - animation: pulse 2s ease-in-out infinite; -} - -.glow { - animation: glow 3s ease-in-out infinite; -} - -.gradient-animation { - background: linear-gradient(-45deg, var(--color-primary), var(--color-secondary), var(--color-accent), var(--color-primary)); - background-size: 400% 400%; - animation: gradient 15s ease infinite; -} - -.typewriter { - overflow: hidden; - border-right: 2px solid var(--color-primary); - white-space: nowrap; - animation: typewriter 3s steps(40, end), blink 0.75s step-end infinite; -} - -.float { - animation: float 3s ease-in-out infinite; -} - -.spin { - animation: spin 1s linear infinite; -} - -.bounce { - animation: bounce 2s infinite; -} - -.shake { - animation: shake 0.5s ease-in-out; -} - -.loading-animation { - background: linear-gradient(90deg, var(--color-bg-secondary) 25%, var(--color-bg-tertiary) 50%, var(--color-bg-secondary) 75%); - background-size: 200% 100%; - animation: loading 1.5s infinite; -} - -/* Hover Animations */ -.hover-lift:hover { - transform: translateY(-5px); - box-shadow: var(--shadow-lg); - transition: all var(--transition-normal); -} - -.hover-scale:hover { - transform: scale(1.05); - transition: transform var(--transition-fast); -} - -.hover-rotate:hover { - transform: rotate(5deg); - transition: transform var(--transition-normal); -} - -.hover-glow:hover { - box-shadow: 0 0 30px rgba(0, 255, 136, 0.5); - transition: box-shadow var(--transition-normal); -} - -.hover-blur:hover { - filter: blur(1px); - transition: filter var(--transition-fast); -} - -/* Scroll Animations */ -.scroll-reveal { - opacity: 0; - transform: translateY(50px); - transition: all 0.6s ease-out; -} - -.scroll-reveal.revealed { - opacity: 1; - transform: translateY(0); -} - -.scroll-reveal-left { - opacity: 0; - transform: translateX(-50px); - transition: all 0.6s ease-out; -} - -.scroll-reveal-left.revealed { - opacity: 1; - transform: translateX(0); -} - -.scroll-reveal-right { - opacity: 0; - transform: translateX(50px); - transition: all 0.6s ease-out; -} - -.scroll-reveal-right.revealed { - opacity: 1; - transform: translateX(0); -} - -/* Staggered Animations */ -.stagger-1 { - animation-delay: 0.1s; -} - -.stagger-2 { - animation-delay: 0.2s; -} - -.stagger-3 { - animation-delay: 0.3s; -} - -.stagger-4 { - animation-delay: 0.4s; -} - -.stagger-5 { - animation-delay: 0.5s; -} - -.stagger-6 { - animation-delay: 0.6s; -} - -/* Hero Section Specific Animations */ -.hero-title { - animation: fadeIn 1s ease-out 0.5s both; -} - -.hero-subtitle { - animation: fadeIn 1s ease-out 0.8s both; -} - -.hero-actions { - animation: fadeIn 1s ease-out 1.1s both; -} - -/* Feature Cards Animation */ -.feature-card { - opacity: 0; - transform: translateY(30px); - transition: all 0.6s ease-out; -} - -.feature-card.visible { - opacity: 1; - transform: translateY(0); -} - -.feature-card:nth-child(1) { animation-delay: 0.1s; } -.feature-card:nth-child(2) { animation-delay: 0.2s; } -.feature-card:nth-child(3) { animation-delay: 0.3s; } -.feature-card:nth-child(4) { animation-delay: 0.4s; } -.feature-card:nth-child(5) { animation-delay: 0.5s; } -.feature-card:nth-child(6) { animation-delay: 0.6s; } - -/* Code Block Animations */ -.code-block { - position: relative; - overflow: hidden; -} - -.code-block::before { - content: ''; - position: absolute; - top: 0; - left: -100%; - width: 100%; - height: 100%; - background: linear-gradient(90deg, transparent, rgba(0, 255, 136, 0.2), transparent); - transition: left 0.5s ease; -} - -.code-block:hover::before { - left: 100%; -} - -/* Button Ripple Effect */ -.btn { - position: relative; - overflow: hidden; -} - -.btn::before { - content: ''; - position: absolute; - top: 50%; - left: 50%; - width: 0; - height: 0; - border-radius: 50%; - background: rgba(255, 255, 255, 0.2); - transform: translate(-50%, -50%); - transition: width 0.3s ease, height 0.3s ease; -} - -.btn:active::before { - width: 300px; - height: 300px; -} - -/* Navigation Animation */ -.navbar { - transform: translateY(-100%); - animation: slideDown 0.5s ease-out 0.2s both; -} - -@keyframes slideDown { - from { - transform: translateY(-100%); - } - to { - transform: translateY(0); - } -} - -/* Loading States */ -.btn.loading { - pointer-events: none; - opacity: 0.7; -} - -.btn.loading::after { - content: ''; - position: absolute; - top: 50%; - left: 50%; - width: 16px; - height: 16px; - margin: -8px 0 0 -8px; - border: 2px solid transparent; - border-top-color: currentColor; - border-radius: 50%; - animation: spin 1s linear infinite; -} - -/* Reduced Motion */ -@media (prefers-reduced-motion: reduce) { - *, - *::before, - *::after { - animation-duration: 0.01ms !important; - animation-iteration-count: 1 !important; - transition-duration: 0.01ms !important; - } - - .scroll-reveal, - .scroll-reveal-left, - .scroll-reveal-right { - opacity: 1; - transform: none; - } -} - -/* Dark/Light Theme Transitions */ -@media (prefers-color-scheme: light) { - :root { - transition: background-color 0.3s ease, color 0.3s ease; - } -} - -/* Focus Animations */ -.btn:focus, -.tab-button:focus, -.demo-tab:focus { - animation: pulse 0.3s ease-in-out; -} - -/* Success/Error States */ -.success { - animation: bounce 0.6s ease-in-out; -} - -.error { - animation: shake 0.5s ease-in-out; -} - -/* Particle Animation for Hero Background */ -@keyframes particle-float { - 0%, 100% { - transform: translateY(0px) rotate(0deg); - opacity: 0.3; - } - 50% { - transform: translateY(-20px) rotate(180deg); - opacity: 0.8; - } -} - -.hero::after { - content: ''; - position: absolute; - top: 0; - left: 0; - width: 100%; - height: 100%; - background-image: - radial-gradient(2px 2px at 20px 30px, rgba(0, 255, 136, 0.3), transparent), - radial-gradient(2px 2px at 40px 70px, rgba(0, 102, 255, 0.3), transparent), - radial-gradient(1px 1px at 90px 40px, rgba(255, 102, 0, 0.3), transparent); - background-size: 100px 100px; - animation: particle-float 20s ease-in-out infinite; - pointer-events: none; -} diff --git a/site/css/components.css b/site/css/components.css deleted file mode 100644 index 8c12fab..0000000 --- a/site/css/components.css +++ /dev/null @@ -1,631 +0,0 @@ -/* STRUCT Components CSS */ - -/* Navigation Bar */ -.navbar { - position: sticky; - top: 0; - z-index: var(--z-sticky); - background: rgba(10, 10, 10, 0.95); - backdrop-filter: blur(10px); - border-bottom: 1px solid var(--color-border); - padding: var(--space-4) 0; -} - -.navbar-content { - display: flex; - align-items: center; - justify-content: space-between; - gap: var(--space-8); /* Add proper spacing between sections */ -} - -.navbar-brand { - display: flex; - align-items: center; - gap: var(--space-3); - font-weight: 700; - font-size: var(--text-xl); - color: var(--color-primary); - flex-shrink: 0; /* Prevent logo from shrinking */ -} - -.navbar-nav { - display: flex; - gap: var(--space-6); - list-style: none; - margin-left: auto; /* Push navigation to the right side */ - margin-right: var(--space-4); /* Add space before search/theme toggle */ -} - -.navbar-nav a { - color: var(--color-text-secondary); - font-weight: 500; - transition: color var(--transition-fast); -} - -.navbar-nav a:hover { - color: var(--color-primary); -} - -/* Buttons */ -.btn { - display: inline-flex; - align-items: center; - justify-content: center; - gap: var(--space-2); - padding: var(--space-3) var(--space-6); - border: none; - border-radius: var(--radius-md); - font-family: var(--font-sans); - font-size: var(--text-base); - font-weight: 500; - line-height: 1; - cursor: pointer; - transition: all var(--transition-fast); - text-decoration: none; - white-space: nowrap; -} - -.btn:focus { - outline: 2px solid var(--color-primary); - outline-offset: 2px; -} - -.btn-primary { - background: linear-gradient(135deg, var(--color-primary), var(--color-secondary)); - color: var(--color-bg-primary); -} - -.btn-primary:hover { - transform: translateY(-2px); - box-shadow: var(--shadow-lg); -} - -.btn-secondary { - background-color: transparent; - color: var(--color-text-primary); - border: 1px solid var(--color-border); -} - -.btn-secondary:hover { - background-color: var(--color-bg-secondary); - border-color: var(--color-primary); - color: var(--color-primary); -} - -.btn-ghost { - background-color: transparent; - color: var(--color-text-secondary); -} - -.btn-ghost:hover { - background-color: var(--color-bg-secondary); - color: var(--color-primary); -} - -.btn-lg { - padding: var(--space-4) var(--space-8); - font-size: var(--text-lg); -} - -.btn-sm { - padding: var(--space-2) var(--space-4); - font-size: var(--text-sm); -} - -/* Cards */ -.card { - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - padding: var(--space-6); - transition: all var(--transition-normal); -} - -.card:hover { - border-color: var(--color-primary); - box-shadow: var(--shadow-lg); - transform: translateY(-4px); -} - -.card-header { - margin-bottom: var(--space-4); -} - -.card-title { - font-size: var(--text-xl); - font-weight: 600; - color: var(--color-text-primary); - margin-bottom: var(--space-2); -} - -.card-description { - color: var(--color-text-secondary); - margin-bottom: 0; -} - -.card-content { - margin-bottom: var(--space-4); -} - -.card-footer { - border-top: 1px solid var(--color-border); - padding-top: var(--space-4); - margin-top: var(--space-4); -} - -/* Hero Section */ -.hero { - background: linear-gradient(135deg, var(--color-bg-primary) 0%, var(--color-bg-secondary) 100%); - padding: var(--space-20) 0; - text-align: center; - position: relative; - overflow: hidden; -} - -.hero::before { - content: ''; - position: absolute; - top: 0; - left: 0; - right: 0; - bottom: 0; - background: - radial-gradient(circle at 20% 20%, var(--color-primary) 0%, transparent 50%), - radial-gradient(circle at 80% 80%, var(--color-secondary) 0%, transparent 50%); - opacity: 0.1; - pointer-events: none; -} - -.hero-content { - position: relative; - z-index: 1; -} - -.hero-title { - font-size: clamp(var(--text-4xl), 5vw, var(--text-6xl)); - font-weight: 700; - margin-bottom: var(--space-6); - background: linear-gradient(135deg, var(--color-primary), var(--color-secondary)); - -webkit-background-clip: text; - -webkit-text-fill-color: transparent; - background-clip: text; -} - -.hero-subtitle { - font-size: var(--text-xl); - color: var(--color-text-secondary); - max-width: 600px; - margin: 0 auto var(--space-8); -} - -.hero-actions { - display: flex; - gap: var(--space-4); - justify-content: center; - flex-wrap: wrap; -} - -/* Installation Tabs */ -.installation-tabs { - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - overflow: hidden; -} - -.tab-buttons { - display: flex; - background-color: var(--color-bg-tertiary); - border-bottom: 1px solid var(--color-border); -} - -.tab-button { - flex: 1; - padding: var(--space-4); - background: none; - border: none; - color: var(--color-text-secondary); - font-family: var(--font-sans); - font-size: var(--text-sm); - font-weight: 500; - cursor: pointer; - transition: all var(--transition-fast); - border-right: 1px solid var(--color-border); -} - -.tab-button:last-child { - border-right: none; -} - -.tab-button.active { - background-color: var(--color-bg-secondary); - color: var(--color-primary); -} - -.tab-button:hover:not(.active) { - background-color: var(--color-bg-secondary); - color: var(--color-text-primary); -} - -.tab-content { - padding: var(--space-6); -} - -.tab-pane { - display: none; -} - -.tab-pane.active { - display: block; -} - -/* Code Block with Copy Button */ -.code-block { - position: relative; - margin: var(--space-4) 0; -} - -.code-block pre { - margin: 0; - padding-right: var(--space-12); -} - -.copy-button { - position: absolute; - top: var(--space-2); - right: var(--space-2); - background-color: var(--color-bg-tertiary); - border: 1px solid var(--color-border); - color: var(--color-text-secondary); - padding: var(--space-2); - border-radius: var(--radius-sm); - cursor: pointer; - font-size: var(--text-xs); - transition: all var(--transition-fast); -} - -.copy-button:hover { - background-color: var(--color-primary); - color: var(--color-bg-primary); -} - -/* Feature Grid */ -.features-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(300px, 1fr)); - gap: var(--space-6); - margin: var(--space-12) 0; -} - -.feature-card { - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - padding: var(--space-6); - text-align: center; - transition: all var(--transition-normal); -} - -.feature-card:hover { - border-color: var(--color-primary); - transform: translateY(-4px); - box-shadow: var(--shadow-lg); -} - -.feature-icon { - font-size: var(--text-4xl); - margin-bottom: var(--space-4); - color: var(--color-primary); -} - -.feature-title { - font-size: var(--text-xl); - font-weight: 600; - margin-bottom: var(--space-3); - color: var(--color-text-primary); -} - -.feature-description { - color: var(--color-text-secondary); - line-height: 1.6; -} - -/* GitHub Stats */ -.github-stats { - display: flex; - gap: var(--space-4); - justify-content: center; - flex-wrap: wrap; - margin: var(--space-8) 0; -} - -.stat-item { - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-md); - padding: var(--space-4) var(--space-6); - text-align: center; - min-width: 120px; -} - -.stat-value { - font-size: var(--text-2xl); - font-weight: 700; - color: var(--color-primary); - display: block; -} - -.stat-label { - font-size: var(--text-sm); - color: var(--color-text-secondary); - margin-top: var(--space-1); -} - -/* Demo Carousel */ -.demo-carousel { - position: relative; - background-color: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: var(--radius-lg); - overflow: hidden; - margin: var(--space-8) 0; -} - -.demo-tabs { - display: flex; - background-color: var(--color-bg-tertiary); - border-bottom: 1px solid var(--color-border); - overflow-x: auto; -} - -.demo-tab { - padding: var(--space-3) var(--space-4); - background: none; - border: none; - color: var(--color-text-secondary); - font-family: var(--font-sans); - font-size: var(--text-sm); - font-weight: 500; - cursor: pointer; - transition: all var(--transition-fast); - white-space: nowrap; - border-right: 1px solid var(--color-border); -} - -.demo-tab:last-child { - border-right: none; -} - -.demo-tab.active { - background-color: var(--color-bg-secondary); - color: var(--color-primary); -} - -.demo-tab:hover:not(.active) { - background-color: var(--color-bg-secondary); - color: var(--color-text-primary); -} - -.demo-content { - padding: var(--space-6); - text-align: center; -} - -.demo-content-item { - display: none; - animation: fadeIn 0.3s ease-in-out; -} - -.demo-content-item.active { - display: block; -} - -.demo-video { - max-width: 100%; - border-radius: var(--radius-md); - margin: var(--space-4) 0; -} - -/* Footer */ -.footer { - background-color: var(--color-bg-secondary); - border-top: 1px solid var(--color-border); - padding: var(--space-12) 0 var(--space-8); - margin-top: var(--space-20); -} - -.footer-content { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); - gap: var(--space-8); - margin-bottom: var(--space-8); -} - -.footer-section h3 { - color: var(--color-text-primary); - margin-bottom: var(--space-4); -} - -.footer-section ul { - list-style: none; -} - -.footer-section li { - margin-bottom: var(--space-2); -} - -.footer-section a { - color: var(--color-text-secondary); - transition: color var(--transition-fast); -} - -.footer-section a:hover { - color: var(--color-primary); -} - -.footer-bottom { - border-top: 1px solid var(--color-border); - padding-top: var(--space-6); - text-align: center; - color: var(--color-text-muted); -} - -/* Responsive Design */ -@media (max-width: 768px) { - .navbar-nav { - display: none; - } - - .hero-actions { - flex-direction: column; - align-items: center; - } - - .btn { - width: 100%; - max-width: 300px; - } - - .tab-buttons { - flex-direction: column; - } - - .tab-button { - border-right: none; - border-bottom: 1px solid var(--color-border); - } - - .tab-button:last-child { - border-bottom: none; - } - - .github-stats { - flex-direction: column; - align-items: center; - } - - .stat-item { - min-width: 200px; - } -} - -/* Loading States */ -.loading { - opacity: 0.6; - pointer-events: none; -} - -.skeleton { - background: linear-gradient(90deg, var(--color-bg-secondary) 25%, var(--color-bg-tertiary) 50%, var(--color-bg-secondary) 75%); - background-size: 200% 100%; - animation: loading 1.5s infinite; -} - -@keyframes loading { - 0% { - background-position: 200% 0; - } - 100% { - background-position: -200% 0; - } -} - -/* Utilities for JavaScript Components */ -.fade-in { - animation: fadeIn 0.5s ease-in-out; -} - -@keyframes fadeIn { - from { - opacity: 0; - transform: translateY(20px); - } - to { - opacity: 1; - transform: translateY(0); - } -} - -.slide-up { - animation: slideUp 0.3s ease-out; -} - -@keyframes slideUp { - from { - transform: translateY(10px); - opacity: 0; - } - to { - transform: translateY(0); - opacity: 1; - } -} - -/* Responsive Navigation */ -@media (max-width: 1024px) { - .navbar-content { - gap: var(--space-6); /* Reduce gap on tablets */ - } - - .navbar-nav { - gap: var(--space-4); /* Reduce menu item spacing */ - margin-right: var(--space-3); - } -} - -@media (max-width: 768px) { - .navbar { - padding: var(--space-3) 0; /* Reduce navbar height on mobile */ - } - - .navbar-content { - gap: var(--space-4); /* Further reduce gap on mobile */ - flex-wrap: nowrap; /* Prevent wrapping */ - } - - .navbar-brand { - font-size: var(--text-lg); /* Slightly smaller logo text */ - gap: var(--space-2); - } - - .navbar-nav { - gap: var(--space-3); /* Tighter spacing on mobile */ - margin-right: var(--space-2); - } - - .navbar-nav a { - font-size: var(--text-sm); /* Smaller menu text */ - padding: var(--space-2) 0; /* Add vertical padding for better touch targets */ - } -} - -@media (max-width: 640px) { - .navbar-content { - gap: var(--space-3); - } - - .navbar-nav { - gap: var(--space-2); - margin-right: var(--space-1); - } - - /* Hide some menu items on very small screens if needed */ - .navbar-nav li:nth-child(n+4) { - display: none; - } -} - -@media (max-width: 480px) { - .navbar-brand { - font-size: var(--text-base); - } - - .navbar-nav { - gap: var(--space-1); - } - - /* Show only essential menu items */ - .navbar-nav li:nth-child(n+3) { - display: none; - } -} diff --git a/site/css/main.css b/site/css/main.css deleted file mode 100644 index 9f0c6c3..0000000 --- a/site/css/main.css +++ /dev/null @@ -1,341 +0,0 @@ -/* STRUCT Modern Static Site - Main CSS */ - -/* Import Google Fonts */ -@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=Fira+Code:wght@300;400;500&display=swap'); - -/* CSS Custom Properties - Design System */ -:root { - /* Colors */ - --color-primary: #00ff88; - --color-secondary: #0066ff; - --color-accent: #ff6600; - --color-bg-primary: #0a0a0a; - --color-bg-secondary: #1a1a1a; - --color-bg-tertiary: #2a2a2a; - --color-text-primary: #ffffff; - --color-text-secondary: #b0b0b0; - --color-text-muted: #888888; - --color-border: #333333; - --color-success: #00ff88; - --color-warning: #ffaa00; - --color-error: #ff4444; - - /* Typography */ - --font-sans: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; - --font-mono: 'Fira Code', 'SF Mono', Monaco, 'Cascadia Code', monospace; - - /* Font Sizes */ - --text-xs: 0.75rem; /* 12px */ - --text-sm: 0.875rem; /* 14px */ - --text-base: 1rem; /* 16px */ - --text-lg: 1.125rem; /* 18px */ - --text-xl: 1.25rem; /* 20px */ - --text-2xl: 1.5rem; /* 24px */ - --text-3xl: 1.875rem; /* 30px */ - --text-4xl: 2.25rem; /* 36px */ - --text-5xl: 3rem; /* 48px */ - --text-6xl: 3.75rem; /* 60px */ - - /* Spacing */ - --space-1: 0.25rem; /* 4px */ - --space-2: 0.5rem; /* 8px */ - --space-3: 0.75rem; /* 12px */ - --space-4: 1rem; /* 16px */ - --space-5: 1.25rem; /* 20px */ - --space-6: 1.5rem; /* 24px */ - --space-8: 2rem; /* 32px */ - --space-10: 2.5rem; /* 40px */ - --space-12: 3rem; /* 48px */ - --space-16: 4rem; /* 64px */ - --space-20: 5rem; /* 80px */ - - /* Border Radius */ - --radius-sm: 0.25rem; /* 4px */ - --radius-md: 0.5rem; /* 8px */ - --radius-lg: 0.75rem; /* 12px */ - --radius-xl: 1rem; /* 16px */ - --radius-full: 9999px; - - /* Shadows */ - --shadow-sm: 0 1px 2px 0 rgba(0, 0, 0, 0.5); - --shadow-md: 0 4px 6px -1px rgba(0, 0, 0, 0.5); - --shadow-lg: 0 10px 15px -3px rgba(0, 0, 0, 0.5); - --shadow-xl: 0 20px 25px -5px rgba(0, 0, 0, 0.5); - - /* Transitions */ - --transition-fast: 0.15s ease-in-out; - --transition-normal: 0.3s ease-in-out; - --transition-slow: 0.5s ease-in-out; - - /* Z-index */ - --z-dropdown: 1000; - --z-sticky: 1020; - --z-fixed: 1030; - --z-modal: 1040; - --z-popover: 1050; - --z-tooltip: 1060; -} - -/* Reset and Base Styles */ -*, -*::before, -*::after { - box-sizing: border-box; - margin: 0; - padding: 0; -} - -html { - scroll-behavior: smooth; - font-size: 16px; -} - -body { - font-family: var(--font-sans); - font-size: var(--text-base); - line-height: 1.6; - color: var(--color-text-primary); - background-color: var(--color-bg-primary); - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; -} - -/* Typography */ -h1, h2, h3, h4, h5, h6 { - font-weight: 600; - line-height: 1.2; - margin-bottom: var(--space-4); - color: var(--color-text-primary); -} - -h1 { font-size: var(--text-6xl); } -h2 { font-size: var(--text-4xl); } -h3 { font-size: var(--text-2xl); } -h4 { font-size: var(--text-xl); } -h5 { font-size: var(--text-lg); } -h6 { font-size: var(--text-base); } - -p { - margin-bottom: var(--space-4); - color: var(--color-text-secondary); -} - -a { - color: var(--color-secondary); - text-decoration: none; - transition: color var(--transition-fast); -} - -a:hover { - color: var(--color-primary); -} - -/* Code Typography */ -code, pre { - font-family: var(--font-mono); - font-size: var(--text-sm); -} - -code { - background-color: var(--color-bg-secondary); - padding: var(--space-1) var(--space-2); - border-radius: var(--radius-sm); - color: var(--color-primary); -} - -pre { - background-color: var(--color-bg-secondary); - padding: var(--space-4); - border-radius: var(--radius-md); - overflow-x: auto; - border: 1px solid var(--color-border); -} - -pre code { - background: none; - padding: 0; - color: var(--color-text-primary); -} - -/* Layout */ -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 var(--space-4); -} - -.container-fluid { - width: 100%; - padding: 0 var(--space-4); -} - -/* Responsive containers */ -@media (min-width: 640px) { - .container, .container-fluid { - padding: 0 var(--space-6); - } -} - -@media (min-width: 1024px) { - .container, .container-fluid { - padding: 0 var(--space-8); - } -} - -/* Grid System */ -.grid { - display: grid; - gap: var(--space-6); -} - -.grid-cols-1 { grid-template-columns: repeat(1, 1fr); } -.grid-cols-2 { grid-template-columns: repeat(2, 1fr); } -.grid-cols-3 { grid-template-columns: repeat(3, 1fr); } -.grid-cols-4 { grid-template-columns: repeat(4, 1fr); } - -@media (min-width: 768px) { - .md\:grid-cols-2 { grid-template-columns: repeat(2, 1fr); } - .md\:grid-cols-3 { grid-template-columns: repeat(3, 1fr); } - .md\:grid-cols-4 { grid-template-columns: repeat(4, 1fr); } -} - -@media (min-width: 1024px) { - .lg\:grid-cols-2 { grid-template-columns: repeat(2, 1fr); } - .lg\:grid-cols-3 { grid-template-columns: repeat(3, 1fr); } - .lg\:grid-cols-4 { grid-template-columns: repeat(4, 1fr); } -} - -/* Flexbox Utilities */ -.flex { - display: flex; -} - -.flex-col { - flex-direction: column; -} - -.items-center { - align-items: center; -} - -.justify-center { - justify-content: center; -} - -.justify-between { - justify-content: space-between; -} - -.gap-4 { - gap: var(--space-4); -} - -.gap-6 { - gap: var(--space-6); -} - -.gap-8 { - gap: var(--space-8); -} - -/* Spacing Utilities */ -.mb-4 { margin-bottom: var(--space-4); } -.mb-6 { margin-bottom: var(--space-6); } -.mb-8 { margin-bottom: var(--space-8); } -.mb-12 { margin-bottom: var(--space-12); } - -.mt-4 { margin-top: var(--space-4); } -.mt-6 { margin-top: var(--space-6); } -.mt-8 { margin-top: var(--space-8); } -.mt-12 { margin-top: var(--space-12); } - -.py-4 { padding-top: var(--space-4); padding-bottom: var(--space-4); } -.py-8 { padding-top: var(--space-8); padding-bottom: var(--space-8); } -.py-12 { padding-top: var(--space-12); padding-bottom: var(--space-12); } -.py-20 { padding-top: var(--space-20); padding-bottom: var(--space-20); } - -.px-4 { padding-left: var(--space-4); padding-right: var(--space-4); } -.px-6 { padding-left: var(--space-6); padding-right: var(--space-6); } -.px-8 { padding-left: var(--space-8); padding-right: var(--space-8); } - -/* Text Utilities */ -.text-center { text-align: center; } -.text-left { text-align: left; } -.text-right { text-align: right; } - -.text-primary { color: var(--color-primary); } -.text-secondary { color: var(--color-text-secondary); } -.text-muted { color: var(--color-text-muted); } - -.font-mono { font-family: var(--font-mono); } -.font-sans { font-family: var(--font-sans); } - -/* Background Utilities */ -.bg-primary { background-color: var(--color-bg-primary); } -.bg-secondary { background-color: var(--color-bg-secondary); } -.bg-tertiary { background-color: var(--color-bg-tertiary); } - -/* Border Utilities */ -.border { border: 1px solid var(--color-border); } -.border-t { border-top: 1px solid var(--color-border); } -.border-b { border-bottom: 1px solid var(--color-border); } - -.rounded { border-radius: var(--radius-md); } -.rounded-lg { border-radius: var(--radius-lg); } -.rounded-full { border-radius: var(--radius-full); } - -/* Animation Utilities */ -.transition { - transition: all var(--transition-normal); -} - -.hover\:scale-105:hover { - transform: scale(1.05); -} - -.hover\:shadow-lg:hover { - box-shadow: var(--shadow-lg); -} - -/* Visibility */ -.hidden { - display: none; -} - -@media (min-width: 768px) { - .md\:block { - display: block; - } - - .md\:hidden { - display: none; - } -} - -@media (min-width: 1024px) { - .lg\:block { - display: block; - } - - .lg\:hidden { - display: none; - } -} - -/* Custom Scrollbar */ -::-webkit-scrollbar { - width: 8px; -} - -::-webkit-scrollbar-track { - background: var(--color-bg-secondary); -} - -::-webkit-scrollbar-thumb { - background: var(--color-border); - border-radius: var(--radius-full); -} - -::-webkit-scrollbar-thumb:hover { - background: var(--color-text-muted); -} diff --git a/site/css/phase3.css b/site/css/phase3.css deleted file mode 100644 index ead4dc4..0000000 --- a/site/css/phase3.css +++ /dev/null @@ -1,921 +0,0 @@ -/* Phase 3: Advanced Features & Documentation Integration */ - -/* ===== DOCUMENTATION INTEGRATION ===== */ - -/* Quick Reference Guide */ -.quick-reference { - margin: 4rem 0; - padding: 0; -} - -.quick-reference-header { - text-align: center; - margin-bottom: 3rem; -} - -.quick-reference-title { - font-size: 2.5rem; - font-weight: 700; - margin-bottom: 1rem; - background: linear-gradient(135deg, var(--color-primary), var(--color-secondary)); - -webkit-background-clip: text; - -webkit-text-fill-color: transparent; - background-clip: text; -} - -.reference-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(300px, 1fr)); - gap: 2rem; - margin-bottom: 3rem; -} - -.reference-card { - background: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: 12px; - padding: 2rem; - transition: all 0.3s ease; - position: relative; - overflow: hidden; -} - -.reference-card::before { - content: ''; - position: absolute; - top: 0; - left: 0; - right: 0; - height: 3px; - background: linear-gradient(90deg, var(--color-primary), var(--color-secondary)); - transform: scaleX(0); - transition: transform 0.3s ease; -} - -.reference-card:hover::before { - transform: scaleX(1); -} - -.reference-card:hover { - transform: translateY(-4px); - border-color: var(--color-primary); - box-shadow: 0 20px 40px rgba(0, 255, 136, 0.1); -} - -.reference-card-header { - display: flex; - align-items: center; - margin-bottom: 1.5rem; -} - -.reference-icon { - font-size: 1.5rem; - color: var(--color-primary); - margin-right: 1rem; -} - -.reference-card-title { - font-size: 1.25rem; - font-weight: 600; - margin: 0; -} - -.reference-content { - margin-bottom: 1.5rem; -} - -.reference-item { - display: flex; - align-items: flex-start; - margin-bottom: 1rem; - padding: 0.75rem; - background: rgba(255, 255, 255, 0.02); - border-radius: 8px; - border-left: 3px solid var(--color-primary); -} - -.reference-item-icon { - color: var(--color-primary); - margin-right: 0.75rem; - margin-top: 0.125rem; - flex-shrink: 0; -} - -.reference-item-content { - flex: 1; -} - -.reference-item-title { - font-weight: 600; - margin-bottom: 0.25rem; - color: var(--color-text-primary); -} - -.reference-item-description { - color: var(--color-text-secondary); - font-size: 0.875rem; - line-height: 1.4; -} - -.reference-code { - background: rgba(0, 0, 0, 0.4); - padding: 0.5rem; - border-radius: 4px; - font-family: var(--font-mono); - font-size: 0.8rem; - color: var(--color-primary); - margin-top: 0.5rem; - overflow-x: auto; -} - -/* API Documentation Preview */ -.api-preview { - margin: 4rem 0; - padding: 0; -} - -.api-preview-header { - text-align: center; - margin-bottom: 3rem; -} - -.api-preview-title { - font-size: 2.5rem; - font-weight: 700; - margin-bottom: 1rem; - background: linear-gradient(135deg, var(--color-secondary), var(--color-accent)); - -webkit-background-clip: text; - -webkit-text-fill-color: transparent; - background-clip: text; -} - -.api-tabs { - display: flex; - justify-content: center; - margin-bottom: 2rem; - border-bottom: 1px solid var(--color-border); -} - -.api-tab { - background: none; - border: none; - color: var(--color-text-secondary); - font-size: 1rem; - font-weight: 500; - padding: 1rem 2rem; - cursor: pointer; - transition: all 0.3s ease; - position: relative; -} - -.api-tab.active { - color: var(--color-primary); -} - -.api-tab.active::after { - content: ''; - position: absolute; - bottom: -1px; - left: 0; - right: 0; - height: 2px; - background: var(--color-primary); -} - -.api-tab:hover { - color: var(--color-primary); -} - -.api-content { - max-width: 800px; - margin: 0 auto; -} - -.api-panel { - display: none; - background: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: 12px; - padding: 2rem; -} - -.api-panel.active { - display: block; - animation: fadeIn 0.3s ease; -} - -.api-section { - margin-bottom: 2rem; -} - -.api-section-title { - font-size: 1.25rem; - font-weight: 600; - margin-bottom: 1rem; - color: var(--color-text-primary); -} - -.api-method { - background: rgba(0, 0, 0, 0.3); - border: 1px solid var(--color-border); - border-radius: 8px; - padding: 1.5rem; - margin-bottom: 1rem; -} - -.api-method-header { - display: flex; - align-items: center; - margin-bottom: 1rem; -} - -.api-method-type { - background: var(--color-primary); - color: var(--color-bg-primary); - padding: 0.25rem 0.75rem; - border-radius: 4px; - font-weight: 600; - font-size: 0.75rem; - margin-right: 1rem; -} - -.api-method-name { - font-family: var(--font-mono); - font-weight: 600; - color: var(--color-text-primary); -} - -.api-method-description { - color: var(--color-text-secondary); - margin-bottom: 1rem; - line-height: 1.6; -} - -.api-code-block { - background: rgba(0, 0, 0, 0.6); - border: 1px solid rgba(255, 255, 255, 0.1); - border-radius: 6px; - padding: 1rem; - font-family: var(--font-mono); - font-size: 0.875rem; - color: var(--color-text-primary); - overflow-x: auto; - position: relative; -} - -.api-code-copy { - position: absolute; - top: 0.5rem; - right: 0.5rem; - background: rgba(255, 255, 255, 0.1); - border: none; - color: var(--color-text-secondary); - padding: 0.5rem; - border-radius: 4px; - cursor: pointer; - transition: all 0.3s ease; -} - -.api-code-copy:hover { - background: rgba(255, 255, 255, 0.2); - color: var(--color-text-primary); -} - -/* Getting Started Wizard */ -.getting-started-wizard { - margin: 4rem 0; - padding: 0; -} - -.wizard-header { - text-align: center; - margin-bottom: 3rem; -} - -.wizard-title { - font-size: 2.5rem; - font-weight: 700; - margin-bottom: 1rem; - background: linear-gradient(135deg, var(--color-accent), var(--color-primary)); - -webkit-background-clip: text; - -webkit-text-fill-color: transparent; - background-clip: text; -} - -.wizard-container { - max-width: 900px; - margin: 0 auto; - background: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: 16px; - padding: 3rem; - position: relative; -} - -.wizard-progress { - display: flex; - justify-content: space-between; - align-items: center; - margin-bottom: 3rem; - position: relative; -} - -.wizard-progress::before { - content: ''; - position: absolute; - top: 50%; - left: 0; - right: 0; - height: 2px; - background: var(--color-border); - z-index: 1; -} - -.wizard-progress-line { - position: absolute; - top: 50%; - left: 0; - height: 2px; - background: var(--color-primary); - z-index: 2; - transition: width 0.5s ease; -} - -.wizard-step { - background: var(--color-bg-primary); - border: 2px solid var(--color-border); - border-radius: 50%; - width: 40px; - height: 40px; - display: flex; - align-items: center; - justify-content: center; - font-weight: 600; - color: var(--color-text-secondary); - position: relative; - z-index: 3; - transition: all 0.3s ease; -} - -.wizard-step.active { - border-color: var(--color-primary); - color: var(--color-primary); - background: rgba(0, 255, 136, 0.1); -} - -.wizard-step.completed { - border-color: var(--color-primary); - background: var(--color-primary); - color: var(--color-bg-primary); -} - -.wizard-content { - min-height: 300px; -} - -.wizard-panel { - display: none; -} - -.wizard-panel.active { - display: block; - animation: slideInRight 0.3s ease; -} - -.wizard-panel-title { - font-size: 1.5rem; - font-weight: 600; - margin-bottom: 1rem; - color: var(--color-text-primary); -} - -.wizard-panel-description { - color: var(--color-text-secondary); - margin-bottom: 2rem; - line-height: 1.6; -} - -.wizard-options { - display: grid; - gap: 1rem; - margin-bottom: 2rem; -} - -.wizard-option { - background: rgba(255, 255, 255, 0.02); - border: 1px solid var(--color-border); - border-radius: 8px; - padding: 1.5rem; - cursor: pointer; - transition: all 0.3s ease; - position: relative; - user-select: none; -} - -.wizard-option * { - pointer-events: none; /* Ensure clicks bubble up to the option */ -} - -.wizard-option:hover { - border-color: var(--color-primary); - background: rgba(0, 255, 136, 0.05); - transform: translateY(-2px); -} - -.wizard-option.selected { - border-color: var(--color-primary); - background: rgba(0, 255, 136, 0.1); -} - -.wizard-option-title { - font-weight: 600; - margin-bottom: 0.5rem; - color: var(--color-text-primary); -} - -.wizard-option-description { - color: var(--color-text-secondary); - font-size: 0.875rem; -} - -.wizard-actions { - display: flex; - justify-content: space-between; - align-items: center; - margin-top: 2rem; -} - -.wizard-btn { - background: var(--color-primary); - border: none; - color: var(--color-bg-primary); - padding: 0.75rem 2rem; - border-radius: 8px; - font-weight: 600; - cursor: pointer; - transition: all 0.3s ease; -} - -.wizard-btn:hover { - background: var(--color-primary-dark); - transform: translateY(-2px); -} - -.wizard-btn:disabled { - opacity: 0.5; - cursor: not-allowed; - transform: none; -} - -.wizard-btn-secondary { - background: transparent; - border: 1px solid var(--color-border); - color: var(--color-text-secondary); -} - -.wizard-btn-secondary:hover { - border-color: var(--color-primary); - color: var(--color-primary); - background: rgba(0, 255, 136, 0.05); -} - -/* ===== COMMUNITY & SOCIAL PROOF ===== */ - -/* Community Section */ -.community { - margin: 4rem 0; - padding: 4rem 0; - background: linear-gradient(135deg, rgba(0, 255, 136, 0.05), rgba(0, 102, 255, 0.05)); - border-radius: 20px; - position: relative; - overflow: hidden; -} - -.community::before { - content: ''; - position: absolute; - top: 0; - left: 0; - right: 0; - bottom: 0; - background: radial-gradient(circle at 20% 80%, rgba(0, 255, 136, 0.1) 0%, transparent 50%), - radial-gradient(circle at 80% 20%, rgba(0, 102, 255, 0.1) 0%, transparent 50%); -} - -.community-content { - position: relative; - z-index: 1; -} - -.community-header { - text-align: center; - margin-bottom: 4rem; -} - -.community-title { - font-size: 2.5rem; - font-weight: 700; - margin-bottom: 1rem; - background: linear-gradient(135deg, var(--color-primary), var(--color-secondary)); - -webkit-background-clip: text; - -webkit-text-fill-color: transparent; - background-clip: text; -} - -.community-subtitle { - font-size: 1.25rem; - color: var(--color-text-secondary); - max-width: 600px; - margin: 0 auto; - line-height: 1.6; -} - -.community-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(300px, 1fr)); - gap: 2rem; - margin-bottom: 3rem; -} - -.community-card { - background: rgba(255, 255, 255, 0.02); - border: 1px solid rgba(255, 255, 255, 0.1); - border-radius: 16px; - padding: 2rem; - text-align: center; - transition: all 0.3s ease; - backdrop-filter: blur(10px); -} - -.community-card:hover { - transform: translateY(-8px); - border-color: var(--color-primary); - box-shadow: 0 20px 40px rgba(0, 255, 136, 0.1); -} - -.community-card-icon { - font-size: 3rem; - color: var(--color-primary); - margin-bottom: 1rem; -} - -.community-card-title { - font-size: 1.25rem; - font-weight: 600; - margin-bottom: 1rem; - color: var(--color-text-primary); -} - -.community-card-description { - color: var(--color-text-secondary); - margin-bottom: 1.5rem; - line-height: 1.6; -} - -.community-card-action { - background: var(--color-primary); - color: var(--color-bg-primary); - text-decoration: none; - padding: 0.75rem 1.5rem; - border-radius: 8px; - font-weight: 600; - display: inline-block; - transition: all 0.3s ease; -} - -.community-card-action:hover { - background: var(--color-primary-dark); - transform: translateY(-2px); -} - -/* Testimonials */ -.testimonials { - margin: 4rem 0; -} - -.testimonials-header { - text-align: center; - margin-bottom: 3rem; -} - -.testimonials-title { - font-size: 2.5rem; - font-weight: 700; - margin-bottom: 1rem; - background: linear-gradient(135deg, var(--color-secondary), var(--color-accent)); - -webkit-background-clip: text; - -webkit-text-fill-color: transparent; - background-clip: text; -} - -.testimonials-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(350px, 1fr)); - gap: 2rem; -} - -.testimonial { - background: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: 16px; - padding: 2rem; - position: relative; - transition: all 0.3s ease; -} - -.testimonial::before { - content: '"'; - position: absolute; - top: -10px; - left: 20px; - font-size: 4rem; - color: var(--color-primary); - opacity: 0.3; - font-family: serif; -} - -.testimonial:hover { - transform: translateY(-4px); - border-color: var(--color-primary); - box-shadow: 0 20px 40px rgba(0, 255, 136, 0.1); -} - -.testimonial-content { - margin-bottom: 1.5rem; - font-style: italic; - color: var(--color-text-primary); - line-height: 1.7; - font-size: 1.1rem; -} - -.testimonial-author { - display: flex; - align-items: center; -} - -.testimonial-avatar { - width: 50px; - height: 50px; - border-radius: 50%; - margin-right: 1rem; - border: 2px solid var(--color-primary); -} - -.testimonial-info { - flex: 1; -} - -.testimonial-name { - font-weight: 600; - color: var(--color-text-primary); - margin-bottom: 0.25rem; -} - -.testimonial-role { - color: var(--color-text-secondary); - font-size: 0.875rem; -} - -/* Project Showcase */ -.project-showcase { - margin: 4rem 0; -} - -.showcase-header { - text-align: center; - margin-bottom: 3rem; -} - -.showcase-title { - font-size: 2.5rem; - font-weight: 700; - margin-bottom: 1rem; - background: linear-gradient(135deg, var(--color-accent), var(--color-secondary)); - -webkit-background-clip: text; - -webkit-text-fill-color: transparent; - background-clip: text; -} - -.showcase-filters { - display: flex; - justify-content: center; - flex-wrap: wrap; - gap: 1rem; - margin-bottom: 3rem; -} - -.showcase-filter { - background: transparent; - border: 1px solid var(--color-border); - color: var(--color-text-secondary); - padding: 0.5rem 1.5rem; - border-radius: 25px; - cursor: pointer; - transition: all 0.3s ease; - font-weight: 500; -} - -.showcase-filter.active, -.showcase-filter:hover { - border-color: var(--color-primary); - color: var(--color-primary); - background: rgba(0, 255, 136, 0.1); -} - -.showcase-grid { - display: grid; - grid-template-columns: repeat(auto-fit, minmax(350px, 1fr)); - gap: 2rem; -} - -.showcase-project { - background: var(--color-bg-secondary); - border: 1px solid var(--color-border); - border-radius: 16px; - overflow: hidden; - transition: all 0.3s ease; - position: relative; -} - -.showcase-project:hover { - transform: translateY(-8px); - border-color: var(--color-primary); - box-shadow: 0 20px 40px rgba(0, 255, 136, 0.1); -} - -.showcase-project-image { - width: 100%; - height: 200px; - background: linear-gradient(135deg, var(--color-primary), var(--color-secondary)); - display: flex; - align-items: center; - justify-content: center; - font-size: 3rem; - color: var(--color-bg-primary); - position: relative; - overflow: hidden; -} - -.showcase-project-image::before { - content: ''; - position: absolute; - top: 0; - left: 0; - right: 0; - bottom: 0; - background: linear-gradient(45deg, transparent 30%, rgba(255, 255, 255, 0.1) 50%, transparent 70%); - transform: translateX(-100%); - transition: transform 0.6s ease; -} - -.showcase-project:hover .showcase-project-image::before { - transform: translateX(100%); -} - -.showcase-project-content { - padding: 2rem; -} - -.showcase-project-title { - font-size: 1.25rem; - font-weight: 600; - margin-bottom: 0.5rem; - color: var(--color-text-primary); -} - -.showcase-project-description { - color: var(--color-text-secondary); - margin-bottom: 1.5rem; - line-height: 1.6; -} - -.showcase-project-tags { - display: flex; - flex-wrap: wrap; - gap: 0.5rem; - margin-bottom: 1.5rem; -} - -.showcase-project-tag { - background: rgba(0, 255, 136, 0.1); - color: var(--color-primary); - padding: 0.25rem 0.75rem; - border-radius: 12px; - font-size: 0.75rem; - font-weight: 500; -} - -.showcase-project-links { - display: flex; - gap: 1rem; -} - -.showcase-project-link { - color: var(--color-primary); - text-decoration: none; - font-weight: 500; - display: flex; - align-items: center; - transition: all 0.3s ease; -} - -.showcase-project-link:hover { - color: var(--color-primary-dark); - transform: translateY(-2px); -} - -.showcase-project-link i { - margin-right: 0.5rem; -} - -/* ===== RESPONSIVE DESIGN ===== */ - -@media (max-width: 768px) { - .reference-grid { - grid-template-columns: 1fr; - } - - .api-tabs { - flex-wrap: wrap; - justify-content: flex-start; - } - - .api-tab { - padding: 0.75rem 1rem; - font-size: 0.875rem; - } - - .wizard-container { - padding: 2rem 1rem; - } - - .wizard-progress { - flex-wrap: wrap; - gap: 1rem; - } - - .community-grid { - grid-template-columns: 1fr; - } - - .testimonials-grid { - grid-template-columns: 1fr; - } - - .showcase-grid { - grid-template-columns: 1fr; - } - - .showcase-filters { - justify-content: flex-start; - } -} - -/* ===== ANIMATIONS ===== */ - -@keyframes slideInRight { - from { - opacity: 0; - transform: translateX(30px); - } - to { - opacity: 1; - transform: translateX(0); - } -} - -@keyframes fadeIn { - from { - opacity: 0; - } - to { - opacity: 1; - } -} - -/* ===== PERFORMANCE OPTIMIZATIONS ===== */ - -/* Critical rendering path optimizations */ -.reference-card, -.api-panel, -.wizard-panel, -.community-card, -.testimonial, -.showcase-project { - contain: layout style paint; -} - -/* GPU acceleration for animations */ -.reference-card, -.community-card, -.testimonial, -.showcase-project { - will-change: transform; -} - -.reference-card:not(:hover), -.community-card:not(:hover), -.testimonial:not(:hover), -.showcase-project:not(:hover) { - will-change: auto; -} diff --git a/site/custom-structures/index.html b/site/custom-structures/index.html new file mode 100644 index 0000000..a22814f --- /dev/null +++ b/site/custom-structures/index.html @@ -0,0 +1,1281 @@ + + + + + + + + + + + + + + + + + + + + + + + Creating Custom Structures - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Creating Custom Structures

+

Let's say you are happy with the default structures that STRUCT provides, but you want to customize them for your specific needs. This is totally possible!

+

The best way to approach this is to have a repository where you can store your custom structures. You can then reference these structures in your .struct.yaml files.

+

Suggested Repository Structure

+

Here is a suggested structure for your custom structures repository:

+
structures/
+├── category1/
+│   ├── structure1.yaml
+│   └── structure2.yaml
+├── category2/
+│   ├── structure1.yaml
+│   └── structure2.yaml
+
+

This way you could reference your custom structures in your .struct.yaml files like this:

+
folders:
+  - ./:
+    struct:
+      - category1/structure1
+      - category2/structure2
+    with:
+      var_in_structure1: 'value'
+
+

For this to work, you will need to set the path to the custom structures repository using the -s option when running STRUCT:

+
struct generate -s ~/path/to/custom-structures/structures file://.struct.yaml ./output
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/development/index.html b/site/development/index.html new file mode 100644 index 0000000..90a8d50 --- /dev/null +++ b/site/development/index.html @@ -0,0 +1,2130 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Development Setup - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Development Setup

+

This guide will help you set up a development environment for contributing to STRUCT.

+

Prerequisites

+
    +
  • Python 3.8 or higher
    • +
  • Git
    • +
  • Virtual environment tool (venv, virtualenv, or conda)
    • +
+

Getting Started

+

1. Clone the Repository

+
git clone https://github.com/httpdss/struct.git
+cd struct
+
+

2. Create a Virtual Environment

+
python3 -m venv .venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+
+

3. Install Dependencies

+
# Install runtime dependencies
+pip install -r requirements.txt
+
+# Install development dependencies
+pip install -r requirements.dev.txt
+
+# Install the package in development mode
+pip install -e .
+
+

4. Verify Installation

+
struct --help
+
+

Development Workflow

+

Running Tests

+
# Run all tests
+pytest
+
+# Run tests with coverage
+pytest --cov=struct_module
+
+# Run specific test file
+pytest tests/test_specific.py
+
+

Code Quality

+

This project uses several tools to maintain code quality:

+
# Format code with black
+black .
+
+# Sort imports
+isort .
+
+# Lint with flake8
+flake8 .
+
+# Type checking with mypy
+mypy struct_module/
+
+

Pre-commit Hooks

+

Install pre-commit hooks to automatically run quality checks:

+
pre-commit install
+
+

This will run formatting, linting, and tests before each commit.

+

Project Structure

+
struct/
+├── struct_module/          # Main Python package
+│   ├── commands/          # CLI command implementations
+│   ├── contribs/          # Built-in structure templates
+│   └── ...
+├── tests/                 # Test files
+├── docs/                  # Documentation
+├── example/               # Example configurations
+├── scripts/               # Utility scripts
+└── requirements*.txt      # Dependencies
+
+

Adding New Features

+

1. Create a New Command

+

Commands are defined in struct_module/commands/. Each command should:

+
    +
  • Inherit from a base command class
    • +
  • Include proper argument parsing
    • +
  • Have comprehensive tests
    • +
  • Include documentation
    • +
+

Example:

+
# struct_module/commands/my_command.py
+from .base import BaseCommand
+
+class MyCommand(BaseCommand):
+    def add_arguments(self, parser):
+        parser.add_argument('--option', help='My option')
+
+    def handle(self, args):
+        # Implementation here
+        pass
+
+

2. Add Structure Templates

+

New structure templates go in struct_module/contribs/. Each template should:

+
    +
  • Have a clear directory structure
    • +
  • Provide good documentation
    • +
  • Include example usage
    • +
+

3. Write Tests

+

All new functionality must include tests:

+
# tests/test_my_feature.py
+import pytest
+from struct_module.my_feature import MyFeature
+
+def test_my_feature():
+    feature = MyFeature()
+    result = feature.do_something()
+    assert result == expected_value
+
+

4. Update Documentation

+
    +
  • Add or update relevant documentation in docs/
    • +
  • Add examples if applicable
    • +
+

Testing

+

Unit Tests

+

Run unit tests to verify individual components:

+
pytest tests/unit/
+
+

Integration Tests

+

Run integration tests to verify end-to-end functionality:

+
pytest tests/integration/
+
+

Debugging

+

Enable Debug Logging

+
struct --log=DEBUG generate my-config.yaml ./output
+
+

Use Python Debugger

+

Add breakpoints in your code:

+
import pdb; pdb.set_trace()
+
+
struct --log=DEBUG generate my-config.yaml ./output
+
+

Contributing Guidelines

+

Code Style

+
    +
  • Follow PEP 8
    • +
  • Use type hints where appropriate
    • +
  • Write docstrings for public functions
    • +
  • Keep functions small and focused
    • +
+

Commit Messages

+

Use conventional commit format:

+
feat: add new template variable filter
+fix: resolve issue with file permissions
+docs: update installation guide
+test: add tests for mappings functionality
+
+

Pull Requests

+
    +
  1. Fork the repository
    2. +
  2. Create a feature branch: git checkout -b feature/my-feature
    3. +
  3. Make your changes
    4. +
  4. Write tests
    5. +
  5. Update documentation
    6. +
  6. Submit a pull request
    7. +
+

Review Process

+

All pull requests must:

+
    +
  • Pass all tests
    • +
  • Include appropriate documentation
    • +
  • Follow code style guidelines
    • +
  • Have a clear description of changes
    • +
+

Troubleshooting

+

Common Issues

+

Import errors: Make sure you've installed the package in development mode:

+
pip install -e .
+
+

Test failures: Ensure all dependencies are installed:

+
pip install -r requirements.dev.txt
+
+

Permission errors: Check file permissions and ensure you're in the right directory.

+

Getting Help

+
    +
  • Check existing issues on GitHub
    • +
  • Join our Discord community
    • +
  • Read the documentation thoroughly
    • +
  • Ask questions in discussions
    • +
+

Resources

+ + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/examples/index.html b/site/examples/index.html new file mode 100644 index 0000000..4b4d5f2 --- /dev/null +++ b/site/examples/index.html @@ -0,0 +1,1916 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Examples - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Examples

+

This page contains practical examples of STRUCT configurations for various use cases.

+

Basic Examples

+

Simple Project

+

Basic project structure with files and folders:

+
# Example: Simple Project Structure
+# Use case: Basic project setup with common files
+
+files:
+  - README.md:
+      content: |
+        # {{@ project_name | default('My Project') @}}
+
+        Welcome to the project!
+
+        ## Getting Started
+
+        1. Install dependencies
+        2. Run the application
+        3. Enjoy!
+
+  - .gitignore:
+      content: |
+        node_modules/
+        *.log
+        .env
+        dist/
+
+  - LICENSE:
+      content: |
+        MIT License
+
+        Copyright (c) {{@ year | default('2024') @}} {{@ author | default('Project Author') @}}
+
+folders:
+  - src/:
+      struct:
+        - basic/folder
+  - docs/:
+      struct:
+        - basic/folder
+
+variables:
+  - project_name:
+      description: 'Name of the project'
+      type: string
+      default: 'My Project'
+  - author:
+      description: 'Project author'
+      type: string
+      default: 'Project Author'
+  - year:
+      description: 'Copyright year'
+      type: string
+      default: '2024'
+
+

Template Variables

+

Using dynamic content with variables:

+
# Example: Template Variables
+# Use case: Dynamic content generation with user input
+
+files:
+  - package.json:
+      content: |
+        {
+          "name": "{{@ package_name @}}",
+          "version": "{{@ version | default('1.0.0') @}}",
+          "description": "{{@ description @}}",
+          "author": "{{@ author @}}",
+          "license": "{{@ license | default('MIT') @}}"
+        }
+
+  - src/config.js:
+      content: |
+        module.exports = {
+          appName: '{{@ app_name @}}',
+          version: '{{@ version | default('1.0.0') @}}',
+          environment: '{{@ environment | default('development') @}}'
+        };
+
+variables:
+  - package_name:
+      description: 'NPM package name'
+      type: string
+      required: true
+  - app_name:
+      description: 'Application display name'
+      type: string
+      required: true
+  - description:
+      description: 'Project description'
+      type: string
+      required: true
+  - author:
+      description: 'Package author'
+      type: string
+      required: true
+  - version:
+      description: 'Initial version'
+      type: string
+      default: '1.0.0'
+  - license:
+      description: 'License type'
+      type: string
+      default: 'MIT'
+  - environment:
+      description: 'Target environment'
+      type: string
+      default: 'development'
+
+

Remote Files

+

Fetching content from external sources:

+
# Example: Remote Files
+# Use case: Including content from external URLs or repositories
+
+files:
+  - .gitignore:
+      remote: 'https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore'
+
+  - CODE_OF_CONDUCT.md:
+      remote: 'https://raw.githubusercontent.com/contributor-covenant/contributor-covenant/main/CODE_OF_CONDUCT.md'
+
+  - CONTRIBUTING.md:
+      content: |
+        # Contributing to {{@ project_name @}}
+
+        Thank you for your interest in contributing!
+
+        ## Development Setup
+
+        1. Fork the repository
+        2. Clone your fork
+        3. Install dependencies
+        4. Make your changes
+        5. Submit a pull request
+
+variables:
+  - project_name:
+      description: 'Project name'
+      type: string
+      required: true
+
+

Application Development

+

Python Project

+

Complete Python application structure:

+
# Example: Python Project
+# Use case: Full Python application with proper structure
+
+files:
+  - README.md:
+      content: |
+        # {{@ project_name @}}
+
+        {{@ description @}}
+
+        ## Installation
+
+        ```bash
+        pip install -r requirements.txt
+        ```
+
+        ## Usage
+
+        ```bash
+        python -m {{@ package_name @}}
+        ```
+
+  - requirements.txt:
+      content: |
+        click>=8.0.0
+        requests>=2.25.0
+        pytest>=6.0.0
+
+  - setup.py:
+      content: |
+        from setuptools import setup, find_packages
+
+        setup(
+            name="{{@ package_name @}}",
+            version="{{@ version | default('0.1.0') @}}",
+            description="{{@ description @}}",
+            author="{{@ author @}}",
+            packages=find_packages(),
+            install_requires=[
+                "click>=8.0.0",
+                "requests>=2.25.0",
+            ],
+            entry_points={
+                "console_scripts": [
+                    "{{@ package_name @}}={{@ package_name @}}.cli:main",
+                ],
+            },
+        )
+
+  - '{{@ package_name @}}/__init__.py':
+      content: |
+        """{{@ description @}}"""
+        __version__ = "{{@ version | default('0.1.0') @}}"
+
+  - '{{@ package_name @}}/main.py':
+      content: |
+        """Main application module."""
+
+        def main():
+            """Main entry point."""
+            print("Hello from {{@ project_name @}}!")
+
+        if __name__ == "__main__":
+            main()
+
+  - tests/test_main.py:
+      content: |
+        """Tests for main module."""
+        import pytest
+        from {{@ package_name @}} import main
+
+        def test_main():
+            """Test main function."""
+            # Add your tests here
+            assert True
+
+variables:
+  - project_name:
+      description: 'Project name'
+      type: string
+      required: true
+  - package_name:
+      description: 'Python package name'
+      type: string
+      required: true
+  - description:
+      description: 'Project description'
+      type: string
+      required: true
+  - author:
+      description: 'Project author'
+      type: string
+      required: true
+  - version:
+      description: 'Initial version'
+      type: string
+      default: '0.1.0'
+
+

Node.js API

+

REST API with Express.js:

+
# Example: Node.js API
+# Use case: Express.js REST API with proper structure
+
+files:
+  - package.json:
+      content: |
+        {
+          "name": "{{@ package_name @}}",
+          "version": "{{@ version | default('1.0.0') @}}",
+          "description": "{{@ description @}}",
+          "main": "src/app.js",
+          "scripts": {
+            "start": "node src/app.js",
+            "dev": "nodemon src/app.js",
+            "test": "jest"
+          },
+          "dependencies": {
+            "express": "^4.18.0",
+            "cors": "^2.8.5",
+            "helmet": "^6.0.0",
+            "dotenv": "^16.0.0"
+          },
+          "devDependencies": {
+            "nodemon": "^2.0.20",
+            "jest": "^29.0.0",
+            "supertest": "^6.3.0"
+          }
+        }
+
+  - src/app.js:
+      content: |
+        const express = require('express');
+        const cors = require('cors');
+        const helmet = require('helmet');
+        require('dotenv').config();
+
+        const app = express();
+        const PORT = process.env.PORT || 3000;
+
+        // Middleware
+        app.use(helmet());
+        app.use(cors());
+        app.use(express.json());
+
+        // Routes
+        app.get('/', (req, res) => {
+          res.json({ message: 'Welcome to {{@ project_name @}} API' });
+        });
+
+        app.get('/api/health', (req, res) => {
+          res.json({ status: 'OK', timestamp: new Date().toISOString() });
+        });
+
+        app.listen(PORT, () => {
+          console.log(`{{@ project_name @}} API running on port ${PORT}`);
+        });
+
+        module.exports = app;
+
+  - .env.example:
+      content: |
+        PORT=3000
+        NODE_ENV=development
+
+variables:
+  - project_name:
+      description: 'Project name'
+      type: string
+      required: true
+  - package_name:
+      description: 'NPM package name'
+      type: string
+      required: true
+  - description:
+      description: 'API description'
+      type: string
+      required: true
+  - version:
+      description: 'Initial version'
+      type: string
+      default: '1.0.0'
+
+

Usage

+

To use these examples:

+
    +
  1. Copy the YAML content from any example above
    2. +
  2. Save it to a file (e.g., my-structure.yaml)
    3. +
  3. Run struct generate with your file:
    4. +
+
# Create your structure file
+cat > my-structure.yaml << 'EOF'
+# Paste the YAML content here
+EOF
+
+# Generate your project
+struct generate file://my-structure.yaml ./my-project
+
+

Quick Start with Template Variables

+
# Generate with custom variables
+struct generate -v "project_name=MyApp,author=John Doe" file://my-structure.yaml ./my-project
+
+

Contributing Examples

+

We welcome community examples! To contribute:

+
    +
  1. Create a new .yaml file in this directory
    2. +
  2. Follow the naming convention: descriptive-name.yaml
    3. +
  3. Include comments explaining key concepts
    4. +
  4. Add the example to this index
    5. +
  5. Submit a pull request
    6. +
+

Example Template

+
# Example: [Brief Description]
+# Use case: [What this example demonstrates]
+# Requirements: [Any prerequisites or dependencies]
+
+files:
+  - README.md:
+      content: |
+        # Example Project
+        This demonstrates [key concept]
+
+variables:
+  - example_var:
+      description: 'Example variable'
+      type: string
+      default: 'example_value'
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/file-handling/index.html b/site/file-handling/index.html new file mode 100644 index 0000000..3427e0f --- /dev/null +++ b/site/file-handling/index.html @@ -0,0 +1,1971 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + File Handling - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

File Handling

+

STRUCT provides flexible options for handling files and managing permissions.

+

File Properties

+

Basic Properties

+
    +
  • skip: Skip file/folder creation entirely
    • +
  • skip_if_exists: Skip only if the file already exists
    • +
  • permissions: Set custom file permissions
    • +
  • content: Define file content inline
    • +
  • file: Reference external file content
    • +
+

Skip Behavior

+
files:
+  - README.md:
+      skip: true  # Never create this file
+      content: "This won't be created"
+
+  - config.yml:
+      skip_if_exists: true  # Only create if it doesn't exist
+      content: "default: value"
+
+

File Permissions

+

Set custom permissions using octal notation:

+
files:
+  - scripts/deploy.sh:
+      permissions: '0755'  # Executable script
+      content: |
+        #!/bin/bash
+        echo "Deploying..."
+
+  - secrets/api.key:
+      permissions: '0600'  # Read-only for owner
+      content: "{{@ api_key @}}"
+
+

Content Sources

+

Inline Content

+

Define content directly in the YAML:

+
files:
+  - app.py:
+      content: |
+        #!/usr/bin/env python3
+        print("Hello, {{@ project_name @}}!")
+
+

External Files

+

Reference local or remote files:

+
files:
+  - LICENSE:
+      file: https://raw.githubusercontent.com/nishanths/license/master/LICENSE
+
+

Remote File Protocols

+

STRUCT supports multiple protocols for fetching remote content:

+

HTTP/HTTPS

+
files:
+  - requirements.txt:
+      file: https://raw.githubusercontent.com/example/repo/main/requirements.txt
+
+

GitHub Protocols

+

Standard GitHub

+
files:
+  - .gitignore:
+      file: github://github/gitignore/main/Python.gitignore
+
+

GitHub HTTPS

+
files:
+  - workflow.yml:
+      file: githubhttps://actions/starter-workflows/main/ci/python-app.yml
+
+

GitHub SSH

+
files:
+  - private-config.yml:
+      file: githubssh://company/private-repo/main/config/template.yml
+
+

Cloud Storage

+

Amazon S3

+
files:
+  - data.csv:
+      file: s3://my-bucket/data/template.csv
+
+

Google Cloud Storage

+
files:
+  - config.json:
+      file: gs://my-bucket/configs/default.json
+
+

File Handling Strategies

+

Control how STRUCT handles existing files with the --file-strategy option:

+

Available Strategies

+
    +
  • overwrite: Replace existing files (default)
    • +
  • skip: Skip files that already exist
    • +
  • append: Add content to existing files
    • +
  • rename: Rename existing files with a suffix
    • +
  • backup: Move existing files to backup directory
    • +
+

Usage Examples

+
# Skip existing files
+struct generate --file-strategy=skip my-config.yaml ./output
+
+# Backup existing files
+struct generate --file-strategy=backup --backup=/tmp/backup my-config.yaml ./output
+
+# Rename existing files
+struct generate --file-strategy=rename my-config.yaml ./output
+
+
+

Note: The file:// protocol is automatically added for .yaml files, so these examples work with or without the explicit protocol.

+
+

Advanced Examples

+

Conditional File Creation

+
files:
+  - docker-compose.yml:
+      skip: "{{@ not use_docker @}}"
+      content: |
+        version: '3.8'
+        services:
+          app:
+            build: .
+
+  - Dockerfile:
+      skip_if_exists: true
+      permissions: '0644'
+      file: https://raw.githubusercontent.com/example/dockerfiles/main/python.Dockerfile
+
+

Dynamic Permissions

+
files:
+  - "scripts/{{@ script_name @}}.sh":
+      permissions: '0755'
+      content: |
+        #!/bin/bash
+        # {{@ script_description @}}
+        echo "Running {{@ script_name @}}"
+
+

Multiple Content Sources

+
files:
+  - README.md:
+      content: |
+        # {{@ project_name @}}
+
+        ## Installation
+
+        ```bash
+        pip install -r requirements.txt
+        ```
+
+  - requirements.txt:
+      file: https://raw.githubusercontent.com/example/templates/main/python-requirements.txt
+
+  - .env.example:
+      file: file://./templates/env-template
+
+

Best Practices

+
    +
  1. Use skip_if_exists for configuration files that shouldn't be overwritten
    2. +
  2. Set appropriate permissions for scripts and sensitive files
    3. +
  3. Use remote files for standardized content like licenses and gitignores
    4. +
  4. Combine strategies with command-line options for different deployment scenarios
    5. +
  5. Test with --dry-run before applying changes to important directories
    6. +
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/funding/index.html b/site/funding/index.html new file mode 100644 index 0000000..fb2df5c --- /dev/null +++ b/site/funding/index.html @@ -0,0 +1,1522 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Funding - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Funding STRUCT

+

STRUCT is an open-source project that helps developers create consistent project structures and automate repetitive setup tasks. Your support helps us maintain and improve this tool for the entire community.

+

💰 Support Options

+

GitHub Sponsors

+

The easiest way to support STRUCT development is through GitHub Sponsors:

+ +

GitHub Sponsors allows for recurring monthly contributions or one-time donations. All funds go directly toward:

+
    +
  • Development time for new features
    • +
  • Bug fixes and maintenance
    • +
  • Documentation improvements
    • +
  • Community support
    • +
  • Infrastructure costs
    • +
+

Patreon

+

For ongoing support with additional perks:

+ +

Patreon supporters get access to:

+
    +
  • Early previews of new features
    • +
  • Direct input on roadmap priorities
    • +
  • Exclusive development updates
    • +
  • Recognition in project documentation
    • +
+

One-Time Donations

+

For one-time contributions:

+ +

🤝 Alternative Ways to Support

+

If financial contribution isn't possible, you can still support STRUCT:

+

Code Contributions

+
    +
  • Submit bug fixes and new features
    • +
  • Improve documentation
    • +
  • Add new contrib structures
    • +
  • Help with testing and quality assurance
    • +
+

Community Support

+
    +
  • Answer questions in GitHub Discussions
    • +
  • Help other users in issues
    • +
  • Share STRUCT on social media
    • +
  • Write blog posts or tutorials
    • +
+

Feedback and Testing

+
    +
  • Report bugs and issues
    • +
  • Suggest new features
    • +
  • Test beta releases
    • +
  • Provide user experience feedback
    • +
+
+

Every contribution, no matter the size, helps make STRUCT better for everyone. Thank you for your support! 🎉

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/github-integration/index.html b/site/github-integration/index.html new file mode 100644 index 0000000..bdae67e --- /dev/null +++ b/site/github-integration/index.html @@ -0,0 +1,1428 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + GitHub Integration - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

GitHub Integration

+

STRUCT can seamlessly integrate with GitHub to automate the generation of project structures across repositories.

+

Automating STRUCT

+

Combine GitHub Actions with STRUCT to automate project structure generation in CI/CD pipelines. Trigger the process manually or automatically based on events like pull requests or pushes.

+

Example Workflow:

+
name: run-struct
+
+on:
+  workflow_dispatch:
+
+jobs:
+  generate:
+    uses: httpdss/struct/.github/workflows/struct-generate.yaml@main
+    secrets:
+      token: ${{ secrets.STRUCT_RUN_TOKEN }}
+
+

Best Practices

+
    +
  1. Secure Your Token: Store GitHub tokens in secrets management tools.
    2. +
  2. Use Topics for Filtering: Organize repositories with topics to efficiently manage workflows.
    3. +
  3. Test Locally First: Simulate script actions with --dry-run before executing in a CI/CD environment.
    4. +
  4. Combine with Other Tools: Use STRUCT with Terraform, Ansible, or Docker for comprehensive project management.
    5. +
+

FAQs

+

Why use a GitHub Integration?

+

Using GitHub integration allows you to leverage STRUCT's automation capabilities in a version-controlled environment, enabling consistent and repeatable project structures.

+

Can I customize the GitHub Action?

+

Yes, you can tailor the GitHub Action to your specific needs, including custom triggers, different environments, and additional dependencies.

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/hooks/index.html b/site/hooks/index.html new file mode 100644 index 0000000..178e4e0 --- /dev/null +++ b/site/hooks/index.html @@ -0,0 +1,1828 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Hooks - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Pre-generation and Post-generation Hooks

+

You can define shell commands to run before and after structure generation using the pre_hooks and post_hooks keys in your YAML configuration. These are optional and allow you to automate setup or cleanup steps.

+

Hook Types

+
    +
  • pre_hooks: List of shell commands to run before generation. If any command fails (non-zero exit), generation is aborted.
    • +
  • post_hooks: List of shell commands to run after generation completes. If any command fails, an error is shown.
    • +
+

Basic Example

+
pre_hooks:
+  - echo "Preparing environment..."
+  - ./scripts/prep.sh
+
+post_hooks:
+  - echo "Generation complete!"
+  - ./scripts/cleanup.sh
+
+files:
+  - README.md:
+      content: |
+        # My Project
+
+

How Hooks Work

+

Pre-hooks

+
    +
  1. Execute in the order defined
    2. +
  2. Run before any files or folders are created
    3. +
  3. If any command returns non-zero exit code, generation stops
    4. +
  4. Useful for environment preparation, validation, or dependency checks
    5. +
+

Post-hooks

+
    +
  1. Execute after all files and folders are created
    2. +
  2. Run even if some file operations fail
    3. +
  3. Errors are reported but don't stop execution
    4. +
  4. Useful for cleanup, initialization, or notification tasks
    5. +
+

Output Handling

+
    +
  • Output from hooks (stdout and stderr) is shown in the terminal
    • +
  • Hook execution is logged with appropriate log levels
    • +
  • Failed hooks display error messages with exit codes
    • +
+

Practical Examples

+

Environment Setup

+
pre_hooks:
+  - python -m venv .venv
+  - source .venv/bin/activate
+  - pip install --upgrade pip
+
+post_hooks:
+  - source .venv/bin/activate
+  - pip install -r requirements.txt
+  - echo "Virtual environment ready!"
+
+files:
+  - requirements.txt:
+      content: |
+        flask==2.3.0
+        requests==2.31.0
+
+

Git Repository Initialization

+
pre_hooks:
+  - git --version  # Verify git is available
+
+post_hooks:
+  - git init
+  - git add .
+  - git commit -m "Initial commit from STRUCT"
+  - echo "Git repository initialized"
+
+files:
+  - .gitignore:
+      file: github://github/gitignore/main/Python.gitignore
+  - README.md:
+      content: |
+        # {{@ project_name @}}
+        Generated with STRUCT
+
+

Docker Setup

+
pre_hooks:
+  - docker --version
+  - echo "Setting up Docker environment..."
+
+post_hooks:
+  - docker build -t {{@ project_name | slugify @}} .
+  - echo "Docker image built successfully"
+
+files:
+  - Dockerfile:
+      content: |
+        FROM python:3.11-slim
+        WORKDIR /app
+        COPY . .
+        RUN pip install -r requirements.txt
+        CMD ["python", "app.py"]
+  - docker-compose.yml:
+      content: |
+        version: '3.8'
+        services:
+          app:
+            build: .
+            ports:
+              - "8000:8000"
+
+

Database Migration

+
pre_hooks:
+  - echo "Checking database connection..."
+  - pg_isready -h localhost -p 5432
+
+post_hooks:
+  - python manage.py migrate
+  - python manage.py collectstatic --noinput
+  - echo "Database migrations complete"
+
+files:
+  - manage.py:
+      content: |
+        #!/usr/bin/env python
+        import os
+        import sys
+
+        if __name__ == "__main__":
+            os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+            from django.core.management import execute_from_command_line
+            execute_from_command_line(sys.argv)
+
+

Testing and Validation

+
pre_hooks:
+  - echo "Validating prerequisites..."
+  - node --version
+  - npm --version
+
+post_hooks:
+  - npm install
+  - npm run lint
+  - npm test
+  - echo "All tests passed!"
+
+files:
+  - package.json:
+      content: |
+        {
+          "name": "{{@ project_name | slugify @}}",
+          "version": "1.0.0",
+          "scripts": {
+            "test": "jest",
+            "lint": "eslint src/"
+          }
+        }
+
+

Best Practices

+
    +
  1. Keep hooks simple: Use external scripts for complex operations
    2. +
  2. Handle errors gracefully: Check for tool availability in pre-hooks
    3. +
  3. Use absolute paths: Hooks run in the target directory context
    4. +
  4. Log important actions: Use echo statements for user feedback
    5. +
  5. Test independently: Ensure hook commands work outside STRUCT
    6. +
  6. Consider dependencies: Order hooks based on their requirements
    7. +
+

Error Handling

+

Pre-hook Failures

+
pre_hooks:
+  - echo "Checking Python version..."
+  - python --version || (echo "Python not found!" && exit 1)
+  - echo "Python check passed"
+
+

Post-hook Error Tolerance

+
post_hooks:
+  - npm install || echo "Warning: npm install failed"
+  - git add . || echo "Warning: git add failed"
+  - echo "Setup complete (some warnings may have occurred)"
+
+

Variables in Hooks

+

You can use template variables in hook commands:

+
pre_hooks:
+  - echo "Setting up {{@ project_name @}}"
+  - mkdir -p "{{@ project_name | slugify @}}"
+
+post_hooks:
+  - echo "{{@ project_name @}} setup complete!"
+  - echo "Project created in: $(pwd)"
+
+variables:
+  - project_name:
+      description: "Name of the project"
+      type: string
+      default: "MyProject"
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/images/favicon.png b/site/images/favicon.png deleted file mode 100644 index a3c80b7..0000000 Binary files a/site/images/favicon.png and /dev/null differ diff --git a/site/images/favicon.svg b/site/images/favicon.svg deleted file mode 100644 index 8baa01e..0000000 --- a/site/images/favicon.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/site/index.html b/site/index.html index 1f1587a..c9e1239 100644 --- a/site/index.html +++ b/site/index.html @@ -1,596 +1,1495 @@ - - - - - - - - - - - STRUCT - Automated Project Structure Generator - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

STRUCT:

-

- Powerful, flexible tool for automating project structure creation through YAML configurations. - Generate consistent project layouts, boilerplate code, and configurations with template variables. -

-
- - - Get Started - - - - Documentation - - - - View on GitHub + + + + + + + + + + + + + + + + + + + + + + + + STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
-
- -
-
-
- -
-
-
- - -
-
-

✨ Key Features

-
-
-
📝
-

YAML-Based Configuration

-

- Define project structures in simple, readable YAML files with intuitive syntax and validation. -

-
-
-
🔧
-

Template Variables

-

- Dynamic content with Jinja2 templating, interactive prompts, and custom filters for flexibility. -

-
-
-
🌐
-

Remote Content

-

- Fetch files from GitHub, HTTP/HTTPS, S3, and Google Cloud Storage with automatic content handling. -

-
-
-
🛡️
-

Smart File Handling

-

- Multiple strategies for managing existing files: overwrite, skip, backup, append, and more. -

-
-
-
🪝
-

Automation Hooks

-

- Pre and post-generation shell commands for complete workflow automation and integration. -

-
-
-
🎯
-

Dry Run Mode

-

- Preview changes before applying them with detailed output and validation checks. -

-
-
-
-
- - -
-
-

🚀 Quick Installation

-
-
- - - -
-
-
-

Install via pip

-
- - 
# Install from GitHub
-pip install git+https://github.com/httpdss/struct.git
-
-# Verify installation
-struct --version
-
-

- Requires Python 3.8+ and pip. This is the recommended installation method for most users. -

-
-
-

Run with Docker

-
- - 
# Pull and run with Docker
-docker run -v $(pwd):/workdir ghcr.io/httpdss/struct:main generate my-config.yaml ./output
-
-# Create an alias for easier usage
-alias struct='docker run -v $(pwd):/workdir ghcr.io/httpdss/struct:main'
-
-

- Perfect for CI/CD environments and when you don't want to install Python locally. -

-
-
-

Install from Source

-
- - 
# Clone the repository
-git clone https://github.com/httpdss/struct.git
-cd struct
-
-# Install in development mode
-pip install -e .
-
-# Run tests
-python -m pytest tests/
-
-

- For contributors and users who want the latest development features. -

-
-
-
-
- - -
-
-

🎬 Interactive Demos

-
-
- - - - - -
-
-
-

Basic Project Generation

- Basic Usage Demo -

- See how easy it is to generate a complete project structure with a simple YAML configuration. -

-
-
-

YAML Configuration

- YAML Configuration Demo -

- Learn how to write effective YAML configurations with variables and templates. -

-
-
-

External Mappings

- Mappings Demo -

- Discover how to use external data mappings for dynamic project generation. -

-
-
-

Remote Content Fetching

- Remote Content Demo -

- See how to fetch templates and content from GitHub, HTTP URLs, and cloud storage. -

-
-
-

Advanced Features

- Advanced Features Demo -

- Explore hooks, validation, dry-run mode, and other advanced capabilities. -

-
-
-
+
+
-
- - -
-
-

⚡ Quick Start

-
-
-
-

1. Create Configuration

-
-
-
- - 
# my-project.yaml
-files:
-  - README.md:
-      content: |
-        # {{@ project_name @}}
-        Generated with STRUCT
-
-folders:
-  - src/:
-      struct: project/python
-
-variables:
-  - project_name:
-      description: "Project name"
-      type: string
-
-
+ + + + +
+
- -
-
-
- -
-
-
- -
-
-
- -
-
-
-
-
-

📚 Documentation

-
-
-
-

- - Getting Started -

-
-
-

- Installation guides, quick start tutorials, and basic usage examples to get you up and running. -

-
-
- - Read Guide → - -
-
-
-
-

- - Configuration -

-
-
-

- Complete YAML configuration reference, template variables, and file handling strategies. -

-
-
- - View Reference → - -
-
-
-
-

- - Examples -

-
-
-

- Real-world examples, templates, and practical use cases for various project types. -

-
-
- - Browse Examples → - +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
+ + - - -
-
-
-

Quick Reference

-

Essential STRUCT commands and configuration patterns at your fingertips

-
-
- -
-
-
- - -
-
-
-

API Reference

-

Comprehensive documentation for all STRUCT features and commands

-
-
- -
-
-
- - -
-
-
-

Getting Started Wizard

-

Generate your first STRUCT configuration in minutes

-
-
-
- -
-
-
-
- - -
-
-
-

Join Our Community

-

Connect with developers using STRUCT to build amazing projects

-
-
- -
-
-
- - -
-
-
-

What Developers Say

-

Real feedback from teams using STRUCT in production

-
-
- -
-
-
- - -
-
-
-

Built with STRUCT

-

Discover projects and templates created by the community

-
-
- -
-
- -
-
-
- - - - - - - - - - - + + + + +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

STRUCT Documentation

+

Welcome to the comprehensive documentation for STRUCT - the Automated Project Structure Generator.

+

📚 Documentation Sections

+

Getting Started

+ +

Configuration

+ +

Advanced Features

+ +

Development

+ +

Reference

+ +

🔗 External Resources

+ +

🤝 Community

+ + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + diff --git a/site/installation/index.html b/site/installation/index.html new file mode 100644 index 0000000..5476fa2 --- /dev/null +++ b/site/installation/index.html @@ -0,0 +1,1371 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Installation - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Installation Guide

+

Using pip

+

Install STRUCT with pip:

+
pip install git+https://github.com/httpdss/struct.git
+
+
+

Enable Auto-Completion

+

After installation, enable command-line auto-completion for better productivity: +

eval "$(register-python-argcomplete struct)"
+
+For permanent setup, see the Command-Line Completion guide.

+
+

From Source

+

Clone the repository and install locally. See the Development page for details.

+

Using Docker

+

Run STRUCT without installing, using Docker:

+
docker run -v $(pwd):/workdir -u $(id -u):$(id -g) ghcr.io/httpdss/struct:main generate file:///workdir/example/structure.yaml /workdir/example_output
+
+

Refer to the Quick Start guide for more options.

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/js/advanced.js b/site/js/advanced.js deleted file mode 100644 index 75e9bc3..0000000 --- a/site/js/advanced.js +++ /dev/null @@ -1,509 +0,0 @@ -// STRUCT Advanced Interactive Components - Phase 2 - -class StructSite { - constructor() { - this.initializeSearchFunctionality(); - this.initializeAdvancedStats(); - this.initializeContributorsList(); - this.initializeProjectShowcase(); - this.initializeAdvancedDemoFeatures(); - this.initializeKeyboardShortcuts(); - this.initializeThemeToggle(); - this.initializeProgressiveEnhancement(); - } - - // Advanced Search Functionality - initializeSearchFunctionality() { - const searchInput = document.getElementById('search-input'); - const searchResults = document.getElementById('search-results'); - - if (!searchInput) return; - - let searchIndex = []; - - // Build search index from page content - this.buildSearchIndex(); - - searchInput.addEventListener( - 'input', - this.debounce((e) => { - const query = e.target.value.toLowerCase().trim(); - - if (query.length < 2) { - searchResults.classList.add('hidden'); - return; - } - - const results = this.performSearch(query); - this.displaySearchResults(results); - }, 300) - ); - - // Close search when clicking outside - document.addEventListener('click', (e) => { - if (!searchInput.contains(e.target) && !searchResults.contains(e.target)) { - searchResults.classList.add('hidden'); - } - }); - } - - buildSearchIndex() { - this.searchIndex = [ - { - title: 'YAML Configuration', - content: 'Define project structures in simple YAML files', - section: 'features', - keywords: ['yaml', 'config', 'configuration', 'structure'], - }, - { - title: 'Template Variables', - content: - 'Dynamic content with Jinja2 templating and interactive prompts', - section: 'features', - keywords: ['template', 'variables', 'jinja2', 'dynamic'], - }, - { - title: 'Remote Content', - content: 'Fetch files from GitHub, HTTP/HTTPS, S3, and cloud storage', - section: 'features', - keywords: ['remote', 'github', 'http', 's3', 'cloud', 'fetch'], - }, - { - title: 'Installation Guide', - content: 'pip install, Docker, and source installation methods', - section: 'installation', - keywords: ['install', 'pip', 'docker', 'setup'], - }, - { - title: 'Basic Usage Demo', - content: 'See how to generate project structures with STRUCT', - section: 'demos', - keywords: ['demo', 'usage', 'example', 'generate'], - }, - ]; - } - - performSearch(query) { - return this.searchIndex.filter(item => { - return item.title.toLowerCase().includes(query) || - item.content.toLowerCase().includes(query) || - item.keywords.some(keyword => keyword.includes(query)); - }).slice(0, 5); - } - - displaySearchResults(results) { - const searchResults = document.getElementById('search-results'); - - if (results.length === 0) { - searchResults.innerHTML = '
No results found
'; - } else { - searchResults.innerHTML = results.map(result => ` -
-

${result.title}

-

${result.content}

-
- `).join(''); - } - - searchResults.classList.remove('hidden'); - } - - scrollToSection(sectionId) { - const section = document.getElementById(sectionId); - if (section) { - section.scrollIntoView({ behavior: 'smooth' }); - document.getElementById('search-results').classList.add('hidden'); - document.getElementById('search-input').value = ''; - } - } - - // Enhanced GitHub Stats with Additional Metrics - async initializeAdvancedStats() { - const statsContainer = document.querySelector('.github-stats-advanced'); - if (!statsContainer) return; - - try { - // Show enhanced loading state - statsContainer.innerHTML = this.getLoadingStatsHTML(); - - // Fetch comprehensive GitHub data - const [repoData, contributorsData, releasesData] = await Promise.all([ - fetch('https://api.github.com/repos/httpdss/struct').then(r => r.json()), - fetch('https://api.github.com/repos/httpdss/struct/contributors').then(r => r.json()), - fetch('https://api.github.com/repos/httpdss/struct/releases/latest').then(r => r.json()) - ]); - - // Update with comprehensive stats - statsContainer.innerHTML = this.getAdvancedStatsHTML(repoData, contributorsData, releasesData); - - // Animate counters - this.animateCounters(); - - } catch (error) { - console.error('Failed to fetch advanced GitHub stats:', error); - statsContainer.innerHTML = this.getFallbackStatsHTML(); - } - } - - getLoadingStatsHTML() { - return ` -
- ${Array(6).fill().map(() => ` -
-
-
...
-
Loading
-
- `).join('')} -
- `; - } - - getAdvancedStatsHTML(repo, contributors, release) { - return ` -
-
-
⭐
-
${this.formatNumber(repo.stargazers_count)}
-
Stars
-
-
-
🔀
-
${this.formatNumber(repo.forks_count)}
-
Forks
-
-
-
👥
-
${contributors.length}
-
Contributors
-
-
-
🚀
-
${release.tag_name || 'v1.0'}
-
Latest Release
-
-
-
🐛
-
${repo.open_issues_count}
-
Open Issues
-
-
-
📦
-
${this.formatBytes(repo.size * 1024)}
-
Repository Size
-
-
- `; - } - - // Contributors Showcase - async initializeContributorsList() { - const contributorsContainer = document.querySelector('.contributors-showcase'); - if (!contributorsContainer) return; - - try { - const contributors = await fetch('https://api.github.com/repos/httpdss/struct/contributors') - .then(r => r.json()); - - contributorsContainer.innerHTML = ` -

Contributors

-
- ${contributors.slice(0, 12).map(contributor => ` -
- ${contributor.login} -
-

${contributor.login}

-

${contributor.contributions} commits

-
- - - -
- `).join('')} -
- - View All Contributors → - - `; - } catch (error) { - console.error('Failed to fetch contributors:', error); - } - } - - // Project Showcase - initializeProjectShowcase() { - const showcaseContainer = document.querySelector('.project-showcase'); - if (!showcaseContainer) return; - - const projects = [ - { - name: 'Terraform Modules', - description: 'Generate consistent Terraform module structures', - tags: ['terraform', 'infrastructure', 'iac'], - icon: '🏗️' - }, - { - name: 'Python Projects', - description: 'Bootstrap Python applications with best practices', - tags: ['python', 'fastapi', 'django'], - icon: '🐍' - }, - { - name: 'Next.js Apps', - description: 'Generate modern React applications', - tags: ['react', 'nextjs', 'typescript'], - icon: '⚛️' - }, - { - name: 'Microservices', - description: 'Create microservice architectures', - tags: ['docker', 'kubernetes', 'api'], - icon: '🔧' - } - ]; - - showcaseContainer.innerHTML = ` -

Built with STRUCT

-
- ${projects.map(project => ` -
-
${project.icon}
-

${project.name}

-

${project.description}

-
- ${project.tags.map(tag => `${tag}`).join('')} -
-
- `).join('')} -
- `; - } - - // Advanced Demo Features - initializeAdvancedDemoFeatures() { - const demoContainer = document.querySelector('.demo-carousel'); - if (!demoContainer) return; - - // Add fullscreen functionality - const demoVideos = demoContainer.querySelectorAll('.demo-video'); - demoVideos.forEach(video => { - video.addEventListener('click', () => { - this.openFullscreenDemo(video); - }); - }); - - // Add demo navigation with keyboard support - document.addEventListener('keydown', (e) => { - if (e.target.closest('.demo-carousel')) { - if (e.key === 'ArrowLeft') this.previousDemo(); - if (e.key === 'ArrowRight') this.nextDemo(); - if (e.key === 'Escape') this.closeFullscreenDemo(); - } - }); - } - - openFullscreenDemo(video) { - const modal = document.createElement('div'); - modal.className = 'demo-modal'; - modal.innerHTML = ` -
- - ${video.alt} -
-

${video.alt}

-

Press ESC to close or click outside the demo

-
-
- `; - - document.body.appendChild(modal); - modal.addEventListener('click', (e) => { - if (e.target === modal || e.target.classList.contains('demo-modal-close')) { - this.closeFullscreenDemo(); - } - }); - - setTimeout(() => modal.classList.add('active'), 10); - } - - closeFullscreenDemo() { - const modal = document.querySelector('.demo-modal'); - if (modal) { - modal.classList.remove('active'); - setTimeout(() => modal.remove(), 300); - } - } - - // Keyboard Shortcuts - initializeKeyboardShortcuts() { - const shortcuts = { - 'ctrl+k': () => document.getElementById('search-input')?.focus(), - 'ctrl+/': () => this.showShortcutsHelp(), - 'esc': () => { - document.getElementById('search-results')?.classList.add('hidden'); - this.closeFullscreenDemo(); - } - }; - - document.addEventListener('keydown', (e) => { - const key = `${e.ctrlKey ? 'ctrl+' : ''}${e.key.toLowerCase()}`; - if (shortcuts[key]) { - e.preventDefault(); - shortcuts[key](); - } - }); - } - - showShortcutsHelp() { - const modal = document.createElement('div'); - modal.className = 'shortcuts-modal'; - modal.innerHTML = ` -
-

Keyboard Shortcuts

-
-
- Ctrl + K - Search -
-
- ← / → - Navigate demos -
-
- Esc - Close modals -
-
- Ctrl + / - Show this help -
-
- -
- `; - - document.body.appendChild(modal); - setTimeout(() => modal.classList.add('active'), 10); - } - - // Theme Toggle (Future Enhancement) - initializeThemeToggle() { - const themeToggle = document.querySelector('.theme-toggle'); - if (!themeToggle) return; - - themeToggle.addEventListener('click', () => { - document.body.classList.toggle('light-theme'); - const isLight = document.body.classList.contains('light-theme'); - localStorage.setItem('theme', isLight ? 'light' : 'dark'); - }); - - // Load saved theme - const savedTheme = localStorage.getItem('theme'); - if (savedTheme === 'light') { - document.body.classList.add('light-theme'); - } - } - - // Progressive Enhancement - initializeProgressiveEnhancement() { - // Add 'js-enabled' class for CSS progressive enhancement - document.documentElement.classList.add('js-enabled'); - - // Initialize service worker if supported - if ('serviceWorker' in navigator) { - navigator.serviceWorker.register('/struct/sw.js').catch((err) => { - console.log('ServiceWorker registration failed:', err); - }); - } - - // Initialize intersection observer for animations - this.initializeScrollAnimations(); - } - - initializeScrollAnimations() { - const observerOptions = { - threshold: 0.1, - rootMargin: '0px 0px -50px 0px' - }; - - const observer = new IntersectionObserver((entries) => { - entries.forEach(entry => { - if (entry.isIntersecting) { - entry.target.classList.add('animate-in'); - - // Stagger animations for grid items - if (entry.target.classList.contains('stagger-parent')) { - const children = entry.target.querySelectorAll('.stagger-item'); - children.forEach((child, index) => { - setTimeout(() => { - child.classList.add('animate-in'); - }, index * 100); - }); - } - } - }); - }, observerOptions); - - // Observe all animatable elements - document.querySelectorAll('.animate-on-scroll, .stagger-parent').forEach(el => { - observer.observe(el); - }); - } - - // Utility Methods - formatNumber(num) { - if (num >= 1000000) return (num / 1000000).toFixed(1) + 'M'; - if (num >= 1000) return (num / 1000).toFixed(1) + 'K'; - return num.toString(); - } - - formatBytes(bytes) { - if (bytes === 0) return '0 B'; - const k = 1024; - const sizes = ['B', 'KB', 'MB', 'GB']; - const i = Math.floor(Math.log(bytes) / Math.log(k)); - return parseFloat((bytes / Math.pow(k, i)).toFixed(1)) + ' ' + sizes[i]; - } - - debounce(func, wait) { - let timeout; - return function executedFunction(...args) { - const later = () => { - clearTimeout(timeout); - func(...args); - }; - clearTimeout(timeout); - timeout = setTimeout(later, wait); - }; - } - - animateCounters() { - const statCards = document.querySelectorAll('.stat-card[data-count]'); - statCards.forEach(card => { - const target = parseInt(card.dataset.count); - const valueElement = card.querySelector('.stat-value'); - let current = 0; - const increment = target / 30; - const timer = setInterval(() => { - current += increment; - if (current >= target) { - current = target; - clearInterval(timer); - } - valueElement.textContent = this.formatNumber(Math.floor(current)); - }, 50); - }); - } -} - -// Initialize advanced features when DOM is loaded -document.addEventListener('DOMContentLoaded', () => { - new StructSite(); -}); - -// Export for potential module usage -if (typeof module !== 'undefined' && module.exports) { - module.exports = StructSite; -} diff --git a/site/js/analytics.js b/site/js/analytics.js deleted file mode 100644 index 70784d4..0000000 --- a/site/js/analytics.js +++ /dev/null @@ -1,597 +0,0 @@ -/* Phase 3: Advanced Analytics & Performance Monitoring */ - -class StructAnalytics { - constructor() { - this.sessionId = this.generateSessionId(); - this.startTime = Date.now(); - this.interactions = []; - this.performanceMetrics = {}; - - this.init(); - } - - init() { - this.setupPerformanceMonitoring(); - this.setupUserInteractionTracking(); - this.setupVisibilityTracking(); - this.setupErrorTracking(); - this.startHeartbeat(); - } - - /* ===== PERFORMANCE MONITORING ===== */ - - setupPerformanceMonitoring() { - // Monitor Core Web Vitals - this.monitorWebVitals(); - - // Monitor resource loading - this.monitorResourceLoading(); - - // Monitor JavaScript execution time - this.monitorJSPerformance(); - - // Monitor scroll performance - this.monitorScrollPerformance(); - } - - monitorWebVitals() { - // First Contentful Paint (FCP) - if (window.performance && window.performance.getEntriesByType) { - const paintEntries = window.performance.getEntriesByType('paint'); - paintEntries.forEach((entry) => { - if (entry.name === 'first-contentful-paint') { - this.performanceMetrics.fcp = entry.startTime; - this.reportMetric('core_web_vitals', 'fcp', entry.startTime); - } - }); - } - - // Largest Contentful Paint (LCP) - if (window.PerformanceObserver) { - try { - const lcpObserver = new PerformanceObserver((list) => { - const entries = list.getEntries(); - const lastEntry = entries[entries.length - 1]; - this.performanceMetrics.lcp = lastEntry.startTime; - this.reportMetric('core_web_vitals', 'lcp', lastEntry.startTime); - }); - lcpObserver.observe({ entryTypes: ['largest-contentful-paint'] }); - } catch (e) { - console.warn('LCP monitoring not supported:', e); - } - } - - // Cumulative Layout Shift (CLS) - if (window.PerformanceObserver) { - try { - let clsValue = 0; - const clsObserver = new PerformanceObserver((list) => { - for (const entry of list.getEntries()) { - if (!entry.hadRecentInput) { - clsValue += entry.value; - } - } - this.performanceMetrics.cls = clsValue; - this.reportMetric('core_web_vitals', 'cls', clsValue); - }); - clsObserver.observe({ entryTypes: ['layout-shift'] }); - } catch (e) { - console.warn('CLS monitoring not supported:', e); - } - } - - // First Input Delay (FID) - if (window.PerformanceObserver) { - try { - const fidObserver = new PerformanceObserver((list) => { - for (const entry of list.getEntries()) { - this.performanceMetrics.fid = - entry.processingStart - entry.startTime; - this.reportMetric( - 'core_web_vitals', - 'fid', - this.performanceMetrics.fid - ); - } - }); - fidObserver.observe({ entryTypes: ['first-input'] }); - } catch (e) { - console.warn('FID monitoring not supported:', e); - } - } - } - - monitorResourceLoading() { - window.addEventListener('load', () => { - const navigation = window.performance.getEntriesByType('navigation')[0]; - if (navigation) { - this.performanceMetrics.pageLoadTime = - navigation.loadEventEnd - navigation.fetchStart; - this.performanceMetrics.domContentLoaded = - navigation.domContentLoadedEventEnd - navigation.fetchStart; - this.performanceMetrics.timeToInteractive = - navigation.loadEventEnd - navigation.fetchStart; - - this.reportMetric( - 'performance', - 'page_load_time', - this.performanceMetrics.pageLoadTime - ); - this.reportMetric( - 'performance', - 'dom_content_loaded', - this.performanceMetrics.domContentLoaded - ); - } - - // Monitor resource timings - const resources = window.performance.getEntriesByType('resource'); - const resourceMetrics = { - css: [], - js: [], - images: [], - fonts: [], - }; - - resources.forEach((resource) => { - const loadTime = resource.responseEnd - resource.fetchStart; - const resourceType = this.getResourceType(resource.name); - - if (resourceMetrics[resourceType]) { - resourceMetrics[resourceType].push({ - url: resource.name, - loadTime: loadTime, - size: resource.transferSize || 0, - }); - } - }); - - this.performanceMetrics.resources = resourceMetrics; - this.reportResourceMetrics(resourceMetrics); - }); - } - - monitorJSPerformance() { - // Monitor long tasks - if (window.PerformanceObserver) { - try { - const longTaskObserver = new PerformanceObserver((list) => { - for (const entry of list.getEntries()) { - this.reportMetric('performance', 'long_task', { - duration: entry.duration, - startTime: entry.startTime, - }); - } - }); - longTaskObserver.observe({ entryTypes: ['longtask'] }); - } catch (e) { - console.warn('Long task monitoring not supported:', e); - } - } - - // Monitor function execution times - this.originalFetch = window.fetch; - window.fetch = (...args) => { - const startTime = performance.now(); - return this.originalFetch.apply(window, args).then((response) => { - const endTime = performance.now(); - this.reportMetric('performance', 'fetch_duration', { - url: args[0], - duration: endTime - startTime, - status: response.status, - }); - return response; - }); - }; - } - - monitorScrollPerformance() { - let scrollStartTime = null; - let scrollCount = 0; - - const scrollHandler = this.throttle(() => { - if (!scrollStartTime) { - scrollStartTime = performance.now(); - } - scrollCount++; - }, 16); // 60fps - - const scrollEndHandler = this.debounce(() => { - if (scrollStartTime) { - const scrollDuration = performance.now() - scrollStartTime; - this.reportMetric('interaction', 'scroll_performance', { - duration: scrollDuration, - events: scrollCount, - }); - scrollStartTime = null; - scrollCount = 0; - } - }, 150); - - window.addEventListener( - 'scroll', - () => { - scrollHandler(); - scrollEndHandler(); - }, - { passive: true } - ); - } - - /* ===== USER INTERACTION TRACKING ===== */ - - setupUserInteractionTracking() { - this.trackClicks(); - this.trackFormInteractions(); - this.trackKeyboardShortcuts(); - this.trackTimeOnPage(); - this.trackScrollDepth(); - } - - trackClicks() { - document.addEventListener('click', (e) => { - const target = e.target.closest('a, button, [role="button"]'); - if (target) { - this.recordInteraction('click', { - element: this.getElementInfo(target), - timestamp: Date.now(), - coordinates: { x: e.clientX, y: e.clientY }, - }); - } - }); - } - - trackFormInteractions() { - document.addEventListener('submit', (e) => { - const form = e.target; - if (form.tagName === 'FORM') { - this.recordInteraction('form_submit', { - formId: form.id, - formClass: form.className, - timestamp: Date.now(), - }); - } - }); - - // Track input focus - document.addEventListener( - 'focus', - (e) => { - if (e.target.matches('input, textarea, select')) { - this.recordInteraction('input_focus', { - inputType: e.target.type, - inputId: e.target.id, - timestamp: Date.now(), - }); - } - }, - true - ); - } - - trackKeyboardShortcuts() { - document.addEventListener('keydown', (e) => { - if (e.ctrlKey || e.metaKey || e.altKey) { - this.recordInteraction('keyboard_shortcut', { - key: e.key, - ctrlKey: e.ctrlKey, - metaKey: e.metaKey, - altKey: e.altKey, - shiftKey: e.shiftKey, - timestamp: Date.now(), - }); - } - }); - } - - trackTimeOnPage() { - this.pageStartTime = Date.now(); - - window.addEventListener('beforeunload', () => { - const timeOnPage = Date.now() - this.pageStartTime; - this.reportMetric('engagement', 'time_on_page', timeOnPage); - }); - } - - trackScrollDepth() { - let maxScrollDepth = 0; - const trackPoints = [25, 50, 75, 90, 100]; - const trackedPoints = new Set(); - - const scrollHandler = this.throttle(() => { - const scrollTop = window.pageYOffset; - const documentHeight = - document.documentElement.scrollHeight - window.innerHeight; - const scrollPercentage = Math.round((scrollTop / documentHeight) * 100); - - maxScrollDepth = Math.max(maxScrollDepth, scrollPercentage); - - trackPoints.forEach((point) => { - if (scrollPercentage >= point && !trackedPoints.has(point)) { - trackedPoints.add(point); - this.recordInteraction('scroll_depth', { - percentage: point, - timestamp: Date.now(), - }); - } - }); - }, 100); - - window.addEventListener('scroll', scrollHandler, { passive: true }); - } - - /* ===== VISIBILITY TRACKING ===== */ - - setupVisibilityTracking() { - // Page visibility - document.addEventListener('visibilitychange', () => { - this.recordInteraction('visibility_change', { - hidden: document.hidden, - timestamp: Date.now(), - }); - }); - - // Element visibility using Intersection Observer - this.setupElementVisibilityTracking(); - } - - setupElementVisibilityTracking() { - const importantSections = document.querySelectorAll(` - #features, - #installation, - #demos, - #quick-reference, - #api-preview, - #wizard, - #community, - #testimonials, - #project-showcase - `); - - const observer = new IntersectionObserver( - (entries) => { - entries.forEach((entry) => { - if (entry.isIntersecting) { - this.recordInteraction('section_view', { - sectionId: entry.target.id, - intersectionRatio: entry.intersectionRatio, - timestamp: Date.now(), - }); - } - }); - }, - { - threshold: 0.5, - rootMargin: '0px 0px -10% 0px', - } - ); - - importantSections.forEach((section) => observer.observe(section)); - } - - /* ===== ERROR TRACKING ===== */ - - setupErrorTracking() { - // JavaScript errors - window.addEventListener('error', (e) => { - this.reportError('javascript_error', { - message: e.message, - filename: e.filename, - lineno: e.lineno, - colno: e.colno, - stack: e.error ? e.error.stack : null, - timestamp: Date.now(), - }); - }); - - // Unhandled promise rejections - window.addEventListener('unhandledrejection', (e) => { - this.reportError('unhandled_promise_rejection', { - reason: e.reason, - timestamp: Date.now(), - }); - }); - - // Network errors (fetch failures) - const originalFetch = window.fetch; - window.fetch = (...args) => { - return originalFetch.apply(window, args).catch((error) => { - this.reportError('network_error', { - url: args[0], - error: error.message, - timestamp: Date.now(), - }); - throw error; - }); - }; - } - - /* ===== FEATURE USAGE TRACKING ===== */ - - trackFeatureUsage(featureName, details = {}) { - this.recordInteraction('feature_usage', { - feature: featureName, - details: details, - timestamp: Date.now(), - }); - } - - /* ===== UTILITY METHODS ===== */ - - getResourceType(url) { - if (url.includes('.css')) return 'css'; - if (url.includes('.js')) return 'js'; - if (url.match(/\.(jpg|jpeg|png|gif|svg|webp)$/i)) return 'images'; - if (url.match(/\.(woff|woff2|ttf|otf)$/i)) return 'fonts'; - return 'other'; - } - - getElementInfo(element) { - return { - tagName: element.tagName, - id: element.id, - className: element.className, - textContent: element.textContent?.slice(0, 100), - href: element.href, - type: element.type, - }; - } - - recordInteraction(type, data) { - this.interactions.push({ - type, - data, - sessionId: this.sessionId, - timestamp: Date.now(), - }); - - // Batch send interactions - if (this.interactions.length >= 10) { - this.sendInteractions(); - } - } - - reportMetric(category, metric, value) { - // In a real implementation, this would send to your analytics service - if (window.gtag) { - window.gtag('event', metric, { - event_category: category, - value: typeof value === 'number' ? Math.round(value) : value, - custom_map: { metric_1: 'performance_metric' }, - }); - } - - console.log(`📊 ${category}.${metric}:`, value); - } - - reportResourceMetrics(metrics) { - Object.entries(metrics).forEach(([type, resources]) => { - if (resources.length > 0) { - const avgLoadTime = - resources.reduce((sum, r) => sum + r.loadTime, 0) / resources.length; - const totalSize = resources.reduce((sum, r) => sum + r.size, 0); - - this.reportMetric('resources', `${type}_avg_load_time`, avgLoadTime); - this.reportMetric('resources', `${type}_total_size`, totalSize); - } - }); - } - - reportError(type, error) { - // In a real implementation, this would send to your error tracking service - console.error(`🚨 ${type}:`, error); - - if (window.gtag) { - window.gtag('event', 'exception', { - description: `${type}: ${error.message || error.reason}`, - fatal: false, - }); - } - } - - sendInteractions() { - const interactions = [...this.interactions]; - this.interactions = []; - - // In a real implementation, send to your analytics endpoint - console.log('📈 Sending interactions:', interactions); - } - - startHeartbeat() { - // Send interactions every 30 seconds - setInterval(() => { - if (this.interactions.length > 0) { - this.sendInteractions(); - } - }, 30000); - - // Send final batch on page unload - window.addEventListener('beforeunload', () => { - if (this.interactions.length > 0) { - this.sendInteractions(); - } - }); - } - - generateSessionId() { - return `session_${Date.now()}_${Math.random().toString(36).substr(2, 9)}`; - } - - throttle(func, limit) { - let inThrottle; - return function () { - const args = arguments; - const context = this; - if (!inThrottle) { - func.apply(context, args); - inThrottle = true; - setTimeout(() => (inThrottle = false), limit); - } - }; - } - - debounce(func, wait) { - let timeout; - return function executedFunction(...args) { - const later = () => { - clearTimeout(timeout); - func(...args); - }; - clearTimeout(timeout); - timeout = setTimeout(later, wait); - }; - } - - /* ===== PUBLIC API ===== */ - - // Track custom events - track(eventName, properties = {}) { - this.recordInteraction('custom_event', { - eventName, - properties, - timestamp: Date.now(), - }); - } - - // Get current performance metrics - getPerformanceMetrics() { - return { ...this.performanceMetrics }; - } - - // Get session summary - getSessionSummary() { - return { - sessionId: this.sessionId, - duration: Date.now() - this.startTime, - interactions: this.interactions.length, - performanceMetrics: this.performanceMetrics, - }; - } -} - -// Initialize analytics -document.addEventListener('DOMContentLoaded', () => { - window.structAnalytics = new StructAnalytics(); - - // Track feature usage in existing components - if (window.structPhase3) { - const originalCopyToClipboard = window.structPhase3.copyToClipboard; - window.structPhase3.copyToClipboard = function (text) { - window.structAnalytics.trackFeatureUsage('copy_to_clipboard', { - textLength: text.length, - }); - return originalCopyToClipboard.call(this, text); - }; - } - - // Track search usage - if (window.advancedSearch) { - const originalHandleSearch = window.advancedSearch.handleSearch; - window.advancedSearch.handleSearch = function (e) { - window.structAnalytics.trackFeatureUsage('search', { - query: e.target.value, - }); - return originalHandleSearch.call(this, e); - }; - } -}); diff --git a/site/js/main.js b/site/js/main.js deleted file mode 100644 index f5b95bd..0000000 --- a/site/js/main.js +++ /dev/null @@ -1,277 +0,0 @@ -// STRUCT Static Site - Main JavaScript - -// Initialize all components when DOM is loaded -document.addEventListener('DOMContentLoaded', function() { - initializeInstallationTabs(); - initializeDemoCarousel(); - initializeCodeCopyButtons(); - initializeGitHubStats(); - initializeAnimations(); - initializeMobileMenu(); -}); - -// Installation Tabs Component -function initializeInstallationTabs() { - const tabButtons = document.querySelectorAll('.tab-button'); - const tabPanes = document.querySelectorAll('.tab-pane'); - - tabButtons.forEach(button => { - button.addEventListener('click', () => { - const targetTab = button.dataset.tab; - - // Remove active class from all buttons and panes - tabButtons.forEach(btn => btn.classList.remove('active')); - tabPanes.forEach(pane => pane.classList.remove('active')); - - // Add active class to clicked button and corresponding pane - button.classList.add('active'); - const targetPane = document.getElementById(targetTab); - if (targetPane) { - targetPane.classList.add('active'); - } - }); - }); -} - -// Demo Carousel Component -function initializeDemoCarousel() { - const demoTabs = document.querySelectorAll('.demo-tab'); - const demoContents = document.querySelectorAll('.demo-content-item'); - - demoTabs.forEach(tab => { - tab.addEventListener('click', () => { - const targetDemo = tab.dataset.demo; - - // Remove active class from all tabs and contents - demoTabs.forEach(t => t.classList.remove('active')); - demoContents.forEach(content => { - content.classList.remove('active'); - content.classList.remove('fade-in'); - }); - - // Add active class to clicked tab and corresponding content - tab.classList.add('active'); - const targetContent = document.getElementById(targetDemo); - if (targetContent) { - targetContent.classList.add('active'); - // Use setTimeout to ensure the display change happens first - setTimeout(() => { - targetContent.classList.add('fade-in'); - }, 10); - } - }); - }); -} - -// Code Copy Buttons -function initializeCodeCopyButtons() { - const copyButtons = document.querySelectorAll('.copy-button'); - - copyButtons.forEach(button => { - button.addEventListener('click', async () => { - const codeBlock = button.parentElement.querySelector('code'); - const text = codeBlock.textContent; - - try { - await navigator.clipboard.writeText(text); - - // Visual feedback - const originalText = button.textContent; - button.textContent = 'Copied!'; - button.style.backgroundColor = 'var(--color-success)'; - - setTimeout(() => { - button.textContent = originalText; - button.style.backgroundColor = ''; - }, 2000); - } catch (err) { - console.error('Failed to copy text: ', err); - - // Fallback for older browsers - const textArea = document.createElement('textarea'); - textArea.value = text; - document.body.appendChild(textArea); - textArea.select(); - document.execCommand('copy'); - document.body.removeChild(textArea); - - button.textContent = 'Copied!'; - setTimeout(() => { - button.textContent = 'Copy'; - }, 2000); - } - }); - }); -} - -// GitHub Stats Component -async function initializeGitHubStats() { - const statsContainer = document.querySelector('.github-stats'); - if (!statsContainer) return; - - try { - // Show loading state - statsContainer.innerHTML = ` -
- ... - Stars -
-
- ... - Forks -
-
- ... - Issues -
-
- ... - PRs -
- `; - - // Fetch GitHub stats - const response = await fetch('https://api.github.com/repos/httpdss/struct'); - const data = await response.json(); - - // Update stats with real data - statsContainer.innerHTML = ` -
- ${formatNumber(data.stargazers_count)} - Stars -
-
- ${formatNumber(data.forks_count)} - Forks -
-
- ${formatNumber(data.open_issues_count)} - Issues -
-
- ${formatNumber(data.size)} - KB -
- `; - } catch (error) { - console.error('Failed to fetch GitHub stats:', error); - - // Fallback to static numbers - statsContainer.innerHTML = ` -
- ⭐ - Stars -
-
- 🔗 - Forks -
-
- 🐛 - Issues -
-
- 📊 - Stats -
- `; - } -} - -// Format numbers for display -function formatNumber(num) { - if (num >= 1000000) { - return (num / 1000000).toFixed(1) + 'M'; - } else if (num >= 1000) { - return (num / 1000).toFixed(1) + 'K'; - } - return num.toString(); -} - -// Scroll Animations -function initializeAnimations() { - const observerOptions = { - threshold: 0.1, - rootMargin: '0px 0px -50px 0px' - }; - - const observer = new IntersectionObserver((entries) => { - entries.forEach(entry => { - if (entry.isIntersecting) { - entry.target.classList.add('fade-in'); - } - }); - }, observerOptions); - - // Observe all cards and feature elements - document.querySelectorAll('.card, .feature-card, .stat-item').forEach(el => { - observer.observe(el); - }); -} - -// Mobile Menu (if needed) -function initializeMobileMenu() { - const mobileMenuButton = document.querySelector('.mobile-menu-button'); - const mobileMenu = document.querySelector('.mobile-menu'); - - if (mobileMenuButton && mobileMenu) { - mobileMenuButton.addEventListener('click', () => { - mobileMenu.classList.toggle('active'); - mobileMenuButton.classList.toggle('active'); - }); - - // Close menu when clicking outside - document.addEventListener('click', (e) => { - if (!mobileMenuButton.contains(e.target) && !mobileMenu.contains(e.target)) { - mobileMenu.classList.remove('active'); - mobileMenuButton.classList.remove('active'); - } - }); - } -} - -// Smooth scroll for anchor links -document.querySelectorAll('a[href^="#"]').forEach(anchor => { - anchor.addEventListener('click', function(e) { - e.preventDefault(); - const target = document.querySelector(this.getAttribute('href')); - if (target) { - target.scrollIntoView({ - behavior: 'smooth', - block: 'start' - }); - } - }); -}); - -// Utility functions -const utils = { - // Debounce function for performance - debounce: (func, wait) => { - let timeout; - return function executedFunction(...args) { - const later = () => { - clearTimeout(timeout); - func(...args); - }; - clearTimeout(timeout); - timeout = setTimeout(later, wait); - }; - }, - - // Check if element is in viewport - isInViewport: (element) => { - const rect = element.getBoundingClientRect(); - return ( - rect.top >= 0 && - rect.left >= 0 && - rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && - rect.right <= (window.innerWidth || document.documentElement.clientWidth) - ); - } -}; - -// Export for potential module usage -if (typeof module !== 'undefined' && module.exports) { - module.exports = { utils }; -} diff --git a/site/js/phase3.js b/site/js/phase3.js deleted file mode 100644 index b7f8c1e..0000000 --- a/site/js/phase3.js +++ /dev/null @@ -1,1104 +0,0 @@ -/* Phase 3: Advanced JavaScript Features & Documentation Integration */ - -class StructPhase3 { - constructor() { - this.currentWizardStep = 0; - this.wizardData = {}; - this.currentApiTab = 'commands'; - this.currentShowcaseFilter = 'all'; - this.init(); - } - - init() { - this.initDocumentationFeatures(); - this.initCommunityFeatures(); - this.initGettingStartedWizard(); - this.initAPIPreview(); - this.initProjectShowcase(); - this.initTestimonials(); - this.initPerformanceOptimizations(); - } - - /* ===== DOCUMENTATION INTEGRATION ===== */ - - initDocumentationFeatures() { - this.createQuickReference(); - this.setupQuickReferenceInteractions(); - } - - createQuickReference() { - const referenceData = [ - { - title: 'Basic Commands', - icon: 'fas fa-terminal', - items: [ - { - title: 'struct generate', - description: 'Generate project structure from configuration', - code: 'struct generate config.yaml ./output' - }, - { - title: 'struct validate', - description: 'Validate YAML configuration file', - code: 'struct validate config.yaml' - }, - { - title: 'struct list', - description: 'List available structure templates', - code: 'struct list' - } - ] - }, - { - title: 'Configuration', - icon: 'fas fa-file-code', - items: [ - { - title: 'files', - description: 'Define files to be created', - code: 'files:\n - README.md:\n content: "# Project"' - }, - { - title: 'folders', - description: 'Define folder structures', - code: 'folders:\n - src/:\n struct: python/module' - }, - { - title: 'variables', - description: 'Define template variables', - code: 'variables:\n - project_name:\n type: string' - } - ] - }, - { - title: 'Template Features', - icon: 'fas fa-magic', - items: [ - { - title: 'Variables', - description: 'Use Jinja2 template variables', - code: '{{@ project_name @}}' - }, - { - title: 'Filters', - description: 'Apply custom filters', - code: '{{@ name | slugify @}}' - }, - { - title: 'Remote Content', - description: 'Fetch content from URLs', - code: 'file: github://user/repo/main/file.txt' - } - ] - } - ]; - - const quickRefSection = document.querySelector('#quick-reference .reference-grid'); - if (quickRefSection) { - quickRefSection.innerHTML = referenceData.map(section => ` -
-
- -

${section.title}

-
-
- ${section.items.map(item => ` -
- -
-
${item.title}
-
${item.description}
-
${item.code}
-
-
- `).join('')} -
-
- `).join(''); - } - } - - setupQuickReferenceInteractions() { - // Copy code functionality - document.addEventListener('click', (e) => { - if (e.target.closest('.reference-code')) { - const code = e.target.closest('.reference-code').textContent; - this.copyToClipboard(code); - this.showToast('Code copied to clipboard!'); - } - }); - } - - /* ===== API DOCUMENTATION PREVIEW ===== */ - - initAPIPreview() { - this.createAPIPreview(); - this.setupAPITabs(); - } - - createAPIPreview() { - const apiData = { - commands: { - title: 'CLI Commands', - methods: [ - { - type: 'CMD', - name: 'struct generate', - description: 'Generate project structure from YAML configuration', - code: `# Basic usage -struct generate config.yaml ./output - -# With variables -struct generate config.yaml ./output --var project_name="MyProject" - -# Dry run -struct generate config.yaml ./output --dry-run` - }, - { - type: 'CMD', - name: 'struct validate', - description: 'Validate YAML configuration syntax and structure', - code: `# Validate configuration -struct validate config.yaml - -# Validate with verbose output -struct validate config.yaml --verbose` - } - ] - }, - yaml: { - title: 'YAML Configuration', - methods: [ - { - type: 'YAML', - name: 'Basic Structure', - description: 'Define files, folders, and variables in your configuration', - code: `files: - - README.md: - content: | - # {{@ project_name @}} - {{@ description @}} - -folders: - - src/: - struct: python/module - with: - module_name: "{{@ project_name | slugify @}}" - -variables: - - project_name: - description: "Name of your project" - type: string - default: "MyProject" - - description: - description: "Project description" - type: string` - } - ] - }, - templates: { - title: 'Template Features', - methods: [ - { - type: 'TPL', - name: 'Variable Substitution', - description: 'Use Jinja2 syntax for dynamic content generation', - code: `# Basic variable -{{@ variable_name @}} - -# With default value -{{@ variable_name | default("default_value") @}} - -# Apply filters -{{@ project_name | slugify @}} -{{@ version | latest_release @}} -{{@ branch | default_branch @}}` - } - ] - } - }; - - const apiContent = document.querySelector('#api-preview .api-content'); - if (apiContent) { - apiContent.innerHTML = ` -
- ${Object.keys(apiData).map(key => ` - - `).join('')} -
- ${Object.entries(apiData).map(([key, data]) => ` -
-
-

${data.title}

- ${data.methods.map(method => ` -
-
- ${method.type} - ${method.name} -
-
${method.description}
-
- - 
${method.code}
-
-
- `).join('')} -
-
- `).join('')} - `; - } - } - - setupAPITabs() { - document.addEventListener('click', (e) => { - if (e.target.matches('.api-tab')) { - const tabName = e.target.dataset.tab; - this.switchAPITab(tabName); - } - }); - } - - switchAPITab(tabName) { - // Update active tab - document.querySelectorAll('.api-tab').forEach(tab => tab.classList.remove('active')); - document.querySelector(`[data-tab="${tabName}"]`).classList.add('active'); - - // Update active panel - document.querySelectorAll('.api-panel').forEach(panel => panel.classList.remove('active')); - document.querySelector(`[data-panel="${tabName}"]`).classList.add('active'); - - this.currentApiTab = tabName; - } - - /* ===== GETTING STARTED WIZARD ===== */ - - initGettingStartedWizard() { - this.createWizardSteps(); - this.setupWizardNavigation(); - } - - createWizardSteps() { - const wizardSteps = [ - { - title: 'Choose Your Project Type', - description: 'Select the type of project you want to create with STRUCT', - options: [ - { - id: 'python', - title: 'Python Project', - description: 'Create a Python application or library structure' - }, - { - id: 'web', - title: 'Web Application', - description: 'Generate a web application with frontend/backend structure' - }, - { - id: 'terraform', - title: 'Infrastructure as Code', - description: 'Create Terraform modules and infrastructure templates' - }, - { - id: 'custom', - title: 'Custom Structure', - description: 'Define your own project structure from scratch' - } - ] - }, - { - title: 'Installation Method', - description: 'Choose how you want to install STRUCT', - options: [ - { - id: 'pip', - title: 'pip install', - description: 'Install using Python package manager (recommended)' - }, - { - id: 'docker', - title: 'Docker', - description: 'Use Docker container for isolated environment' - }, - { - id: 'source', - title: 'From Source', - description: 'Clone and install from GitHub repository' - } - ] - }, - { - title: 'Configuration', - description: 'Generate your first STRUCT configuration', - isResult: true - } - ]; - - const wizardContainer = document.querySelector('#wizard .wizard-content'); - if (wizardContainer) { - wizardContainer.innerHTML = ` -
-
- ${wizardSteps.map((step, index) => ` -
- ${index + 1} -
- `).join('')} -
- ${wizardSteps.map((step, index) => ` -
-

${step.title}

-

${step.description}

- ${step.isResult ? this.createWizardResult() : ` -
- ${step.options.map(option => ` -
-
${option.title}
-
${option.description}
-
- `).join('')} -
- `} -
- - - ${index === wizardSteps.length - 1 ? ` - - ` : ''} -
-
- `).join('')} - `; - } - } - - createWizardResult() { - return ` -
- - 
Loading configuration...
-
-
-

Your configuration is ready! You can:

-
    -
  • Copy the configuration above
    • -
  • Download it as a YAML file
    • -
  • Start building your project structure
    • -
-
- `; - } - - setupWizardNavigation() { - document.addEventListener('click', (e) => { - // Check if the clicked element is a wizard option or its child - const wizardOption = e.target.closest('.wizard-option'); - if (wizardOption) { - const panel = wizardOption.closest('.wizard-panel'); - if (!panel || !panel.classList.contains('active')) { - return; // Only handle clicks in the active panel - } - - // Remove selection from all options in this panel - panel.querySelectorAll('.wizard-option').forEach(opt => opt.classList.remove('selected')); - wizardOption.classList.add('selected'); - - const step = parseInt(panel.dataset.panel); - const value = wizardOption.dataset.value; - this.wizardData[step] = value; - - console.log(`Wizard step ${step} selected: ${value}`); // Debug log - - // Remove any existing error when selection is made - const existingError = panel.querySelector('.wizard-error'); - if (existingError) { - existingError.remove(); - } - - // Enable the Next button - const nextBtn = panel.querySelector('.wizard-btn:not(.wizard-btn-secondary)'); - if (nextBtn && !nextBtn.textContent.includes('Download')) { - nextBtn.disabled = false; - nextBtn.style.opacity = '1'; - } - } - }); - } - - nextWizardStep() { - // Validate that current step has a selection - if (!this.wizardData[this.currentWizardStep]) { - this.showWizardError('Please make a selection before continuing.'); - return; - } - - if (this.currentWizardStep < 2) { - this.currentWizardStep++; - this.updateWizardStep(); - - // Debug: Log current step and check if panel exists - console.log(`Advanced to step ${this.currentWizardStep}`); - const activePanel = document.querySelector('.wizard-panel.active'); - console.log('Active panel:', activePanel); - console.log('Wizard options in active panel:', activePanel ? activePanel.querySelectorAll('.wizard-option').length : 0); - - if (this.currentWizardStep === 2) { - this.generateWizardResult(); - } - } - } - - previousWizardStep() { - if (this.currentWizardStep > 0) { - this.currentWizardStep--; - this.updateWizardStep(); - } - } - - showWizardError(message) { - // Remove any existing error - const existingError = document.querySelector('.wizard-error'); - if (existingError) { - existingError.remove(); - } - - // Create and show error message - const activePanel = document.querySelector('.wizard-panel.active'); - const errorDiv = document.createElement('div'); - errorDiv.className = 'wizard-error'; - errorDiv.style.cssText = ` - background-color: var(--color-error); - color: white; - padding: var(--space-3); - border-radius: var(--radius-md); - margin: var(--space-4) 0; - font-size: var(--text-sm); - `; - errorDiv.textContent = message; - - const actions = activePanel.querySelector('.wizard-actions'); - actions.parentNode.insertBefore(errorDiv, actions); - - // Auto-hide error after 3 seconds - setTimeout(() => { - if (errorDiv.parentNode) { - errorDiv.remove(); - } - }, 3000); - } - - updateWizardStep() { - // Update progress - const progress = (this.currentWizardStep / 2) * 100; - document.querySelector('.wizard-progress-line').style.width = `${progress}%`; - - // Update steps - document.querySelectorAll('.wizard-step').forEach((step, index) => { - step.classList.remove('active', 'completed'); - if (index < this.currentWizardStep) { - step.classList.add('completed'); - } else if (index === this.currentWizardStep) { - step.classList.add('active'); - } - }); - - // Update panels - document.querySelectorAll('.wizard-panel').forEach((panel, index) => { - panel.classList.remove('active'); - if (index === this.currentWizardStep) { - panel.classList.add('active'); - - // Update button states for the active panel - const nextBtn = panel.querySelector('.wizard-btn:not(.wizard-btn-secondary)'); - const hasSelection = this.wizardData[index] !== undefined; - - if (nextBtn && !nextBtn.textContent.includes('Download')) { - nextBtn.disabled = !hasSelection; - nextBtn.style.opacity = hasSelection ? '1' : '0.5'; - } - - // Update Previous button - const prevBtn = panel.querySelector('.wizard-btn-secondary'); - if (prevBtn) { - prevBtn.disabled = index === 0; - } - } - }); - } - - generateWizardResult() { - const projectType = this.wizardData[0] || 'custom'; - const installMethod = this.wizardData[1] || 'pip'; - - const configurations = { - python: `files: - - README.md: - content: | - # {{@ project_name @}} - {{@ description @}} - - ## Installation - \`\`\`bash - pip install -e . - \`\`\` - - setup.py: - content: | - from setuptools import setup, find_packages - - setup( - name="{{@ project_name | slugify @}}", - version="0.1.0", - packages=find_packages(), - ) - - requirements.txt: - content: | - # Add your dependencies here - -folders: - - {{@ project_name | slugify @}}/: - struct: python/module - - tests/: - struct: python/tests - -variables: - - project_name: - description: "Name of your Python project" - type: string - default: "MyPythonProject" - - description: - description: "Project description" - type: string - default: "A Python project created with STRUCT"`, - - web: `files: - - README.md: - content: | - # {{@ project_name @}} - {{@ description @}} - - ## Development - \`\`\`bash - npm install - npm start - \`\`\` - - package.json: - content: | - { - "name": "{{@ project_name | slugify @}}", - "version": "1.0.0", - "description": "{{@ description @}}", - "main": "src/index.js", - "scripts": { - "start": "node src/index.js" - } - } - -folders: - - src/: - struct: web/frontend - - api/: - struct: web/backend - -variables: - - project_name: - description: "Name of your web project" - type: string - default: "MyWebApp" - - description: - description: "Project description" - type: string - default: "A web application created with STRUCT"`, - }; - - const config = configurations[projectType] || configurations.python; - - setTimeout(() => { - document.getElementById('wizard-result').textContent = config; - }, 500); - - this.generatedConfig = config; - } - - copyWizardConfig() { - this.copyToClipboard(this.generatedConfig); - this.showToast('Configuration copied to clipboard!'); - } - - downloadWizardConfig() { - const blob = new Blob([this.generatedConfig], { type: 'text/yaml' }); - const url = URL.createObjectURL(blob); - const a = document.createElement('a'); - a.href = url; - a.download = 'struct-config.yaml'; - a.click(); - URL.revokeObjectURL(url); - } - - /* ===== COMMUNITY FEATURES ===== */ - - initCommunityFeatures() { - this.createCommunitySection(); - this.loadGitHubCommunityStats(); - } - - createCommunitySection() { - const communityData = [ - { - icon: 'fab fa-github', - title: 'GitHub Repository', - description: - 'Contribute to STRUCT, report issues, and collaborate with the community', - action: 'View on GitHub', - link: 'https://github.com/httpdss/struct', - }, - { - icon: 'fas fa-comments', - title: 'Discussions', - description: - 'Ask questions, share ideas, and get help from other STRUCT users', - action: 'Join Discussion', - link: 'https://github.com/httpdss/struct/discussions', - }, - { - icon: 'fas fa-book', - title: 'Documentation', - description: 'Comprehensive guides, tutorials, and API documentation', - action: 'Read Docs', - link: 'https://httpdss.github.io/struct/docs/', - }, - { - icon: 'fas fa-heart', - title: 'Support Project', - description: 'Help keep STRUCT development active and growing', - action: 'Support Us', - link: 'https://patreon.com/structproject', - }, - ]; - - const communityGrid = document.querySelector('#community .community-grid'); - if (communityGrid) { - communityGrid.innerHTML = communityData.map(item => ` -
-
- -
-

${item.title}

-

${item.description}

- - ${item.action} - -
- `).join(''); - } - } - - async loadGitHubCommunityStats() { - try { - const [repoResponse, contributorsResponse] = await Promise.all([ - fetch('https://api.github.com/repos/httpdss/struct'), - fetch('https://api.github.com/repos/httpdss/struct/contributors') - ]); - - const repo = await repoResponse.json(); - const contributors = await contributorsResponse.json(); - - this.updateCommunityStats(repo, contributors); - } catch (error) { - console.warn('Failed to load community stats:', error); - } - } - - updateCommunityStats(repo, contributors) { - const statsHTML = ` -
-
-
${repo.stargazers_count}
-
GitHub Stars
-
-
-
${repo.forks_count}
-
Forks
-
-
-
${contributors.length}
-
Contributors
-
-
-
${repo.open_issues_count}
-
Open Issues
-
-
- `; - - const communityHeader = document.querySelector('#community .community-header'); - if (communityHeader) { - communityHeader.insertAdjacentHTML('afterend', statsHTML); - } - } - - /* ===== TESTIMONIALS ===== */ - - initTestimonials() { - this.createTestimonials(); - } - - createTestimonials() { - const testimonials = [ - { - content: - 'STRUCT has completely transformed how we scaffold new projects. What used to take hours of manual setup now takes minutes. The YAML configuration is intuitive and the template system is incredibly powerful.', - author: 'Sarah Chen', - role: 'Senior DevOps Engineer', - avatar: - 'https://images.unsplash.com/photo-1531746020798-e6953c6e8e04?w=100&h=100&fit=crop&crop=face', - }, - { - content: - "The best project structure generator I've used. The ability to fetch content from remote sources and the Jinja2 templating makes it perfect for creating consistent, enterprise-ready project layouts.", - author: 'Marcus Rodriguez', - role: 'Platform Architect', - avatar: - 'https://images.unsplash.com/photo-1472099645785-5658abf4ff4e?w=100&h=100&fit=crop&crop=face', - }, - { - content: - "STRUCT's flexibility is unmatched. We use it for everything from microservices to Terraform modules. The hook system allows us to integrate it perfectly into our CI/CD pipeline.", - author: 'Alex Thompson', - role: 'Lead Developer', - avatar: - 'https://images.unsplash.com/photo-1507003211169-0a1dd7228f2d?w=100&h=100&fit=crop&crop=face', - }, - ]; - - const testimonialsGrid = document.querySelector('#testimonials .testimonials-grid'); - if (testimonialsGrid) { - testimonialsGrid.innerHTML = testimonials.map(testimonial => ` -
-
${testimonial.content}
-
- ${testimonial.author} -
-
${testimonial.author}
-
${testimonial.role}
-
-
-
- `).join(''); - } - } - - /* ===== PROJECT SHOWCASE ===== */ - - initProjectShowcase() { - this.createProjectShowcase(); - this.setupShowcaseFilters(); - } - - createProjectShowcase() { - const projects = [ - { - title: 'Terraform AWS Modules', - description: 'Complete AWS infrastructure modules with best practices and security configurations', - tags: ['terraform', 'aws', 'infrastructure'], - icon: 'fas fa-cloud', - category: 'infrastructure', - github: 'https://github.com/example/terraform-aws-modules', - demo: 'https://example.com/demo' - }, - { - title: 'Python Microservice Template', - description: 'FastAPI-based microservice with Docker, testing, and CI/CD pipeline setup', - tags: ['python', 'fastapi', 'microservice', 'docker'], - icon: 'fab fa-python', - category: 'backend', - github: 'https://github.com/example/python-microservice', - demo: 'https://example.com/demo' - }, - { - title: 'React Component Library', - description: 'Reusable React components with Storybook, testing, and automated publishing', - tags: ['react', 'typescript', 'storybook'], - icon: 'fab fa-react', - category: 'frontend', - github: 'https://github.com/example/react-components', - demo: 'https://example.com/demo' - }, - { - title: 'DevOps Toolkit', - description: 'Complete DevOps setup with monitoring, logging, and deployment automation', - tags: ['devops', 'kubernetes', 'monitoring'], - icon: 'fas fa-tools', - category: 'devops', - github: 'https://github.com/example/devops-toolkit', - demo: 'https://example.com/demo' - } - ]; - - const showcaseGrid = document.querySelector('#project-showcase .showcase-grid'); - if (showcaseGrid) { - showcaseGrid.innerHTML = projects.map(project => ` -
-
- -
-
-

${project.title}

-

${project.description}

-
- ${project.tags.map(tag => `${tag}`).join('')} -
-
- - Code - - - Demo - -
-
-
- `).join(''); - } - } - - setupShowcaseFilters() { - const filters = ['all', 'infrastructure', 'backend', 'frontend', 'devops']; - const filtersContainer = document.querySelector('#project-showcase .showcase-filters'); - - if (filtersContainer) { - filtersContainer.innerHTML = filters.map(filter => ` - - `).join(''); - } - - document.addEventListener('click', (e) => { - if (e.target.matches('.showcase-filter')) { - const filter = e.target.dataset.filter; - this.filterShowcaseProjects(filter); - } - }); - } - - filterShowcaseProjects(filter) { - // Update active filter - document.querySelectorAll('.showcase-filter').forEach(btn => btn.classList.remove('active')); - document.querySelector(`[data-filter="${filter}"]`).classList.add('active'); - - // Filter projects - const projects = document.querySelectorAll('.showcase-project'); - projects.forEach(project => { - if (filter === 'all' || project.dataset.category === filter) { - project.style.display = 'block'; - project.style.animation = 'fadeIn 0.3s ease'; - } else { - project.style.display = 'none'; - } - }); - - this.currentShowcaseFilter = filter; - } - - /* ===== PERFORMANCE OPTIMIZATIONS ===== */ - - initPerformanceOptimizations() { - this.setupIntersectionObserver(); - this.setupImageLazyLoading(); - this.optimizeAnimations(); - } - - setupIntersectionObserver() { - const observerOptions = { - threshold: 0.1, - rootMargin: '50px 0px' - }; - - const observer = new IntersectionObserver((entries) => { - entries.forEach(entry => { - if (entry.isIntersecting) { - entry.target.classList.add('animate-in'); - observer.unobserve(entry.target); - } - }); - }, observerOptions); - - // Observe all cards and interactive elements - const elementsToObserve = document.querySelectorAll(` - .reference-card, - .community-card, - .testimonial, - .showcase-project, - .api-method - `); - - elementsToObserve.forEach(el => observer.observe(el)); - } - - setupImageLazyLoading() { - const images = document.querySelectorAll('img[data-src]'); - - const imageObserver = new IntersectionObserver((entries) => { - entries.forEach(entry => { - if (entry.isIntersecting) { - const img = entry.target; - img.src = img.dataset.src; - img.removeAttribute('data-src'); - imageObserver.unobserve(img); - } - }); - }); - - images.forEach(img => imageObserver.observe(img)); - } - - optimizeAnimations() { - // Reduce animations for users who prefer reduced motion - if (window.matchMedia('(prefers-reduced-motion: reduce)').matches) { - document.documentElement.style.setProperty('--animation-duration', '0.1s'); - } - } - - /* ===== UTILITY METHODS ===== */ - - copyToClipboard(text) { - if (navigator.clipboard) { - navigator.clipboard.writeText(text); - } else { - // Fallback for older browsers - const textArea = document.createElement('textarea'); - textArea.value = text; - document.body.appendChild(textArea); - textArea.select(); - document.execCommand('copy'); - document.body.removeChild(textArea); - } - } - - showToast(message, type = 'success') { - const toast = document.createElement('div'); - toast.className = `toast toast-${type}`; - toast.textContent = message; - - toast.style.cssText = ` - position: fixed; - top: 20px; - right: 20px; - background: var(--color-primary); - color: var(--color-bg-primary); - padding: 1rem 2rem; - border-radius: 8px; - z-index: 10000; - animation: slideInRight 0.3s ease; - `; - - document.body.appendChild(toast); - - setTimeout(() => { - toast.style.animation = 'slideOutRight 0.3s ease'; - setTimeout(() => { - document.body.removeChild(toast); - }, 300); - }, 3000); - } - - debounce(func, wait) { - let timeout; - return function executedFunction(...args) { - const later = () => { - clearTimeout(timeout); - func(...args); - }; - clearTimeout(timeout); - timeout = setTimeout(later, wait); - }; - } -} - -// Initialize Phase 3 features when DOM is loaded -document.addEventListener('DOMContentLoaded', () => { - window.structPhase3 = new StructPhase3(); -}); - -// Add CSS animations -const additionalCSS = ` - -`; - -document.head.insertAdjacentHTML('beforeend', additionalCSS); diff --git a/site/js/search.js b/site/js/search.js deleted file mode 100644 index 0ddd4ec..0000000 --- a/site/js/search.js +++ /dev/null @@ -1,520 +0,0 @@ -/* Advanced Search Functionality for Phase 3 */ - -class AdvancedSearch { - constructor() { - this.searchIndex = []; - this.searchInput = document.getElementById('search-input'); - this.searchResults = document.getElementById('search-results'); - this.isSearchVisible = false; - this.selectedIndex = -1; - - this.init(); - } - - init() { - this.buildSearchIndex(); - this.setupEventListeners(); - this.setupKeyboardShortcuts(); - } - - buildSearchIndex() { - // Index content from different sections - this.searchIndex = [ - // Commands - { - title: 'struct generate', - description: 'Generate project structure from YAML configuration', - category: 'Commands', - url: '#api-preview', - content: - 'generate project structure yaml configuration template variables', - }, - { - title: 'struct validate', - description: 'Validate YAML configuration syntax and structure', - category: 'Commands', - url: '#api-preview', - content: 'validate yaml configuration syntax structure check', - }, - { - title: 'struct list', - description: 'List available structure templates', - category: 'Commands', - url: '#api-preview', - content: 'list available structure templates browse', - }, - - // Configuration - { - title: 'files', - description: 'Define files to be created in your project', - category: 'Configuration', - url: '#quick-reference', - content: 'files configuration yaml content template create', - }, - { - title: 'folders', - description: 'Define folder structures and nested configurations', - category: 'Configuration', - url: '#quick-reference', - content: 'folders directory structure nested configuration', - }, - { - title: 'variables', - description: 'Define template variables for dynamic content', - category: 'Configuration', - url: '#quick-reference', - content: 'variables template dynamic content jinja2', - }, - - // Features - { - title: 'Template Variables', - description: 'Use Jinja2 syntax for dynamic content generation', - category: 'Features', - url: '#features', - content: 'template variables jinja2 dynamic content generation', - }, - { - title: 'Remote Content', - description: 'Fetch files from GitHub, HTTP/HTTPS, and cloud storage', - category: 'Features', - url: '#features', - content: 'remote content github http https cloud storage fetch', - }, - { - title: 'Dry Run Mode', - description: 'Preview changes before applying them to your project', - category: 'Features', - url: '#features', - content: 'dry run preview changes before applying project', - }, - - // Community - { - title: 'GitHub Repository', - description: 'Contribute to STRUCT development and report issues', - category: 'Community', - url: '#community', - content: 'github repository contribute development issues', - }, - { - title: 'Discussions', - description: 'Ask questions and share ideas with the community', - category: 'Community', - url: '#community', - content: 'discussions questions community ideas help', - }, - - // Getting Started - { - title: 'Installation', - description: 'Install STRUCT using pip, Docker, or from source', - category: 'Getting Started', - url: '#installation', - content: 'installation install pip docker source setup', - }, - { - title: 'Quick Start', - description: 'Get started with STRUCT in minutes using our wizard', - category: 'Getting Started', - url: '#wizard', - content: 'quick start wizard getting started minutes tutorial', - }, - ]; - } - - setupEventListeners() { - if (!this.searchInput || !this.searchResults) return; - - // Search input events - this.searchInput.addEventListener( - 'input', - this.debounce(this.handleSearch.bind(this), 300) - ); - this.searchInput.addEventListener('focus', () => { - if (this.searchInput.value.trim()) { - this.showSearchResults(); - } - }); - this.searchInput.addEventListener('blur', () => { - // Delay hiding to allow clicking on results - setTimeout(() => this.hideSearchResults(), 150); - }); - - // Navigation with arrow keys - this.searchInput.addEventListener( - 'keydown', - this.handleKeyNavigation.bind(this) - ); - - // Close search when clicking outside - document.addEventListener('click', (e) => { - if (!e.target.closest('.search-container')) { - this.hideSearchResults(); - } - }); - } - - setupKeyboardShortcuts() { - document.addEventListener('keydown', (e) => { - // Ctrl+K or Cmd+K to focus search - if ((e.ctrlKey || e.metaKey) && e.key === 'k') { - e.preventDefault(); - this.focusSearch(); - } - - // Escape to close search - if (e.key === 'Escape' && this.isSearchVisible) { - this.hideSearchResults(); - this.searchInput.blur(); - } - }); - } - - handleSearch(e) { - const query = e.target.value.trim().toLowerCase(); - - if (query.length < 2) { - this.hideSearchResults(); - return; - } - - const results = this.searchIndex - .filter((item) => { - const searchText = - `${item.title} ${item.description} ${item.content}`.toLowerCase(); - return searchText.includes(query); - }) - .slice(0, 8); // Limit to 8 results - - this.displaySearchResults(results, query); - } - - displaySearchResults(results, query) { - if (results.length === 0) { - this.searchResults.innerHTML = ` -
- -

No results found for "${query}"

- Try different keywords or check our documentation -
- `; - } else { - this.searchResults.innerHTML = results - .map( - (result, index) => ` -
-
${result.category}
-
${this.highlightMatch( - result.title, - query - )}
-
${this.highlightMatch( - result.description, - query - )}
-
- ` - ) - .join(''); - - // Add click handlers - this.searchResults - .querySelectorAll('.search-result-item') - .forEach((item) => { - item.addEventListener('click', () => { - this.navigateToResult(item.dataset.url); - }); - }); - } - - this.showSearchResults(); - } - - highlightMatch(text, query) { - const regex = new RegExp(`(${query})`, 'gi'); - return text.replace(regex, '$1'); - } - - handleKeyNavigation(e) { - if (!this.isSearchVisible) return; - - const results = this.searchResults.querySelectorAll('.search-result-item'); - - switch (e.key) { - case 'ArrowDown': - e.preventDefault(); - this.selectedIndex = Math.min( - this.selectedIndex + 1, - results.length - 1 - ); - this.updateSelection(); - break; - - case 'ArrowUp': - e.preventDefault(); - this.selectedIndex = Math.max(this.selectedIndex - 1, -1); - this.updateSelection(); - break; - - case 'Enter': - e.preventDefault(); - if (this.selectedIndex >= 0 && results[this.selectedIndex]) { - this.navigateToResult(results[this.selectedIndex].dataset.url); - } - break; - } - } - - updateSelection() { - const results = this.searchResults.querySelectorAll('.search-result-item'); - results.forEach((item, index) => { - item.classList.toggle('selected', index === this.selectedIndex); - }); - } - - navigateToResult(url) { - this.hideSearchResults(); - this.searchInput.blur(); - - // Navigate to the URL - if (url.startsWith('#')) { - const element = document.querySelector(url); - if (element) { - element.scrollIntoView({ behavior: 'smooth' }); - - // Add highlight effect - element.style.outline = '2px solid var(--color-primary)'; - element.style.outlineOffset = '4px'; - setTimeout(() => { - element.style.outline = ''; - element.style.outlineOffset = ''; - }, 2000); - } - } else { - window.open(url, '_blank', 'noopener,noreferrer'); - } - } - - focusSearch() { - if (this.searchInput) { - this.searchInput.focus(); - this.searchInput.select(); - } - } - - showSearchResults() { - if (this.searchResults) { - this.searchResults.classList.remove('hidden'); - this.isSearchVisible = true; - this.selectedIndex = -1; - } - } - - hideSearchResults() { - if (this.searchResults) { - this.searchResults.classList.add('hidden'); - this.isSearchVisible = false; - this.selectedIndex = -1; - } - } - - debounce(func, wait) { - let timeout; - return function executedFunction(...args) { - const later = () => { - clearTimeout(timeout); - func(...args); - }; - clearTimeout(timeout); - timeout = setTimeout(later, wait); - }; - } -} - -// Enhanced search styles -const searchStyles = ` - -`; - -// Initialize advanced search when DOM is loaded -document.addEventListener('DOMContentLoaded', () => { - // Add search styles - document.head.insertAdjacentHTML('beforeend', searchStyles); - - // Initialize search - window.advancedSearch = new AdvancedSearch(); -}); diff --git a/site/js/theme.js b/site/js/theme.js deleted file mode 100644 index 1467b7a..0000000 --- a/site/js/theme.js +++ /dev/null @@ -1,405 +0,0 @@ -/* Phase 3: Advanced Theme System */ - -class ThemeManager { - constructor() { - this.currentTheme = 'dark'; - this.themes = { - dark: { - name: 'Dark', - properties: { - '--color-primary': '#00ff88', - '--color-primary-dark': '#00cc6a', - '--color-primary-light': '#33ff9f', - '--color-secondary': '#0066ff', - '--color-secondary-dark': '#0052cc', - '--color-secondary-light': '#3385ff', - '--color-accent': '#ff6600', - '--color-accent-dark': '#cc5200', - '--color-accent-light': '#ff8533', - '--color-bg-primary': '#0a0a0a', - '--color-bg-secondary': '#1a1a1a', - '--color-bg-tertiary': '#2a2a2a', - '--color-text-primary': '#ffffff', - '--color-text-secondary': '#b0b0b0', - '--color-text-tertiary': '#808080', - '--color-border': '#333333', - '--color-border-light': '#444444', - '--color-success': '#00ff88', - '--color-warning': '#ffaa00', - '--color-error': '#ff4444', - '--color-info': '#0066ff', - }, - }, - light: { - name: 'Light', - properties: { - '--color-primary': '#00aa5e', - '--color-primary-dark': '#008a4d', - '--color-primary-light': '#00cc6f', - '--color-secondary': '#0052cc', - '--color-secondary-dark': '#0042a3', - '--color-secondary-light': '#1a66d9', - '--color-accent': '#cc4400', - '--color-accent-dark': '#a33600', - '--color-accent-light': '#e55500', - '--color-bg-primary': '#ffffff', - '--color-bg-secondary': '#f8f9fa', - '--color-bg-tertiary': '#e9ecef', - '--color-text-primary': '#212529', - '--color-text-secondary': '#6c757d', - '--color-text-tertiary': '#adb5bd', - '--color-border': '#dee2e6', - '--color-border-light': '#e9ecef', - '--color-success': '#28a745', - '--color-warning': '#ffc107', - '--color-error': '#dc3545', - '--color-info': '#17a2b8', - }, - }, - auto: { - name: 'Auto', - properties: {}, // Will be set based on system preference - }, - }; - - this.init(); - } - - init() { - this.loadThemePreference(); - this.setupThemeToggle(); - this.setupSystemThemeDetection(); - this.applyTheme(this.currentTheme); - } - - loadThemePreference() { - const saved = localStorage.getItem('struct-theme'); - if (saved && this.themes[saved]) { - this.currentTheme = saved; - } else { - // Default to auto theme - this.currentTheme = 'auto'; - } - } - - setupThemeToggle() { - // Create theme toggle button - const themeToggle = document.createElement('button'); - themeToggle.className = 'theme-toggle'; - themeToggle.innerHTML = ''; - themeToggle.setAttribute('aria-label', 'Toggle theme'); - themeToggle.setAttribute('title', 'Toggle theme (T)'); - - // Add to navigation - const navbar = document.querySelector('.navbar-content'); - if (navbar) { - navbar.appendChild(themeToggle); - } - - // Toggle functionality - themeToggle.addEventListener('click', () => { - this.cycleTheme(); - }); - - // Keyboard shortcut (T) - document.addEventListener('keydown', (e) => { - if (e.key === 't' || e.key === 'T') { - if (!e.target.matches('input, textarea')) { - e.preventDefault(); - this.cycleTheme(); - } - } - }); - } - - setupSystemThemeDetection() { - // Listen for system theme changes - if (window.matchMedia) { - const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)'); - mediaQuery.addListener(() => { - if (this.currentTheme === 'auto') { - this.applyAutoTheme(); - } - }); - } - } - - cycleTheme() { - const themeOrder = ['dark', 'light', 'auto']; - const currentIndex = themeOrder.indexOf(this.currentTheme); - const nextIndex = (currentIndex + 1) % themeOrder.length; - const nextTheme = themeOrder[nextIndex]; - - this.setTheme(nextTheme); - } - - setTheme(themeName) { - if (!this.themes[themeName]) return; - - this.currentTheme = themeName; - this.applyTheme(themeName); - this.saveThemePreference(); - this.updateThemeToggle(); - this.announceThemeChange(themeName); - - // Track theme change - if (window.structAnalytics) { - window.structAnalytics.trackFeatureUsage('theme_change', { - theme: themeName, - }); - } - } - - applyTheme(themeName) { - const root = document.documentElement; - - if (themeName === 'auto') { - this.applyAutoTheme(); - } else { - const theme = this.themes[themeName]; - Object.entries(theme.properties).forEach(([property, value]) => { - root.style.setProperty(property, value); - }); - } - - // Update body class for theme-specific styles - document.body.className = document.body.className.replace(/theme-\w+/g, ''); - document.body.classList.add(`theme-${themeName}`); - - // Update meta theme-color - this.updateMetaThemeColor(); - } - - applyAutoTheme() { - const prefersDark = - window.matchMedia && - window.matchMedia('(prefers-color-scheme: dark)').matches; - const autoTheme = prefersDark ? 'dark' : 'light'; - - const theme = this.themes[autoTheme]; - const root = document.documentElement; - - Object.entries(theme.properties).forEach(([property, value]) => { - root.style.setProperty(property, value); - }); - - document.body.className = document.body.className.replace(/theme-\w+/g, ''); - document.body.classList.add(`theme-auto-${autoTheme}`); - } - - updateThemeToggle() { - const toggle = document.querySelector('.theme-toggle'); - if (!toggle) return; - - const icons = { - dark: '', - light: '', - auto: '', - }; - - const titles = { - dark: 'Switch to light theme', - light: 'Switch to auto theme', - auto: 'Switch to dark theme', - }; - - toggle.innerHTML = icons[this.currentTheme] || icons.dark; - toggle.setAttribute('title', titles[this.currentTheme] || titles.dark); - } - - updateMetaThemeColor() { - const themeColorMeta = document.querySelector('meta[name="theme-color"]'); - if (themeColorMeta) { - const bgColor = getComputedStyle(document.documentElement) - .getPropertyValue('--color-bg-primary') - .trim(); - themeColorMeta.setAttribute('content', bgColor); - } - } - - saveThemePreference() { - localStorage.setItem('struct-theme', this.currentTheme); - } - - announceThemeChange(themeName) { - // Create accessible announcement - const announcement = document.createElement('div'); - announcement.setAttribute('aria-live', 'polite'); - announcement.setAttribute('aria-atomic', 'true'); - announcement.className = 'sr-only'; - announcement.textContent = `Theme changed to ${this.themes[themeName].name}`; - - document.body.appendChild(announcement); - - setTimeout(() => { - document.body.removeChild(announcement); - }, 1000); - } - - // Public API - getCurrentTheme() { - return this.currentTheme; - } - - getAvailableThemes() { - return Object.keys(this.themes); - } - - // Custom theme creation - createCustomTheme(name, properties) { - this.themes[name] = { - name: name.charAt(0).toUpperCase() + name.slice(1), - properties: { ...properties }, - }; - } -} - -// Theme toggle styles -const themeStyles = ` - -`; - -// Initialize theme manager -document.addEventListener('DOMContentLoaded', () => { - // Add theme styles - document.head.insertAdjacentHTML('beforeend', themeStyles); - - // Initialize theme manager - window.themeManager = new ThemeManager(); -}); diff --git a/site/known-issues/index.html b/site/known-issues/index.html new file mode 100644 index 0000000..9608062 --- /dev/null +++ b/site/known-issues/index.html @@ -0,0 +1,2373 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Known Issues - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Known Issues

+

This page tracks known issues, limitations, and workarounds for STRUCT. If you encounter any of these issues, check here for potential solutions.

+

Current Known Issues

+

Performance Issues

+

Large Directory Structures

+

Issue: Generation becomes slow with very large directory structures (1000+ files).

+

Workaround:

+
    +
  • Break large structures into smaller, modular components
    • +
  • Use the --dry-run option to preview before full generation
    • +
  • Consider using parallel processing for independent structures
    • +
+

Status: Under investigation

+

Remote File Fetching

+

Issue: Fetching many remote files can be slow due to sequential processing.

+

Workaround:

+
    +
  • Cache frequently used remote files locally
    • +
  • Use local mirrors when possible
    • +
  • Batch remote operations when feasible
    • +
+

Status: Planned for future release

+

Template Engine

+

Complex Jinja2 Expressions

+

Issue: Very complex Jinja2 expressions may not render correctly in all contexts.

+

Example:

+
# May not work as expected
+content: "{{@ complex | filter | another_filter if condition else fallback @}}"
+
+

Workaround: Break complex expressions into simpler parts or use variables:

+
variables:
+  - intermediate_value:
+      default: "{{@ complex | filter @}}"
+
+files:
+  - test.txt:
+      content: "{{@ intermediate_value | another_filter @}}"
+
+

Status: Investigating improvements

+

Unicode in File Names

+

Issue: File names with unicode characters may cause issues on some filesystems.

+

Workaround: Use ASCII-safe file names or test thoroughly on target systems.

+

Status: Platform-specific limitation

+

Platform-Specific Issues

+

Windows Path Handling

+

Issue: Long path names on Windows may exceed the 260-character limit.

+

Workaround:

+
    +
  • Use shorter path names
    • +
  • Enable long path support in Windows 10/11
    • +
  • Use mapped drives for shorter paths
    • +
+

Status: Windows limitation

+

macOS Case Sensitivity

+

Issue: macOS filesystem case-insensitivity can cause conflicts with similarly named files.

+

Workaround: Ensure file names differ by more than just case.

+

Status: Platform limitation

+

GitHub Integration

+

Rate Limiting

+

Issue: GitHub API rate limits may affect custom filters like latest_release.

+

Workaround:

+
    +
  • Set GITHUB_TOKEN environment variable for higher limits
    • +
  • Cache results when possible
    • +
  • Implement retry logic in scripts
    • +
+

Status: API limitation

+

Private Repository Access

+

Issue: Accessing private repositories requires proper authentication.

+

Workaround: Ensure GITHUB_TOKEN has appropriate permissions.

+

Status: Expected behavior

+

Docker Issues

+

File Permissions

+

Issue: Files created in Docker containers may have incorrect ownership.

+

Workaround: Use the -u $(id -u):$(id -g) option when running Docker:

+
docker run -v $(pwd):/workdir -u $(id -u):$(id -g) ghcr.io/httpdss/struct:main generate file://config.yaml .
+
+

Status: Docker behavior

+

Volume Mounting

+

Issue: Complex volume mounting scenarios may not work as expected.

+

Workaround: Use simpler mounting patterns and absolute paths.

+

Status: Docker limitation

+

Limitations

+

Template Variables

+

Variable Scope

+

Limitation: Variables defined in nested structures don't propagate back to parent structures.

+

Design Decision: This is intentional to maintain structure isolation.

+

Circular References

+

Limitation: Circular references in variable definitions are not detected.

+

Example:

+
variables:
+  - var_a:
+      default: "{{@ var_b @}}"
+  - var_b:
+      default: "{{@ var_a @}}"
+
+

Impact: May cause infinite loops or unexpected behavior.

+

File Operations

+

Atomic Operations

+

Limitation: File operations are not atomic - partial failures may leave the system in an inconsistent state.

+

Mitigation: Use the --backup option for important operations.

+ +

Limitation: Symbolic links are not explicitly handled and may be followed or replaced.

+

Impact: May affect complex directory structures with symlinks.

+

Configuration

+

YAML Complexity

+

Limitation: Very large YAML files (>10MB) may cause performance issues.

+

Recommendation: Split large configurations into multiple files.

+

Schema Validation

+

Limitation: Schema validation doesn't catch all runtime errors.

+

Note: Use struct validate and testing for comprehensive validation.

+

Workarounds and Best Practices

+

Performance Optimization

+
    +
  1. Use --dry-run for testing large configurations
    2. +
  2. Modularize structures instead of creating monolithic ones
    3. +
  3. Cache remote content locally when possible
    4. +
  4. Use specific structure paths instead of recursive searches
    5. +
+

Error Prevention

+
    +
  1. Validate configurations before deployment
    2. +
  2. Test with small datasets first
    3. +
  3. Use version control for all configuration files
    4. +
  4. Implement backup strategies for important operations
    5. +
+

Cross-Platform Compatibility

+
    +
  1. Test on target platforms before deployment
    2. +
  2. Use relative paths when possible
    3. +
  3. Avoid platform-specific commands in hooks
    4. +
  4. Document platform requirements clearly
    5. +
+

Reporting Issues

+

Before Reporting

+
    +
  1. Check this known issues page
    2. +
  2. Search existing GitHub issues
    3. +
  3. Test with the latest version
    4. +
  4. Prepare a minimal reproduction case
    5. +
+

Issue Report Template

+
**STRUCT Version**: [e.g., 1.2.3]
+**Platform**: [e.g., Ubuntu 20.04, macOS 12.0, Windows 11]
+**Python Version**: [e.g., 3.9.7]
+
+**Expected Behavior**:
+[Describe what you expected to happen]
+
+**Actual Behavior**:
+[Describe what actually happened]
+
+**Reproduction Steps**:
+1. [Step 1]
+2. [Step 2]
+3. [Step 3]
+
+**Configuration File**:
+
+```yaml
+[Paste minimal configuration that reproduces the issue]
+
+

Error Output:

+
[Paste any error messages or logs]
+
+

Additional Context:

+

[Any other relevant information]

+

```text

+

Priority Guidelines

+
    +
  • Critical: Security issues, data loss, system crashes
    • +
  • High: Major functionality broken, widespread impact
    • +
  • Medium: Minor functionality issues, workarounds available
    • +
  • Low: Enhancement requests, documentation issues
    • +
+

Contributing Fixes

+

We welcome contributions to fix known issues:

+
    +
  1. Fork the repository
    2. +
  2. Create a feature branch: git checkout -b fix/issue-name
    3. +
  3. Write tests for your fix
    4. +
  4. Update documentation if necessary
    5. +
  5. Submit a pull request
    6. +
+

Testing Requirements

+
    +
  • All existing tests must pass
    • +
  • New tests should cover the fixed functionality
    • +
  • Manual testing on multiple platforms when applicable
    • +
+

Version Compatibility

+

Supported Versions

+
    +
  • Latest release: Full support and active development
    • +
  • Previous minor version: Security fixes and critical bugs
    • +
  • Older versions: Community support only
    • +
+

Upgrade Recommendations

+
    +
  • Test upgrades in non-production environments first
    • +
  • Review changelog for breaking changes
    • +
  • Update configurations for deprecated features
    • +
+
+

This page is updated regularly. Subscribe to repository notifications for updates on issue status.

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/manifest.json b/site/manifest.json deleted file mode 100644 index ce7945b..0000000 --- a/site/manifest.json +++ /dev/null @@ -1,110 +0,0 @@ -{ - "name": "STRUCT - Automated Project Structure Generator", - "short_name": "STRUCT", - "description": "Powerful, flexible tool for automating project structure creation through YAML configurations", - "start_url": "/", - "display": "standalone", - "background_color": "#0a0a0a", - "theme_color": "#00ff88", - "orientation": "portrait-primary", - "lang": "en", - "scope": "/", - "categories": ["developer", "productivity", "utilities"], - "icons": [ - { - "src": "/struct/images/favicon.svg", - "sizes": "any", - "type": "image/svg+xml", - "purpose": "any maskable" - }, - { - "src": "/struct//images/icon-192.png", - "sizes": "192x192", - "type": "image/png", - "purpose": "any" - }, - { - "src": "/struct/images/icon-512.png", - "sizes": "512x512", - "type": "image/png", - "purpose": "any" - }, - { - "src": "/struct/images/icon-maskable-192.png", - "sizes": "192x192", - "type": "image/png", - "purpose": "maskable" - }, - { - "src": "/struct/images/icon-maskable-512.png", - "sizes": "512x512", - "type": "image/png", - "purpose": "maskable" - } - ], - "shortcuts": [ - { - "name": "GitHub Repository", - "short_name": "GitHub", - "description": "View STRUCT on GitHub", - "url": "https://github.com/httpdss/struct", - "icons": [ - { - "src": "/struct/images/github-icon.png", - "sizes": "96x96" - } - ] - }, - { - "name": "Documentation", - "short_name": "Docs", - "description": "Read STRUCT documentation", - "url": "https://httpdss.github.io/struct/docs", - "icons": [ - { - "src": "/struct/images/docs-icon.png", - "sizes": "96x96" - } - ] - }, - { - "name": "Quick Start", - "short_name": "Start", - "description": "Quick start guide", - "url": "https://httpdss.github.io/struct/docs/quickstart", - "icons": [ - { - "src": "/struct/images/quickstart-icon.png", - "sizes": "96x96" - } - ] - } - ], - "screenshots": [ - { - "src": "/struct/demos/basic-usage.gif", - "sizes": "800x450", - "type": "image/gif", - "label": "Basic usage demonstration" - }, - { - "src": "/struct/demos/yaml-config.gif", - "sizes": "800x450", - "type": "image/gif", - "label": "YAML configuration creation" - } - ], - "related_applications": [ - { - "platform": "web", - "url": "https://github.com/httpdss/struct" - } - ], - "prefer_related_applications": false, - "edge_side_panel": { - "preferred_width": 400 - }, - "launch_handler": { - "client_mode": "focus-existing" - } -} diff --git a/site/mappings/index.html b/site/mappings/index.html new file mode 100644 index 0000000..fee0172 --- /dev/null +++ b/site/mappings/index.html @@ -0,0 +1,1894 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Mappings - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Mappings Support

+

You can provide a mappings YAML file to inject key-value maps into your templates. This is useful for referencing environment-specific values, IDs, or any other mapping you want to use in your generated files.

+

What are Mappings?

+

Mappings are external data files that provide structured key-value pairs for use in your STRUCT templates. They allow you to:

+
    +
  • Separate data from templates
    • +
  • Share common values across multiple structures
    • +
  • Manage environment-specific configurations
    • +
  • Centralize reference data like account IDs, team names, or service endpoints
    • +
+

Mappings File Format

+

Basic Structure

+
mappings:
+  teams:
+    devops: devops-team
+    frontend: frontend-team
+    backend: backend-team
+
+  aws_account_ids:
+    development: 123456789012
+    staging: 234567890123
+    production: 345678901234
+
+  service_endpoints:
+    api_gateway: https://api.example.com
+    database: postgres://db.example.com:5432
+    redis: redis://cache.example.com:6379
+
+

Nested Mappings

+
mappings:
+  environments:
+    development:
+      database_url: postgres://dev-db:5432/myapp
+      redis_url: redis://dev-cache:6379
+      debug: true
+
+    production:
+      database_url: postgres://prod-db:5432/myapp
+      redis_url: redis://prod-cache:6379
+      debug: false
+
+  regions:
+    us_east_1:
+      vpc_id: vpc-12345
+      subnet_ids:
+        - subnet-abc123
+        - subnet-def456
+
+    eu_west_1:
+      vpc_id: vpc-67890
+      subnet_ids:
+        - subnet-ghi789
+        - subnet-jkl012
+
+

Using Mappings in Templates

+

Basic Usage

+

Reference mapping values using the mappings variable:

+
files:
+  - config.yml:
+      content: |
+        database_url: {{@ mappings.service_endpoints.database @}}
+        api_endpoint: {{@ mappings.service_endpoints.api_gateway @}}
+
+        # Team information
+        owner: {{@ mappings.teams.backend @}}
+
+

Array Access

+

For nested structures and arrays:

+
files:
+  - terraform/main.tf:
+      content: |
+        resource "aws_instance" "web" {
+          ami           = "ami-12345"
+          instance_type = "t3.micro"
+
+          vpc_security_group_ids = [
+            "{{@ mappings.regions.us_east_1.vpc_id @}}"
+          ]
+
+          subnet_id = "{{@ mappings.regions.us_east_1.subnet_ids[0] @}}"
+        }
+
+

Dynamic Key Access

+

Use bracket notation for dynamic keys:

+
files:
+  - app.py:
+      content: |
+        import os
+
+        ENVIRONMENT = "{{@ environment @}}"
+        DATABASE_URL = "{{@ mappings.environments[environment].database_url @}}"
+        DEBUG = {{@ mappings.environments[environment].debug @}}
+
+variables:
+  - environment:
+      description: "Target environment"
+      type: string
+      default: "development"
+
+

Using Mappings in the with Clause

+

You can assign values from mappings directly in the with clause for folder struct calls:

+
folders:
+  - ./infrastructure:
+      struct: terraform/aws-vpc
+      with:
+        vpc_id: {{@ mappings.regions.us_east_1.vpc_id @}}
+        subnet_ids: {{@ mappings.regions.us_east_1.subnet_ids @}}
+
+  - ./backend:
+      struct: project/django
+      with:
+        team: {{@ mappings.teams.backend @}}
+        database_url: {{@ mappings.environments.production.database_url @}}
+
+

This approach allows you to pass specific mapping values as variables to nested structures.

+

Command Line Usage

+

Use the --mappings-file argument with the generate command:

+
# Both commands work identically - file:// is automatically added for .yaml files
+struct generate --mappings-file ./mymap.yaml my-struct.yaml .
+struct generate --mappings-file ./mymap.yaml file://my-struct.yaml .
+
+

Multiple Mappings Files

+

You can specify multiple mappings files that will be merged in order:

+
struct generate \
+  --mappings-file ./common-mappings.yaml \
+  --mappings-file ./env-specific-mappings.yaml \
+  my-struct.yaml .
+
+

Merging behavior:

+
    +
  • Files are processed in the order specified
    • +
  • Later files override earlier ones for conflicting keys
    • +
  • Deep merging is performed for nested dictionaries
    • +
  • This enables clean separation of common vs environment-specific configuration
    • +
+

Example with environment variable:

+
struct generate \
+  --mappings-file ./mappings/common.yaml \
+  --mappings-file ./mappings/${ENVIRONMENT}.yaml \
+  infrastructure.yaml \
+  ./output
+
+

Practical Examples

+

Multi-Environment Deployment

+

mappings.yaml:

+
mappings:
+  environments:
+    dev:
+      namespace: myapp-dev
+      replicas: 1
+      image_tag: latest
+      resources:
+        cpu: 100m
+        memory: 128Mi
+
+    prod:
+      namespace: myapp-prod
+      replicas: 3
+      image_tag: v1.2.3
+      resources:
+        cpu: 500m
+        memory: 512Mi
+
+

k8s-deployment.yaml template:

+
files:
+  - k8s/deployment.yaml:
+      content: |
+        apiVersion: apps/v1
+        kind: Deployment
+        metadata:
+          name: {{@ app_name @}}
+          namespace: {{@ mappings.environments[target_env].namespace @}}
+        spec:
+          replicas: {{@ mappings.environments[target_env].replicas @}}
+          template:
+            spec:
+              containers:
+              - name: app
+                image: myapp:{{@ mappings.environments[target_env].image_tag @}}
+                resources:
+                  requests:
+                    cpu: {{@ mappings.environments[target_env].resources.cpu @}}
+                    memory: {{@ mappings.environments[target_env].resources.memory @}}
+
+variables:
+  - target_env:
+      description: "Target environment (dev/prod)"
+      type: string
+      default: "dev"
+  - app_name:
+      description: "Application name"
+      type: string
+
+

Team-Specific Configurations

+

teams.yaml:

+
mappings:
+  teams:
+    platform:
+      email: platform@company.com
+      slack: "#platform-team"
+      oncall: platform-oncall@company.com
+
+    data:
+      email: data@company.com
+      slack: "#data-team"
+      oncall: data-oncall@company.com
+
+

Usage:

+
folders:
+  - ./services/api:
+      struct: service/rest-api
+      with:
+        team_email: {{@ mappings.teams.platform.email @}}
+        team_slack: {{@ mappings.teams.platform.slack @}}
+
+  - ./services/etl:
+      struct: service/data-pipeline
+      with:
+        team_email: {{@ mappings.teams.data.email @}}
+        team_slack: {{@ mappings.teams.data.slack @}}
+
+

Best Practices

+
    +
  1. +

    Organize by Context: Group related mappings together (e.g., environments, teams, regions)

    +
    2. +
  2. +

    Use Consistent Naming: Follow naming conventions across all mapping files

    +
    3. +
  3. +

    Version Control: Keep mappings files in version control alongside your structures

    +
    4. +
  4. +

    Validate Data: Ensure mapping values are correct before generating structures

    +
    5. +
  5. +

    Document Mappings: Include comments or separate documentation for complex mappings

    +
    6. +
  6. +

    Environment Separation: Use separate mapping files for different environments

    +
    7. +
  7. +

    Default Values: Provide sensible defaults in your templates for missing mappings

    +
    8. +
+

Error Handling

+

If a mapping key doesn't exist, STRUCT will show an error:

+
files:
+  - config.yml:
+      content: |
+        # This will cause an error if 'nonexistent' key doesn't exist
+        value: {{@ mappings.nonexistent.key @}}
+
+

Use the default filter to provide fallbacks:

+
files:
+  - config.yml:
+      content: |
+        # This provides a fallback value
+        value: {{@ mappings.team.devops | default "no_team" @}}
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/mcp-integration/index.html b/site/mcp-integration/index.html new file mode 100644 index 0000000..e734847 --- /dev/null +++ b/site/mcp-integration/index.html @@ -0,0 +1,1893 @@ + + + + + + + + + + + + + + + + + + + + + + + MCP (Model Context Protocol) Integration - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

MCP (Model Context Protocol) Integration

+

The struct tool now supports MCP (Model Context Protocol) integration, providing a programmable interface to interact with structure definitions. This enables automation and integration with other tools, particularly AI-assisted development workflows.

+

Available MCP Tools

+

1. list_structures

+

Lists all available structure definitions.

+
{
+  "name": "list_structures",
+  "arguments": {
+    "structures_path": "/path/to/custom/structures"  // optional
+  }
+}
+
+

Parameters: +- structures_path (optional): Custom path to structure definitions

+

2. get_structure_info

+

Get detailed information about a specific structure.

+
{
+  "name": "get_structure_info",
+  "arguments": {
+    "structure_name": "project/python",
+    "structures_path": "/path/to/custom/structures"  // optional
+  }
+}
+
+

Parameters: +- structure_name (required): Name of the structure to get info about +- structures_path (optional): Custom path to structure definitions

+

3. generate_structure

+

Generate a project structure using specified definition and options.

+
{
+  "name": "generate_structure",
+  "arguments": {
+    "structure_definition": "project/python",
+    "base_path": "/tmp/myproject",
+    "output": "console",  // "console" or "files"
+    "dry_run": false,
+    "mappings": {
+      "project_name": "MyProject",
+      "author": "John Doe"
+    },
+    "structures_path": "/path/to/custom/structures"  // optional
+  }
+}
+
+

Parameters: +- structure_definition (required): Name or path to the structure definition +- base_path (required): Base path where the structure should be generated +- output (optional): Output mode - "console" for stdout or "files" for actual generation (default: "files") +- dry_run (optional): Perform a dry run without creating actual files (default: false) +- mappings (optional): Variable mappings for template substitution +- structures_path (optional): Custom path to structure definitions

+

4. validate_structure

+

Validate a structure configuration YAML file.

+
{
+  "name": "validate_structure",
+  "arguments": {
+    "yaml_file": "/path/to/structure.yaml"
+  }
+}
+
+

Parameters: +- yaml_file (required): Path to the YAML configuration file to validate

+

Usage

+

Starting the MCP Server

+

To start the MCP server for stdio communication:

+
struct mcp --server
+
+

Command Line Integration

+

The existing list and info commands now support an optional --mcp flag:

+
# List structures with MCP support
+struct list --mcp
+
+# Get structure info with MCP support
+struct info project/python --mcp
+
+

MCP Client Integration

+

Claude Desktop Integration

+

Add the following to your Claude Desktop configuration file:

+

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json +Windows: %APPDATA%\Claude\claude_desktop_config.json +Linux: ~/.config/claude/claude_desktop_config.json

+
{
+  "mcpServers": {
+    "struct": {
+      "command": "struct",
+      "args": ["mcp", "--server"],
+      "cwd": "/path/to/your/project"
+    }
+  }
+}
+
+

Cline/Continue Integration

+

For Cline (VS Code extension), add to your .cline_mcp_settings.json:

+
{
+  "mcpServers": {
+    "struct": {
+      "command": "struct",
+      "args": ["mcp", "--server"]
+    }
+  }
+}
+
+

Custom MCP Client Integration

+

For any MCP-compatible client, use these connection parameters:

+
// Node.js example
+import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+
+const transport = new StdioClientTransport({
+  command: 'struct',
+  args: ['mcp', '--server']
+});
+
+const client = new Client(
+  {
+    name: "struct-client",
+    version: "1.0.0"
+  },
+  {
+    capabilities: {}
+  }
+);
+
+await client.connect(transport);
+
+
# Python example
+import asyncio
+from mcp import ClientSession, StdioServerParameters
+from mcp.client.stdio import stdio_client
+
+async def main():
+    server_params = StdioServerParameters(
+        command="struct",
+        args=["mcp", "--server"]
+    )
+
+    async with stdio_client(server_params) as (read, write):
+        async with ClientSession(read, write) as session:
+            await session.initialize()
+
+            # List available tools
+            tools = await session.list_tools()
+            print(f"Available tools: {[tool.name for tool in tools.tools]}")
+
+            # Call a tool
+            result = await session.call_tool("list_structures", {})
+            print(result.content[0].text)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+

AI-Assisted Development Workflows

+

The MCP integration is particularly powerful for AI-assisted development workflows:

+

Console Output Mode

+

Using output: "console" with generate_structure allows piping structure content to stdout for subsequent AI prompts:

+
# Generate structure content to console for AI review
+struct mcp --server | ai-tool "Review this project structure"
+
+

Chaining Operations

+

The MCP tools can be chained together for complex workflows:

+
    +
  1. List available structures
    2. +
  2. Get detailed info about a specific structure
    3. +
  3. Generate the structure with custom mappings
    4. +
  4. Validate any custom configurations
    5. +
+

Integration Examples

+

Example 1: Generate and Review +

// 1. Generate structure to console
+{
+  "name": "generate_structure",
+  "arguments": {
+    "structure_definition": "project/python",
+    "base_path": "/tmp/review",
+    "output": "console"
+  }
+}
+
+// 2. Use output as context for AI code review
+

+

Example 2: Custom Structure Validation +

// 1. Validate custom structure
+{
+  "name": "validate_structure",
+  "arguments": {
+    "yaml_file": "/path/to/custom-structure.yaml"
+  }
+}
+
+// 2. If valid, generate using the custom structure
+{
+  "name": "generate_structure",
+  "arguments": {
+    "structure_definition": "file:///path/to/custom-structure.yaml",
+    "base_path": "/tmp/project"
+  }
+}
+

+

Configuration

+

Environment Variables

+

The MCP server respects the same environment variables as the regular struct tool: +- STRUCT_STRUCTURES_PATH: Default path for structure definitions +- Any mapping variables used in templates

+

Client Configuration Examples

+

1. Basic Configuration

+
{
+  "command": "struct",
+  "args": ["mcp", "--server"]
+}
+
+

2. With Custom Structures Path

+
{
+  "command": "struct",
+  "args": ["mcp", "--server"],
+  "env": {
+    "STRUCT_STRUCTURES_PATH": "/path/to/custom/structures"
+  }
+}
+
+

3. With Python Virtual Environment

+
{
+  "command": "/path/to/venv/bin/python",
+  "args": ["-m", "struct_module.main", "mcp", "--server"],
+  "cwd": "/path/to/struct/project"
+}
+
+

4. Using Shell Script Wrapper

+

Create a shell script struct-mcp.sh: +

#!/bin/bash
+cd /path/to/your/project
+source .venv/bin/activate
+struct mcp --server
+

+

Then configure your MCP client: +

{
+  "command": "/path/to/struct-mcp.sh",
+  "args": []
+}
+

+

Quick Start Guide

+

Step 1: Install struct with MCP support

+
pip install struct[mcp]  # or pip install struct && pip install mcp
+
+

Step 2: Test MCP server

+
# Test that MCP server starts correctly
+struct mcp --server
+# Should show: Starting MCP server...
+# Press Ctrl+C to stop
+
+

Step 3: Configure your MCP client

+

Add the configuration to your MCP client (see examples above).

+

Step 4: Start using MCP tools

+

Once connected, you can use these tools: +- list_structures - Get all available structures +- get_structure_info - Get details about a specific structure +- generate_structure - Generate project structures +- validate_structure - Validate YAML configuration files

+

Troubleshooting

+

Common Issues

+
    +
  1. "Command not found: struct"
    2. +
  2. Solution: Ensure struct is installed and in your PATH
    3. +
  3. +

    Alternative: Use full path to Python executable

    +
    4. +
  4. +

    MCP server won't start

    +
    5. +
  5. Check if mcp package is installed: pip show mcp
    6. +
  6. +

    Try running with verbose logging: struct mcp --server --log DEBUG

    +
    7. +
  7. +

    Client can't connect

    +
    8. +
  8. Verify the command and args in your client configuration
    9. +
  9. Test MCP server manually first
    10. +
  10. +

    Check working directory and environment variables

    +
    11. +
  11. +

    Structures not found

    +
    12. +
  12. Set STRUCT_STRUCTURES_PATH environment variable
    13. +
  13. Use absolute paths in configuration
    14. +
  14. Verify structure files exist and are readable
    15. +
+

Debug Mode

+
# Run with debug logging
+STRUCT_LOG_LEVEL=DEBUG struct mcp --server
+
+

Benefits

+
    +
  1. Automation: Programmatic access to all struct tool functionality
    2. +
  2. Integration: Easy integration with other development tools
    3. +
  3. AI Workflows: Enhanced support for AI-assisted development processes
    4. +
  4. Consistency: Same underlying logic as CLI commands
    5. +
  5. Flexibility: Support for custom paths, mappings, and output modes
    6. +
+

Backward Compatibility

+

All existing struct tool functionality remains unchanged. The MCP integration is additive and does not affect existing workflows or commands.

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/quickstart/index.html b/site/quickstart/index.html new file mode 100644 index 0000000..209889e --- /dev/null +++ b/site/quickstart/index.html @@ -0,0 +1,1447 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Quick Start - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Quick Start

+

Quick Start Using Docker

+
    +
  1. Create a YAML configuration file for your project structure. See sample configuration here.
    2. +
  2. Run the following command to generate the project structure:
    3. +
+
docker run \
+  -v $(pwd):/workdir \
+  -u $(id -u):$(id -g) \
+  ghcr.io/httpdss/struct:main generate \
+  file:///workdir/example/structure.yaml \
+  /workdir/example_output
+
+

Quick Start Using Docker Alpine

+
docker run \
+  -v $(pwd):/workdir \
+  -u $(id -u):$(id -g) \
+  ghcr.io/httpdss/struct:alpine generate \
+  file:///workdir/example/structure.yaml \
+  /workdir/example_output
+
+

For testing, you can run an alpine Docker container and install the script inside it:

+
docker run -it --entrypoint="" python:3.10-alpine sh -l
+
+

Inside the container:

+
apk add python-pip git vim
+pip install git+https://github.com/httpdss/struct.git
+mkdir example
+cd example/
+touch structure.yaml
+vim structure.yaml # copy the content from the example folder
+struct generate structure.yaml .
+
+
+

Note: The file:// protocol is automatically added for .yaml files, so structure.yaml and file://structure.yaml work identically.

+
+

Discovering Available Structures

+

Before generating, see what structures are available:

+
struct list
+
+

This shows all built-in structures you can use.

+
+

Auto-Completion

+

If you've enabled auto-completion, you can press Tab after struct generate to see all available structures!

+
+

First Example

+

After installing STRUCT, try this simple example:

+
struct generate terraform/modules/generic ./my-terraform-module
+
+

This will create a new terraform module structure in the ./my-terraform-module directory.

+

Or try a simple project structure:

+
struct generate project/nodejs ./my-node-app
+
+

Next Steps

+ + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/robots.txt b/site/robots.txt deleted file mode 100644 index 7ce1dd3..0000000 --- a/site/robots.txt +++ /dev/null @@ -1,18 +0,0 @@ -User-agent: * -Allow: / - -Sitemap: https://httpdss.github.io/struct/sitemap.xml - -# Disallow crawling of demo source files -Disallow: /demos/*.tape -Disallow: /docs/vhs/ - -# Allow all other content -Allow: /css/ -Allow: /js/ -Allow: /images/ -Allow: /demos/*.gif -Allow: /demos/*.mp4 - -# Crawl delay (optional, remove if not needed) -Crawl-delay: 1 diff --git a/site/schema/index.html b/site/schema/index.html new file mode 100644 index 0000000..4d0f8d0 --- /dev/null +++ b/site/schema/index.html @@ -0,0 +1,1996 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Schema Reference - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

YAML Schema Reference

+

STRUCT provides JSON schema validation to ensure your YAML configuration files are correctly structured. This helps catch errors early and provides IDE support with autocompletion.

+

Schema Location

+

The official schema is available at:

+
https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json
+
+

IDE Configuration

+

VS Code

+
    +
  1. Install the YAML extension
    2. +
  2. Add this to your workspace settings (.vscode/settings.json):
    3. +
+
{
+  "yaml.schemas": {
+    "https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json": ".struct.yaml"
+  }
+}
+
+

This provides validation and autocompletion for all .struct.yaml files.

+

JetBrains IDEs (IntelliJ, PyCharm, etc.)

+
    +
  1. Go to Settings → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings
    2. +
  2. Click + to add a new mapping
    3. +
  3. Set Schema file or URL to: https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json
    4. +
  4. Set File path pattern to: *.struct.yaml
    5. +
+

Generating Custom Schema

+

If you have custom structures, generate a schema that includes them:

+
# Generate schema with custom structures
+struct generate-schema -s /path/to/custom/structures -o my-schema.json
+
+# Use in VS Code settings
+{
+  "yaml.schemas": {
+    "./my-schema.json": ".struct.yaml"
+  }
+}
+
+

Schema Structure

+

The schema validates the following top-level properties:

+

files (array)

+

Defines files to be created:

+
files:
+  - filename.txt:
+      content: "File contents"
+      permissions: "0644"
+      skip: false
+      skip_if_exists: false
+      file: "https://example.com/template.txt"
+
+

Properties:

+
    +
  • content (string): Inline file content
    • +
  • permissions (string): Octal permissions (e.g., "0755")
    • +
  • skip (boolean): Skip file creation
    • +
  • skip_if_exists (boolean): Skip if file exists
    • +
  • file (string): External file URL or path
    • +
+

folders (array)

+

Defines folders and nested structures:

+
folders:
+  - path/to/folder:
+      struct: "structure-name"
+      with:
+        variable: "value"
+
+

Properties:

+
    +
  • struct (string|array): Structure name(s) to apply
    • +
  • with (object): Variables to pass to the structure
    • +
+

variables (array)

+

Defines template variables:

+
variables:
+  - variable_name:
+      description: "Variable description"
+      type: "string"
+      default: "default_value"
+
+

Properties:

+
    +
  • description (string): Human-readable description
    • +
  • type (string): Variable type (string, integer, boolean)
    • +
  • default (any): Default value
    • +
+

pre_hooks (array)

+

Shell commands to run before generation:

+
pre_hooks:
+  - "echo 'Starting generation...'"
+  - "./scripts/prepare.sh"
+
+

post_hooks (array)

+

Shell commands to run after generation:

+
post_hooks:
+  - "npm install"
+  - "git init"
+
+

Validation

+

Command Line Validation

+
# Validate a configuration file
+struct validate my-config.yaml
+
+

Programmatic Validation

+
import json
+import yaml
+from jsonschema import validate
+
+# Load schema
+with open('struct-schema.json') as f:
+    schema = json.load(f)
+
+# Load and validate config
+with open('my-config.yaml') as f:
+    config = yaml.safe_load(f)
+
+validate(config, schema)  # Raises exception if invalid
+
+

Common Validation Errors

+

Invalid File Structure

+
# ❌ Wrong - files should be array of objects
+files:
+  README.md: "content"
+
+# ✅ Correct
+files:
+  - README.md:
+      content: "content"
+
+

Missing Required Properties

+
# ❌ Wrong - struct property missing
+folders:
+  - src/:
+      with:
+        name: "myapp"
+
+# ✅ Correct
+folders:
+  - src/:
+      struct: "project/node"
+      with:
+        name: "myapp"
+
+

Invalid Variable Types

+
# ❌ Wrong - type should be string
+variables:
+  - port:
+      type: number
+      default: 8080
+
+# ✅ Correct
+variables:
+  - port:
+      type: integer
+      default: 8080
+
+

Schema Extensions

+

You can extend the base schema for custom validation:

+
{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "allOf": [
+    {
+      "$ref": "https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json"
+    },
+    {
+      "properties": {
+        "custom_section": {
+          "type": "object",
+          "properties": {
+            "custom_property": {"type": "string"}
+          }
+        }
+      }
+    }
+  ]
+}
+
+

IDE Benefits

+

With schema validation enabled, you get:

+
    +
  • Real-time validation: Errors highlighted as you type
    • +
  • Autocompletion: Suggested properties and values
    • +
  • Documentation: Hover tooltips with property descriptions
    • +
  • Structure guidance: Valid structure names and paths
    • +
+

Troubleshooting

+

Schema Not Loading

+
    +
  1. Check internet connection (for remote schema)
    2. +
  2. Verify file path (for local schema)
    3. +
  3. Restart IDE after configuration changes
    4. +
  4. Check IDE logs for error messages
    5. +
+

Validation Errors

+
    +
  1. Use struct validate command for detailed error messages
    2. +
  2. Check schema documentation for required properties
    3. +
  3. Verify YAML syntax is correct
    4. +
  4. Ensure structure names exist in your installation
    5. +
+

Performance Issues

+
    +
  1. Use local schema files for better performance
    2. +
  2. Consider schema caching in your IDE
    3. +
  3. Limit schema complexity for large configurations
    4. +
+

This schema system ensures your STRUCT configurations are valid and provides a better development experience through IDE integration.

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/search/search_index.json b/site/search/search_index.json new file mode 100644 index 0000000..4579f69 --- /dev/null +++ b/site/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"STRUCT Documentation","text":"

Welcome to the comprehensive documentation for STRUCT - the Automated Project Structure Generator.

"},{"location":"#documentation-sections","title":"\ud83d\udcda Documentation Sections","text":""},{"location":"#getting-started","title":"Getting Started","text":"
  • Installation Guide - How to install STRUCT
  • Quick Start - Get up and running quickly
  • Basic Usage - Core functionality and commands
"},{"location":"#configuration","title":"Configuration","text":"
  • YAML Configuration - Complete configuration reference
  • Template Variables - Working with dynamic content
  • File Handling - Managing files and permissions
"},{"location":"#advanced-features","title":"Advanced Features","text":"
  • Custom Structures - Creating your own templates
  • Hooks - Pre and post-generation automation
  • Mappings - Using external data mappings
  • GitHub Integration - Automation with GitHub Actions
  • MCP Integration - Model Context Protocol for AI-assisted workflows
"},{"location":"#development","title":"Development","text":"
  • Development Setup - Contributing to STRUCT
  • Command-Line Completion - Auto-completion setup
"},{"location":"#reference","title":"Reference","text":"
  • CLI Reference - Complete command documentation
  • Schema Reference - YAML validation and IDE support
  • Examples - Practical examples and use cases
"},{"location":"#external-resources","title":"\ud83d\udd17 External Resources","text":"
  • GitHub Repository
  • Articles and Tutorials
  • Known Issues
"},{"location":"#community","title":"\ud83e\udd1d Community","text":"
  • Contributing Guidelines
  • License
  • Funding
"},{"location":"articles/","title":"Articles and Resources","text":"

Collection of articles, tutorials, and external resources about STRUCT.

"},{"location":"articles/#official-articles","title":"Official Articles","text":""},{"location":"articles/#defining-user-prompts-on-struct-harnessing-gpt-41-for-scalable-project-scaffolding","title":"Defining User Prompts on STRUCT: Harnessing GPT-4.1 for Scalable Project Scaffolding","text":"

Learn how to leverage GPT-4.1 to create intelligent project scaffolding with STRUCT. This article covers advanced prompting techniques and AI-driven project generation.

Topics covered:

  • AI-powered template generation
  • Dynamic project structures
  • GPT-4.1 integration patterns
  • Scalable scaffolding strategies
"},{"location":"articles/#unlocking-developer-productivity-with-struct-the-ultimate-open-source-tool-for-automated-project-structures","title":"Unlocking Developer Productivity with STRUCT: The Ultimate Open-Source Tool for Automated Project Structures","text":"

A comprehensive overview of STRUCT's capabilities and how it can boost developer productivity through automation.

Topics covered:

  • Project structure automation
  • Developer workflow optimization
  • Open-source benefits
  • Real-world use cases
"},{"location":"articles/#automating-project-structures-with-struct-and-github-actions","title":"Automating Project Structures with STRUCT and GitHub Actions","text":"

Discover how to integrate STRUCT with GitHub Actions for automated project setup and maintenance across repositories.

Topics covered:

  • GitHub Actions integration
  • CI/CD automation
  • Repository management
  • Workflow triggers
"},{"location":"articles/#advanced-struct-tips-working-with-template-variables-and-jinja2-filters","title":"Advanced STRUCT Tips: Working with Template Variables and Jinja2 Filters","text":"

Deep dive into STRUCT's templating system, covering advanced variable usage and custom Jinja2 filters.

Topics covered:

  • Template variable patterns
  • Custom Jinja2 filters
  • Dynamic content generation
  • Advanced templating techniques
"},{"location":"articles/#community-articles","title":"Community Articles","text":"

Community contributions welcome! Submit a PR to add your STRUCT-related articles here.

"},{"location":"articles/#tutorials","title":"Tutorials","text":""},{"location":"articles/#video-tutorials","title":"Video Tutorials","text":"

Coming soon - video tutorials will be added as they become available.

"},{"location":"articles/#interactive-tutorials","title":"Interactive Tutorials","text":"
  • Getting Started Guide: Follow along with practical examples in the Quick Start documentation
  • Template Variables: Learn by example in the Template Variables guide
  • Advanced Configuration: Explore complex scenarios in YAML Configuration
"},{"location":"articles/#use-cases","title":"Use Cases","text":""},{"location":"articles/#devops-and-infrastructure","title":"DevOps and Infrastructure","text":"
  • Terraform Module Generation: Standardize infrastructure code
  • Kubernetes Manifests: Generate consistent deployment configurations
  • CI/CD Pipeline Templates: Automate pipeline creation
  • Configuration Management: Maintain consistent environments
"},{"location":"articles/#application-development","title":"Application Development","text":"
  • Microservice Scaffolding: Generate service boilerplate
  • API Project Templates: Standardize REST API structures
  • Frontend Framework Setup: Bootstrap React, Vue, or Angular projects
  • Database Schema Generation: Create consistent database structures
"},{"location":"articles/#documentation-and-compliance","title":"Documentation and Compliance","text":"
  • Project Documentation: Generate README templates and docs
  • Compliance Templates: Ensure regulatory requirements
  • Security Configurations: Apply security best practices
  • Audit Trail Generation: Create trackable project structures
"},{"location":"articles/#presentations-and-talks","title":"Presentations and Talks","text":"

Conference presentations and community talks about STRUCT will be listed here.

"},{"location":"articles/#research-and-academic-papers","title":"Research and Academic Papers","text":"

Academic research involving STRUCT or related concepts will be referenced here.

"},{"location":"articles/#external-tools-and-integrations","title":"External Tools and Integrations","text":""},{"location":"articles/#ide-extensions","title":"IDE Extensions","text":"
  • VS Code YAML Extension: Enhanced editing with schema validation
  • IntelliJ YAML Support: Schema-aware editing and completion
"},{"location":"articles/#cicd-integrations","title":"CI/CD Integrations","text":"
  • GitHub Actions: Pre-built actions for STRUCT workflows
  • GitLab CI: Integration examples and templates
  • Jenkins: Pipeline integration patterns
"},{"location":"articles/#complementary-tools","title":"Complementary Tools","text":"
  • Cookiecutter: Alternative project templating tool
  • Yeoman: JavaScript-focused scaffolding
  • Copilot: AI-powered code generation
"},{"location":"articles/#community-resources","title":"Community Resources","text":""},{"location":"articles/#forums-and-discussion","title":"Forums and Discussion","text":"
  • GitHub Discussions: Official community forum
  • Stack Overflow: Questions tagged with struct-tool
"},{"location":"articles/#code-examples","title":"Code Examples","text":"
  • GitHub Examples Repository: Community-contributed examples
  • Gist Collections: Snippets and configurations
  • Docker Hub: Pre-built images and examples
"},{"location":"articles/#learning-paths","title":"Learning Paths","text":""},{"location":"articles/#beginner-path","title":"Beginner Path","text":"
  1. Start with Installation
  2. Follow the Quick Start guide
  3. Explore Basic Usage
  4. Learn YAML Configuration basics
"},{"location":"articles/#intermediate-path","title":"Intermediate Path","text":"
  1. Master Template Variables
  2. Understand File Handling strategies
  3. Explore Custom Structures
  4. Learn Mappings for data separation
"},{"location":"articles/#advanced-path","title":"Advanced Path","text":"
  1. Implement Hooks for automation
  2. Set up GitHub Integration
  3. Contribute to Development
  4. Create complex multi-environment setups
"},{"location":"articles/#contributing-content","title":"Contributing Content","text":"

We welcome contributions to this resource collection! Here's how you can help:

"},{"location":"articles/#adding-articles","title":"Adding Articles","text":"
  1. Fork the repository
  2. Add your article to the appropriate section
  3. Include a brief description and key topics
  4. Submit a pull request
"},{"location":"articles/#suggesting-resources","title":"Suggesting Resources","text":"
  • Open an issue with the \"resource suggestion\" label
  • Include the resource link and description
  • Explain why it would be valuable to the community
"},{"location":"articles/#writing-tutorials","title":"Writing Tutorials","text":"
  • Create step-by-step guides with practical examples
  • Include code snippets and expected outputs
  • Test instructions thoroughly before submitting
"},{"location":"articles/#newsletter-and-updates","title":"Newsletter and Updates","text":"

Stay updated with the latest STRUCT developments:

  • GitHub Releases: Watch the repository for release notifications
  • Community Updates: Follow project maintainers on social media
  • Blog Subscriptions: Subscribe to the official blog for updates

This page is regularly updated with new content. Bookmark it for future reference!

"},{"location":"cli-reference/","title":"CLI Reference","text":"

This document provides a reference for the struct command-line interface (CLI).

"},{"location":"cli-reference/#overview","title":"Overview","text":"

The struct CLI allows you to generate project structures from YAML configuration files. It supports both built-in structure definitions and custom structures.

Basic Usage:

struct {info,validate,generate,list,generate-schema} ...\n
"},{"location":"cli-reference/#global-options","title":"Global Options","text":"

These options are available for all commands:

  • -h, --help: Show the help message and exit.
  • -l LOG, --log LOG: Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL).
  • -c CONFIG_FILE, --config-file CONFIG_FILE: Path to a configuration file.
  • -i LOG_FILE, --log-file LOG_FILE: Path to a log file.
"},{"location":"cli-reference/#commands","title":"Commands","text":""},{"location":"cli-reference/#info","title":"info","text":"

Show information about a structure definition.

Usage:

struct info [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH] structure_definition\n

Arguments:

  • structure_definition: Name of the structure definition.
  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
"},{"location":"cli-reference/#validate","title":"validate","text":"

Validate the YAML configuration file.

Usage:

struct validate [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] yaml_file\n

Arguments:

  • yaml_file: Path to the YAML configuration file.
"},{"location":"cli-reference/#generate","title":"generate","text":"

Generate the project structure.

Usage:

struct generate [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH] [-n INPUT_STORE] [-d] [-v VARS] [-b BACKUP] [-f {overwrite,skip,append,rename,backup}] [-p GLOBAL_SYSTEM_PROMPT] [--non-interactive] [--mappings-file MAPPINGS_FILE] [-o {console,file}] structure_definition base_path\n

Arguments:

  • structure_definition: Path to the YAML configuration file.
  • base_path: Base path where the structure will be created.
  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
  • -n INPUT_STORE, --input-store INPUT_STORE: Path to the input store.
  • -d, --dry-run: Perform a dry run without creating any files or directories.
  • -v VARS, --vars VARS: Template variables in the format KEY1=value1,KEY2=value2.
  • -b BACKUP, --backup BACKUP: Path to the backup folder.
  • -f {overwrite,skip,append,rename,backup}, --file-strategy {overwrite,skip,append,rename,backup}: Strategy for handling existing files.
  • -p GLOBAL_SYSTEM_PROMPT, --global-system-prompt GLOBAL_SYSTEM_PROMPT: Global system prompt for OpenAI.
  • --non-interactive: Run the command in non-interactive mode.
  • --mappings-file MAPPINGS_FILE: Path to a YAML file containing mappings to be used in templates (can be specified multiple times).
  • -o {console,file}, --output {console,file}: Output mode.
"},{"location":"cli-reference/#list","title":"list","text":"

List available structures.

Usage:

struct list [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH]\n

Arguments:

  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
"},{"location":"cli-reference/#generate-schema","title":"generate-schema","text":"

Generate JSON schema for available structures.

Usage:

struct generate-schema [-h] [-l LOG] [-c CONFIG_FILE] [-i LOG_FILE] [-s STRUCTURES_PATH] [-o OUTPUT]\n

Arguments:

  • -s STRUCTURES_PATH, --structures-path STRUCTURES_PATH: Path to structure definitions.
  • -o OUTPUT, --output OUTPUT: Output file path for the schema (default: stdout).
"},{"location":"cli-reference/#examples","title":"Examples","text":""},{"location":"cli-reference/#basic-structure-generation","title":"Basic Structure Generation","text":"

Generate a structure using a built-in definition:

struct generate python-basic ./my-project\n

Generate from a custom YAML file:

struct generate file://my-structure.yaml ./output-dir\n
"},{"location":"cli-reference/#using-custom-structures","title":"Using Custom Structures","text":"

Generate with custom structure path:

struct generate -s ~/custom-structures python-api ./my-api\n
"},{"location":"cli-reference/#template-variables","title":"Template Variables","text":"

Pass template variables to the structure:

struct generate -v \"project_name=MyApp,author=John Doe\" file://structure.yaml ./output\n
"},{"location":"cli-reference/#dry-run","title":"Dry Run","text":"

Test structure generation without creating files:

struct generate -d file://structure.yaml ./output\n
"},{"location":"cli-reference/#file-strategies","title":"File Strategies","text":"

Handle existing files with different strategies:

# Skip existing files\nstruct generate -f skip file://structure.yaml ./output\n\n# Backup existing files\nstruct generate -f backup -b ./backup file://structure.yaml ./output\n
"},{"location":"cli-reference/#console-output","title":"Console Output","text":"

Output to console instead of creating files:

struct generate -o console file://structure.yaml ./output\n
"},{"location":"cli-reference/#validation","title":"Validation","text":"

Validate a YAML configuration before generation:

struct validate my-structure.yaml\n
"},{"location":"cli-reference/#list-available-structures","title":"List Available Structures","text":"

List all built-in structures:

struct list\n

List structures from custom path:

struct list -s ~/custom-structures\n
"},{"location":"cli-reference/#get-structure-information","title":"Get Structure Information","text":"

Get detailed information about a structure:

struct info python-basic\n
"},{"location":"cli-reference/#generate-schema_1","title":"Generate Schema","text":"

Generate JSON schema and save to file:

struct generate-schema -o schema.json\n
"},{"location":"completion/","title":"Command-Line Auto-Completion","text":"

STRUCT provides intelligent auto-completion for commands, options, and structure names using argcomplete. This makes discovering and using available structures much faster and more user-friendly.

New Feature: Structure Name Completion

STRUCT now automatically completes structure names when using struct generate, showing all 47+ available structures from both built-in and custom paths!

"},{"location":"completion/#quick-setup","title":"Quick Setup","text":"

For most users, this simple setup will enable full completion:

# Install (if not already installed)\npip install argcomplete\n\n# Enable completion for current session\neval \"$(register-python-argcomplete struct)\"\n\n# Make permanent - add to your ~/.zshrc or ~/.bashrc\necho 'eval \"$(register-python-argcomplete struct)\"' >> ~/.zshrc\n
"},{"location":"completion/#detailed-installation","title":"Detailed Installation","text":""},{"location":"completion/#1-install-argcomplete","title":"1. Install argcomplete","text":"
pip install argcomplete\n
"},{"location":"completion/#2-enable-global-completion-optional","title":"2. Enable Global Completion (Optional)","text":"

This step is optional but can be done once per system:

activate-global-python-argcomplete\n

This command sets up global completion for all Python scripts that use argcomplete.

"},{"location":"completion/#3-register-the-script","title":"3. Register the Script","text":"

Add the following line to your shell's configuration file:

For Bash (.bashrc or .bash_profile):

eval \"$(register-python-argcomplete struct)\"\n

For Zsh (.zshrc):

eval \"$(register-python-argcomplete struct)\"\n

For Fish (.config/fish/config.fish):

register-python-argcomplete --shell fish struct | source\n
"},{"location":"completion/#4-reload-your-shell","title":"4. Reload Your Shell","text":"
# For Bash\nsource ~/.bashrc\n\n# For Zsh\nsource ~/.zshrc\n\n# For Fish\nsource ~/.config/fish/config.fish\n
"},{"location":"completion/#usage","title":"Usage","text":"

After completing the setup, you can use auto-completion by typing part of a command and pressing Tab:

"},{"location":"completion/#command-completion","title":"Command Completion","text":"
struct <Tab>\n# Shows: generate, generate-schema, validate, info, list\n
"},{"location":"completion/#structure-name-completion","title":"Structure Name Completion \u2728","text":"
# Complete structure names - shows all available structures!\nstruct generate <Tab>\n# Shows: ansible-playbook, docker-files, github/workflows/codeql, project/nodejs, etc.\n\n# Partial completion works too\nstruct generate git<Tab>\n# Shows: git-hooks, github/workflows/codeql, github/templates, etc.\n\n# Works with nested structures\nstruct generate github/<Tab>\n# Shows: github/workflows/codeql, github/templates, github/prompts/generic, etc.\n
"},{"location":"completion/#custom-structure-paths","title":"Custom Structure Paths","text":"
# Completion works with custom structure paths\nstruct generate --structures-path /custom/path <Tab>\n# Shows structures from both custom path and built-in structures\n
"},{"location":"completion/#option-completion","title":"Option Completion","text":"
struct generate --<Tab>\n# Shows: --log, --dry-run, --backup, --file-strategy, --structures-path, etc.\n\nstruct generate --log <Tab>\n# Shows: DEBUG, INFO, WARNING, ERROR, CRITICAL\n
"},{"location":"completion/#advanced-configuration","title":"Advanced Configuration","text":""},{"location":"completion/#per-project-completion","title":"Per-Project Completion","text":"

If you only want completion for specific projects, you can add completion to your project's virtual environment activation script:

# In your .venv/bin/activate file, add:\neval \"$(register-python-argcomplete struct)\"\n
"},{"location":"completion/#custom-completion","title":"Custom Completion","text":"

You can create custom completion functions for specific use cases:

# Custom completion for structure names\n_struct_structures() {\n    local structures=$(struct list --names-only 2>/dev/null)\n    COMPREPLY=($(compgen -W \"$structures\" -- \"${COMP_WORDS[COMP_CWORD]}\"))\n}\n\n# Register custom completion\ncomplete -F _struct_structures struct-generate\n
"},{"location":"completion/#troubleshooting","title":"Troubleshooting","text":""},{"location":"completion/#completion-not-working","title":"Completion Not Working","text":"
  1. Check argcomplete installation:
python -c \"import argcomplete; print('OK')\"\n
  1. Verify global activation:
activate-global-python-argcomplete --user\n

  1. Check shell configuration: Make sure the eval statement is in the correct shell configuration file.

  2. Restart your shell: Sometimes you need to completely restart your terminal.

"},{"location":"completion/#slow-completion","title":"Slow Completion","text":"

If completion is slow, you can enable caching:

export ARGCOMPLETE_USE_TEMPFILES=1\n

Add this to your shell configuration file for persistent caching.

"},{"location":"completion/#debug-completion","title":"Debug Completion","text":"

Enable debug mode to troubleshoot completion issues:

export _ARGCOMPLETE_DEBUG=1\nstruct <Tab>\n
"},{"location":"completion/#platform-specific-notes","title":"Platform-Specific Notes","text":""},{"location":"completion/#macos","title":"macOS","text":"

On macOS, you might need to install bash-completion first:

# Using Homebrew\nbrew install bash-completion\n\n# Then add to ~/.bash_profile:\n[[ -r \"/usr/local/etc/profile.d/bash_completion.sh\" ]] && . \"/usr/local/etc/profile.d/bash_completion.sh\"\n
"},{"location":"completion/#windows","title":"Windows","text":"

For Windows users using Git Bash or WSL, follow the same steps as Linux. For PowerShell, argcomplete support is limited.

"},{"location":"completion/#docker","title":"Docker","text":"

When running STRUCT in Docker, completion won't work directly. However, you can create a wrapper script:

#!/bin/bash\n# struct-wrapper.sh\ndocker run --rm -v $(pwd):/workdir ghcr.io/httpdss/struct:main \"$@\"\n

Then set up completion for the wrapper:

eval \"$(register-python-argcomplete struct-wrapper.sh)\"\n
"},{"location":"completion/#benefits-of-auto-completion","title":"Benefits of Auto-Completion","text":"
  • Faster typing: Quickly complete command names and options
  • Discoverability: See available commands and options
  • Accuracy: Reduce typos and errors
  • Productivity: Spend less time looking up command syntax
"},{"location":"completion/#supported-completions","title":"Supported Completions","text":"

STRUCT provides intelligent completion for:

  • Commands: generate, validate, list, info, generate-schema
  • Options: --log, --dry-run, --backup, --file-strategy, --structures-path, etc.
  • Structure names: All 47+ available built-in and custom structures
  • Built-in structures: ansible-playbook, docker-files, helm-chart, etc.
  • Nested structures: github/workflows/codeql, project/nodejs, terraform/apps/generic, etc.
  • Custom structures: From --structures-path directories
  • File paths: Local files and directories
  • Enum values: Log levels (DEBUG, INFO, etc.), file strategies (overwrite, skip, etc.)
"},{"location":"completion/#how-structure-completion-works","title":"How Structure Completion Works","text":"

The structure name completion feature:

  1. Dynamically discovers all available structure files (.yaml files)
  2. Scans multiple locations:
  3. Built-in structures in struct_module/contribs/
  4. Custom structures from --structures-path if specified
  5. Returns clean names without .yaml extensions
  6. Supports nested directories like github/workflows/codeql
  7. Updates automatically when new structures are added
"},{"location":"completion/#example-session","title":"Example Session","text":"
# Command completion\n$ struct <Tab>\ngenerate        generate-schema info           list           validate\n\n# Structure name completion (NEW!)\n$ struct generate <Tab>\nansible-playbook     configs/codeowners    github/workflows/codeql  project/nodejs\nchef-cookbook        docker-files          helm-chart               terraform/apps/generic\nci-cd-pipelines      git-hooks            kubernetes-manifests      vagrant-files\n\n# Partial completion\n$ struct generate proj<Tab>\nproject/custom-structures  project/go      project/nodejs  project/ruby\nproject/generic           project/java    project/python  project/rust\n\n# Nested structure completion\n$ struct generate github/<Tab>\ngithub/chatmodes/plan       github/prompts/react-form    github/workflows/codeql\ngithub/instructions/generic github/prompts/security-api  github/workflows/labeler\ngithub/prompts/generic      github/workflows/pre-commit  github/workflows/stale\n\n# Option completion\n$ struct generate --<Tab>\n--backup        --dry-run       --file-strategy --log\n--log-file      --mappings-file --structures-path --vars\n\n# Enum value completion\n$ struct generate --log <Tab>\nDEBUG    ERROR    INFO     WARNING  CRITICAL\n\n$ struct generate --file-strategy <Tab>\nappend    backup    overwrite    rename    skip\n

This makes working with STRUCT much more efficient and user-friendly!

"},{"location":"configuration/","title":"YAML Configuration","text":""},{"location":"configuration/#configuration-properties","title":"Configuration Properties","text":"

When defining your project structure in the YAML configuration file, you can use various properties to control the behavior of the script. Here are the available properties:

  • skip: If set to true, the file or folder will be skipped and not created.
  • skip_if_exists: If set to true, the file or folder will be skipped if it already exists.
  • permissions: Set custom file permissions using a string representation of the octal value (e.g., '0777').
  • content: Define the content of the file directly in the YAML configuration.
  • file: Specify a local or remote file to include. Supported protocols include file://, http://, https://, github://, githubhttps://, githubssh://, s3://, and gs://.

Note: For local .yaml files, the file:// protocol is automatically added if not specified.

Example:

files:\n  - README.md:\n      skip: true\n      content: |\n        # {{@ project_name @}}\n        This is a template repository.\n  - script.sh:\n      skip_if_exists: true\n      permissions: '0777'\n      content: |\n        #!/bin/bash\n        echo \"Hello, {{@ author_name @}}!\"\n  - LICENSE:\n      file: https://raw.githubusercontent.com/nishanths/license/master/LICENSE\n  - remote_file.txt:\n      file: file:///path/to/local/file.txt\n  - github_file.py:\n      file: github://owner/repo/branch/path/to/file.py\n  - github_https_file.py:\n      file: githubhttps://owner/repo/branch/path/to/file.py\n  - github_ssh_file.py:\n      file: githubssh://owner/repo/branch/path/to/file.py\n  - s3_file.txt:\n      file: s3://bucket_name/key\n  - gcs_file.txt:\n      file: gs://bucket_name/key\n  - src/main.py:\n      content: |\n        print(\"Hello, World!\")\nfolders:\n  - .devops/modules/mod1:\n      struct: terraform/module\n  - .devops/modules/mod2:\n      struct: terraform/module\n      with:\n        module_name: mymod2\n  - ./:\n      struct:\n        - docker-files\n        - project/go\nvariables:\n  - project_name:\n      description: \"The name of the project\"\n      default: \"MyProject\"\n      type: string\n  - author_name:\n      description: \"The name of the author\"\n      type: string\n      default: \"John Doe\"\n

These properties allow you to customize the behavior and content of the files and folders generated by the script, providing flexibility and control over your project structure.

"},{"location":"configuration/#template-variables","title":"Template Variables","text":"

You can use template variables in your configuration file by enclosing them in {{@ and @}}. For example, {{@ project_name @}} will be replaced with the value of the project_name variable at runtime. If this are not set when running the script, it will prompt you to enter the value interactively.

If you need to define blocks you can use starting block notation {%@ and end block notation %@}.

To define comments you can use the comment start notation {#@ and end comment notation @#}.

"},{"location":"configuration/#default-template-variables","title":"Default template variables","text":"
  • file_name: The name of the file being processed.
  • file_directory: The name of the directory of file that is being processed.
"},{"location":"configuration/#interactive-template-variables","title":"Interactive template variables","text":"

If you don't provide a default value for a variable, the script will prompt you to enter the value interactively.

The struct defined should define the variable on a specific section of the YAML file. For example:

variables:\n  - author_name:\n      description: \"The name of the author\"\n      type: string\n      default: \"John Doe\"\n

as you can see, the author_name variable is defined on the variables section of the YAML file. it includes a description, type and default value which is used if the user doesn't provide a value interactively.

"},{"location":"configuration/#custom-jinja2-filters","title":"Custom Jinja2 filters","text":""},{"location":"configuration/#latest_release","title":"latest_release","text":"

This filter fetches the latest release version of a GitHub repository. It takes the repository name as an argument.

files:\n  - README.md:\n      content: |\n        # MyProject\n        Latest release: {{@ \"httpdss/struct\" | latest_release @}}\n

This uses PyGithub to fetch the latest release of the repository so setting the GITHUB_TOKEN environment variable will give you access to private repositories.

If there is an error in the process, the filter will return LATEST_RELEASE_ERROR.

NOTE: you can use this filter to get the latest release for a terraform provider. For example, to get the latest release of the aws provider, you can use {{@ \"hashicorp/terraform-provider-aws\" | latest_release @}} or datadog provider {{@ \"DataDog/terraform-provider-datadog\" | latest_release @}}.

"},{"location":"configuration/#slugify","title":"slugify","text":"

This filter converts a string into a slug. It takes an optional argument to specify the separator character (default is -).

files:\n  - README.md:\n      content: |\n        # {{@ project_name @}}\n        This is a template repository.\n        slugify project_name: {{@ project_name | slugify @}}\n
"},{"location":"configuration/#default_branch","title":"default_branch","text":"

This filter fetches the default branch name of a GitHub repository. It takes the repository name as an argument.

files:\n  - README.md:\n      content: |\n        # MyProject\n        Default branch: {{@ \"httpdss/struct\" | default_branch @}}\n
"},{"location":"contributing/","title":"Contributing to STRUCT","text":"

Thank you for your interest in contributing to STRUCT! We welcome contributions from the community and are pleased to have you join us.

"},{"location":"contributing/#quick-start","title":"\ud83d\ude80 Quick Start","text":"
  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a feature branch from main
  4. Make your changes and commit them
  5. Push to your fork and submit a pull request
"},{"location":"contributing/#development-setup","title":"\ud83d\udccb Development Setup","text":""},{"location":"contributing/#prerequisites","title":"Prerequisites","text":"
  • Python 3.8 or higher
  • Git
  • A text editor or IDE
"},{"location":"contributing/#local-development","title":"Local Development","text":"

Clone the repository:

git clone https://github.com/httpdss/struct.git\ncd struct\n

Create a virtual environment:

python -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\n

Install in development mode:

pip install -e .\npip install -r requirements.dev.txt\n

Run tests to ensure everything works:

pytest\n
"},{"location":"contributing/#making-changes","title":"\ud83d\udd27 Making Changes","text":""},{"location":"contributing/#code-style","title":"Code Style","text":"
  • Follow PEP 8 guidelines
  • Use 2 spaces for indentation in YAML files
  • Use 4 spaces for indentation in Python files
  • Write clear, descriptive commit messages
  • Add docstrings to new functions and classes
"},{"location":"contributing/#testing","title":"Testing","text":"
  • Write tests for new functionality
  • Ensure all existing tests pass
  • Run the test suite: pytest
  • Check test coverage: pytest --cov=struct_module
"},{"location":"contributing/#pull-request-guidelines","title":"Pull Request Guidelines","text":"
  1. Create descriptive PR titles that summarize the change
  2. Fill out the PR template completely
  3. Link to related issues when applicable
  4. Keep PRs focused - one feature/fix per PR
  5. Update documentation if your changes affect user-facing functionality
"},{"location":"contributing/#documentation","title":"\ud83d\udcdd Documentation","text":"

We use Markdown for documentation. When contributing:

  • Update relevant documentation files
  • Add examples for new features
  • Keep language clear and concise
  • Follow the existing documentation structure
"},{"location":"contributing/#documentation-structure","title":"Documentation Structure","text":"
docs/\n\u251c\u2500\u2500 index.md              # Main documentation index\n\u251c\u2500\u2500 installation.md       # Installation instructions\n\u251c\u2500\u2500 quickstart.md         # Quick start guide\n\u251c\u2500\u2500 configuration.md      # YAML configuration reference\n\u251c\u2500\u2500 template-variables.md # Template variable documentation\n\u251c\u2500\u2500 file-handling.md      # File handling features\n\u251c\u2500\u2500 custom-structures.md  # Creating custom structures\n\u251c\u2500\u2500 hooks.md              # Pre/post hooks\n\u251c\u2500\u2500 mappings.md           # External data mappings\n\u251c\u2500\u2500 github-integration.md # GitHub Actions integration\n\u251c\u2500\u2500 development.md        # Development setup\n\u251c\u2500\u2500 completion.md         # CLI completion setup\n\u251c\u2500\u2500 cli-reference.md      # Complete CLI reference\n\u251c\u2500\u2500 schema.md             # YAML schema reference\n\u251c\u2500\u2500 examples/             # Example configurations\n\u251c\u2500\u2500 articles.md           # External articles and tutorials\n\u251c\u2500\u2500 known-issues.md       # Known limitations\n\u251c\u2500\u2500 contributing.md       # This file\n\u2514\u2500\u2500 funding.md            # Funding information\n
"},{"location":"contributing/#contributing-new-structures","title":"\ud83c\udfd7\ufe0f Contributing New Structures","text":"

STRUCT includes a collection of contrib structures in struct_module/contribs/. To add a new structure:

  1. Create a new YAML file in the appropriate subdirectory
  2. Follow naming conventions: use lowercase with hyphens
  3. Test your structure with various scenarios
  4. Add documentation explaining what the structure does
  5. Include examples in your PR description
"},{"location":"contributing/#structure-guidelines","title":"Structure Guidelines","text":"
  • Use descriptive file and folder names
  • Include appropriate comments in YAML
  • Follow the established patterns in existing structures
  • Test with different variable combinations
  • Ensure compatibility across platforms
"},{"location":"contributing/#reporting-issues","title":"\ud83d\udc1b Reporting Issues","text":""},{"location":"contributing/#bug-reports","title":"Bug Reports","text":"

When reporting bugs, please include:

  • OS and Python version
  • STRUCT version (struct --version)
  • Complete error message or traceback
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Sample configuration that reproduces the issue
"},{"location":"contributing/#feature-requests","title":"Feature Requests","text":"

For feature requests:

  • Describe the use case clearly
  • Explain the benefit to other users
  • Provide examples of how it would work
  • Consider implementation complexity
"},{"location":"contributing/#project-structure","title":"\ud83d\udcca Project Structure","text":"
struct/\n\u251c\u2500\u2500 struct_module/           # Main Python package\n\u2502   \u251c\u2500\u2500 commands/           # CLI command implementations\n\u2502   \u251c\u2500\u2500 contribs/          # Contributed structure templates\n\u2502   \u251c\u2500\u2500 __init__.py\n\u2502   \u251c\u2500\u2500 main.py            # CLI entry point\n\u2502   \u251c\u2500\u2500 file_item.py       # File handling logic\n\u2502   \u251c\u2500\u2500 template_renderer.py # Jinja2 template rendering\n\u2502   \u251c\u2500\u2500 content_fetcher.py # Remote content fetching\n\u2502   \u251c\u2500\u2500 model_wrapper.py   # AI model integration\n\u2502   \u2514\u2500\u2500 utils.py           # Utility functions\n\u251c\u2500\u2500 tests/                  # Test suite\n\u251c\u2500\u2500 docs/                   # Documentation\n\u251c\u2500\u2500 examples/              # Example configurations\n\u251c\u2500\u2500 requirements.txt       # Production dependencies\n\u251c\u2500\u2500 requirements.dev.txt   # Development dependencies\n\u251c\u2500\u2500 setup.py              # Package configuration\n\u251c\u2500\u2500 struct-schema.json    # JSON schema for validation\n\u2514\u2500\u2500 README.md             # Project overview\n
"},{"location":"contributing/#issue-labels","title":"\ud83c\udff7\ufe0f Issue Labels","text":"

We use labels to categorize issues:

  • bug - Something isn't working
  • enhancement - New feature or request
  • documentation - Improvements to documentation
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed
  • question - Further information is requested
"},{"location":"contributing/#communication","title":"\ud83d\udcac Communication","text":"
  • GitHub Issues - Bug reports and feature requests
  • GitHub Discussions - General questions and community support
  • Pull Requests - Code contributions and reviews
"},{"location":"contributing/#recognition","title":"\ud83d\ude4f Recognition","text":"

All contributors will be recognized in our documentation and releases. We appreciate every contribution, whether it's:

  • Code improvements
  • Bug reports
  • Documentation updates
  • Feature suggestions
  • Community support
"},{"location":"contributing/#code-of-conduct","title":"\ud83d\udcdc Code of Conduct","text":"

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

"},{"location":"contributing/#getting-help","title":"\ud83e\udd1d Getting Help","text":"

If you need help contributing:

  1. Check existing documentation
  2. Search existing issues
  3. Create a new issue with the question label
  4. Join our GitHub Discussions

Thank you for contributing to STRUCT! \ud83c\udf89

"},{"location":"custom-structures/","title":"Creating Custom Structures","text":"

Let's say you are happy with the default structures that STRUCT provides, but you want to customize them for your specific needs. This is totally possible!

The best way to approach this is to have a repository where you can store your custom structures. You can then reference these structures in your .struct.yaml files.

"},{"location":"custom-structures/#suggested-repository-structure","title":"Suggested Repository Structure","text":"

Here is a suggested structure for your custom structures repository:

structures/\n\u251c\u2500\u2500 category1/\n\u2502   \u251c\u2500\u2500 structure1.yaml\n\u2502   \u2514\u2500\u2500 structure2.yaml\n\u251c\u2500\u2500 category2/\n\u2502   \u251c\u2500\u2500 structure1.yaml\n\u2502   \u2514\u2500\u2500 structure2.yaml\n

This way you could reference your custom structures in your .struct.yaml files like this:

folders:\n  - ./:\n    struct:\n      - category1/structure1\n      - category2/structure2\n    with:\n      var_in_structure1: 'value'\n

For this to work, you will need to set the path to the custom structures repository using the -s option when running STRUCT:

struct generate -s ~/path/to/custom-structures/structures file://.struct.yaml ./output\n
"},{"location":"development/","title":"Development Setup","text":"

This guide will help you set up a development environment for contributing to STRUCT.

"},{"location":"development/#prerequisites","title":"Prerequisites","text":"
  • Python 3.8 or higher
  • Git
  • Virtual environment tool (venv, virtualenv, or conda)
"},{"location":"development/#getting-started","title":"Getting Started","text":""},{"location":"development/#1-clone-the-repository","title":"1. Clone the Repository","text":"
git clone https://github.com/httpdss/struct.git\ncd struct\n
"},{"location":"development/#2-create-a-virtual-environment","title":"2. Create a Virtual Environment","text":"
python3 -m venv .venv\nsource .venv/bin/activate  # On Windows: .venv\\Scripts\\activate\n
"},{"location":"development/#3-install-dependencies","title":"3. Install Dependencies","text":"
# Install runtime dependencies\npip install -r requirements.txt\n\n# Install development dependencies\npip install -r requirements.dev.txt\n\n# Install the package in development mode\npip install -e .\n
"},{"location":"development/#4-verify-installation","title":"4. Verify Installation","text":"
struct --help\n
"},{"location":"development/#development-workflow","title":"Development Workflow","text":""},{"location":"development/#running-tests","title":"Running Tests","text":"
# Run all tests\npytest\n\n# Run tests with coverage\npytest --cov=struct_module\n\n# Run specific test file\npytest tests/test_specific.py\n
"},{"location":"development/#code-quality","title":"Code Quality","text":"

This project uses several tools to maintain code quality:

# Format code with black\nblack .\n\n# Sort imports\nisort .\n\n# Lint with flake8\nflake8 .\n\n# Type checking with mypy\nmypy struct_module/\n
"},{"location":"development/#pre-commit-hooks","title":"Pre-commit Hooks","text":"

Install pre-commit hooks to automatically run quality checks:

pre-commit install\n

This will run formatting, linting, and tests before each commit.

"},{"location":"development/#project-structure","title":"Project Structure","text":"
struct/\n\u251c\u2500\u2500 struct_module/          # Main Python package\n\u2502   \u251c\u2500\u2500 commands/          # CLI command implementations\n\u2502   \u251c\u2500\u2500 contribs/          # Built-in structure templates\n\u2502   \u2514\u2500\u2500 ...\n\u251c\u2500\u2500 tests/                 # Test files\n\u251c\u2500\u2500 docs/                  # Documentation\n\u251c\u2500\u2500 example/               # Example configurations\n\u251c\u2500\u2500 scripts/               # Utility scripts\n\u2514\u2500\u2500 requirements*.txt      # Dependencies\n
"},{"location":"development/#adding-new-features","title":"Adding New Features","text":""},{"location":"development/#1-create-a-new-command","title":"1. Create a New Command","text":"

Commands are defined in struct_module/commands/. Each command should:

  • Inherit from a base command class
  • Include proper argument parsing
  • Have comprehensive tests
  • Include documentation

Example:

# struct_module/commands/my_command.py\nfrom .base import BaseCommand\n\nclass MyCommand(BaseCommand):\n    def add_arguments(self, parser):\n        parser.add_argument('--option', help='My option')\n\n    def handle(self, args):\n        # Implementation here\n        pass\n
"},{"location":"development/#2-add-structure-templates","title":"2. Add Structure Templates","text":"

New structure templates go in struct_module/contribs/. Each template should:

  • Have a clear directory structure
  • Provide good documentation
  • Include example usage
"},{"location":"development/#3-write-tests","title":"3. Write Tests","text":"

All new functionality must include tests:

# tests/test_my_feature.py\nimport pytest\nfrom struct_module.my_feature import MyFeature\n\ndef test_my_feature():\n    feature = MyFeature()\n    result = feature.do_something()\n    assert result == expected_value\n
"},{"location":"development/#4-update-documentation","title":"4. Update Documentation","text":"
  • Add or update relevant documentation in docs/
  • Add examples if applicable
"},{"location":"development/#testing","title":"Testing","text":""},{"location":"development/#unit-tests","title":"Unit Tests","text":"

Run unit tests to verify individual components:

pytest tests/unit/\n
"},{"location":"development/#integration-tests","title":"Integration Tests","text":"

Run integration tests to verify end-to-end functionality:

pytest tests/integration/\n
"},{"location":"development/#debugging","title":"Debugging","text":""},{"location":"development/#enable-debug-logging","title":"Enable Debug Logging","text":"
struct --log=DEBUG generate my-config.yaml ./output\n
"},{"location":"development/#use-python-debugger","title":"Use Python Debugger","text":"

Add breakpoints in your code:

import pdb; pdb.set_trace()\n
struct --log=DEBUG generate my-config.yaml ./output\n
"},{"location":"development/#contributing-guidelines","title":"Contributing Guidelines","text":""},{"location":"development/#code-style","title":"Code Style","text":"
  • Follow PEP 8
  • Use type hints where appropriate
  • Write docstrings for public functions
  • Keep functions small and focused
"},{"location":"development/#commit-messages","title":"Commit Messages","text":"

Use conventional commit format:

feat: add new template variable filter\nfix: resolve issue with file permissions\ndocs: update installation guide\ntest: add tests for mappings functionality\n
"},{"location":"development/#pull-requests","title":"Pull Requests","text":"
  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Write tests
  5. Update documentation
  6. Submit a pull request
"},{"location":"development/#review-process","title":"Review Process","text":"

All pull requests must:

  • Pass all tests
  • Include appropriate documentation
  • Follow code style guidelines
  • Have a clear description of changes
"},{"location":"development/#troubleshooting","title":"Troubleshooting","text":""},{"location":"development/#common-issues","title":"Common Issues","text":"

Import errors: Make sure you've installed the package in development mode:

pip install -e .\n

Test failures: Ensure all dependencies are installed:

pip install -r requirements.dev.txt\n

Permission errors: Check file permissions and ensure you're in the right directory.

"},{"location":"development/#getting-help","title":"Getting Help","text":"
  • Check existing issues on GitHub
  • Join our Discord community
  • Read the documentation thoroughly
  • Ask questions in discussions
"},{"location":"development/#resources","title":"Resources","text":"
  • Python Development Guide
  • pytest Documentation
  • GitHub Flow
  • Conventional Commits
"},{"location":"file-handling/","title":"File Handling","text":"

STRUCT provides flexible options for handling files and managing permissions.

"},{"location":"file-handling/#file-properties","title":"File Properties","text":""},{"location":"file-handling/#basic-properties","title":"Basic Properties","text":"
  • skip: Skip file/folder creation entirely
  • skip_if_exists: Skip only if the file already exists
  • permissions: Set custom file permissions
  • content: Define file content inline
  • file: Reference external file content
"},{"location":"file-handling/#skip-behavior","title":"Skip Behavior","text":"
files:\n  - README.md:\n      skip: true  # Never create this file\n      content: \"This won't be created\"\n\n  - config.yml:\n      skip_if_exists: true  # Only create if it doesn't exist\n      content: \"default: value\"\n
"},{"location":"file-handling/#file-permissions","title":"File Permissions","text":"

Set custom permissions using octal notation:

files:\n  - scripts/deploy.sh:\n      permissions: '0755'  # Executable script\n      content: |\n        #!/bin/bash\n        echo \"Deploying...\"\n\n  - secrets/api.key:\n      permissions: '0600'  # Read-only for owner\n      content: \"{{@ api_key @}}\"\n
"},{"location":"file-handling/#content-sources","title":"Content Sources","text":""},{"location":"file-handling/#inline-content","title":"Inline Content","text":"

Define content directly in the YAML:

files:\n  - app.py:\n      content: |\n        #!/usr/bin/env python3\n        print(\"Hello, {{@ project_name @}}!\")\n
"},{"location":"file-handling/#external-files","title":"External Files","text":"

Reference local or remote files:

files:\n  - LICENSE:\n      file: https://raw.githubusercontent.com/nishanths/license/master/LICENSE\n
"},{"location":"file-handling/#remote-file-protocols","title":"Remote File Protocols","text":"

STRUCT supports multiple protocols for fetching remote content:

"},{"location":"file-handling/#httphttps","title":"HTTP/HTTPS","text":"
files:\n  - requirements.txt:\n      file: https://raw.githubusercontent.com/example/repo/main/requirements.txt\n
"},{"location":"file-handling/#github-protocols","title":"GitHub Protocols","text":""},{"location":"file-handling/#standard-github","title":"Standard GitHub","text":"
files:\n  - .gitignore:\n      file: github://github/gitignore/main/Python.gitignore\n
"},{"location":"file-handling/#github-https","title":"GitHub HTTPS","text":"
files:\n  - workflow.yml:\n      file: githubhttps://actions/starter-workflows/main/ci/python-app.yml\n
"},{"location":"file-handling/#github-ssh","title":"GitHub SSH","text":"
files:\n  - private-config.yml:\n      file: githubssh://company/private-repo/main/config/template.yml\n
"},{"location":"file-handling/#cloud-storage","title":"Cloud Storage","text":""},{"location":"file-handling/#amazon-s3","title":"Amazon S3","text":"
files:\n  - data.csv:\n      file: s3://my-bucket/data/template.csv\n
"},{"location":"file-handling/#google-cloud-storage","title":"Google Cloud Storage","text":"
files:\n  - config.json:\n      file: gs://my-bucket/configs/default.json\n
"},{"location":"file-handling/#file-handling-strategies","title":"File Handling Strategies","text":"

Control how STRUCT handles existing files with the --file-strategy option:

"},{"location":"file-handling/#available-strategies","title":"Available Strategies","text":"
  • overwrite: Replace existing files (default)
  • skip: Skip files that already exist
  • append: Add content to existing files
  • rename: Rename existing files with a suffix
  • backup: Move existing files to backup directory
"},{"location":"file-handling/#usage-examples","title":"Usage Examples","text":"
# Skip existing files\nstruct generate --file-strategy=skip my-config.yaml ./output\n\n# Backup existing files\nstruct generate --file-strategy=backup --backup=/tmp/backup my-config.yaml ./output\n\n# Rename existing files\nstruct generate --file-strategy=rename my-config.yaml ./output\n

Note: The file:// protocol is automatically added for .yaml files, so these examples work with or without the explicit protocol.

"},{"location":"file-handling/#advanced-examples","title":"Advanced Examples","text":""},{"location":"file-handling/#conditional-file-creation","title":"Conditional File Creation","text":"
files:\n  - docker-compose.yml:\n      skip: \"{{@ not use_docker @}}\"\n      content: |\n        version: '3.8'\n        services:\n          app:\n            build: .\n\n  - Dockerfile:\n      skip_if_exists: true\n      permissions: '0644'\n      file: https://raw.githubusercontent.com/example/dockerfiles/main/python.Dockerfile\n
"},{"location":"file-handling/#dynamic-permissions","title":"Dynamic Permissions","text":"
files:\n  - \"scripts/{{@ script_name @}}.sh\":\n      permissions: '0755'\n      content: |\n        #!/bin/bash\n        # {{@ script_description @}}\n        echo \"Running {{@ script_name @}}\"\n
"},{"location":"file-handling/#multiple-content-sources","title":"Multiple Content Sources","text":"
files:\n  - README.md:\n      content: |\n        # {{@ project_name @}}\n\n        ## Installation\n\n        ```bash\n        pip install -r requirements.txt\n        ```\n\n  - requirements.txt:\n      file: https://raw.githubusercontent.com/example/templates/main/python-requirements.txt\n\n  - .env.example:\n      file: file://./templates/env-template\n
"},{"location":"file-handling/#best-practices","title":"Best Practices","text":"
  1. Use skip_if_exists for configuration files that shouldn't be overwritten
  2. Set appropriate permissions for scripts and sensitive files
  3. Use remote files for standardized content like licenses and gitignores
  4. Combine strategies with command-line options for different deployment scenarios
  5. Test with --dry-run before applying changes to important directories
"},{"location":"funding/","title":"Funding STRUCT","text":"

STRUCT is an open-source project that helps developers create consistent project structures and automate repetitive setup tasks. Your support helps us maintain and improve this tool for the entire community.

"},{"location":"funding/#support-options","title":"\ud83d\udcb0 Support Options","text":""},{"location":"funding/#github-sponsors","title":"GitHub Sponsors","text":"

The easiest way to support STRUCT development is through GitHub Sponsors:

  • Sponsor @httpdss on GitHub

GitHub Sponsors allows for recurring monthly contributions or one-time donations. All funds go directly toward:

  • Development time for new features
  • Bug fixes and maintenance
  • Documentation improvements
  • Community support
  • Infrastructure costs
"},{"location":"funding/#patreon","title":"Patreon","text":"

For ongoing support with additional perks:

  • Support STRUCT on Patreon

Patreon supporters get access to:

  • Early previews of new features
  • Direct input on roadmap priorities
  • Exclusive development updates
  • Recognition in project documentation
"},{"location":"funding/#one-time-donations","title":"One-Time Donations","text":"

For one-time contributions:

  • PayPal: Donate via PayPal
"},{"location":"funding/#alternative-ways-to-support","title":"\ud83e\udd1d Alternative Ways to Support","text":"

If financial contribution isn't possible, you can still support STRUCT:

"},{"location":"funding/#code-contributions","title":"Code Contributions","text":"
  • Submit bug fixes and new features
  • Improve documentation
  • Add new contrib structures
  • Help with testing and quality assurance
"},{"location":"funding/#community-support","title":"Community Support","text":"
  • Answer questions in GitHub Discussions
  • Help other users in issues
  • Share STRUCT on social media
  • Write blog posts or tutorials
"},{"location":"funding/#feedback-and-testing","title":"Feedback and Testing","text":"
  • Report bugs and issues
  • Suggest new features
  • Test beta releases
  • Provide user experience feedback

Every contribution, no matter the size, helps make STRUCT better for everyone. Thank you for your support! \ud83c\udf89

"},{"location":"github-integration/","title":"GitHub Integration","text":"

STRUCT can seamlessly integrate with GitHub to automate the generation of project structures across repositories.

"},{"location":"github-integration/#automating-struct","title":"Automating STRUCT","text":"

Combine GitHub Actions with STRUCT to automate project structure generation in CI/CD pipelines. Trigger the process manually or automatically based on events like pull requests or pushes.

Example Workflow:

name: run-struct\n\non:\n  workflow_dispatch:\n\njobs:\n  generate:\n    uses: httpdss/struct/.github/workflows/struct-generate.yaml@main\n    secrets:\n      token: ${{ secrets.STRUCT_RUN_TOKEN }}\n
"},{"location":"github-integration/#best-practices","title":"Best Practices","text":"
  1. Secure Your Token: Store GitHub tokens in secrets management tools.
  2. Use Topics for Filtering: Organize repositories with topics to efficiently manage workflows.
  3. Test Locally First: Simulate script actions with --dry-run before executing in a CI/CD environment.
  4. Combine with Other Tools: Use STRUCT with Terraform, Ansible, or Docker for comprehensive project management.
"},{"location":"github-integration/#faqs","title":"FAQs","text":""},{"location":"github-integration/#why-use-a-github-integration","title":"Why use a GitHub Integration?","text":"

Using GitHub integration allows you to leverage STRUCT's automation capabilities in a version-controlled environment, enabling consistent and repeatable project structures.

"},{"location":"github-integration/#can-i-customize-the-github-action","title":"Can I customize the GitHub Action?","text":"

Yes, you can tailor the GitHub Action to your specific needs, including custom triggers, different environments, and additional dependencies.

"},{"location":"hooks/","title":"Pre-generation and Post-generation Hooks","text":"

You can define shell commands to run before and after structure generation using the pre_hooks and post_hooks keys in your YAML configuration. These are optional and allow you to automate setup or cleanup steps.

"},{"location":"hooks/#hook-types","title":"Hook Types","text":"
  • pre_hooks: List of shell commands to run before generation. If any command fails (non-zero exit), generation is aborted.
  • post_hooks: List of shell commands to run after generation completes. If any command fails, an error is shown.
"},{"location":"hooks/#basic-example","title":"Basic Example","text":"
pre_hooks:\n  - echo \"Preparing environment...\"\n  - ./scripts/prep.sh\n\npost_hooks:\n  - echo \"Generation complete!\"\n  - ./scripts/cleanup.sh\n\nfiles:\n  - README.md:\n      content: |\n        # My Project\n
"},{"location":"hooks/#how-hooks-work","title":"How Hooks Work","text":""},{"location":"hooks/#pre-hooks","title":"Pre-hooks","text":"
  1. Execute in the order defined
  2. Run before any files or folders are created
  3. If any command returns non-zero exit code, generation stops
  4. Useful for environment preparation, validation, or dependency checks
"},{"location":"hooks/#post-hooks","title":"Post-hooks","text":"
  1. Execute after all files and folders are created
  2. Run even if some file operations fail
  3. Errors are reported but don't stop execution
  4. Useful for cleanup, initialization, or notification tasks
"},{"location":"hooks/#output-handling","title":"Output Handling","text":"
  • Output from hooks (stdout and stderr) is shown in the terminal
  • Hook execution is logged with appropriate log levels
  • Failed hooks display error messages with exit codes
"},{"location":"hooks/#practical-examples","title":"Practical Examples","text":""},{"location":"hooks/#environment-setup","title":"Environment Setup","text":"
pre_hooks:\n  - python -m venv .venv\n  - source .venv/bin/activate\n  - pip install --upgrade pip\n\npost_hooks:\n  - source .venv/bin/activate\n  - pip install -r requirements.txt\n  - echo \"Virtual environment ready!\"\n\nfiles:\n  - requirements.txt:\n      content: |\n        flask==2.3.0\n        requests==2.31.0\n
"},{"location":"hooks/#git-repository-initialization","title":"Git Repository Initialization","text":"
pre_hooks:\n  - git --version  # Verify git is available\n\npost_hooks:\n  - git init\n  - git add .\n  - git commit -m \"Initial commit from STRUCT\"\n  - echo \"Git repository initialized\"\n\nfiles:\n  - .gitignore:\n      file: github://github/gitignore/main/Python.gitignore\n  - README.md:\n      content: |\n        # {{@ project_name @}}\n        Generated with STRUCT\n
"},{"location":"hooks/#docker-setup","title":"Docker Setup","text":"
pre_hooks:\n  - docker --version\n  - echo \"Setting up Docker environment...\"\n\npost_hooks:\n  - docker build -t {{@ project_name | slugify @}} .\n  - echo \"Docker image built successfully\"\n\nfiles:\n  - Dockerfile:\n      content: |\n        FROM python:3.11-slim\n        WORKDIR /app\n        COPY . .\n        RUN pip install -r requirements.txt\n        CMD [\"python\", \"app.py\"]\n  - docker-compose.yml:\n      content: |\n        version: '3.8'\n        services:\n          app:\n            build: .\n            ports:\n              - \"8000:8000\"\n
"},{"location":"hooks/#database-migration","title":"Database Migration","text":"
pre_hooks:\n  - echo \"Checking database connection...\"\n  - pg_isready -h localhost -p 5432\n\npost_hooks:\n  - python manage.py migrate\n  - python manage.py collectstatic --noinput\n  - echo \"Database migrations complete\"\n\nfiles:\n  - manage.py:\n      content: |\n        #!/usr/bin/env python\n        import os\n        import sys\n\n        if __name__ == \"__main__\":\n            os.environ.setdefault(\"DJANGO_SETTINGS_MODULE\", \"settings\")\n            from django.core.management import execute_from_command_line\n            execute_from_command_line(sys.argv)\n
"},{"location":"hooks/#testing-and-validation","title":"Testing and Validation","text":"
pre_hooks:\n  - echo \"Validating prerequisites...\"\n  - node --version\n  - npm --version\n\npost_hooks:\n  - npm install\n  - npm run lint\n  - npm test\n  - echo \"All tests passed!\"\n\nfiles:\n  - package.json:\n      content: |\n        {\n          \"name\": \"{{@ project_name | slugify @}}\",\n          \"version\": \"1.0.0\",\n          \"scripts\": {\n            \"test\": \"jest\",\n            \"lint\": \"eslint src/\"\n          }\n        }\n
"},{"location":"hooks/#best-practices","title":"Best Practices","text":"
  1. Keep hooks simple: Use external scripts for complex operations
  2. Handle errors gracefully: Check for tool availability in pre-hooks
  3. Use absolute paths: Hooks run in the target directory context
  4. Log important actions: Use echo statements for user feedback
  5. Test independently: Ensure hook commands work outside STRUCT
  6. Consider dependencies: Order hooks based on their requirements
"},{"location":"hooks/#error-handling","title":"Error Handling","text":""},{"location":"hooks/#pre-hook-failures","title":"Pre-hook Failures","text":"
pre_hooks:\n  - echo \"Checking Python version...\"\n  - python --version || (echo \"Python not found!\" && exit 1)\n  - echo \"Python check passed\"\n
"},{"location":"hooks/#post-hook-error-tolerance","title":"Post-hook Error Tolerance","text":"
post_hooks:\n  - npm install || echo \"Warning: npm install failed\"\n  - git add . || echo \"Warning: git add failed\"\n  - echo \"Setup complete (some warnings may have occurred)\"\n
"},{"location":"hooks/#variables-in-hooks","title":"Variables in Hooks","text":"

You can use template variables in hook commands:

pre_hooks:\n  - echo \"Setting up {{@ project_name @}}\"\n  - mkdir -p \"{{@ project_name | slugify @}}\"\n\npost_hooks:\n  - echo \"{{@ project_name @}} setup complete!\"\n  - echo \"Project created in: $(pwd)\"\n\nvariables:\n  - project_name:\n      description: \"Name of the project\"\n      type: string\n      default: \"MyProject\"\n
"},{"location":"installation/","title":"Installation Guide","text":""},{"location":"installation/#using-pip","title":"Using pip","text":"

Install STRUCT with pip:

pip install git+https://github.com/httpdss/struct.git\n

Enable Auto-Completion

After installation, enable command-line auto-completion for better productivity: 

eval \"$(register-python-argcomplete struct)\"\n
For permanent setup, see the Command-Line Completion guide.

"},{"location":"installation/#from-source","title":"From Source","text":"

Clone the repository and install locally. See the Development page for details.

"},{"location":"installation/#using-docker","title":"Using Docker","text":"

Run STRUCT without installing, using Docker:

docker run -v $(pwd):/workdir -u $(id -u):$(id -g) ghcr.io/httpdss/struct:main generate file:///workdir/example/structure.yaml /workdir/example_output\n

Refer to the Quick Start guide for more options.

"},{"location":"known-issues/","title":"Known Issues","text":"

This page tracks known issues, limitations, and workarounds for STRUCT. If you encounter any of these issues, check here for potential solutions.

"},{"location":"known-issues/#current-known-issues","title":"Current Known Issues","text":""},{"location":"known-issues/#performance-issues","title":"Performance Issues","text":""},{"location":"known-issues/#large-directory-structures","title":"Large Directory Structures","text":"

Issue: Generation becomes slow with very large directory structures (1000+ files).

Workaround:

  • Break large structures into smaller, modular components
  • Use the --dry-run option to preview before full generation
  • Consider using parallel processing for independent structures

Status: Under investigation

"},{"location":"known-issues/#remote-file-fetching","title":"Remote File Fetching","text":"

Issue: Fetching many remote files can be slow due to sequential processing.

Workaround:

  • Cache frequently used remote files locally
  • Use local mirrors when possible
  • Batch remote operations when feasible

Status: Planned for future release

"},{"location":"known-issues/#template-engine","title":"Template Engine","text":""},{"location":"known-issues/#complex-jinja2-expressions","title":"Complex Jinja2 Expressions","text":"

Issue: Very complex Jinja2 expressions may not render correctly in all contexts.

Example:

# May not work as expected\ncontent: \"{{@ complex | filter | another_filter if condition else fallback @}}\"\n

Workaround: Break complex expressions into simpler parts or use variables:

variables:\n  - intermediate_value:\n      default: \"{{@ complex | filter @}}\"\n\nfiles:\n  - test.txt:\n      content: \"{{@ intermediate_value | another_filter @}}\"\n

Status: Investigating improvements

"},{"location":"known-issues/#unicode-in-file-names","title":"Unicode in File Names","text":"

Issue: File names with unicode characters may cause issues on some filesystems.

Workaround: Use ASCII-safe file names or test thoroughly on target systems.

Status: Platform-specific limitation

"},{"location":"known-issues/#platform-specific-issues","title":"Platform-Specific Issues","text":""},{"location":"known-issues/#windows-path-handling","title":"Windows Path Handling","text":"

Issue: Long path names on Windows may exceed the 260-character limit.

Workaround:

  • Use shorter path names
  • Enable long path support in Windows 10/11
  • Use mapped drives for shorter paths

Status: Windows limitation

"},{"location":"known-issues/#macos-case-sensitivity","title":"macOS Case Sensitivity","text":"

Issue: macOS filesystem case-insensitivity can cause conflicts with similarly named files.

Workaround: Ensure file names differ by more than just case.

Status: Platform limitation

"},{"location":"known-issues/#github-integration","title":"GitHub Integration","text":""},{"location":"known-issues/#rate-limiting","title":"Rate Limiting","text":"

Issue: GitHub API rate limits may affect custom filters like latest_release.

Workaround:

  • Set GITHUB_TOKEN environment variable for higher limits
  • Cache results when possible
  • Implement retry logic in scripts

Status: API limitation

"},{"location":"known-issues/#private-repository-access","title":"Private Repository Access","text":"

Issue: Accessing private repositories requires proper authentication.

Workaround: Ensure GITHUB_TOKEN has appropriate permissions.

Status: Expected behavior

"},{"location":"known-issues/#docker-issues","title":"Docker Issues","text":""},{"location":"known-issues/#file-permissions","title":"File Permissions","text":"

Issue: Files created in Docker containers may have incorrect ownership.

Workaround: Use the -u $(id -u):$(id -g) option when running Docker:

docker run -v $(pwd):/workdir -u $(id -u):$(id -g) ghcr.io/httpdss/struct:main generate file://config.yaml .\n

Status: Docker behavior

"},{"location":"known-issues/#volume-mounting","title":"Volume Mounting","text":"

Issue: Complex volume mounting scenarios may not work as expected.

Workaround: Use simpler mounting patterns and absolute paths.

Status: Docker limitation

"},{"location":"known-issues/#limitations","title":"Limitations","text":""},{"location":"known-issues/#template-variables","title":"Template Variables","text":""},{"location":"known-issues/#variable-scope","title":"Variable Scope","text":"

Limitation: Variables defined in nested structures don't propagate back to parent structures.

Design Decision: This is intentional to maintain structure isolation.

"},{"location":"known-issues/#circular-references","title":"Circular References","text":"

Limitation: Circular references in variable definitions are not detected.

Example:

variables:\n  - var_a:\n      default: \"{{@ var_b @}}\"\n  - var_b:\n      default: \"{{@ var_a @}}\"\n

Impact: May cause infinite loops or unexpected behavior.

"},{"location":"known-issues/#file-operations","title":"File Operations","text":""},{"location":"known-issues/#atomic-operations","title":"Atomic Operations","text":"

Limitation: File operations are not atomic - partial failures may leave the system in an inconsistent state.

Mitigation: Use the --backup option for important operations.

"},{"location":"known-issues/#symlink-handling","title":"Symlink Handling","text":"

Limitation: Symbolic links are not explicitly handled and may be followed or replaced.

Impact: May affect complex directory structures with symlinks.

"},{"location":"known-issues/#configuration","title":"Configuration","text":""},{"location":"known-issues/#yaml-complexity","title":"YAML Complexity","text":"

Limitation: Very large YAML files (>10MB) may cause performance issues.

Recommendation: Split large configurations into multiple files.

"},{"location":"known-issues/#schema-validation","title":"Schema Validation","text":"

Limitation: Schema validation doesn't catch all runtime errors.

Note: Use struct validate and testing for comprehensive validation.

"},{"location":"known-issues/#workarounds-and-best-practices","title":"Workarounds and Best Practices","text":""},{"location":"known-issues/#performance-optimization","title":"Performance Optimization","text":"
  1. Use --dry-run for testing large configurations
  2. Modularize structures instead of creating monolithic ones
  3. Cache remote content locally when possible
  4. Use specific structure paths instead of recursive searches
"},{"location":"known-issues/#error-prevention","title":"Error Prevention","text":"
  1. Validate configurations before deployment
  2. Test with small datasets first
  3. Use version control for all configuration files
  4. Implement backup strategies for important operations
"},{"location":"known-issues/#cross-platform-compatibility","title":"Cross-Platform Compatibility","text":"
  1. Test on target platforms before deployment
  2. Use relative paths when possible
  3. Avoid platform-specific commands in hooks
  4. Document platform requirements clearly
"},{"location":"known-issues/#reporting-issues","title":"Reporting Issues","text":""},{"location":"known-issues/#before-reporting","title":"Before Reporting","text":"
  1. Check this known issues page
  2. Search existing GitHub issues
  3. Test with the latest version
  4. Prepare a minimal reproduction case
"},{"location":"known-issues/#issue-report-template","title":"Issue Report Template","text":"
**STRUCT Version**: [e.g., 1.2.3]\n**Platform**: [e.g., Ubuntu 20.04, macOS 12.0, Windows 11]\n**Python Version**: [e.g., 3.9.7]\n\n**Expected Behavior**:\n[Describe what you expected to happen]\n\n**Actual Behavior**:\n[Describe what actually happened]\n\n**Reproduction Steps**:\n1. [Step 1]\n2. [Step 2]\n3. [Step 3]\n\n**Configuration File**:\n\n```yaml\n[Paste minimal configuration that reproduces the issue]\n

Error Output:

[Paste any error messages or logs]\n

Additional Context:

[Any other relevant information]

```text

"},{"location":"known-issues/#priority-guidelines","title":"Priority Guidelines","text":"
  • Critical: Security issues, data loss, system crashes
  • High: Major functionality broken, widespread impact
  • Medium: Minor functionality issues, workarounds available
  • Low: Enhancement requests, documentation issues
"},{"location":"known-issues/#contributing-fixes","title":"Contributing Fixes","text":"

We welcome contributions to fix known issues:

  1. Fork the repository
  2. Create a feature branch: git checkout -b fix/issue-name
  3. Write tests for your fix
  4. Update documentation if necessary
  5. Submit a pull request
"},{"location":"known-issues/#testing-requirements","title":"Testing Requirements","text":"
  • All existing tests must pass
  • New tests should cover the fixed functionality
  • Manual testing on multiple platforms when applicable
"},{"location":"known-issues/#version-compatibility","title":"Version Compatibility","text":""},{"location":"known-issues/#supported-versions","title":"Supported Versions","text":"
  • Latest release: Full support and active development
  • Previous minor version: Security fixes and critical bugs
  • Older versions: Community support only
"},{"location":"known-issues/#upgrade-recommendations","title":"Upgrade Recommendations","text":"
  • Test upgrades in non-production environments first
  • Review changelog for breaking changes
  • Update configurations for deprecated features

This page is updated regularly. Subscribe to repository notifications for updates on issue status.

"},{"location":"mappings/","title":"Mappings Support","text":"

You can provide a mappings YAML file to inject key-value maps into your templates. This is useful for referencing environment-specific values, IDs, or any other mapping you want to use in your generated files.

"},{"location":"mappings/#what-are-mappings","title":"What are Mappings?","text":"

Mappings are external data files that provide structured key-value pairs for use in your STRUCT templates. They allow you to:

  • Separate data from templates
  • Share common values across multiple structures
  • Manage environment-specific configurations
  • Centralize reference data like account IDs, team names, or service endpoints
"},{"location":"mappings/#mappings-file-format","title":"Mappings File Format","text":""},{"location":"mappings/#basic-structure","title":"Basic Structure","text":"
mappings:\n  teams:\n    devops: devops-team\n    frontend: frontend-team\n    backend: backend-team\n\n  aws_account_ids:\n    development: 123456789012\n    staging: 234567890123\n    production: 345678901234\n\n  service_endpoints:\n    api_gateway: https://api.example.com\n    database: postgres://db.example.com:5432\n    redis: redis://cache.example.com:6379\n
"},{"location":"mappings/#nested-mappings","title":"Nested Mappings","text":"
mappings:\n  environments:\n    development:\n      database_url: postgres://dev-db:5432/myapp\n      redis_url: redis://dev-cache:6379\n      debug: true\n\n    production:\n      database_url: postgres://prod-db:5432/myapp\n      redis_url: redis://prod-cache:6379\n      debug: false\n\n  regions:\n    us_east_1:\n      vpc_id: vpc-12345\n      subnet_ids:\n        - subnet-abc123\n        - subnet-def456\n\n    eu_west_1:\n      vpc_id: vpc-67890\n      subnet_ids:\n        - subnet-ghi789\n        - subnet-jkl012\n
"},{"location":"mappings/#using-mappings-in-templates","title":"Using Mappings in Templates","text":""},{"location":"mappings/#basic-usage","title":"Basic Usage","text":"

Reference mapping values using the mappings variable:

files:\n  - config.yml:\n      content: |\n        database_url: {{@ mappings.service_endpoints.database @}}\n        api_endpoint: {{@ mappings.service_endpoints.api_gateway @}}\n\n        # Team information\n        owner: {{@ mappings.teams.backend @}}\n
"},{"location":"mappings/#array-access","title":"Array Access","text":"

For nested structures and arrays:

files:\n  - terraform/main.tf:\n      content: |\n        resource \"aws_instance\" \"web\" {\n          ami           = \"ami-12345\"\n          instance_type = \"t3.micro\"\n\n          vpc_security_group_ids = [\n            \"{{@ mappings.regions.us_east_1.vpc_id @}}\"\n          ]\n\n          subnet_id = \"{{@ mappings.regions.us_east_1.subnet_ids[0] @}}\"\n        }\n
"},{"location":"mappings/#dynamic-key-access","title":"Dynamic Key Access","text":"

Use bracket notation for dynamic keys:

files:\n  - app.py:\n      content: |\n        import os\n\n        ENVIRONMENT = \"{{@ environment @}}\"\n        DATABASE_URL = \"{{@ mappings.environments[environment].database_url @}}\"\n        DEBUG = {{@ mappings.environments[environment].debug @}}\n\nvariables:\n  - environment:\n      description: \"Target environment\"\n      type: string\n      default: \"development\"\n
"},{"location":"mappings/#using-mappings-in-the-with-clause","title":"Using Mappings in the with Clause","text":"

You can assign values from mappings directly in the with clause for folder struct calls:

folders:\n  - ./infrastructure:\n      struct: terraform/aws-vpc\n      with:\n        vpc_id: {{@ mappings.regions.us_east_1.vpc_id @}}\n        subnet_ids: {{@ mappings.regions.us_east_1.subnet_ids @}}\n\n  - ./backend:\n      struct: project/django\n      with:\n        team: {{@ mappings.teams.backend @}}\n        database_url: {{@ mappings.environments.production.database_url @}}\n

This approach allows you to pass specific mapping values as variables to nested structures.

"},{"location":"mappings/#command-line-usage","title":"Command Line Usage","text":"

Use the --mappings-file argument with the generate command:

# Both commands work identically - file:// is automatically added for .yaml files\nstruct generate --mappings-file ./mymap.yaml my-struct.yaml .\nstruct generate --mappings-file ./mymap.yaml file://my-struct.yaml .\n
"},{"location":"mappings/#multiple-mappings-files","title":"Multiple Mappings Files","text":"

You can specify multiple mappings files that will be merged in order:

struct generate \\\n  --mappings-file ./common-mappings.yaml \\\n  --mappings-file ./env-specific-mappings.yaml \\\n  my-struct.yaml .\n

Merging behavior:

  • Files are processed in the order specified
  • Later files override earlier ones for conflicting keys
  • Deep merging is performed for nested dictionaries
  • This enables clean separation of common vs environment-specific configuration

Example with environment variable:

struct generate \\\n  --mappings-file ./mappings/common.yaml \\\n  --mappings-file ./mappings/${ENVIRONMENT}.yaml \\\n  infrastructure.yaml \\\n  ./output\n
"},{"location":"mappings/#practical-examples","title":"Practical Examples","text":""},{"location":"mappings/#multi-environment-deployment","title":"Multi-Environment Deployment","text":"

mappings.yaml:

mappings:\n  environments:\n    dev:\n      namespace: myapp-dev\n      replicas: 1\n      image_tag: latest\n      resources:\n        cpu: 100m\n        memory: 128Mi\n\n    prod:\n      namespace: myapp-prod\n      replicas: 3\n      image_tag: v1.2.3\n      resources:\n        cpu: 500m\n        memory: 512Mi\n

k8s-deployment.yaml template:

files:\n  - k8s/deployment.yaml:\n      content: |\n        apiVersion: apps/v1\n        kind: Deployment\n        metadata:\n          name: {{@ app_name @}}\n          namespace: {{@ mappings.environments[target_env].namespace @}}\n        spec:\n          replicas: {{@ mappings.environments[target_env].replicas @}}\n          template:\n            spec:\n              containers:\n              - name: app\n                image: myapp:{{@ mappings.environments[target_env].image_tag @}}\n                resources:\n                  requests:\n                    cpu: {{@ mappings.environments[target_env].resources.cpu @}}\n                    memory: {{@ mappings.environments[target_env].resources.memory @}}\n\nvariables:\n  - target_env:\n      description: \"Target environment (dev/prod)\"\n      type: string\n      default: \"dev\"\n  - app_name:\n      description: \"Application name\"\n      type: string\n
"},{"location":"mappings/#team-specific-configurations","title":"Team-Specific Configurations","text":"

teams.yaml:

mappings:\n  teams:\n    platform:\n      email: platform@company.com\n      slack: \"#platform-team\"\n      oncall: platform-oncall@company.com\n\n    data:\n      email: data@company.com\n      slack: \"#data-team\"\n      oncall: data-oncall@company.com\n

Usage:

folders:\n  - ./services/api:\n      struct: service/rest-api\n      with:\n        team_email: {{@ mappings.teams.platform.email @}}\n        team_slack: {{@ mappings.teams.platform.slack @}}\n\n  - ./services/etl:\n      struct: service/data-pipeline\n      with:\n        team_email: {{@ mappings.teams.data.email @}}\n        team_slack: {{@ mappings.teams.data.slack @}}\n
"},{"location":"mappings/#best-practices","title":"Best Practices","text":"

  1. Organize by Context: Group related mappings together (e.g., environments, teams, regions)

  2. Use Consistent Naming: Follow naming conventions across all mapping files

  3. Version Control: Keep mappings files in version control alongside your structures

  4. Validate Data: Ensure mapping values are correct before generating structures

  5. Document Mappings: Include comments or separate documentation for complex mappings

  6. Environment Separation: Use separate mapping files for different environments

  7. Default Values: Provide sensible defaults in your templates for missing mappings

"},{"location":"mappings/#error-handling","title":"Error Handling","text":"

If a mapping key doesn't exist, STRUCT will show an error:

files:\n  - config.yml:\n      content: |\n        # This will cause an error if 'nonexistent' key doesn't exist\n        value: {{@ mappings.nonexistent.key @}}\n

Use the default filter to provide fallbacks:

files:\n  - config.yml:\n      content: |\n        # This provides a fallback value\n        value: {{@ mappings.team.devops | default \"no_team\" @}}\n
"},{"location":"mcp-integration/","title":"MCP (Model Context Protocol) Integration","text":"

The struct tool now supports MCP (Model Context Protocol) integration, providing a programmable interface to interact with structure definitions. This enables automation and integration with other tools, particularly AI-assisted development workflows.

"},{"location":"mcp-integration/#available-mcp-tools","title":"Available MCP Tools","text":""},{"location":"mcp-integration/#1-list_structures","title":"1. list_structures","text":"

Lists all available structure definitions.

{\n  \"name\": \"list_structures\",\n  \"arguments\": {\n    \"structures_path\": \"/path/to/custom/structures\"  // optional\n  }\n}\n

Parameters: - structures_path (optional): Custom path to structure definitions

"},{"location":"mcp-integration/#2-get_structure_info","title":"2. get_structure_info","text":"

Get detailed information about a specific structure.

{\n  \"name\": \"get_structure_info\",\n  \"arguments\": {\n    \"structure_name\": \"project/python\",\n    \"structures_path\": \"/path/to/custom/structures\"  // optional\n  }\n}\n

Parameters: - structure_name (required): Name of the structure to get info about - structures_path (optional): Custom path to structure definitions

"},{"location":"mcp-integration/#3-generate_structure","title":"3. generate_structure","text":"

Generate a project structure using specified definition and options.

{\n  \"name\": \"generate_structure\",\n  \"arguments\": {\n    \"structure_definition\": \"project/python\",\n    \"base_path\": \"/tmp/myproject\",\n    \"output\": \"console\",  // \"console\" or \"files\"\n    \"dry_run\": false,\n    \"mappings\": {\n      \"project_name\": \"MyProject\",\n      \"author\": \"John Doe\"\n    },\n    \"structures_path\": \"/path/to/custom/structures\"  // optional\n  }\n}\n

Parameters: - structure_definition (required): Name or path to the structure definition - base_path (required): Base path where the structure should be generated - output (optional): Output mode - \"console\" for stdout or \"files\" for actual generation (default: \"files\") - dry_run (optional): Perform a dry run without creating actual files (default: false) - mappings (optional): Variable mappings for template substitution - structures_path (optional): Custom path to structure definitions

"},{"location":"mcp-integration/#4-validate_structure","title":"4. validate_structure","text":"

Validate a structure configuration YAML file.

{\n  \"name\": \"validate_structure\",\n  \"arguments\": {\n    \"yaml_file\": \"/path/to/structure.yaml\"\n  }\n}\n

Parameters: - yaml_file (required): Path to the YAML configuration file to validate

"},{"location":"mcp-integration/#usage","title":"Usage","text":""},{"location":"mcp-integration/#starting-the-mcp-server","title":"Starting the MCP Server","text":"

To start the MCP server for stdio communication:

struct mcp --server\n
"},{"location":"mcp-integration/#command-line-integration","title":"Command Line Integration","text":"

The existing list and info commands now support an optional --mcp flag:

# List structures with MCP support\nstruct list --mcp\n\n# Get structure info with MCP support\nstruct info project/python --mcp\n
"},{"location":"mcp-integration/#mcp-client-integration","title":"MCP Client Integration","text":""},{"location":"mcp-integration/#claude-desktop-integration","title":"Claude Desktop Integration","text":"

Add the following to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\\Claude\\claude_desktop_config.json Linux: ~/.config/claude/claude_desktop_config.json

{\n  \"mcpServers\": {\n    \"struct\": {\n      \"command\": \"struct\",\n      \"args\": [\"mcp\", \"--server\"],\n      \"cwd\": \"/path/to/your/project\"\n    }\n  }\n}\n
"},{"location":"mcp-integration/#clinecontinue-integration","title":"Cline/Continue Integration","text":"

For Cline (VS Code extension), add to your .cline_mcp_settings.json:

{\n  \"mcpServers\": {\n    \"struct\": {\n      \"command\": \"struct\",\n      \"args\": [\"mcp\", \"--server\"]\n    }\n  }\n}\n
"},{"location":"mcp-integration/#custom-mcp-client-integration","title":"Custom MCP Client Integration","text":"

For any MCP-compatible client, use these connection parameters:

// Node.js example\nimport { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';\nimport { Client } from '@modelcontextprotocol/sdk/client/index.js';\n\nconst transport = new StdioClientTransport({\n  command: 'struct',\n  args: ['mcp', '--server']\n});\n\nconst client = new Client(\n  {\n    name: \"struct-client\",\n    version: \"1.0.0\"\n  },\n  {\n    capabilities: {}\n  }\n);\n\nawait client.connect(transport);\n
# Python example\nimport asyncio\nfrom mcp import ClientSession, StdioServerParameters\nfrom mcp.client.stdio import stdio_client\n\nasync def main():\n    server_params = StdioServerParameters(\n        command=\"struct\",\n        args=[\"mcp\", \"--server\"]\n    )\n\n    async with stdio_client(server_params) as (read, write):\n        async with ClientSession(read, write) as session:\n            await session.initialize()\n\n            # List available tools\n            tools = await session.list_tools()\n            print(f\"Available tools: {[tool.name for tool in tools.tools]}\")\n\n            # Call a tool\n            result = await session.call_tool(\"list_structures\", {})\n            print(result.content[0].text)\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n
"},{"location":"mcp-integration/#ai-assisted-development-workflows","title":"AI-Assisted Development Workflows","text":"

The MCP integration is particularly powerful for AI-assisted development workflows:

"},{"location":"mcp-integration/#console-output-mode","title":"Console Output Mode","text":"

Using output: \"console\" with generate_structure allows piping structure content to stdout for subsequent AI prompts:

# Generate structure content to console for AI review\nstruct mcp --server | ai-tool \"Review this project structure\"\n
"},{"location":"mcp-integration/#chaining-operations","title":"Chaining Operations","text":"

The MCP tools can be chained together for complex workflows:

  1. List available structures
  2. Get detailed info about a specific structure
  3. Generate the structure with custom mappings
  4. Validate any custom configurations
"},{"location":"mcp-integration/#integration-examples","title":"Integration Examples","text":"

Example 1: Generate and Review 

// 1. Generate structure to console\n{\n  \"name\": \"generate_structure\",\n  \"arguments\": {\n    \"structure_definition\": \"project/python\",\n    \"base_path\": \"/tmp/review\",\n    \"output\": \"console\"\n  }\n}\n\n// 2. Use output as context for AI code review\n

Example 2: Custom Structure Validation 

// 1. Validate custom structure\n{\n  \"name\": \"validate_structure\",\n  \"arguments\": {\n    \"yaml_file\": \"/path/to/custom-structure.yaml\"\n  }\n}\n\n// 2. If valid, generate using the custom structure\n{\n  \"name\": \"generate_structure\",\n  \"arguments\": {\n    \"structure_definition\": \"file:///path/to/custom-structure.yaml\",\n    \"base_path\": \"/tmp/project\"\n  }\n}\n

"},{"location":"mcp-integration/#configuration","title":"Configuration","text":""},{"location":"mcp-integration/#environment-variables","title":"Environment Variables","text":"

The MCP server respects the same environment variables as the regular struct tool: - STRUCT_STRUCTURES_PATH: Default path for structure definitions - Any mapping variables used in templates

"},{"location":"mcp-integration/#client-configuration-examples","title":"Client Configuration Examples","text":""},{"location":"mcp-integration/#1-basic-configuration","title":"1. Basic Configuration","text":"
{\n  \"command\": \"struct\",\n  \"args\": [\"mcp\", \"--server\"]\n}\n
"},{"location":"mcp-integration/#2-with-custom-structures-path","title":"2. With Custom Structures Path","text":"
{\n  \"command\": \"struct\",\n  \"args\": [\"mcp\", \"--server\"],\n  \"env\": {\n    \"STRUCT_STRUCTURES_PATH\": \"/path/to/custom/structures\"\n  }\n}\n
"},{"location":"mcp-integration/#3-with-python-virtual-environment","title":"3. With Python Virtual Environment","text":"
{\n  \"command\": \"/path/to/venv/bin/python\",\n  \"args\": [\"-m\", \"struct_module.main\", \"mcp\", \"--server\"],\n  \"cwd\": \"/path/to/struct/project\"\n}\n
"},{"location":"mcp-integration/#4-using-shell-script-wrapper","title":"4. Using Shell Script Wrapper","text":"

Create a shell script struct-mcp.sh: 

#!/bin/bash\ncd /path/to/your/project\nsource .venv/bin/activate\nstruct mcp --server\n

Then configure your MCP client: 

{\n  \"command\": \"/path/to/struct-mcp.sh\",\n  \"args\": []\n}\n

"},{"location":"mcp-integration/#quick-start-guide","title":"Quick Start Guide","text":""},{"location":"mcp-integration/#step-1-install-struct-with-mcp-support","title":"Step 1: Install struct with MCP support","text":"
pip install struct[mcp]  # or pip install struct && pip install mcp\n
"},{"location":"mcp-integration/#step-2-test-mcp-server","title":"Step 2: Test MCP server","text":"
# Test that MCP server starts correctly\nstruct mcp --server\n# Should show: Starting MCP server...\n# Press Ctrl+C to stop\n
"},{"location":"mcp-integration/#step-3-configure-your-mcp-client","title":"Step 3: Configure your MCP client","text":"

Add the configuration to your MCP client (see examples above).

"},{"location":"mcp-integration/#step-4-start-using-mcp-tools","title":"Step 4: Start using MCP tools","text":"

Once connected, you can use these tools: - list_structures - Get all available structures - get_structure_info - Get details about a specific structure - generate_structure - Generate project structures - validate_structure - Validate YAML configuration files

"},{"location":"mcp-integration/#troubleshooting","title":"Troubleshooting","text":""},{"location":"mcp-integration/#common-issues","title":"Common Issues","text":"
  1. \"Command not found: struct\"
  2. Solution: Ensure struct is installed and in your PATH

  3. Alternative: Use full path to Python executable

  4. MCP server won't start

  5. Check if mcp package is installed: pip show mcp

  6. Try running with verbose logging: struct mcp --server --log DEBUG

  7. Client can't connect

  8. Verify the command and args in your client configuration
  9. Test MCP server manually first

  10. Check working directory and environment variables

  11. Structures not found

  12. Set STRUCT_STRUCTURES_PATH environment variable
  13. Use absolute paths in configuration
  14. Verify structure files exist and are readable
"},{"location":"mcp-integration/#debug-mode","title":"Debug Mode","text":"
# Run with debug logging\nSTRUCT_LOG_LEVEL=DEBUG struct mcp --server\n
"},{"location":"mcp-integration/#benefits","title":"Benefits","text":"
  1. Automation: Programmatic access to all struct tool functionality
  2. Integration: Easy integration with other development tools
  3. AI Workflows: Enhanced support for AI-assisted development processes
  4. Consistency: Same underlying logic as CLI commands
  5. Flexibility: Support for custom paths, mappings, and output modes
"},{"location":"mcp-integration/#backward-compatibility","title":"Backward Compatibility","text":"

All existing struct tool functionality remains unchanged. The MCP integration is additive and does not affect existing workflows or commands.

"},{"location":"quickstart/","title":"Quick Start","text":""},{"location":"quickstart/#quick-start-using-docker","title":"Quick Start Using Docker","text":"
  1. Create a YAML configuration file for your project structure. See sample configuration here.
  2. Run the following command to generate the project structure:
docker run \\\n  -v $(pwd):/workdir \\\n  -u $(id -u):$(id -g) \\\n  ghcr.io/httpdss/struct:main generate \\\n  file:///workdir/example/structure.yaml \\\n  /workdir/example_output\n
"},{"location":"quickstart/#quick-start-using-docker-alpine","title":"Quick Start Using Docker Alpine","text":"
docker run \\\n  -v $(pwd):/workdir \\\n  -u $(id -u):$(id -g) \\\n  ghcr.io/httpdss/struct:alpine generate \\\n  file:///workdir/example/structure.yaml \\\n  /workdir/example_output\n

For testing, you can run an alpine Docker container and install the script inside it:

docker run -it --entrypoint=\"\" python:3.10-alpine sh -l\n

Inside the container:

apk add python-pip git vim\npip install git+https://github.com/httpdss/struct.git\nmkdir example\ncd example/\ntouch structure.yaml\nvim structure.yaml # copy the content from the example folder\nstruct generate structure.yaml .\n

Note: The file:// protocol is automatically added for .yaml files, so structure.yaml and file://structure.yaml work identically.

"},{"location":"quickstart/#discovering-available-structures","title":"Discovering Available Structures","text":"

Before generating, see what structures are available:

struct list\n

This shows all built-in structures you can use.

Auto-Completion

If you've enabled auto-completion, you can press Tab after struct generate to see all available structures!

"},{"location":"quickstart/#first-example","title":"First Example","text":"

After installing STRUCT, try this simple example:

struct generate terraform/modules/generic ./my-terraform-module\n

This will create a new terraform module structure in the ./my-terraform-module directory.

Or try a simple project structure:

struct generate project/nodejs ./my-node-app\n
"},{"location":"quickstart/#next-steps","title":"Next Steps","text":"
  • Learn about YAML Configuration
  • Explore Template Variables
  • Check out Usage Examples
"},{"location":"schema/","title":"YAML Schema Reference","text":"

STRUCT provides JSON schema validation to ensure your YAML configuration files are correctly structured. This helps catch errors early and provides IDE support with autocompletion.

"},{"location":"schema/#schema-location","title":"Schema Location","text":"

The official schema is available at:

https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json\n
"},{"location":"schema/#ide-configuration","title":"IDE Configuration","text":""},{"location":"schema/#vs-code","title":"VS Code","text":"
  1. Install the YAML extension
  2. Add this to your workspace settings (.vscode/settings.json):
{\n  \"yaml.schemas\": {\n    \"https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json\": \".struct.yaml\"\n  }\n}\n

This provides validation and autocompletion for all .struct.yaml files.

"},{"location":"schema/#jetbrains-ides-intellij-pycharm-etc","title":"JetBrains IDEs (IntelliJ, PyCharm, etc.)","text":"
  1. Go to Settings \u2192 Languages & Frameworks \u2192 Schemas and DTDs \u2192 JSON Schema Mappings
  2. Click + to add a new mapping
  3. Set Schema file or URL to: https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json
  4. Set File path pattern to: *.struct.yaml
"},{"location":"schema/#generating-custom-schema","title":"Generating Custom Schema","text":"

If you have custom structures, generate a schema that includes them:

# Generate schema with custom structures\nstruct generate-schema -s /path/to/custom/structures -o my-schema.json\n\n# Use in VS Code settings\n{\n  \"yaml.schemas\": {\n    \"./my-schema.json\": \".struct.yaml\"\n  }\n}\n
"},{"location":"schema/#schema-structure","title":"Schema Structure","text":"

The schema validates the following top-level properties:

"},{"location":"schema/#files-array","title":"files (array)","text":"

Defines files to be created:

files:\n  - filename.txt:\n      content: \"File contents\"\n      permissions: \"0644\"\n      skip: false\n      skip_if_exists: false\n      file: \"https://example.com/template.txt\"\n

Properties:

  • content (string): Inline file content
  • permissions (string): Octal permissions (e.g., \"0755\")
  • skip (boolean): Skip file creation
  • skip_if_exists (boolean): Skip if file exists
  • file (string): External file URL or path
"},{"location":"schema/#folders-array","title":"folders (array)","text":"

Defines folders and nested structures:

folders:\n  - path/to/folder:\n      struct: \"structure-name\"\n      with:\n        variable: \"value\"\n

Properties:

  • struct (string|array): Structure name(s) to apply
  • with (object): Variables to pass to the structure
"},{"location":"schema/#variables-array","title":"variables (array)","text":"

Defines template variables:

variables:\n  - variable_name:\n      description: \"Variable description\"\n      type: \"string\"\n      default: \"default_value\"\n

Properties:

  • description (string): Human-readable description
  • type (string): Variable type (string, integer, boolean)
  • default (any): Default value
"},{"location":"schema/#pre_hooks-array","title":"pre_hooks (array)","text":"

Shell commands to run before generation:

pre_hooks:\n  - \"echo 'Starting generation...'\"\n  - \"./scripts/prepare.sh\"\n
"},{"location":"schema/#post_hooks-array","title":"post_hooks (array)","text":"

Shell commands to run after generation:

post_hooks:\n  - \"npm install\"\n  - \"git init\"\n
"},{"location":"schema/#validation","title":"Validation","text":""},{"location":"schema/#command-line-validation","title":"Command Line Validation","text":"
# Validate a configuration file\nstruct validate my-config.yaml\n
"},{"location":"schema/#programmatic-validation","title":"Programmatic Validation","text":"
import json\nimport yaml\nfrom jsonschema import validate\n\n# Load schema\nwith open('struct-schema.json') as f:\n    schema = json.load(f)\n\n# Load and validate config\nwith open('my-config.yaml') as f:\n    config = yaml.safe_load(f)\n\nvalidate(config, schema)  # Raises exception if invalid\n
"},{"location":"schema/#common-validation-errors","title":"Common Validation Errors","text":""},{"location":"schema/#invalid-file-structure","title":"Invalid File Structure","text":"
# \u274c Wrong - files should be array of objects\nfiles:\n  README.md: \"content\"\n\n# \u2705 Correct\nfiles:\n  - README.md:\n      content: \"content\"\n
"},{"location":"schema/#missing-required-properties","title":"Missing Required Properties","text":"
# \u274c Wrong - struct property missing\nfolders:\n  - src/:\n      with:\n        name: \"myapp\"\n\n# \u2705 Correct\nfolders:\n  - src/:\n      struct: \"project/node\"\n      with:\n        name: \"myapp\"\n
"},{"location":"schema/#invalid-variable-types","title":"Invalid Variable Types","text":"
# \u274c Wrong - type should be string\nvariables:\n  - port:\n      type: number\n      default: 8080\n\n# \u2705 Correct\nvariables:\n  - port:\n      type: integer\n      default: 8080\n
"},{"location":"schema/#schema-extensions","title":"Schema Extensions","text":"

You can extend the base schema for custom validation:

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"allOf\": [\n    {\n      \"$ref\": \"https://raw.githubusercontent.com/httpdss/struct/main/struct-schema.json\"\n    },\n    {\n      \"properties\": {\n        \"custom_section\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"custom_property\": {\"type\": \"string\"}\n          }\n        }\n      }\n    }\n  ]\n}\n
"},{"location":"schema/#ide-benefits","title":"IDE Benefits","text":"

With schema validation enabled, you get:

  • Real-time validation: Errors highlighted as you type
  • Autocompletion: Suggested properties and values
  • Documentation: Hover tooltips with property descriptions
  • Structure guidance: Valid structure names and paths
"},{"location":"schema/#troubleshooting","title":"Troubleshooting","text":""},{"location":"schema/#schema-not-loading","title":"Schema Not Loading","text":"
  1. Check internet connection (for remote schema)
  2. Verify file path (for local schema)
  3. Restart IDE after configuration changes
  4. Check IDE logs for error messages
"},{"location":"schema/#validation-errors","title":"Validation Errors","text":"
  1. Use struct validate command for detailed error messages
  2. Check schema documentation for required properties
  3. Verify YAML syntax is correct
  4. Ensure structure names exist in your installation
"},{"location":"schema/#performance-issues","title":"Performance Issues","text":"
  1. Use local schema files for better performance
  2. Consider schema caching in your IDE
  3. Limit schema complexity for large configurations

This schema system ensures your STRUCT configurations are valid and provides a better development experience through IDE integration.

"},{"location":"structures/","title":"List of Structures in struct_module/contribs","text":""},{"location":"structures/#ansible-playbook","title":"Ansible Playbook","text":"
  • File: ansible-playbook.yaml
  • Description: Contains the structure for an Ansible playbook with various components like main.yml, vars.yml, tasks/main.yml, handlers/main.yml, templates/README.md, and README.md.
  • Structure name: ansible_playbook
"},{"location":"structures/#cicd-pipelines","title":"CI/CD Pipelines","text":"
  • File: ci-cd-pipelines.yaml
  • Description: Defines the structure for CI/CD pipelines including .gitlab-ci.yml, Jenkinsfile, .github/workflows/ci.yml, and .github/workflows/cd.yml.
  • Structure name: ci_cd_pipelines
"},{"location":"structures/#cloudformation-files","title":"CloudFormation Files","text":"
  • File: cloudformation-files.yaml
  • Description: Contains the structure for AWS CloudFormation files including template.yaml, parameters.json, and deploy.sh.
  • Structure name: cloudformation_files
"},{"location":"structures/#codeowners-configuration","title":"Codeowners Configuration","text":"
  • File: configs/codeowners.yaml
  • Description: Defines the structure for a CODEOWNERS file.
  • Structure name: configs/codeowners
"},{"location":"structures/#devcontainer-configuration","title":"Devcontainer Configuration","text":"
  • File: configs/devcontainer.yaml
  • Description: Contains the structure for a .devcontainer/devcontainer.json file.
  • Structure name: configs/devcontainer
"},{"location":"structures/#editor-config","title":"Editor Config","text":"
  • File: configs/editor-config.yaml
  • Description: Defines the structure for an .editorconfig file.
  • Structure name: configs/editor-config
"},{"location":"structures/#eslint-configuration","title":"ESLint Configuration","text":"
  • File: configs/eslint.yaml
  • Description: Contains the structure for ESLint configuration files including .eslintrc.json and .eslintignore.
  • Structure name: configs/eslint
"},{"location":"structures/#jshint-configuration","title":"JSHint Configuration","text":"
  • File: configs/jshint.yaml
  • Description: Defines the structure for JSHint configuration files including .jshintrc and .jshintignore.
  • Structure name: configs/jshint
"},{"location":"structures/#kubectl-configuration","title":"Kubectl Configuration","text":"
  • File: configs/kubectl.yaml
  • Description: Contains the structure for a .kuberc configuration file.
  • Structure name: configs/kubectl
"},{"location":"structures/#prettier-configuration","title":"Prettier Configuration","text":"
  • File: configs/prettier.yaml
  • Description: Contains the structure for Prettier configuration files including .prettierrc and .prettierignore.
  • Structure name: configs/prettier
"},{"location":"structures/#docker-files","title":"Docker Files","text":"
  • File: docker-files.yaml
  • Description: Defines the structure for Docker-related files including Dockerfile, .dockerignore, docker-compose.yml, and .env.
  • Structure name: docker-files
"},{"location":"structures/#documentation-template","title":"Documentation Template","text":"
  • File: documentation-template.yaml
  • Description: Contains the structure for documentation files including README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and LICENSE.md.
  • Structure name: documentation-template
"},{"location":"structures/#git-hooks","title":"Git Hooks","text":"

  • File: git-hooks.yaml

  • Description: Defines the structure for Git hook scripts including .git/hooks/pre-commit, .git/hooks/pre-push, and .git/hooks/commit-msg.

  • Structure name: git-hooks
"},{"location":"structures/#github-workflows","title":"GitHub Workflows","text":"
  • File: github/workflows/execute-tf-workflow.yaml
  • Description: Contains the structure for a GitHub Actions workflow to execute Terraform.
  • Structure name: github/workflows/execute-terraform-workflow
"},{"location":"structures/#github-labeler-workflow","title":"Github Labeler Workflow","text":"
  • File: github/workflows/labeler.yaml
  • Description: Defines the structure for a GitHub Actions workflow to label issues and pull requests.
  • Structure name: github/workflows/labeler
"},{"location":"structures/#github-stale-workflow","title":"GitHub stale Workflow","text":"
  • File: github/workflows/stale.yaml
  • Description: Contains the structure for a GitHub Actions workflow to mark stale issues and pull requests.
  • Structure name: github/workflows/stale
"},{"location":"structures/#github-pre-commit-workflow","title":"GitHub Pre-commit Workflow","text":"
  • File: github/workflows/pre-commit.yaml
  • Description: Defines the structure for a GitHub Actions workflow to run pre-commit hooks.
  • Structure name: github/workflows/pre-commit
"},{"location":"structures/#github-release-drafter-workflow","title":"GitHub Release Drafter Workflow","text":"
  • File: github/workflows/release-drafter.yaml
  • Description: Contains the structure for a GitHub Actions workflow to draft releases.
  • Structure name: github/workflows/release-drafter
"},{"location":"structures/#github-run-struct-workflow","title":"GitHub Run Struct Workflow","text":"
  • File: github/workflows/run-struct.yaml
  • Description: Defines the structure for a GitHub Actions workflow to run Struct.
  • Structure name: github/workflows/run-struct
"},{"location":"structures/#github-templates","title":"GitHub Templates","text":"
  • File: github/templates.yaml
  • Description: Contains the structure for GitHub templates including ISSUE_TEMPLATE/bug_report.yaml, ISSUE_TEMPLATE/feature_request.yaml, and PULL_REQUEST_TEMPLATE.md.
  • Structure name: github/templates
"},{"location":"structures/#helm-chart","title":"Helm Chart","text":"
  • File: helm-chart.yaml
  • Description: Contains the structure for a Helm chart including Chart.yaml, values.yaml, and various templates.
  • Structure name: helm-chart
"},{"location":"structures/#github-instructions","title":"Github Instructions","text":"
  • File: github/instructions/generic.yaml
  • Description: Defines the structure for generic GitHub instructions. generic.instruction.md
  • Structure name: github/instructions/generic
"},{"location":"structures/#github-generic-prompt","title":"Github generic prompt","text":"
  • File: github/prompt/generic.yaml
  • Description: Contains the structure for a generic GitHub prompt.
  • Structure name: github/prompt/generic
"},{"location":"structures/#github-react-form-prompt","title":"Github react form prompt","text":"
  • File: github/prompt/react-form.yaml
  • Description: Defines the structure for a React form prompt in GitHub.
  • Structure name: github/prompt/react-form
"},{"location":"structures/#github-security-api-prompt","title":"Github security api prompt","text":"
  • File: github/prompt/security-api.yaml
  • Description: Contains the structure for a GitHub security API prompt.
  • Structure name: github/prompt/security-api
"},{"location":"structures/#github-struct-prompt","title":"Github struct prompt","text":"
  • File: github/prompt/struct.yaml
  • Description: Defines the structure for a Struct prompt in GitHub.
  • Structure name: github/prompt/struct
"},{"location":"structures/#kubernetes-manifests","title":"Kubernetes Manifests","text":"
  • File: kubernetes-manifests.yaml
  • Description: Defines the structure for Kubernetes manifests including deployment.yaml, service.yaml, ingress.yaml, configmap.yaml, secrets.yaml, and README.md.
  • Structure name: kubernetes-manifests
"},{"location":"structures/#generic-project","title":"Generic Project","text":"
  • File: project/generic.yaml
  • Description: Contains the structure for a generic project with various configuration files and folders.
  • Structure name: project/generic
"},{"location":"structures/#go-project","title":"Go Project","text":"
  • File: project/go.yaml
  • Description: Defines the structure for a Go project including .editorconfig, .env, .gitignore, LICENSE, README.md, main.go, and various folders.
  • Structure name: project/go
"},{"location":"structures/#java-project","title":"Java Project","text":"
  • File: project/java.yaml
  • Description: Contains the structure for a Java project including .editorconfig, .env, .gitignore, LICENSE, README.md, pom.xml, and various folders.
  • Structure name: project/java
"},{"location":"structures/#nodejs-project","title":"Node.js Project","text":"
  • File: project/nodejs.yaml
  • Description: Defines the structure for a Node.js project.
  • Structure name: project/nodejs
"},{"location":"structures/#python-project","title":"Python Project","text":"
  • File: project/python.yaml
  • Description: Contains the structure for a Python project.
  • Structure name: project/python
"},{"location":"structures/#ruby-project","title":"Ruby Project","text":"
  • File: project/ruby.yaml
  • Description: Defines the structure for a Ruby project.
  • Structure name: project/ruby
"},{"location":"structures/#rust-project","title":"Rust Project","text":"
  • File: project/rust.yaml
  • Description: Contains the structure for a Rust project.
  • Structure name: project/rust
"},{"location":"structures/#aws-accounts-terraform","title":"AWS Accounts Terraform","text":"
  • File: terraform/apps/aws-accounts.yaml
  • Description: Defines the structure for AWS accounts Terraform configuration.
  • Structure name: terraform/apps/aws-accounts
"},{"location":"structures/#environments-terraform","title":"Environments Terraform","text":"
  • File: terraform/apps/environments.yaml
  • Description: Contains the structure for environments Terraform configuration.
  • Structure name: terraform/apps/environments
"},{"location":"structures/#generic-terraform","title":"Generic Terraform","text":"
  • File: terraform/apps/generic.yaml
  • Description: Defines the structure for generic Terraform configuration.
  • Structure name: terraform/apps/generic
"},{"location":"structures/#github-organization-terraform","title":"GitHub Organization Terraform","text":"
  • File: terraform/apps/github-organization.yaml
  • Description: Contains the structure for GitHub organization Terraform configuration.
  • Structure name: terraform/apps/github-organization
"},{"location":"structures/#init-terraform","title":"Init Terraform","text":"
  • File: terraform/apps/init.yaml
  • Description: Defines the structure for init Terraform configuration.
  • Structure name: terraform/apps/init
"},{"location":"structures/#generic-terraform-module","title":"Generic Terraform Module","text":"
  • File: terraform/modules/generic.yaml
  • Description: Contains the structure for a generic Terraform module.
  • Structure name: terraform/modules/generic
"},{"location":"structures/#vagrant-files","title":"Vagrant Files","text":"
  • File: vagrant-files.yaml
  • Description: Defines the structure for Vagrant files.
  • Structure name: vagrant-files
"},{"location":"template-variables/","title":"Template Variables","text":"

Template variables allow you to create dynamic content in your STRUCT configurations. This page covers all aspects of working with variables.

"},{"location":"template-variables/#basic-syntax","title":"Basic Syntax","text":"

Use template variables by enclosing them in {{@ and @}}:

files:\n  - README.md:\n      content: |\n        # {{@ project_name @}}\n        Welcome to {{@ project_name @}}!\n
"},{"location":"template-variables/#block-syntax","title":"Block Syntax","text":"

For control structures, use block notation:

  • Start block: {%@
  • End block: %@}
files:\n  - config.yaml:\n      content: |\n        {%@ if environment == \"production\" @%}\n        debug: false\n        {%@ else @%}\n        debug: true\n        {%@ endif @%}\n
"},{"location":"template-variables/#comments","title":"Comments","text":"

Use comment notation to document your templates:

  • Start comment: {#@
  • End comment: @#}
files:\n  - app.py:\n      content: |\n        {#@ This is a template comment @#}\n        app_name = \"{{@ project_name @}}\"\n
"},{"location":"template-variables/#default-variables","title":"Default Variables","text":"

STRUCT provides these built-in variables:

  • file_name: The name of the file being processed
  • file_directory: The directory containing the file being processed
"},{"location":"template-variables/#interactive-variables","title":"Interactive Variables","text":"

Define variables that prompt users for input:

variables:\n  - project_name:\n      description: \"The name of your project\"\n      type: string\n      default: \"MyProject\"\n  - author_name:\n      description: \"Your name\"\n      type: string\n      # No default = interactive prompt\n  - port:\n      description: \"Application port\"\n      type: integer\n      default: 8080\n
"},{"location":"template-variables/#variable-types","title":"Variable Types","text":"
  • string: Text values
  • integer: Numeric values
  • boolean: True/false values
"},{"location":"template-variables/#custom-jinja2-filters","title":"Custom Jinja2 Filters","text":"

STRUCT includes custom filters for common tasks:

"},{"location":"template-variables/#latest_release","title":"latest_release","text":"

Fetch the latest release version from GitHub:

files:\n  - Dockerfile:\n      content: |\n        FROM node:{{@ \"nodejs/node\" | latest_release @}}\n

Requirements: Set GITHUB_TOKEN environment variable for private repos.

"},{"location":"template-variables/#slugify","title":"slugify","text":"

Convert strings to URL-friendly slugs:

files:\n  - \"{{@ project_name | slugify @}}.conf\":\n      content: |\n        server_name {{@ project_name | slugify @}};\n

Options: Optional separator character (default: -)

"},{"location":"template-variables/#default_branch","title":"default_branch","text":"

Get the default branch name of a GitHub repository:

files:\n  - .github/workflows/ci.yml:\n      content: |\n        on:\n          push:\n            branches: [ {{@ \"httpdss/struct\" | default_branch @}} ]\n
"},{"location":"template-variables/#the-with-clause","title":"The with Clause","text":"

Pass additional variables to nested structures:

folders:\n  - frontend/:\n      struct: project/react\n      with:\n        app_name: \"{{@ project_name @}}-frontend\"\n        port: 3000\n  - backend/:\n      struct: project/node\n      with:\n        app_name: \"{{@ project_name @}}-backend\"\n        port: 8000\n

Variables defined in with are merged with global variables and take precedence.

"},{"location":"template-variables/#advanced-examples","title":"Advanced Examples","text":""},{"location":"template-variables/#conditional-file-creation","title":"Conditional File Creation","text":"
files:\n  - docker-compose.yml:\n      skip: \"{{@ not use_docker @}}\"\n      content: |\n        version: '3.8'\n        services:\n          app:\n            image: {{@ project_name | slugify @}}:latest\n
"},{"location":"template-variables/#dynamic-file-names","title":"Dynamic File Names","text":"
files:\n  - \"src/{{@ module_name @}}/index.js\":\n      content: |\n        // {{@ module_name @}} module\n        export default {};\n
"},{"location":"template-variables/#environment-specific-content","title":"Environment-Specific Content","text":"
files:\n  - config/{{@ environment @}}.yml:\n      content: |\n        {%@ if environment == \"production\" @%}\n        database_url: {{@ production_db_url @}}\n        {%@ else @%}\n        database_url: sqlite:///dev.db\n        {%@ endif @%}\n
"},{"location":"usage/","title":"Basic Usage","text":"

Run the script with the following command using one of the following subcommands:

  • generate: Generate the project structure based on the YAML configuration.
  • generate-schema: Generate JSON schema for available structure templates.
  • validate: Validate the YAML configuration file.
  • info: Display information about the script and its dependencies.
  • list: List the available structs

For more information, run the script with the -h or --help option (this is also available for each subcommand):

struct -h\n
"},{"location":"usage/#generate-command","title":"Generate Command","text":""},{"location":"usage/#finding-available-structures","title":"Finding Available Structures","text":"

Use the list command to see all available structures:

struct list\n

Or if you have auto-completion enabled, use Tab to see all options:

struct generate <Tab>\n# Shows all available structures\n
"},{"location":"usage/#simple-example","title":"Simple Example","text":"
struct generate terraform/modules/generic ./my-terraform-module\n
"},{"location":"usage/#yaml-file-usage","title":"YAML File Usage","text":"

For local YAML configuration files, the file:// protocol is automatically added:

# Both of these work identically\nstruct generate my-config.yaml ./output\nstruct generate file://my-config.yaml ./output\n
"},{"location":"usage/#complete-example","title":"Complete Example","text":"
struct generate \\\n  --log=DEBUG \\\n  --dry-run \\\n  --backup=/path/to/backup \\\n  --file-strategy=rename \\\n  --log-file=/path/to/logfile.log \\\n  terraform-module \\\n  ./my-terraform-module\n
"},{"location":"usage/#command-options","title":"Command Options","text":"
  • --log: Set logging level (DEBUG, INFO, WARNING, ERROR)
  • --dry-run: Preview actions without making changes
  • --backup: Specify backup directory for existing files
  • --file-strategy: Choose how to handle existing files (overwrite, skip, append, rename, backup)
  • --log-file: Write logs to specified file
  • --mappings-file: Provide external mappings file (can be used multiple times)
"},{"location":"usage/#generate-schema-command","title":"Generate Schema Command","text":"

The generate-schema command creates JSON schema definitions for available structure templates, making it easier for tools and IDEs to provide autocompletion and validation.

"},{"location":"usage/#basic-usage-of-generate-schema","title":"Basic Usage of generate-schema","text":"
# Generate schema to stdout\nstruct generate-schema\n\n# Generate schema with custom structures path\nstruct generate-schema -s /path/to/custom/structures\n\n# Save schema to file\nstruct generate-schema -o schema.json\n\n# Combine custom path and output file\nstruct generate-schema -s /path/to/custom/structures -o schema.json\n
"},{"location":"usage/#command-options-for-generate-schema","title":"Command Options for generate-schema","text":"
  • -s, --structures-path: Path to additional structure definitions (optional)
  • -o, --output: Output file path for the schema (default: stdout)

The generated schema includes all available structures from both the built-in contribs directory and any custom structures path you specify. This is useful for:

  • IDE autocompletion when writing .struct.yaml files
  • Validation of structure references in your configurations
  • Programmatic discovery of available templates
"},{"location":"usage/#other-commands","title":"Other Commands","text":""},{"location":"usage/#validate-configuration","title":"Validate Configuration","text":"
struct validate my-structure.yaml\n
"},{"location":"usage/#list-available-structures","title":"List Available Structures","text":"
struct list\n
"},{"location":"usage/#show-information","title":"Show Information","text":"
struct info <structure_definition>\n
"},{"location":"examples/","title":"Examples","text":"

This page contains practical examples of STRUCT configurations for various use cases.

"},{"location":"examples/#basic-examples","title":"Basic Examples","text":""},{"location":"examples/#simple-project","title":"Simple Project","text":"

Basic project structure with files and folders:

# Example: Simple Project Structure\n# Use case: Basic project setup with common files\n\nfiles:\n  - README.md:\n      content: |\n        # {{@ project_name | default('My Project') @}}\n\n        Welcome to the project!\n\n        ## Getting Started\n\n        1. Install dependencies\n        2. Run the application\n        3. Enjoy!\n\n  - .gitignore:\n      content: |\n        node_modules/\n        *.log\n        .env\n        dist/\n\n  - LICENSE:\n      content: |\n        MIT License\n\n        Copyright (c) {{@ year | default('2024') @}} {{@ author | default('Project Author') @}}\n\nfolders:\n  - src/:\n      struct:\n        - basic/folder\n  - docs/:\n      struct:\n        - basic/folder\n\nvariables:\n  - project_name:\n      description: 'Name of the project'\n      type: string\n      default: 'My Project'\n  - author:\n      description: 'Project author'\n      type: string\n      default: 'Project Author'\n  - year:\n      description: 'Copyright year'\n      type: string\n      default: '2024'\n
"},{"location":"examples/#template-variables","title":"Template Variables","text":"

Using dynamic content with variables:

# Example: Template Variables\n# Use case: Dynamic content generation with user input\n\nfiles:\n  - package.json:\n      content: |\n        {\n          \"name\": \"{{@ package_name @}}\",\n          \"version\": \"{{@ version | default('1.0.0') @}}\",\n          \"description\": \"{{@ description @}}\",\n          \"author\": \"{{@ author @}}\",\n          \"license\": \"{{@ license | default('MIT') @}}\"\n        }\n\n  - src/config.js:\n      content: |\n        module.exports = {\n          appName: '{{@ app_name @}}',\n          version: '{{@ version | default('1.0.0') @}}',\n          environment: '{{@ environment | default('development') @}}'\n        };\n\nvariables:\n  - package_name:\n      description: 'NPM package name'\n      type: string\n      required: true\n  - app_name:\n      description: 'Application display name'\n      type: string\n      required: true\n  - description:\n      description: 'Project description'\n      type: string\n      required: true\n  - author:\n      description: 'Package author'\n      type: string\n      required: true\n  - version:\n      description: 'Initial version'\n      type: string\n      default: '1.0.0'\n  - license:\n      description: 'License type'\n      type: string\n      default: 'MIT'\n  - environment:\n      description: 'Target environment'\n      type: string\n      default: 'development'\n
"},{"location":"examples/#remote-files","title":"Remote Files","text":"

Fetching content from external sources:

# Example: Remote Files\n# Use case: Including content from external URLs or repositories\n\nfiles:\n  - .gitignore:\n      remote: 'https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore'\n\n  - CODE_OF_CONDUCT.md:\n      remote: 'https://raw.githubusercontent.com/contributor-covenant/contributor-covenant/main/CODE_OF_CONDUCT.md'\n\n  - CONTRIBUTING.md:\n      content: |\n        # Contributing to {{@ project_name @}}\n\n        Thank you for your interest in contributing!\n\n        ## Development Setup\n\n        1. Fork the repository\n        2. Clone your fork\n        3. Install dependencies\n        4. Make your changes\n        5. Submit a pull request\n\nvariables:\n  - project_name:\n      description: 'Project name'\n      type: string\n      required: true\n
"},{"location":"examples/#application-development","title":"Application Development","text":""},{"location":"examples/#python-project","title":"Python Project","text":"

Complete Python application structure:

# Example: Python Project\n# Use case: Full Python application with proper structure\n\nfiles:\n  - README.md:\n      content: |\n        # {{@ project_name @}}\n\n        {{@ description @}}\n\n        ## Installation\n\n        ```bash\n        pip install -r requirements.txt\n        ```\n\n        ## Usage\n\n        ```bash\n        python -m {{@ package_name @}}\n        ```\n\n  - requirements.txt:\n      content: |\n        click>=8.0.0\n        requests>=2.25.0\n        pytest>=6.0.0\n\n  - setup.py:\n      content: |\n        from setuptools import setup, find_packages\n\n        setup(\n            name=\"{{@ package_name @}}\",\n            version=\"{{@ version | default('0.1.0') @}}\",\n            description=\"{{@ description @}}\",\n            author=\"{{@ author @}}\",\n            packages=find_packages(),\n            install_requires=[\n                \"click>=8.0.0\",\n                \"requests>=2.25.0\",\n            ],\n            entry_points={\n                \"console_scripts\": [\n                    \"{{@ package_name @}}={{@ package_name @}}.cli:main\",\n                ],\n            },\n        )\n\n  - '{{@ package_name @}}/__init__.py':\n      content: |\n        \"\"\"{{@ description @}}\"\"\"\n        __version__ = \"{{@ version | default('0.1.0') @}}\"\n\n  - '{{@ package_name @}}/main.py':\n      content: |\n        \"\"\"Main application module.\"\"\"\n\n        def main():\n            \"\"\"Main entry point.\"\"\"\n            print(\"Hello from {{@ project_name @}}!\")\n\n        if __name__ == \"__main__\":\n            main()\n\n  - tests/test_main.py:\n      content: |\n        \"\"\"Tests for main module.\"\"\"\n        import pytest\n        from {{@ package_name @}} import main\n\n        def test_main():\n            \"\"\"Test main function.\"\"\"\n            # Add your tests here\n            assert True\n\nvariables:\n  - project_name:\n      description: 'Project name'\n      type: string\n      required: true\n  - package_name:\n      description: 'Python package name'\n      type: string\n      required: true\n  - description:\n      description: 'Project description'\n      type: string\n      required: true\n  - author:\n      description: 'Project author'\n      type: string\n      required: true\n  - version:\n      description: 'Initial version'\n      type: string\n      default: '0.1.0'\n
"},{"location":"examples/#nodejs-api","title":"Node.js API","text":"

REST API with Express.js:

# Example: Node.js API\n# Use case: Express.js REST API with proper structure\n\nfiles:\n  - package.json:\n      content: |\n        {\n          \"name\": \"{{@ package_name @}}\",\n          \"version\": \"{{@ version | default('1.0.0') @}}\",\n          \"description\": \"{{@ description @}}\",\n          \"main\": \"src/app.js\",\n          \"scripts\": {\n            \"start\": \"node src/app.js\",\n            \"dev\": \"nodemon src/app.js\",\n            \"test\": \"jest\"\n          },\n          \"dependencies\": {\n            \"express\": \"^4.18.0\",\n            \"cors\": \"^2.8.5\",\n            \"helmet\": \"^6.0.0\",\n            \"dotenv\": \"^16.0.0\"\n          },\n          \"devDependencies\": {\n            \"nodemon\": \"^2.0.20\",\n            \"jest\": \"^29.0.0\",\n            \"supertest\": \"^6.3.0\"\n          }\n        }\n\n  - src/app.js:\n      content: |\n        const express = require('express');\n        const cors = require('cors');\n        const helmet = require('helmet');\n        require('dotenv').config();\n\n        const app = express();\n        const PORT = process.env.PORT || 3000;\n\n        // Middleware\n        app.use(helmet());\n        app.use(cors());\n        app.use(express.json());\n\n        // Routes\n        app.get('/', (req, res) => {\n          res.json({ message: 'Welcome to {{@ project_name @}} API' });\n        });\n\n        app.get('/api/health', (req, res) => {\n          res.json({ status: 'OK', timestamp: new Date().toISOString() });\n        });\n\n        app.listen(PORT, () => {\n          console.log(`{{@ project_name @}} API running on port ${PORT}`);\n        });\n\n        module.exports = app;\n\n  - .env.example:\n      content: |\n        PORT=3000\n        NODE_ENV=development\n\nvariables:\n  - project_name:\n      description: 'Project name'\n      type: string\n      required: true\n  - package_name:\n      description: 'NPM package name'\n      type: string\n      required: true\n  - description:\n      description: 'API description'\n      type: string\n      required: true\n  - version:\n      description: 'Initial version'\n      type: string\n      default: '1.0.0'\n
"},{"location":"examples/#usage","title":"Usage","text":"

To use these examples:

  1. Copy the YAML content from any example above
  2. Save it to a file (e.g., my-structure.yaml)
  3. Run struct generate with your file:
# Create your structure file\ncat > my-structure.yaml << 'EOF'\n# Paste the YAML content here\nEOF\n\n# Generate your project\nstruct generate file://my-structure.yaml ./my-project\n
"},{"location":"examples/#quick-start-with-template-variables","title":"Quick Start with Template Variables","text":"
# Generate with custom variables\nstruct generate -v \"project_name=MyApp,author=John Doe\" file://my-structure.yaml ./my-project\n
"},{"location":"examples/#contributing-examples","title":"Contributing Examples","text":"

We welcome community examples! To contribute:

  1. Create a new .yaml file in this directory
  2. Follow the naming convention: descriptive-name.yaml
  3. Include comments explaining key concepts
  4. Add the example to this index
  5. Submit a pull request
"},{"location":"examples/#example-template","title":"Example Template","text":"
# Example: [Brief Description]\n# Use case: [What this example demonstrates]\n# Requirements: [Any prerequisites or dependencies]\n\nfiles:\n  - README.md:\n      content: |\n        # Example Project\n        This demonstrates [key concept]\n\nvariables:\n  - example_var:\n      description: 'Example variable'\n      type: string\n      default: 'example_value'\n
"},{"location":"vhs/","title":"STRUCT VHS Demo Tapes","text":"

This directory contains VHS tape files for creating animated GIF demonstrations of STRUCT's features. These tapes showcase various use cases and capabilities of the STRUCT tool.

"},{"location":"vhs/#available-tapes","title":"\ud83c\udfac Available Tapes","text":""},{"location":"vhs/#1-installation-setup","title":"1. Installation & Setup","text":"

File: install.tape Duration: ~30 seconds Description: Shows how to install STRUCT using pip and verify the installation.

"},{"location":"vhs/#2-basic-usage","title":"2. Basic Usage","text":"

File: basic-usage.tape Description: Demonstrates basic STRUCT commands like list, info, and simple project generation.

Output docs/vhs/basic-usage.gif\n\nSet Theme \"Monokai Vivid\"\nSet FontSize 14\nSet TypingSpeed 40ms\nSet WindowBar Colorful\nSet BorderRadius 8\nSet Margin 0\nSet Padding 10\nSet Width 1400\nSet Height 800\nSet Shell \"bash\"\n\nType \"# Explore available structures\" Enter\nType \"struct list\" Enter\nSleep 3\nType \"\" Enter\nType \"# Get information about a specific structure\" Enter\nType \"struct info terraform/module\" Enter\nSleep 5\nType \"\" Enter\nType \"# Generate a simple project structure\" Enter\nType \"struct generate terraform/module ./my-terraform-module\" Enter\nSleep 8\nType \"\" Enter\nType \"# Verify the generated structure\" Enter\nType \"tree my-terraform-module\" Enter\nSleep 5\n
"},{"location":"vhs/#3-yaml-configuration","title":"3. YAML Configuration","text":"

File: yaml-config.tape Description: Shows how to create and use custom YAML configuration files.

Output docs/vhs/yaml-config.gif\n\nSet Theme \"Monokai Vivid\"\nSet FontSize 14\nSet TypingSpeed 40ms\nSet WindowBar Colorful\nSet BorderRadius 8\nSet Margin 0\nSet Padding 10\nSet Width 1400\nSet Height 800\nSet Shell \"bash\"\n\nType \"# Create a custom YAML configuration\" Enter\nType \"cat > my-project.yaml << 'EOF'\" Enter\nType \"files:\" Enter\nType \"  - README.md:\" Enter\nType \"      content: |\" Enter\nType \"        # {{@ project_name @}}\" Enter\nType \"        Welcome to my awesome project!\" Enter\nType \"  - src/main.py:\" Enter\nType \"      content: |\" Enter\nType \"        print('Hello from {{@ project_name @}}!')\" Enter\nType \"\" Enter\nType \"variables:\" Enter\nType \"  - project_name:\" Enter\nType \"      description: 'Name of your project'\" Enter\nType \"      type: string\" Enter\nType \"      default: 'MyProject'\" Enter\nType \"EOF\" Enter\nSleep 2\nType \"\" Enter\nType \"# Generate structure from YAML (note: file:// is automatic)\" Enter\nType \"struct generate my-project.yaml ./output\" Enter\nSleep 5\nType \"\" Enter\nType \"# Check the generated files\" Enter\nType \"tree output && echo && cat output/README.md\" Enter\nSleep 5\n
"},{"location":"vhs/#4-mappings-variables","title":"4. Mappings & Variables","text":"

File: mappings-demo.tape Description: Demonstrates external mappings files and template variables.

Output docs/vhs/mappings-demo.gif\n\nSet Theme \"Monokai Vivid\"\nSet FontSize 14\nSet TypingSpeed 40ms\nSet WindowBar Colorful\nSet BorderRadius 8\nSet Margin 0\nSet Padding 10\nSet Width 1400\nSet Height 800\nSet Shell \"bash\"\n\nType \"# Create mappings file for environment variables\" Enter\nType \"cat > mappings.yaml << 'EOF'\" Enter\nType \"mappings:\" Enter\nType \"  environments:\" Enter\nType \"    dev:\" Enter\nType \"      database_url: 'postgres://localhost:5432/myapp_dev'\" Enter\nType \"      debug: true\" Enter\nType \"    prod:\" Enter\nType \"      database_url: 'postgres://prod-server:5432/myapp'\" Enter\nType \"      debug: false\" Enter\nType \"  teams:\" Enter\nType \"    devops: 'devops-team@company.com'\" Enter\nType \"    frontend: 'frontend-team@company.com'\" Enter\nType \"EOF\" Enter\nSleep 2\nType \"\" Enter\nType \"# Create structure that uses mappings\" Enter\nType \"cat > app-config.yaml << 'EOF'\" Enter\nType \"files:\" Enter\nType \"  - config/{{@ env @}}.json:\" Enter\nType \"      content: |\" Enter\nType \"        {\" Enter\nType \"          \\\"database_url\\\": \\\"{{@ mappings.environments[env].database_url @}}\\\",\" Enter\nType \"          \\\"debug\\\": {{@ mappings.environments[env].debug @}},\" Enter\nType \"          \\\"contact\\\": \\\"{{@ mappings.teams.devops @}}\\\"\" Enter\nType \"        }\" Enter\nType \"variables:\" Enter\nType \"  - env:\" Enter\nType \"      description: 'Environment (dev/prod)'\" Enter\nType \"      type: string\" Enter\nType \"      default: 'dev'\" Enter\nType \"EOF\" Enter\nSleep 3\nType \"\" Enter\nType \"# Generate with mappings file\" Enter\nType \"struct generate --mappings-file mappings.yaml app-config.yaml ./config-output\" Enter\nSleep 5\nType \"\" Enter\nType \"# Check generated configuration\" Enter\nType \"cat config-output/config/dev.json\" Enter\nSleep 3\n
"},{"location":"vhs/#5-multiple-mappings-files","title":"5. Multiple Mappings Files","text":"

File: multiple-mappings.tape Description: Shows the new multiple mappings file feature with deep merging.

Output docs/vhs/multiple-mappings.gif\n\nSet Theme \"Monokai Vivid\"\nSet FontSize 14\nSet TypingSpeed 40ms\nSet WindowBar Colorful\nSet BorderRadius 8\nSet Margin 0\nSet Padding 10\nSet Width 1400\nSet Height 800\nSet Shell \"bash\"\n\nType \"# Create base mappings file\" Enter\nType \"cat > base-mappings.yaml << 'EOF'\" Enter\nType \"mappings:\" Enter\nType \"  common:\" Enter\nType \"    app_name: 'MyApp'\" Enter\nType \"    version: '1.0.0'\" Enter\nType \"  environments:\" Enter\nType \"    dev:\" Enter\nType \"      replicas: 1\" Enter\nType \"EOF\" Enter\nSleep 2\nType \"\" Enter\nType \"# Create environment-specific overrides\" Enter\nType \"cat > prod-mappings.yaml << 'EOF'\" Enter\nType \"mappings:\" Enter\nType \"  environments:\" Enter\nType \"    dev:\" Enter\nType \"      debug: true\" Enter\nType \"    prod:\" Enter\nType \"      replicas: 3\" Enter\nType \"      debug: false\" Enter\nType \"EOF\" Enter\nSleep 2\nType \"\" Enter\nType \"# Create deployment template\" Enter\nType \"cat > deployment.yaml << 'EOF'\" Enter\nType \"files:\" Enter\nType \"  - k8s/deployment.yaml:\" Enter\nType \"      content: |\" Enter\nType \"        apiVersion: apps/v1\" Enter\nType \"        kind: Deployment\" Enter\nType \"        metadata:\" Enter\nType \"          name: {{@ mappings.common.app_name @}}\" Enter\nType \"        spec:\" Enter\nType \"          replicas: {{@ mappings.environments[env].replicas @}}\" Enter\nType \"variables:\" Enter\nType \"  - env:\" Enter\nType \"      description: 'Target environment'\" Enter\nType \"      default: 'dev'\" Enter\nType \"EOF\" Enter\nSleep 3\nType \"\" Enter\nType \"# Generate with multiple mappings files (deep merge)\" Enter\nType \"struct generate \\\\\" Enter\nType \"  --mappings-file base-mappings.yaml \\\\\" Enter\nType \"  --mappings-file prod-mappings.yaml \\\\\" Enter\nType \"  deployment.yaml ./k8s-output\" Enter\nSleep 5\nType \"\" Enter\nType \"# Check the merged result\" Enter\nType \"cat k8s-output/k8s/deployment.yaml\" Enter\nSleep 3\n
"},{"location":"vhs/#6-advanced-features","title":"6. Advanced Features","text":"

File: advanced-features.tape Description: Demonstrates dry-run, file strategies, and validation.

Output docs/vhs/advanced-features.gif\n\nSet Theme \"Monokai Vivid\"\nSet FontSize 14\nSet TypingSpeed 40ms\nSet WindowBar Colorful\nSet BorderRadius 8\nSet Margin 0\nSet Padding 10\nSet Width 1400\nSet Height 800\nSet Shell \"bash\"\n\nType \"# Create a test structure\" Enter\nType \"mkdir -p existing-project && echo 'old content' > existing-project/README.md\" Enter\nSleep 1\nType \"\" Enter\nType \"# Use dry-run to preview changes\" Enter\nType \"struct generate --dry-run terraform/module ./existing-project\" Enter\nSleep 5\nType \"\" Enter\nType \"# Validate a YAML configuration\" Enter\nType \"cat > test-config.yaml << 'EOF'\" Enter\nType \"files:\" Enter\nType \"  - test.txt:\" Enter\nType \"      content: 'Hello World'\" Enter\nType \"EOF\" Enter\nSleep 2\nType \"struct validate test-config.yaml\" Enter\nSleep 3\nType \"\" Enter\nType \"# Generate with backup strategy\" Enter\nType \"struct generate --file-strategy=backup --backup=./backups terraform/module ./existing-project\" Enter\nSleep 5\nType \"\" Enter\nType \"# Check backup was created\" Enter\nType \"ls -la backups/ && echo && echo 'New content:' && head existing-project/README.md\" Enter\nSleep 3\n
"},{"location":"vhs/#7-remote-content-protocols","title":"7. Remote Content & Protocols","text":"

File: remote-content.tape Description: Shows fetching content from remote sources (GitHub, HTTP, etc.).

Output docs/vhs/remote-content.gif\n\nSet Theme \"Monokai Vivid\"\nSet FontSize 14\nSet TypingSpeed 40ms\nSet WindowBar Colorful\nSet BorderRadius 8\nSet Margin 0\nSet Padding 10\nSet Width 1400\nSet Height 800\nSet Shell \"bash\"\n\nType \"# Create structure using remote content\" Enter\nType \"cat > remote-demo.yaml << 'EOF'\" Enter\nType \"files:\" Enter\nType \"  - .gitignore:\" Enter\nType \"      file: github://github/gitignore/main/Python.gitignore\" Enter\nType \"  - LICENSE:\" Enter\nType \"      file: https://raw.githubusercontent.com/licenses/license-templates/master/templates/mit.txt\" Enter\nType \"  - README.md:\" Enter\nType \"      content: |\" Enter\nType \"        # {{@ project_name @}}\" Enter\nType \"        \" Enter\nType \"        This project uses remote content from GitHub.\" Enter\nType \"variables:\" Enter\nType \"  - project_name:\" Enter\nType \"      description: 'Project name'\" Enter\nType \"      default: 'RemoteDemo'\" Enter\nType \"EOF\" Enter\nSleep 3\nType \"\" Enter\nType \"# Generate project with remote content\" Enter\nType \"struct generate remote-demo.yaml ./remote-project\" Enter\nSleep 8\nType \"\" Enter\nType \"# Check downloaded content\" Enter\nType \"echo 'Generated files:' && ls -la remote-project/\" Enter\nType \"echo && echo 'First few lines of .gitignore:' && head -10 remote-project/.gitignore\" Enter\nSleep 5\n
"},{"location":"vhs/#8-schema-generation","title":"8. Schema Generation","text":"

File: schema-generation.tape Description: Demonstrates the generate-schema command for IDE integration.

Output docs/vhs/schema-generation.gif\n\nSet Theme \"Monokai Vivid\"\nSet FontSize 14\nSet TypingSpeed 40ms\nSet WindowBar Colorful\nSet BorderRadius 8\nSet Margin 0\nSet Padding 10\nSet Width 1400\nSet Height 800\nSet Shell \"bash\"\n\nType \"# Generate JSON schema for available structures\" Enter\nType \"struct generate-schema\" Enter\nSleep 5\nType \"\" Enter\nType \"# Save schema to file for IDE integration\" Enter\nType \"struct generate-schema -o struct-schema.json\" Enter\nSleep 3\nType \"\" Enter\nType \"# Check the generated schema\" Enter\nType \"echo 'Schema file created:' && ls -la struct-schema.json\" Enter\nType \"echo && echo 'Available structures in schema:' && jq -r '.definitions.PluginList.enum[]' struct-schema.json | head -10\" Enter\nSleep 5\nType \"\" Enter\nType \"# Schema can be used in VS Code for autocompletion\" Enter\nType \"echo 'Add to your .struct.yaml files for IDE support:'\" Enter\nType \"echo '# yaml-language-server: \\$schema=./struct-schema.json'\" Enter\nSleep 3\n
"},{"location":"vhs/#creating-the-gifs","title":"\ud83c\udfa5 Creating the GIFs","text":"

To generate all the GIF animations, run:

# Install VHS if not already installed\ngo install github.com/charmbracelet/vhs@latest\n\n# Generate all tapes\ncd docs/vhs\nvhs install.tape\nvhs basic-usage.tape\nvhs yaml-config.tape\nvhs mappings-demo.tape\nvhs multiple-mappings.tape\nvhs advanced-features.tape\nvhs remote-content.tape\nvhs schema-generation.tape\n
"},{"location":"vhs/#usage-in-documentation","title":"\ud83d\udcd6 Usage in Documentation","text":"

These GIFs can be embedded in:

  • README.md - Show installation and basic usage
  • docs/quickstart.md - Include basic-usage.gif
  • docs/mappings.md - Include mappings-demo.gif and multiple-mappings.gif
  • docs/configuration.md - Include yaml-config.gif
  • docs/file-handling.md - Include advanced-features.gif
  • docs/schema.md - Include schema-generation.gif

Example markdown embedding:

![STRUCT Basic Usage](./docs/vhs/basic-usage.gif)\n
"},{"location":"vhs/#vhs-configuration","title":"\u2699\ufe0f VHS Configuration","text":"

All tapes use consistent settings:

  • Theme: Monokai Vivid
  • Font Size: 14
  • Typing Speed: 40ms
  • Dimensions: 1400x800
  • Shell: bash
"},{"location":"vhs/#updating-tapes","title":"\ud83d\udd04 Updating Tapes","text":"

When STRUCT features change:

  1. Update the relevant tape file
  2. Regenerate the GIF: vhs filename.tape
  3. Commit both the tape and GIF files
  4. Update documentation references if needed

These demonstrations provide comprehensive coverage of STRUCT's capabilities, from basic usage to advanced features like multiple mappings files, remote content fetching, and schema generation.

"}]} diff --git a/site/sitemap.xml b/site/sitemap.xml index 773ff5c..f929f1f 100644 --- a/site/sitemap.xml +++ b/site/sitemap.xml @@ -1,208 +1,95 @@ - - - - - https://httpdss.github.io/struct/ - 2025-07-28 - weekly - 1.0 - - - - https://httpdss.github.io/struct/demos/basic-usage.gif - STRUCT Basic Usage Demo - Basic Project Generation with STRUCT - - - - https://httpdss.github.io/struct/demos/yaml-config.gif - STRUCT YAML Configuration Demo - YAML Configuration Creation - - - - https://httpdss.github.io/struct/demos/mappings-demo.gif - STRUCT Mappings Demo - External Mappings Usage - - - - https://httpdss.github.io/struct/demos/remote-content.gif - STRUCT Remote Content Demo - Remote Content Fetching - - - - https://httpdss.github.io/struct/demos/advanced-features.gif - STRUCT Advanced Features Demo - Advanced Features and Hooks - - - - - - - https://httpdss.github.io/struct/docs/configuration - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/hooks - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/development - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/vhs/index.html - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/template-vriables - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/known-issues - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/articles - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/404 - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/installtion - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/schema - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/usage - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/completion - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/structures - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/contributing - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/github-integration - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/examples/index.html - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/file-handling - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/ - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/mappings - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/quickstart - 2025-08-02 - weekly - 0.8 - - - - https://httpdss.github.io/struct/docs/funding - 2025-08-02 - weekly - 0.8 - - - - - https://httpdss.github.io/struct/docs/cli-reference - 2025-08-02 - weekly - 0.9 - - - - https://httpdss.github.io/struct/docs/custom-structures - 2025-08-02 - weekly - 0.9 - - + + + https://structio.netlify.app/ + 2025-08-05 + + + https://structio.netlify.app/articles/ + 2025-08-05 + + + https://structio.netlify.app/cli-reference/ + 2025-08-05 + + + https://structio.netlify.app/completion/ + 2025-08-05 + + + https://structio.netlify.app/configuration/ + 2025-08-05 + + + https://structio.netlify.app/contributing/ + 2025-08-05 + + + https://structio.netlify.app/custom-structures/ + 2025-08-05 + + + https://structio.netlify.app/development/ + 2025-08-05 + + + https://structio.netlify.app/file-handling/ + 2025-08-05 + + + https://structio.netlify.app/funding/ + 2025-08-05 + + + https://structio.netlify.app/github-integration/ + 2025-08-05 + + + https://structio.netlify.app/hooks/ + 2025-08-05 + + + https://structio.netlify.app/installation/ + 2025-08-05 + + + https://structio.netlify.app/known-issues/ + 2025-08-05 + + + https://structio.netlify.app/mappings/ + 2025-08-05 + + + https://structio.netlify.app/mcp-integration/ + 2025-08-05 + + + https://structio.netlify.app/quickstart/ + 2025-08-05 + + + https://structio.netlify.app/schema/ + 2025-08-05 + + + https://structio.netlify.app/structures/ + 2025-08-05 + + + https://structio.netlify.app/template-variables/ + 2025-08-05 + + + https://structio.netlify.app/usage/ + 2025-08-05 + + + https://structio.netlify.app/examples/ + 2025-08-05 + + + https://structio.netlify.app/vhs/ + 2025-08-05 + diff --git a/site/sitemap.xml.gz b/site/sitemap.xml.gz new file mode 100644 index 0000000..98c259a Binary files /dev/null and b/site/sitemap.xml.gz differ diff --git a/site/structured-data.json b/site/structured-data.json deleted file mode 100644 index f446be6..0000000 --- a/site/structured-data.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "@context": "https://schema.org", - "@type": "SoftwareApplication", - "name": "STRUCT", - "applicationCategory": "DeveloperApplication", - "applicationSubCategory": "Code Generator", - "description": "Powerful, flexible tool for automating project structure creation through YAML configurations. Generate consistent project layouts, boilerplate code, and configurations with template variables.", - "operatingSystem": "Cross-platform", - "programmingLanguage": "Python", - "downloadUrl": "https://github.com/httpdss/struct", - "codeRepository": "https://github.com/httpdss/struct", - "url": "https://httpdss.github.io/struct/", - "author": { - "@type": "Organization", - "name": "httpdss", - "url": "https://github.com/httpdss" - }, - "maintainer": { - "@type": "Organization", - "name": "httpdss", - "url": "https://github.com/httpdss" - }, - "license": "https://opensource.org/licenses/Apache-2.0", - "keywords": [ - "project structure", - "automation", - "YAML", - "template", - "boilerplate", - "code generator", - "infrastructure", - "scaffolding", - "developer tools", - "CLI" - ], - "offers": { - "@type": "Offer", - "price": "0", - "priceCurrency": "USD", - "availability": "https://schema.org/InStock" - }, - "softwareVersion": "1.0", - "releaseNotes": "Initial release with YAML-based project structure generation", - "screenshot": "https://httpdss.github.io/struct/demos/basic-usage.gif", - "featureList": [ - "YAML-Based Configuration", - "Template Variables with Jinja2", - "Remote Content Fetching", - "Smart File Handling", - "Automation Hooks", - "Dry Run Mode", - "Configuration Validation", - "Cross-platform Support" - ], - "requirements": "Python 3.8+", - "installUrl": "https://httpdss.github.io/struct/docs/installation/", - "supportingData": { - "@type": "Dataset", - "name": "STRUCT Documentation", - "description": "Complete documentation and examples for STRUCT", - "url": "https://httpdss.github.io/struct/docs/" - } -} diff --git a/site/structures/index.html b/site/structures/index.html new file mode 100644 index 0000000..489648c --- /dev/null +++ b/site/structures/index.html @@ -0,0 +1,2287 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Custom Structures - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

List of Structures in struct_module/contribs

+

Ansible Playbook

+
    +
  • File: ansible-playbook.yaml
    • +
  • Description: Contains the structure for an Ansible playbook with various components like main.yml, vars.yml, tasks/main.yml, handlers/main.yml, templates/README.md, and README.md.
    • +
  • Structure name: ansible_playbook
    • +
+

CI/CD Pipelines

+
    +
  • File: ci-cd-pipelines.yaml
    • +
  • Description: Defines the structure for CI/CD pipelines including .gitlab-ci.yml, Jenkinsfile, .github/workflows/ci.yml, and .github/workflows/cd.yml.
    • +
  • Structure name: ci_cd_pipelines
    • +
+

CloudFormation Files

+
    +
  • File: cloudformation-files.yaml
    • +
  • Description: Contains the structure for AWS CloudFormation files including template.yaml, parameters.json, and deploy.sh.
    • +
  • Structure name: cloudformation_files
    • +
+

Codeowners Configuration

+
    +
  • File: configs/codeowners.yaml
    • +
  • Description: Defines the structure for a CODEOWNERS file.
    • +
  • Structure name: configs/codeowners
    • +
+

Devcontainer Configuration

+
    +
  • File: configs/devcontainer.yaml
    • +
  • Description: Contains the structure for a .devcontainer/devcontainer.json file.
    • +
  • Structure name: configs/devcontainer
    • +
+

Editor Config

+
    +
  • File: configs/editor-config.yaml
    • +
  • Description: Defines the structure for an .editorconfig file.
    • +
  • Structure name: configs/editor-config
    • +
+

ESLint Configuration

+
    +
  • File: configs/eslint.yaml
    • +
  • Description: Contains the structure for ESLint configuration files including .eslintrc.json and .eslintignore.
    • +
  • Structure name: configs/eslint
    • +
+

JSHint Configuration

+
    +
  • File: configs/jshint.yaml
    • +
  • Description: Defines the structure for JSHint configuration files including .jshintrc and .jshintignore.
    • +
  • Structure name: configs/jshint
    • +
+

Kubectl Configuration

+
    +
  • File: configs/kubectl.yaml
    • +
  • Description: Contains the structure for a .kuberc configuration file.
    • +
  • Structure name: configs/kubectl
    • +
+

Prettier Configuration

+
    +
  • File: configs/prettier.yaml
    • +
  • Description: Contains the structure for Prettier configuration files including .prettierrc and .prettierignore.
    • +
  • Structure name: configs/prettier
    • +
+

Docker Files

+
    +
  • File: docker-files.yaml
    • +
  • Description: Defines the structure for Docker-related files including Dockerfile, .dockerignore, docker-compose.yml, and .env.
    • +
  • Structure name: docker-files
    • +
+

Documentation Template

+
    +
  • File: documentation-template.yaml
    • +
  • Description: Contains the structure for documentation files including README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and LICENSE.md.
    • +
  • Structure name: documentation-template
    • +
+

Git Hooks

+
    +
  • +

    File: git-hooks.yaml

    +
    • +
  • +

    Description: Defines the structure for Git hook scripts including .git/hooks/pre-commit, .git/hooks/pre-push, and .git/hooks/commit-msg.

    +
    • +
  • Structure name: git-hooks
    • +
+

GitHub Workflows

+
    +
  • File: github/workflows/execute-tf-workflow.yaml
    • +
  • Description: Contains the structure for a GitHub Actions workflow to execute Terraform.
    • +
  • Structure name: github/workflows/execute-terraform-workflow
    • +
+

Github Labeler Workflow

+
    +
  • File: github/workflows/labeler.yaml
    • +
  • Description: Defines the structure for a GitHub Actions workflow to label issues and pull requests.
    • +
  • Structure name: github/workflows/labeler
    • +
+

GitHub stale Workflow

+
    +
  • File: github/workflows/stale.yaml
    • +
  • Description: Contains the structure for a GitHub Actions workflow to mark stale issues and pull requests.
    • +
  • Structure name: github/workflows/stale
    • +
+

GitHub Pre-commit Workflow

+
    +
  • File: github/workflows/pre-commit.yaml
    • +
  • Description: Defines the structure for a GitHub Actions workflow to run pre-commit hooks.
    • +
  • Structure name: github/workflows/pre-commit
    • +
+

GitHub Release Drafter Workflow

+
    +
  • File: github/workflows/release-drafter.yaml
    • +
  • Description: Contains the structure for a GitHub Actions workflow to draft releases.
    • +
  • Structure name: github/workflows/release-drafter
    • +
+

GitHub Run Struct Workflow

+
    +
  • File: github/workflows/run-struct.yaml
    • +
  • Description: Defines the structure for a GitHub Actions workflow to run Struct.
    • +
  • Structure name: github/workflows/run-struct
    • +
+

GitHub Templates

+
    +
  • File: github/templates.yaml
    • +
  • Description: Contains the structure for GitHub templates including ISSUE_TEMPLATE/bug_report.yaml, ISSUE_TEMPLATE/feature_request.yaml, and PULL_REQUEST_TEMPLATE.md.
    • +
  • Structure name: github/templates
    • +
+

Helm Chart

+
    +
  • File: helm-chart.yaml
    • +
  • Description: Contains the structure for a Helm chart including Chart.yaml, values.yaml, and various templates.
    • +
  • Structure name: helm-chart
    • +
+

Github Instructions

+
    +
  • File: github/instructions/generic.yaml
    • +
  • Description: Defines the structure for generic GitHub instructions. generic.instruction.md
    • +
  • Structure name: github/instructions/generic
    • +
+

Github generic prompt

+
    +
  • File: github/prompt/generic.yaml
    • +
  • Description: Contains the structure for a generic GitHub prompt.
    • +
  • Structure name: github/prompt/generic
    • +
+

Github react form prompt

+
    +
  • File: github/prompt/react-form.yaml
    • +
  • Description: Defines the structure for a React form prompt in GitHub.
    • +
  • Structure name: github/prompt/react-form
    • +
+

Github security api prompt

+
    +
  • File: github/prompt/security-api.yaml
    • +
  • Description: Contains the structure for a GitHub security API prompt.
    • +
  • Structure name: github/prompt/security-api
    • +
+

Github struct prompt

+
    +
  • File: github/prompt/struct.yaml
    • +
  • Description: Defines the structure for a Struct prompt in GitHub.
    • +
  • Structure name: github/prompt/struct
    • +
+

Kubernetes Manifests

+
    +
  • File: kubernetes-manifests.yaml
    • +
  • Description: Defines the structure for Kubernetes manifests including deployment.yaml, service.yaml, ingress.yaml, configmap.yaml, secrets.yaml, and README.md.
    • +
  • Structure name: kubernetes-manifests
    • +
+

Generic Project

+
    +
  • File: project/generic.yaml
    • +
  • Description: Contains the structure for a generic project with various configuration files and folders.
    • +
  • Structure name: project/generic
    • +
+

Go Project

+
    +
  • File: project/go.yaml
    • +
  • Description: Defines the structure for a Go project including .editorconfig, .env, .gitignore, LICENSE, README.md, main.go, and various folders.
    • +
  • Structure name: project/go
    • +
+

Java Project

+
    +
  • File: project/java.yaml
    • +
  • Description: Contains the structure for a Java project including .editorconfig, .env, .gitignore, LICENSE, README.md, pom.xml, and various folders.
    • +
  • Structure name: project/java
    • +
+

Node.js Project

+
    +
  • File: project/nodejs.yaml
    • +
  • Description: Defines the structure for a Node.js project.
    • +
  • Structure name: project/nodejs
    • +
+

Python Project

+
    +
  • File: project/python.yaml
    • +
  • Description: Contains the structure for a Python project.
    • +
  • Structure name: project/python
    • +
+

Ruby Project

+
    +
  • File: project/ruby.yaml
    • +
  • Description: Defines the structure for a Ruby project.
    • +
  • Structure name: project/ruby
    • +
+

Rust Project

+
    +
  • File: project/rust.yaml
    • +
  • Description: Contains the structure for a Rust project.
    • +
  • Structure name: project/rust
    • +
+

AWS Accounts Terraform

+
    +
  • File: terraform/apps/aws-accounts.yaml
    • +
  • Description: Defines the structure for AWS accounts Terraform configuration.
    • +
  • Structure name: terraform/apps/aws-accounts
    • +
+

Environments Terraform

+
    +
  • File: terraform/apps/environments.yaml
    • +
  • Description: Contains the structure for environments Terraform configuration.
    • +
  • Structure name: terraform/apps/environments
    • +
+

Generic Terraform

+
    +
  • File: terraform/apps/generic.yaml
    • +
  • Description: Defines the structure for generic Terraform configuration.
    • +
  • Structure name: terraform/apps/generic
    • +
+

GitHub Organization Terraform

+
    +
  • File: terraform/apps/github-organization.yaml
    • +
  • Description: Contains the structure for GitHub organization Terraform configuration.
    • +
  • Structure name: terraform/apps/github-organization
    • +
+

Init Terraform

+
    +
  • File: terraform/apps/init.yaml
    • +
  • Description: Defines the structure for init Terraform configuration.
    • +
  • Structure name: terraform/apps/init
    • +
+

Generic Terraform Module

+
    +
  • File: terraform/modules/generic.yaml
    • +
  • Description: Contains the structure for a generic Terraform module.
    • +
  • Structure name: terraform/modules/generic
    • +
+

Vagrant Files

+
    +
  • File: vagrant-files.yaml
    • +
  • Description: Defines the structure for Vagrant files.
    • +
  • Structure name: vagrant-files
    • +
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/stylesheets/extra.css b/site/stylesheets/extra.css new file mode 100644 index 0000000..21b617b --- /dev/null +++ b/site/stylesheets/extra.css @@ -0,0 +1,287 @@ +/* STRUCT MkDocs Custom Theme - Matching main site styling */ +@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=Fira+Code:wght@300;400;500&display=swap'); + +/* CSS Custom Properties - Matching main site */ +:root { + /* Colors from main site */ + --md-primary-fg-color: #00ff88; + --md-primary-fg-color--light: #00ff88; + --md-primary-fg-color--dark: #00cc6a; + --md-accent-fg-color: #0066ff; + --md-accent-fg-color--transparent: rgba(0, 102, 255, 0.1); + + /* Dark theme colors */ + --md-default-bg-color: #0a0a0a; + --md-default-fg-color: #ffffff; + --md-default-fg-color--light: #b0b0b0; + --md-default-fg-color--lighter: #888888; + --md-default-fg-color--lightest: #666666; + + /* Code colors */ + --md-code-bg-color: #1a1a1a; + --md-code-fg-color: #00ff88; + + /* Typography */ + --md-text-font: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', + sans-serif; + --md-code-font: 'Fira Code', 'SF Mono', Monaco, 'Cascadia Code', monospace; +} + +/* Base styling overrides */ +[data-md-color-scheme='slate'] { + --md-hue: 232; + --md-default-bg-color: #0a0a0a; + --md-default-fg-color: #ffffff; + --md-default-fg-color--light: #b0b0b0; + --md-default-fg-color--lighter: #888888; + --md-default-fg-color--lightest: #666666; + --md-code-bg-color: #1a1a1a; + --md-code-fg-color: #00ff88; +} + +/* Body and container styling */ +body { + font-family: var(--md-text-font); + background-color: var(--md-default-bg-color); + color: var(--md-default-fg-color); +} + +.md-container { + background-color: var(--md-default-bg-color); +} + +.md-main { + background-color: var(--md-default-bg-color); +} + +/* Header styling */ +.md-header { + background-color: #1a1a1a; + color: var(--md-default-fg-color); + border-bottom: 1px solid #333333; +} + +.md-header__title { + color: var(--md-primary-fg-color); + font-weight: 600; +} + +/* Navigation styling */ +.md-nav { + background-color: var(--md-default-bg-color); +} + +.md-nav__title { + color: var(--md-default-fg-color); + font-weight: 600; +} + +.md-nav__item .md-nav__link { + color: var(--md-default-fg-color--light); +} + +.md-nav__item .md-nav__link:hover { + color: var(--md-primary-fg-color); +} + +.md-nav__item .md-nav__link--active { + color: var(--md-primary-fg-color); +} + +/* Content area styling */ +.md-content { + background-color: var(--md-default-bg-color); +} + +.md-typeset { + color: var(--md-default-fg-color); +} + +/* Headings */ +.md-typeset h1, +.md-typeset h2, +.md-typeset h3, +.md-typeset h4, +.md-typeset h5, +.md-typeset h6 { + color: var(--md-default-fg-color); + font-weight: 600; +} + +.md-typeset h1 { + color: var(--md-primary-fg-color); +} + +/* Paragraphs and text */ +.md-typeset p { + color: var(--md-default-fg-color--light); +} + +/* Links */ +.md-typeset a { + color: var(--md-accent-fg-color); +} + +.md-typeset a:hover { + color: var(--md-primary-fg-color); +} + +/* Code styling */ +.md-typeset code { + background-color: var(--md-code-bg-color); + color: var(--md-code-fg-color); + border: 1px solid #333333; + border-radius: 4px; + padding: 2px 8px; + font-family: var(--md-code-font); +} + +.md-typeset pre { + background-color: var(--md-code-bg-color); + border: 1px solid #333333; + border-radius: 8px; +} + +.md-typeset pre code { + background: none; + border: none; + color: var(--md-default-fg-color); +} + +/* Search styling */ +.md-search__form { + background-color: #1a1a1a; + border: 1px solid #333333; +} + +.md-search__input { + background-color: transparent; + color: var(--md-default-fg-color); +} + +.md-search__input::placeholder { + color: var(--md-default-fg-color--lighter); +} + +/* Footer */ +.md-footer { + background-color: #1a1a1a; + border-top: 1px solid #333333; +} + +.md-footer__meta { + background-color: #0a0a0a; +} + +/* Sidebar */ +.md-sidebar { + background-color: var(--md-default-bg-color); +} + +.md-sidebar--secondary { + background-color: var(--md-default-bg-color); +} + +/* Tables */ +.md-typeset table:not([class]) { + border: 1px solid #333333; +} + +.md-typeset table:not([class]) th { + background-color: #1a1a1a; + color: var(--md-default-fg-color); + border-bottom: 1px solid #333333; +} + +.md-typeset table:not([class]) td { + border-top: 1px solid #333333; + color: var(--md-default-fg-color--light); +} + +/* Admonitions */ +.md-typeset .admonition { + border-left: 4px solid var(--md-primary-fg-color); + background-color: #1a1a1a; + border-radius: 0 8px 8px 0; +} + +.md-typeset .admonition-title { + color: var(--md-default-fg-color); + font-weight: 600; +} + +/* Buttons and form elements */ +.md-button { + background-color: var(--md-primary-fg-color); + color: #0a0a0a; + border-radius: 8px; + font-weight: 500; +} + +.md-button:hover { + background-color: var(--md-primary-fg-color--dark); +} + +/* Tabs */ +.md-tabs { + background-color: #1a1a1a; + border-bottom: 1px solid #333333; +} + +.md-tabs__item { + color: var(--md-default-fg-color--light); +} + +.md-tabs__link:hover { + color: var(--md-primary-fg-color); +} + +.md-tabs__link--active { + color: var(--md-primary-fg-color); +} + +/* Custom scrollbar */ +::-webkit-scrollbar { + width: 8px; +} + +::-webkit-scrollbar-track { + background: #1a1a1a; +} + +::-webkit-scrollbar-thumb { + background: #333333; + border-radius: 4px; +} + +::-webkit-scrollbar-thumb:hover { + background: #888888; +} + +/* Responsive adjustments */ +@media screen and (max-width: 76.1875em) { + .md-nav--primary .md-nav__title { + background-color: var(--md-primary-fg-color); + color: #0a0a0a; + } +} + +/* Additional Material theme overrides for better integration */ +.md-typeset .highlight { + background-color: var(--md-code-bg-color); + border: 1px solid #333333; + border-radius: 8px; +} + +.md-typeset .highlight pre { + background: none; + border: none; +} + +/* Make sure dark mode is properly applied */ +@media (prefers-color-scheme: dark) { + :root { + --md-default-bg-color: #0a0a0a; + --md-default-fg-color: #ffffff; + } +} diff --git a/site/sw.js b/site/sw.js deleted file mode 100644 index 22fe30f..0000000 --- a/site/sw.js +++ /dev/null @@ -1,380 +0,0 @@ -// STRUCT Service Worker for Offline Support - -const CACHE_NAME = 'struct-site-v1'; -const STATIC_CACHE_URLS = [ - '/struct/', - '/struct/index.html', - '/struct/css/main.css', - '/struct/css/components.css', - '/struct/css/animations.css', - '/struct/css/advanced.css', - '/struct/js/main.js', - '/struct/js/advanced.js', - '/struct/images/favicon.svg', - 'https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=Fira+Code:wght@300;400;500&display=swap', - 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/all.min.css', -]; - -const DEMO_CACHE_URLS = [ - '/struct/demos/basic-usage.gif', - '/struct/demos/yaml-config.gif', - '/struct/demos/mappings-demo.gif', - '/struct/demos/remote-content.gif', - '/struct/demos/advanced-features.gif', -]; - -// Install event - cache static assets -self.addEventListener('install', event => { - console.log('Service Worker: Installing...'); - - event.waitUntil( - Promise.all([ - // Cache static assets - caches.open(CACHE_NAME).then((cache) => { - console.log('Service Worker: Caching static files'); - return cache.addAll( - STATIC_CACHE_URLS.map( - (url) => - new Request(url, { - cache: 'reload', - }) - ) - ); - }), - - // Cache demo files (optional, fail silently) - caches.open(`${CACHE_NAME}-demos`).then((cache) => { - console.log('Service Worker: Caching demo files'); - return Promise.allSettled( - DEMO_CACHE_URLS.map((url) => - cache - .add(new Request(url, { cache: 'reload' })) - .catch((err) => console.log(`Failed to cache ${url}:`, err)) - ) - ); - }), - ]).then(() => { - console.log('Service Worker: Installation complete'); - return self.skipWaiting(); - }) - ); -}); - -// Activate event - clean up old caches -self.addEventListener('activate', (event) => { - console.log('Service Worker: Activating...'); - - event.waitUntil( - caches - .keys() - .then((cacheNames) => { - return Promise.all( - cacheNames.map((cacheName) => { - if ( - cacheName !== CACHE_NAME && - cacheName !== `${CACHE_NAME}-demos` - ) { - console.log('Service Worker: Deleting old cache:', cacheName); - return caches.delete(cacheName); - } - }) - ); - }) - .then(() => { - console.log('Service Worker: Activation complete'); - return self.clients.claim(); - }) - ); -}); - -// Fetch event - serve from cache with network fallback -self.addEventListener('fetch', (event) => { - const request = event.request; - const url = new URL(request.url); - - // Skip non-GET requests - if (request.method !== 'GET') { - return; - } - - // Skip external API calls (let them go through normally) - if (url.hostname === 'api.github.com') { - return; - } - - // Skip Google Analytics - if ( - url.hostname === 'www.googletagmanager.com' || - url.hostname === 'www.google-analytics.com' - ) { - return; - } - - event.respondWith(handleFetchRequest(request)); -}); - -async function handleFetchRequest(request) { - const url = new URL(request.url); - - try { - // For navigation requests, try cache first, then network - if (request.mode === 'navigate') { - return await handleNavigationRequest(request); - } - - // For demo files, try cache first - if (url.pathname.startsWith('/demos/')) { - return await handleDemoRequest(request); - } - - // For static assets, try cache first, then network - if (isStaticAsset(url.pathname)) { - return await handleStaticAssetRequest(request); - } - - // For everything else, network first with cache fallback - return await handleNetworkFirstRequest(request); - } catch (error) { - console.error('Service Worker: Fetch error:', error); - return await handleOfflineFallback(request); - } -} - -async function handleNavigationRequest(request) { - try { - // Try network first for navigation - const networkResponse = await fetch(request); - - if (networkResponse.ok) { - // Cache successful navigation responses - const cache = await caches.open(CACHE_NAME); - cache.put(request, networkResponse.clone()); - return networkResponse; - } - - throw new Error('Network response not ok'); - } catch (error) { - // Fallback to cache - const cachedResponse = await caches.match(request); - if (cachedResponse) { - return cachedResponse; - } - - // Fallback to offline page - return await caches.match('/index.html'); - } -} - -async function handleDemoRequest(request) { - // Try cache first for demo files - const cachedResponse = await caches.match(request); - if (cachedResponse) { - return cachedResponse; - } - - try { - // Try network if not in cache - const networkResponse = await fetch(request); - if (networkResponse.ok) { - const cache = await caches.open(`${CACHE_NAME}-demos`); - cache.put(request, networkResponse.clone()); - return networkResponse; - } - throw new Error('Demo file not found'); - } catch (error) { - // Return placeholder for missing demo files - return new Response(createDemoPlaceholder(request.url), { - headers: { - 'Content-Type': 'image/svg+xml', - 'Cache-Control': 'no-cache', - }, - }); - } -} - -async function handleStaticAssetRequest(request) { - // Try cache first for static assets - const cachedResponse = await caches.match(request); - if (cachedResponse) { - return cachedResponse; - } - - // Try network and cache the response - try { - const networkResponse = await fetch(request); - if (networkResponse.ok) { - const cache = await caches.open(CACHE_NAME); - cache.put(request, networkResponse.clone()); - return networkResponse; - } - throw new Error('Asset not found'); - } catch (error) { - throw error; - } -} - -async function handleNetworkFirstRequest(request) { - try { - const networkResponse = await fetch(request); - return networkResponse; - } catch (error) { - const cachedResponse = await caches.match(request); - if (cachedResponse) { - return cachedResponse; - } - throw error; - } -} - -async function handleOfflineFallback(request) { - const url = new URL(request.url); - - // For HTML pages, return the main page - if (request.mode === 'navigate') { - const mainPage = await caches.match('/index.html'); - if (mainPage) { - return mainPage; - } - } - - // For images, return a placeholder - if (request.destination === 'image') { - return new Response(createImagePlaceholder(), { - headers: { - 'Content-Type': 'image/svg+xml', - 'Cache-Control': 'no-cache', - }, - }); - } - - // For other resources, return a basic offline message - return new Response('Offline - Content not available', { - status: 503, - statusText: 'Service Unavailable', - headers: { - 'Content-Type': 'text/plain', - }, - }); -} - -function isStaticAsset(pathname) { - return pathname.startsWith('/css/') || - pathname.startsWith('/js/') || - pathname.startsWith('/images/') || - pathname.endsWith('.css') || - pathname.endsWith('.js') || - pathname.endsWith('.svg') || - pathname.endsWith('.png') || - pathname.endsWith('.jpg') || - pathname.endsWith('.gif'); -} - -function createDemoPlaceholder(url) { - const filename = url.split('/').pop(); - return ` - - - - - Demo: ${filename} - - - Offline - Demo not available - - - - - `; -} - -function createImagePlaceholder() { - return ` - - - - - Image Offline - - - Content not available - - - `; -} - -// Background sync for form submissions (future enhancement) -self.addEventListener('sync', event => { - if (event.tag === 'background-sync') { - console.log('Service Worker: Background sync triggered'); - event.waitUntil(handleBackgroundSync()); - } -}); - -async function handleBackgroundSync() { - // Handle any pending form submissions or data sync - console.log('Service Worker: Performing background sync'); -} - -// Push notifications (future enhancement) -self.addEventListener('push', (event) => { - if (event.data) { - const data = event.data.json(); - const options = { - body: data.body, - icon: '/images/favicon.svg', - badge: '/images/favicon.svg', - actions: [ - { - action: 'view', - title: 'View', - icon: '/images/favicon.svg', - }, - { - action: 'dismiss', - title: 'Dismiss', - }, - ], - }; - - event.waitUntil(self.registration.showNotification(data.title, options)); - } -}); - -// Notification click handler -self.addEventListener('notificationclick', (event) => { - event.notification.close(); - - if (event.action === 'view') { - event.waitUntil(clients.openWindow('/')); - } -}); - -// Message handler for cache updates -self.addEventListener('message', (event) => { - if (event.data && event.data.type === 'SKIP_WAITING') { - self.skipWaiting(); - } - - if (event.data && event.data.type === 'UPDATE_CACHE') { - event.waitUntil(updateCache()); - } -}); - -async function updateCache() { - console.log('Service Worker: Updating cache...'); - const cache = await caches.open(CACHE_NAME); - - try { - await cache.addAll( - STATIC_CACHE_URLS.map( - (url) => - new Request(url, { - cache: 'reload', - }) - ) - ); - console.log('Service Worker: Cache updated successfully'); - } catch (error) { - console.error('Service Worker: Cache update failed:', error); - } -} diff --git a/site/template-variables/index.html b/site/template-variables/index.html new file mode 100644 index 0000000..7b64109 --- /dev/null +++ b/site/template-variables/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Template Variables - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Template Variables

+

Template variables allow you to create dynamic content in your STRUCT configurations. This page covers all aspects of working with variables.

+

Basic Syntax

+

Use template variables by enclosing them in {{@ and @}}:

+
files:
+  - README.md:
+      content: |
+        # {{@ project_name @}}
+        Welcome to {{@ project_name @}}!
+
+

Block Syntax

+

For control structures, use block notation:

+
    +
  • Start block: {%@
    • +
  • End block: %@}
    • +
+
files:
+  - config.yaml:
+      content: |
+        {%@ if environment == "production" @%}
+        debug: false
+        {%@ else @%}
+        debug: true
+        {%@ endif @%}
+
+

Comments

+

Use comment notation to document your templates:

+
    +
  • Start comment: {#@
    • +
  • End comment: @#}
    • +
+
files:
+  - app.py:
+      content: |
+        {#@ This is a template comment @#}
+        app_name = "{{@ project_name @}}"
+
+

Default Variables

+

STRUCT provides these built-in variables:

+
    +
  • file_name: The name of the file being processed
    • +
  • file_directory: The directory containing the file being processed
    • +
+

Interactive Variables

+

Define variables that prompt users for input:

+
variables:
+  - project_name:
+      description: "The name of your project"
+      type: string
+      default: "MyProject"
+  - author_name:
+      description: "Your name"
+      type: string
+      # No default = interactive prompt
+  - port:
+      description: "Application port"
+      type: integer
+      default: 8080
+
+

Variable Types

+
    +
  • string: Text values
    • +
  • integer: Numeric values
    • +
  • boolean: True/false values
    • +
+

Custom Jinja2 Filters

+

STRUCT includes custom filters for common tasks:

+

latest_release

+

Fetch the latest release version from GitHub:

+
files:
+  - Dockerfile:
+      content: |
+        FROM node:{{@ "nodejs/node" | latest_release @}}
+
+

Requirements: Set GITHUB_TOKEN environment variable for private repos.

+

slugify

+

Convert strings to URL-friendly slugs:

+
files:
+  - "{{@ project_name | slugify @}}.conf":
+      content: |
+        server_name {{@ project_name | slugify @}};
+
+

Options: Optional separator character (default: -)

+

default_branch

+

Get the default branch name of a GitHub repository:

+
files:
+  - .github/workflows/ci.yml:
+      content: |
+        on:
+          push:
+            branches: [ {{@ "httpdss/struct" | default_branch @}} ]
+
+

The with Clause

+

Pass additional variables to nested structures:

+
folders:
+  - frontend/:
+      struct: project/react
+      with:
+        app_name: "{{@ project_name @}}-frontend"
+        port: 3000
+  - backend/:
+      struct: project/node
+      with:
+        app_name: "{{@ project_name @}}-backend"
+        port: 8000
+
+

Variables defined in with are merged with global variables and take precedence.

+

Advanced Examples

+

Conditional File Creation

+
files:
+  - docker-compose.yml:
+      skip: "{{@ not use_docker @}}"
+      content: |
+        version: '3.8'
+        services:
+          app:
+            image: {{@ project_name | slugify @}}:latest
+
+

Dynamic File Names

+
files:
+  - "src/{{@ module_name @}}/index.js":
+      content: |
+        // {{@ module_name @}} module
+        export default {};
+
+

Environment-Specific Content

+
files:
+  - config/{{@ environment @}}.yml:
+      content: |
+        {%@ if environment == "production" @%}
+        database_url: {{@ production_db_url @}}
+        {%@ else @%}
+        database_url: sqlite:///dev.db
+        {%@ endif @%}
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/update-sitemap.sh b/site/update-sitemap.sh deleted file mode 100755 index 57ef12d..0000000 --- a/site/update-sitemap.sh +++ /dev/null @@ -1,65 +0,0 @@ -#!/bin/bash - -# Script to automatically update sitemap.xml with all generated documentation pages -# Usage: ./update-sitemap.sh - -SITEMAP_FILE="sitemap.xml" -DOCS_DIR="docs" -BASE_URL="https://httpdss.github.io/struct" -TODAY=$(date +%Y-%m-%d) - -echo "📄 Updating sitemap.xml with generated documentation pages..." - -# Backup original sitemap -cp "$SITEMAP_FILE" "${SITEMAP_FILE}.backup" - -# Find all HTML files in docs directory -echo "🔍 Finding HTML files in $DOCS_DIR..." -html_files=$(find "$DOCS_DIR" -name "*.html" | sort) - -# Count files -file_count=$(echo "$html_files" | wc -l) -echo "📊 Found $file_count HTML files to add to sitemap" - -# Create temporary file with new entries -temp_file=$(mktemp) - -# Copy everything before -sed '/<\/urlset>/d' "$SITEMAP_FILE" > "$temp_file" - -# Add comment for generated docs -echo "" >> "$temp_file" -echo " " >> "$temp_file" -echo "" >> "$temp_file" - -# Add each HTML file as a URL entry -while IFS= read -r file; do - # Convert file path to URL path - url_path=${file#docs/} - - # Remove index.html from path for cleaner URLs - if [[ "$url_path" == */index.html ]]; then - url_path=${url_path%/index.html}/ - fi - - # Add URL entry - echo " " >> "$temp_file" - echo " $BASE_URL/$file" >> "$temp_file" - echo " $TODAY" >> "$temp_file" - echo " weekly" >> "$temp_file" - echo " 0.8" >> "$temp_file" - echo " " >> "$temp_file" - echo "" >> "$temp_file" -done <<< "$html_files" - -# Close urlset -echo "" >> "$temp_file" - -# Replace original sitemap -mv "$temp_file" "$SITEMAP_FILE" - -echo "✅ Sitemap updated successfully!" -echo "📈 Total URLs in sitemap: $(grep -c '' "$SITEMAP_FILE")" -echo "📂 Documentation pages: $(grep -c "docs/" "$SITEMAP_FILE")" -echo "" -echo "💡 Backup created: ${SITEMAP_FILE}.backup" diff --git a/site/usage/index.html b/site/usage/index.html new file mode 100644 index 0000000..471ed14 --- /dev/null +++ b/site/usage/index.html @@ -0,0 +1,1654 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Usage - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

Basic Usage

+

Run the script with the following command using one of the following subcommands:

+
    +
  • generate: Generate the project structure based on the YAML configuration.
    • +
  • generate-schema: Generate JSON schema for available structure templates.
    • +
  • validate: Validate the YAML configuration file.
    • +
  • info: Display information about the script and its dependencies.
    • +
  • list: List the available structs
    • +
+

For more information, run the script with the -h or --help option (this is also available for each subcommand):

+

Struct List

+
struct -h
+
+

Generate Command

+

Finding Available Structures

+

Use the list command to see all available structures:

+
struct list
+
+

Or if you have auto-completion enabled, use Tab to see all options:

+
struct generate <Tab>
+# Shows all available structures
+
+

Simple Example

+
struct generate terraform/modules/generic ./my-terraform-module
+
+

YAML File Usage

+

For local YAML configuration files, the file:// protocol is automatically added:

+
# Both of these work identically
+struct generate my-config.yaml ./output
+struct generate file://my-config.yaml ./output
+
+

Complete Example

+
struct generate \
+  --log=DEBUG \
+  --dry-run \
+  --backup=/path/to/backup \
+  --file-strategy=rename \
+  --log-file=/path/to/logfile.log \
+  terraform-module \
+  ./my-terraform-module
+
+

Command Options

+
    +
  • --log: Set logging level (DEBUG, INFO, WARNING, ERROR)
    • +
  • --dry-run: Preview actions without making changes
    • +
  • --backup: Specify backup directory for existing files
    • +
  • --file-strategy: Choose how to handle existing files (overwrite, skip, append, rename, backup)
    • +
  • --log-file: Write logs to specified file
    • +
  • --mappings-file: Provide external mappings file (can be used multiple times)
    • +
+

Generate Schema Command

+

The generate-schema command creates JSON schema definitions for available structure templates, making it easier for tools and IDEs to provide autocompletion and validation.

+

Basic Usage of generate-schema

+
# Generate schema to stdout
+struct generate-schema
+
+# Generate schema with custom structures path
+struct generate-schema -s /path/to/custom/structures
+
+# Save schema to file
+struct generate-schema -o schema.json
+
+# Combine custom path and output file
+struct generate-schema -s /path/to/custom/structures -o schema.json
+
+

Command Options for generate-schema

+
    +
  • -s, --structures-path: Path to additional structure definitions (optional)
    • +
  • -o, --output: Output file path for the schema (default: stdout)
    • +
+

The generated schema includes all available structures from both the built-in contribs directory and any custom structures path you specify. This is useful for:

+
    +
  • IDE autocompletion when writing .struct.yaml files
    • +
  • Validation of structure references in your configurations
    • +
  • Programmatic discovery of available templates
    • +
+

Other Commands

+

Validate Configuration

+
struct validate my-structure.yaml
+
+

List Available Structures

+
struct list
+
+

Show Information

+
struct info <structure_definition>
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/demos/advanced-features.gif b/site/vhs/advanced-features.gif similarity index 100% rename from site/demos/advanced-features.gif rename to site/vhs/advanced-features.gif diff --git a/site/vhs/advanced-features.tape b/site/vhs/advanced-features.tape new file mode 100644 index 0000000..3d959ac --- /dev/null +++ b/site/vhs/advanced-features.tape @@ -0,0 +1,60 @@ +Output docs/vhs/advanced-features.gif + +Set Theme "Monokai Vivid" +Set FontSize 14 +Set TypingSpeed 40ms +Set Width 1400 +Set Height 800 +Set Shell "bash" + +Type "# STRUCT Advanced Features Demo" +Enter +Sleep 1s + +Type "# Generate schema for VSCode autocompletion" +Enter +Type "mkdir -p .vscode" +Enter +Type "struct generate-schema --output .vscode/struct-schema.json" +Enter +Sleep 2s + +Type "# Show the generated schema" +Enter +Type "cat .vscode/struct-schema.json" +Enter +Sleep 3s + +Type "# Create config with remote content" +Enter +Type "cat > remote-demo.yaml << EOF" +Enter +Type "files:" +Enter +Type " - LICENSE:" +Enter +Type " file: https://raw.githubusercontent.com/licenses/license-templates/master/templates/mit.txt" +Enter +Type " - .gitignore:" +Enter +Type " file: https://raw.githubusercontent.com/github/gitignore/refs/heads/main/Python.gitignore" +Enter +Type "EOF" +Enter +Sleep 2s + +Type "# Generate with remote content" +Enter +Type "struct generate remote-demo.yaml ./remote-project" +Enter +Sleep 3s + +Type "# Check what was downloaded" +Enter +Type "ls -la remote-project/" +Enter +Sleep 2s + +Type "# Advanced features make STRUCT incredibly powerful!" +Enter +Sleep 2s diff --git a/site/demos/basic-usage.gif b/site/vhs/basic-usage.gif similarity index 100% rename from site/demos/basic-usage.gif rename to site/vhs/basic-usage.gif diff --git a/site/vhs/basic-usage.tape b/site/vhs/basic-usage.tape new file mode 100644 index 0000000..32ffb13 --- /dev/null +++ b/site/vhs/basic-usage.tape @@ -0,0 +1,47 @@ +Output docs/vhs/usage.gif + +Set Theme "Dracula" +Set FontSize 14 +Set Width 1200 +Set Height 600 +Set Shell "bash" + +Type "# STRUCT - Basic Usage Demo" +Enter +Sleep 1s + +Type "# First, let's see what structures are available" +Enter +Sleep 500ms + +Type "struct list" +Enter +Sleep 2s + +Type "# Let's generate a simple Python project" +Enter +Sleep 500ms + +Type "struct generate project/python ./my-python-app" +Enter +Sleep 3s + +Type "# Check what was created" +Enter +Sleep 500ms + +Type "ls -la my-python-app/" +Enter +Sleep 2s + +Type "# View the project structure" +Enter +Sleep 500ms + +Type "tree my-python-app/ || find my-python-app/ -type f" +Enter +Sleep 2s + +Type "# That's it! STRUCT made it easy to bootstrap a project" +Enter +Sleep 1s diff --git a/site/vhs/index.html b/site/vhs/index.html new file mode 100644 index 0000000..d7d0a23 --- /dev/null +++ b/site/vhs/index.html @@ -0,0 +1,1747 @@ + + + + + + + + + + + + + + + + + + + + + + + STRUCT VHS Demo Tapes - STRUCT Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + + + + +

STRUCT VHS Demo Tapes

+

This directory contains VHS tape files for creating animated GIF demonstrations of STRUCT's features. These tapes showcase various use cases and capabilities of the STRUCT tool.

+

🎬 Available Tapes

+

1. Installation & Setup

+

File: install.tape +Duration: ~30 seconds +Description: Shows how to install STRUCT using pip and verify the installation.

+

2. Basic Usage

+

File: basic-usage.tape +Description: Demonstrates basic STRUCT commands like list, info, and simple project generation.

+
Output docs/vhs/basic-usage.gif
+
+Set Theme "Monokai Vivid"
+Set FontSize 14
+Set TypingSpeed 40ms
+Set WindowBar Colorful
+Set BorderRadius 8
+Set Margin 0
+Set Padding 10
+Set Width 1400
+Set Height 800
+Set Shell "bash"
+
+Type "# Explore available structures" Enter
+Type "struct list" Enter
+Sleep 3
+Type "" Enter
+Type "# Get information about a specific structure" Enter
+Type "struct info terraform/module" Enter
+Sleep 5
+Type "" Enter
+Type "# Generate a simple project structure" Enter
+Type "struct generate terraform/module ./my-terraform-module" Enter
+Sleep 8
+Type "" Enter
+Type "# Verify the generated structure" Enter
+Type "tree my-terraform-module" Enter
+Sleep 5
+
+

3. YAML Configuration

+

File: yaml-config.tape +Description: Shows how to create and use custom YAML configuration files.

+
Output docs/vhs/yaml-config.gif
+
+Set Theme "Monokai Vivid"
+Set FontSize 14
+Set TypingSpeed 40ms
+Set WindowBar Colorful
+Set BorderRadius 8
+Set Margin 0
+Set Padding 10
+Set Width 1400
+Set Height 800
+Set Shell "bash"
+
+Type "# Create a custom YAML configuration" Enter
+Type "cat > my-project.yaml << 'EOF'" Enter
+Type "files:" Enter
+Type "  - README.md:" Enter
+Type "      content: |" Enter
+Type "        # {{@ project_name @}}" Enter
+Type "        Welcome to my awesome project!" Enter
+Type "  - src/main.py:" Enter
+Type "      content: |" Enter
+Type "        print('Hello from {{@ project_name @}}!')" Enter
+Type "" Enter
+Type "variables:" Enter
+Type "  - project_name:" Enter
+Type "      description: 'Name of your project'" Enter
+Type "      type: string" Enter
+Type "      default: 'MyProject'" Enter
+Type "EOF" Enter
+Sleep 2
+Type "" Enter
+Type "# Generate structure from YAML (note: file:// is automatic)" Enter
+Type "struct generate my-project.yaml ./output" Enter
+Sleep 5
+Type "" Enter
+Type "# Check the generated files" Enter
+Type "tree output && echo && cat output/README.md" Enter
+Sleep 5
+
+

4. Mappings & Variables

+

File: mappings-demo.tape +Description: Demonstrates external mappings files and template variables.

+
Output docs/vhs/mappings-demo.gif
+
+Set Theme "Monokai Vivid"
+Set FontSize 14
+Set TypingSpeed 40ms
+Set WindowBar Colorful
+Set BorderRadius 8
+Set Margin 0
+Set Padding 10
+Set Width 1400
+Set Height 800
+Set Shell "bash"
+
+Type "# Create mappings file for environment variables" Enter
+Type "cat > mappings.yaml << 'EOF'" Enter
+Type "mappings:" Enter
+Type "  environments:" Enter
+Type "    dev:" Enter
+Type "      database_url: 'postgres://localhost:5432/myapp_dev'" Enter
+Type "      debug: true" Enter
+Type "    prod:" Enter
+Type "      database_url: 'postgres://prod-server:5432/myapp'" Enter
+Type "      debug: false" Enter
+Type "  teams:" Enter
+Type "    devops: 'devops-team@company.com'" Enter
+Type "    frontend: 'frontend-team@company.com'" Enter
+Type "EOF" Enter
+Sleep 2
+Type "" Enter
+Type "# Create structure that uses mappings" Enter
+Type "cat > app-config.yaml << 'EOF'" Enter
+Type "files:" Enter
+Type "  - config/{{@ env @}}.json:" Enter
+Type "      content: |" Enter
+Type "        {" Enter
+Type "          \"database_url\": \"{{@ mappings.environments[env].database_url @}}\"," Enter
+Type "          \"debug\": {{@ mappings.environments[env].debug @}}," Enter
+Type "          \"contact\": \"{{@ mappings.teams.devops @}}\"" Enter
+Type "        }" Enter
+Type "variables:" Enter
+Type "  - env:" Enter
+Type "      description: 'Environment (dev/prod)'" Enter
+Type "      type: string" Enter
+Type "      default: 'dev'" Enter
+Type "EOF" Enter
+Sleep 3
+Type "" Enter
+Type "# Generate with mappings file" Enter
+Type "struct generate --mappings-file mappings.yaml app-config.yaml ./config-output" Enter
+Sleep 5
+Type "" Enter
+Type "# Check generated configuration" Enter
+Type "cat config-output/config/dev.json" Enter
+Sleep 3
+
+

5. Multiple Mappings Files

+

File: multiple-mappings.tape +Description: Shows the new multiple mappings file feature with deep merging.

+
Output docs/vhs/multiple-mappings.gif
+
+Set Theme "Monokai Vivid"
+Set FontSize 14
+Set TypingSpeed 40ms
+Set WindowBar Colorful
+Set BorderRadius 8
+Set Margin 0
+Set Padding 10
+Set Width 1400
+Set Height 800
+Set Shell "bash"
+
+Type "# Create base mappings file" Enter
+Type "cat > base-mappings.yaml << 'EOF'" Enter
+Type "mappings:" Enter
+Type "  common:" Enter
+Type "    app_name: 'MyApp'" Enter
+Type "    version: '1.0.0'" Enter
+Type "  environments:" Enter
+Type "    dev:" Enter
+Type "      replicas: 1" Enter
+Type "EOF" Enter
+Sleep 2
+Type "" Enter
+Type "# Create environment-specific overrides" Enter
+Type "cat > prod-mappings.yaml << 'EOF'" Enter
+Type "mappings:" Enter
+Type "  environments:" Enter
+Type "    dev:" Enter
+Type "      debug: true" Enter
+Type "    prod:" Enter
+Type "      replicas: 3" Enter
+Type "      debug: false" Enter
+Type "EOF" Enter
+Sleep 2
+Type "" Enter
+Type "# Create deployment template" Enter
+Type "cat > deployment.yaml << 'EOF'" Enter
+Type "files:" Enter
+Type "  - k8s/deployment.yaml:" Enter
+Type "      content: |" Enter
+Type "        apiVersion: apps/v1" Enter
+Type "        kind: Deployment" Enter
+Type "        metadata:" Enter
+Type "          name: {{@ mappings.common.app_name @}}" Enter
+Type "        spec:" Enter
+Type "          replicas: {{@ mappings.environments[env].replicas @}}" Enter
+Type "variables:" Enter
+Type "  - env:" Enter
+Type "      description: 'Target environment'" Enter
+Type "      default: 'dev'" Enter
+Type "EOF" Enter
+Sleep 3
+Type "" Enter
+Type "# Generate with multiple mappings files (deep merge)" Enter
+Type "struct generate \\" Enter
+Type "  --mappings-file base-mappings.yaml \\" Enter
+Type "  --mappings-file prod-mappings.yaml \\" Enter
+Type "  deployment.yaml ./k8s-output" Enter
+Sleep 5
+Type "" Enter
+Type "# Check the merged result" Enter
+Type "cat k8s-output/k8s/deployment.yaml" Enter
+Sleep 3
+
+

6. Advanced Features

+

File: advanced-features.tape +Description: Demonstrates dry-run, file strategies, and validation.

+
Output docs/vhs/advanced-features.gif
+
+Set Theme "Monokai Vivid"
+Set FontSize 14
+Set TypingSpeed 40ms
+Set WindowBar Colorful
+Set BorderRadius 8
+Set Margin 0
+Set Padding 10
+Set Width 1400
+Set Height 800
+Set Shell "bash"
+
+Type "# Create a test structure" Enter
+Type "mkdir -p existing-project && echo 'old content' > existing-project/README.md" Enter
+Sleep 1
+Type "" Enter
+Type "# Use dry-run to preview changes" Enter
+Type "struct generate --dry-run terraform/module ./existing-project" Enter
+Sleep 5
+Type "" Enter
+Type "# Validate a YAML configuration" Enter
+Type "cat > test-config.yaml << 'EOF'" Enter
+Type "files:" Enter
+Type "  - test.txt:" Enter
+Type "      content: 'Hello World'" Enter
+Type "EOF" Enter
+Sleep 2
+Type "struct validate test-config.yaml" Enter
+Sleep 3
+Type "" Enter
+Type "# Generate with backup strategy" Enter
+Type "struct generate --file-strategy=backup --backup=./backups terraform/module ./existing-project" Enter
+Sleep 5
+Type "" Enter
+Type "# Check backup was created" Enter
+Type "ls -la backups/ && echo && echo 'New content:' && head existing-project/README.md" Enter
+Sleep 3
+
+

7. Remote Content & Protocols

+

File: remote-content.tape +Description: Shows fetching content from remote sources (GitHub, HTTP, etc.).

+
Output docs/vhs/remote-content.gif
+
+Set Theme "Monokai Vivid"
+Set FontSize 14
+Set TypingSpeed 40ms
+Set WindowBar Colorful
+Set BorderRadius 8
+Set Margin 0
+Set Padding 10
+Set Width 1400
+Set Height 800
+Set Shell "bash"
+
+Type "# Create structure using remote content" Enter
+Type "cat > remote-demo.yaml << 'EOF'" Enter
+Type "files:" Enter
+Type "  - .gitignore:" Enter
+Type "      file: github://github/gitignore/main/Python.gitignore" Enter
+Type "  - LICENSE:" Enter
+Type "      file: https://raw.githubusercontent.com/licenses/license-templates/master/templates/mit.txt" Enter
+Type "  - README.md:" Enter
+Type "      content: |" Enter
+Type "        # {{@ project_name @}}" Enter
+Type "        " Enter
+Type "        This project uses remote content from GitHub." Enter
+Type "variables:" Enter
+Type "  - project_name:" Enter
+Type "      description: 'Project name'" Enter
+Type "      default: 'RemoteDemo'" Enter
+Type "EOF" Enter
+Sleep 3
+Type "" Enter
+Type "# Generate project with remote content" Enter
+Type "struct generate remote-demo.yaml ./remote-project" Enter
+Sleep 8
+Type "" Enter
+Type "# Check downloaded content" Enter
+Type "echo 'Generated files:' && ls -la remote-project/" Enter
+Type "echo && echo 'First few lines of .gitignore:' && head -10 remote-project/.gitignore" Enter
+Sleep 5
+
+

8. Schema Generation

+

File: schema-generation.tape +Description: Demonstrates the generate-schema command for IDE integration.

+
Output docs/vhs/schema-generation.gif
+
+Set Theme "Monokai Vivid"
+Set FontSize 14
+Set TypingSpeed 40ms
+Set WindowBar Colorful
+Set BorderRadius 8
+Set Margin 0
+Set Padding 10
+Set Width 1400
+Set Height 800
+Set Shell "bash"
+
+Type "# Generate JSON schema for available structures" Enter
+Type "struct generate-schema" Enter
+Sleep 5
+Type "" Enter
+Type "# Save schema to file for IDE integration" Enter
+Type "struct generate-schema -o struct-schema.json" Enter
+Sleep 3
+Type "" Enter
+Type "# Check the generated schema" Enter
+Type "echo 'Schema file created:' && ls -la struct-schema.json" Enter
+Type "echo && echo 'Available structures in schema:' && jq -r '.definitions.PluginList.enum[]' struct-schema.json | head -10" Enter
+Sleep 5
+Type "" Enter
+Type "# Schema can be used in VS Code for autocompletion" Enter
+Type "echo 'Add to your .struct.yaml files for IDE support:'" Enter
+Type "echo '# yaml-language-server: \$schema=./struct-schema.json'" Enter
+Sleep 3
+
+

🎥 Creating the GIFs

+

To generate all the GIF animations, run:

+
# Install VHS if not already installed
+go install github.com/charmbracelet/vhs@latest
+
+# Generate all tapes
+cd docs/vhs
+vhs install.tape
+vhs basic-usage.tape
+vhs yaml-config.tape
+vhs mappings-demo.tape
+vhs multiple-mappings.tape
+vhs advanced-features.tape
+vhs remote-content.tape
+vhs schema-generation.tape
+
+

📖 Usage in Documentation

+

These GIFs can be embedded in:

+
    +
  • README.md - Show installation and basic usage
    • +
  • docs/quickstart.md - Include basic-usage.gif
    • +
  • docs/mappings.md - Include mappings-demo.gif and multiple-mappings.gif
    • +
  • docs/configuration.md - Include yaml-config.gif
    • +
  • docs/file-handling.md - Include advanced-features.gif
    • +
  • docs/schema.md - Include schema-generation.gif
    • +
+

Example markdown embedding:

+
![STRUCT Basic Usage](./docs/vhs/basic-usage.gif)
+
+

⚙️ VHS Configuration

+

All tapes use consistent settings:

+
    +
  • Theme: Monokai Vivid
    • +
  • Font Size: 14
    • +
  • Typing Speed: 40ms
    • +
  • Dimensions: 1400x800
    • +
  • Shell: bash
    • +
+

🔄 Updating Tapes

+

When STRUCT features change:

+
    +
  1. Update the relevant tape file
    2. +
  2. Regenerate the GIF: vhs filename.tape
    3. +
  3. Commit both the tape and GIF files
    4. +
  4. Update documentation references if needed
    5. +
+
+

These demonstrations provide comprehensive coverage of STRUCT's capabilities, from basic usage to advanced features like multiple mappings files, remote content fetching, and schema generation.

+ + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + diff --git a/site/demos/install.gif b/site/vhs/install.gif similarity index 100% rename from site/demos/install.gif rename to site/vhs/install.gif diff --git a/site/vhs/install.tape b/site/vhs/install.tape new file mode 100644 index 0000000..a8e1f04 --- /dev/null +++ b/site/vhs/install.tape @@ -0,0 +1,45 @@ + +Output docs/vhs/install.gif + +Set Theme "Monokai Vivid" +Set FontSize 14 +Set TypingSpeed 40ms +Set Width 1400 +Set Height 800 +Set Shell "bash" + +Type "# STRUCT Installation Demo" +Enter +Sleep 1s + +Type "# Create python virtual environment and install struct" +Enter +Type "python3 -m venv .venv" +Enter +Sleep 2s + +Type "source .venv/bin/activate" +Enter +Sleep 1s + +Type "# Install STRUCT from GitHub" +Enter +Type "pip install git+https://github.com/httpdss/struct.git" +Enter +Sleep 5s + +Type "# Verify installation" +Enter +Type "struct --help" +Enter +Sleep 2s + +Type "# Check available structures" +Enter +Type "struct list" +Enter +Sleep 3s + +Type "# STRUCT is now installed and ready to use!" +Enter +Sleep 2s diff --git a/site/demos/mappings-demo.gif b/site/vhs/mappings-demo.gif similarity index 100% rename from site/demos/mappings-demo.gif rename to site/vhs/mappings-demo.gif diff --git a/site/vhs/mappings-demo.tape b/site/vhs/mappings-demo.tape new file mode 100644 index 0000000..65707d9 --- /dev/null +++ b/site/vhs/mappings-demo.tape @@ -0,0 +1,72 @@ +Output docs/vhs/mappings-demo.gif + +Set Theme "Monokai Vivid" +Set FontSize 14 +Set TypingSpeed 40ms +Set Width 1400 +Set Height 800 +Set Shell "bash" + +Type "# STRUCT Mappings Demo" +Enter +Sleep 1s + +Type "# Create a simple mapping file with team data" +Enter +Type "cat > team-mapping.yaml << EOF" +Enter +Type "mappings:" +Enter +Type " team_info:" +Enter +Type " backend:" +Enter +Type ' lead: "Alice Johnson"' +Enter +Type ' tech_stack: ["Python", "FastAPI", "PostgreSQL"]' +Enter +Type ' repo: "https://github.com/company/backend"' +Enter +Type "EOF" +Enter +Sleep 2s + +Type "# Create structure using mapping data" +Enter +Type "cat > project-with-mapping.yaml << EOF" +Enter +Type "mappings:" +Enter +Type " - team-mapping.yaml" +Enter +Type "files:" +Enter +Type " - README.md:" +Enter +Type " content: |" +Enter +Type " # Backend Team Project" +Enter +Type " Team Lead: Alice Johnson" +Enter +Type " Tech Stack: Python, FastAPI, PostgreSQL" +Enter +Type "EOF" +Enter +Sleep 2s + +Type "# Generate project for backend team" +Enter +Type "struct generate project-with-mapping.yaml ./backend-project" +Enter +Sleep 3s + +Type "# Check the generated README" +Enter +Type "cat backend-project/README.md" +Enter +Sleep 2s + +Type "# Mappings enable data-driven project generation!" +Enter +Sleep 2s diff --git a/site/demos/multiple-mappings.gif b/site/vhs/multiple-mappings.gif similarity index 100% rename from site/demos/multiple-mappings.gif rename to site/vhs/multiple-mappings.gif diff --git a/site/vhs/multiple-mappings.tape b/site/vhs/multiple-mappings.tape new file mode 100644 index 0000000..341ba60 --- /dev/null +++ b/site/vhs/multiple-mappings.tape @@ -0,0 +1,104 @@ +Output docs/vhs/multiple-mappings.gif + +Set Theme "Monokai Vivid" +Set FontSize 14 +Set TypingSpeed 40ms +Set Width 1400 +Set Height 800 +Set Shell "bash" + +Type "# STRUCT Multiple Mappings Demo" +Enter +Sleep 1s + +Type "# Create company info mapping" +Enter +Type "cat > company-info.yaml << EOF" +Enter +Type "mappings:" +Enter +Type " company:" +Enter +Type ' name: "TechCorp Inc"' +Enter +Type ' website: "https://techcorp.com"' +Enter +Type ' license: "MIT"' +Enter +Type "EOF" +Enter +Sleep 1s + +Type "# Create environment mapping" +Enter +Type "cat > environments.yaml << EOF" +Enter +Type "mappings:" +Enter +Type " environments:" +Enter +Type " development:" +Enter +Type ' domain: "dev.techcorp.com"' +Enter +Type ' database: "postgres://dev-db:5432/app"' +Enter +Type " production:" +Enter +Type ' domain: "techcorp.com"' +Enter +Type ' database: "postgres://prod-db:5432/app"' +Enter +Type "EOF" +Enter +Sleep 1s + +Type "# Create project using multiple mappings" +Enter +Type "cat > multi-mapping-project.yaml << EOF" +Enter +Type "mappings:" +Enter +Type " - company-info.yaml" +Enter +Type " - environments.yaml" +Enter +Type "files:" +Enter +Type " - config/app.yaml:" +Enter +Type " content: |" +Enter +Type " app:" +Enter +Type " name: MyApp" +Enter +Type " company: TechCorp Inc" +Enter +Type " website: https://techcorp.com" +Enter +Type " environment:" +Enter +Type " domain: dev.techcorp.com" +Enter +Type " database: postgres://dev-db:5432/app" +Enter +Type "EOF" +Enter +Sleep 2s + +Type "# Generate for development environment" +Enter +Type "struct generate multi-mapping-project.yaml ./dev-app" +Enter +Sleep 3s + +Type "# View the generated config" +Enter +Type "cat dev-app/config/app.yaml" +Enter +Sleep 2s + +Type "# Multiple mappings provide powerful data composition!" +Enter +Sleep 2s diff --git a/site/demos/remote-content.gif b/site/vhs/remote-content.gif similarity index 100% rename from site/demos/remote-content.gif rename to site/vhs/remote-content.gif diff --git a/site/vhs/remote-content.tape b/site/vhs/remote-content.tape new file mode 100644 index 0000000..31d01a7 --- /dev/null +++ b/site/vhs/remote-content.tape @@ -0,0 +1,66 @@ +Output docs/vhs/remote-content.gif + +Set Theme "Monokai Vivid" +Set FontSize 14 +Set TypingSpeed 40ms +Set Width 1400 +Set Height 800 +Set Shell "bash" + +Type "# STRUCT Remote Content Demo" +Enter +Sleep 1s + +Type "# Create configuration with remote files" +Enter +Type "cat > remote-example.yaml << EOF" +Enter +Type "files:" +Enter +Type " - .gitignore:" +Enter +Type " file: https://raw.githubusercontent.com/github/gitignore/refs/heads/main/Python.gitignore" +Enter +Type " - LICENSE:" +Enter +Type " file: https://raw.githubusercontent.com/licenses/license-templates/master/templates/mit.txt" +Enter +Type " - README.md:" +Enter +Type " content: |" +Enter +Type " # Remote Content Demo" +Enter +Type " This project uses remote content from various sources." +Enter +Type "EOF" +Enter +Sleep 2s + +Type "# Generate project with remote content" +Enter +Type "struct generate remote-example.yaml ./remote-demo" +Enter +Sleep 4s + +Type "# Check downloaded files" +Enter +Type "ls -la remote-demo/" +Enter +Sleep 2s + +Type "# View the .gitignore from GitHub" +Enter +Type "head -10 remote-demo/.gitignore" +Enter +Sleep 2s + +Type "# View the LICENSE file" +Enter +Type "head -5 remote-demo/LICENSE" +Enter +Sleep 2s + +Type "# Remote content makes reusing existing resources easy!" +Enter +Sleep 2s diff --git a/site/demos/schema-generation.gif b/site/vhs/schema-generation.gif similarity index 100% rename from site/demos/schema-generation.gif rename to site/vhs/schema-generation.gif diff --git a/site/vhs/schema-generation.tape b/site/vhs/schema-generation.tape new file mode 100644 index 0000000..f762a91 --- /dev/null +++ b/site/vhs/schema-generation.tape @@ -0,0 +1,60 @@ +Output docs/vhs/schema-generation.gif + +Set Theme "Monokai Vivid" +Set FontSize 14 +Set TypingSpeed 40ms +Set Width 1400 +Set Height 800 +Set Shell "bash" + +Type "# STRUCT Schema Generation Demo" +Enter +Sleep 1s + +Type "# Generate JSON schema for VSCode autocompletion" +Enter +Type "struct generate-schema" +Enter +Sleep 3s + +Type "# Save schema to a file for VSCode" +Enter +Type "mkdir -p .vscode" +Enter +Type "struct generate-schema --output .vscode/struct-plugins.schema.json" +Enter +Sleep 2s + +Type "# View the generated schema" +Enter +Type "cat .vscode/struct-plugins.schema.json" +Enter +Sleep 3s + +Type "# Create VSCode settings to use the schema" +Enter +Type "cat > .vscode/settings.json << EOF" +Enter +Type "{" +Enter +Type ' "yaml.schemas": {' +Enter +Type ' "./.vscode/struct-plugins.schema.json": "*.struct.yaml"' +Enter +Type " }" +Enter +Type "}" +Enter +Type "EOF" +Enter +Sleep 2s + +Type "# Now VSCode will provide autocompletion for struct names!" +Enter +Type "# when you type 'struct:' in a .struct.yaml file" +Enter +Sleep 2s + +Type "# Schema generation enables better IDE support!" +Enter +Sleep 2s diff --git a/site/demos/yaml-config.gif b/site/vhs/yaml-config.gif similarity index 100% rename from site/demos/yaml-config.gif rename to site/vhs/yaml-config.gif diff --git a/site/vhs/yaml-config.tape b/site/vhs/yaml-config.tape new file mode 100644 index 0000000..b2cabbd --- /dev/null +++ b/site/vhs/yaml-config.tape @@ -0,0 +1,64 @@ +Output docs/vhs/yaml-config.gif + +Set Theme "Monokai Vivid" +Set FontSize 14 +Set TypingSpeed 40ms +Set Width 1400 +Set Height 800 +Set Shell "bash" + +Type "# STRUCT YAML Configuration Demo" +Enter +Sleep 1s + +Type "# Create a simple project structure configuration" +Enter +Type "cat > my-project.yaml << EOF" +Enter +Type "files:" +Enter +Type " - README.md:" +Enter +Type " content: |" +Enter +Type " # My Project" +Enter +Type " Generated with STRUCT" +Enter +Type " - .gitignore:" +Enter +Type " file: https://raw.githubusercontent.com/github/gitignore/refs/heads/main/Python.gitignore" +Enter +Type "EOF" +Enter +Sleep 3s + +Type "# Validate the configuration" +Enter +Type "struct validate my-project.yaml" +Enter +Sleep 2s + +Type "# Generate the project" +Enter +Type "struct generate my-project.yaml ./my-custom-project" +Enter +Sleep 3s + +Type "# Check the generated structure" +Enter +Type "ls -la my-custom-project/" +Enter +Sleep 2s + +Type "cat my-custom-project/README.md" +Enter +Sleep 2s + +Type "# YAML configuration makes STRUCT highly flexible!" +Enter +Sleep 2s +Sleep 2s + +Type "# YAML configuration makes STRUCT highly flexible!" Enter +Sleep 2s diff --git a/struct_module/commands/generate.py b/struct_module/commands/generate.py index e78b83d..be49c02 100644 --- a/struct_module/commands/generate.py +++ b/struct_module/commands/generate.py @@ -12,9 +12,21 @@ class GenerateCommand(Command): def __init__(self, parser): super().__init__(parser) - structure_arg = parser.add_argument('structure_definition', type=str, help='Path to the YAML configuration file') + structure_arg = parser.add_argument( + 'structure_definition', + type=str, + help='Path to the YAML configuration file', + nargs='?', + default='./.struct.yaml' + ) structure_arg.completer = structures_completer - parser.add_argument('base_path', type=str, help='Base path where the structure will be created') + parser.add_argument( + 'base_path', + type=str, + nargs='?', + default='.', + help='Base path where the structure will be created (default: current directory)' + ) parser.add_argument('-s', '--structures-path', type=str, help='Path to structure definitions') parser.add_argument('-n', '--input-store', type=str, help='Path to the input store', default='/tmp/struct/input.json') parser.add_argument('-d', '--dry-run', action='store_true', help='Perform a dry run without creating any files or directories') @@ -192,7 +204,7 @@ def _create_structure(self, args, mappings=None): # Output mode logic if hasattr(args, 'output') and args.output == 'console': # Print the file path and content to the console instead of creating the file - print(f"=== {file_path_to_create} ===") + print(f"\n📝 === {file_path_to_create.upper()} === 📝\n") print(file_item.content) else: file_item.create( @@ -201,74 +213,74 @@ def _create_structure(self, args, mappings=None): args.backup or None, args.file_strategy or 'overwrite' ) + if not "console" in args.output: + for item in config_folders: + for folder, content in item.items(): + folder_path = os.path.join(args.base_path, folder) + if hasattr(args, 'output') and args.output == 'file': + os.makedirs(folder_path, exist_ok=True) + self.logger.info(f"Created folder") + self.logger.info(f" Folder: {folder_path}") - for item in config_folders: - for folder, content in item.items(): - folder_path = os.path.join(args.base_path, folder) - if hasattr(args, 'output') and args.output == 'file': - os.makedirs(folder_path, exist_ok=True) - self.logger.info(f"Created folder") - self.logger.info(f" Folder: {folder_path}") + # check if content has struct value + if 'struct' in content: + self.logger.info(f"Generating structure") + self.logger.info(f" Folder: {folder}") + self.logger.info(f" Struct:") + if isinstance(content['struct'], list): + # iterate over the list of structures + for struct in content['struct']: + self.logger.info(f" - {struct}") + if isinstance(content['struct'], str): + self.logger.info(f" - {content['struct']}") - # check if content has struct value - if 'struct' in content: - self.logger.info(f"Generating structure") - self.logger.info(f" Folder: {folder}") - self.logger.info(f" Struct:") - if isinstance(content['struct'], list): - # iterate over the list of structures - for struct in content['struct']: - self.logger.info(f" - {struct}") - if isinstance(content['struct'], str): - self.logger.info(f" - {content['struct']}") + # get vars from with param. this will be a dict of key value pairs + merged_vars = "" - # get vars from with param. this will be a dict of key value pairs - merged_vars = "" + # dict to comma separated string + if 'with' in content: + if isinstance(content['with'], dict): + # Render Jinja2 expressions in each value using TemplateRenderer + rendered_with = {} + renderer = TemplateRenderer( + config_variables, args.input_store, args.non_interactive, mappings) + for k, v in content['with'].items(): + # Render the value as a template, passing in mappings and template_vars + context = template_vars.copy() if template_vars else {} + context['mappings'] = mappings or {} + rendered_with[k] = renderer.render_template(str(v), context) + merged_vars = ",".join( + [f"{k}={v}" for k, v in rendered_with.items()]) - # dict to comma separated string - if 'with' in content: - if isinstance(content['with'], dict): - # Render Jinja2 expressions in each value using TemplateRenderer - rendered_with = {} - renderer = TemplateRenderer( - config_variables, args.input_store, args.non_interactive, mappings) - for k, v in content['with'].items(): - # Render the value as a template, passing in mappings and template_vars - context = template_vars.copy() if template_vars else {} - context['mappings'] = mappings or {} - rendered_with[k] = renderer.render_template(str(v), context) - merged_vars = ",".join( - [f"{k}={v}" for k, v in rendered_with.items()]) + if args.vars: + merged_vars = args.vars + "," + merged_vars - if args.vars: - merged_vars = args.vars + "," + merged_vars - - if isinstance(content['struct'], str): - self._create_structure({ - 'structure_definition': content['struct'], - 'base_path': folder_path, - 'structures_path': args.structures_path, - 'dry_run': args.dry_run, - 'vars': merged_vars, - 'backup': args.backup, - 'file_strategy': args.file_strategy, - 'global_system_prompt': args.global_system_prompt, - 'input_store': args.input_store, - 'non_interactive': args.non_interactive, - }) - elif isinstance(content['struct'], list): - for struct in content['struct']: + if isinstance(content['struct'], str): self._create_structure({ - 'structure_definition': struct, - 'base_path': folder_path, - 'structures_path': args.structures_path, - 'dry_run': args.dry_run, - 'vars': merged_vars, - 'backup': args.backup, - 'file_strategy': args.file_strategy, - 'global_system_prompt': args.global_system_prompt, - 'input_store': args.input_store, - 'non_interactive': args.non_interactive, + 'structure_definition': content['struct'], + 'base_path': folder_path, + 'structures_path': args.structures_path, + 'dry_run': args.dry_run, + 'vars': merged_vars, + 'backup': args.backup, + 'file_strategy': args.file_strategy, + 'global_system_prompt': args.global_system_prompt, + 'input_store': args.input_store, + 'non_interactive': args.non_interactive, }) - else: - self.logger.warning(f"Unsupported content in folder: {folder}") + elif isinstance(content['struct'], list): + for struct in content['struct']: + self._create_structure({ + 'structure_definition': struct, + 'base_path': folder_path, + 'structures_path': args.structures_path, + 'dry_run': args.dry_run, + 'vars': merged_vars, + 'backup': args.backup, + 'file_strategy': args.file_strategy, + 'global_system_prompt': args.global_system_prompt, + 'input_store': args.input_store, + 'non_interactive': args.non_interactive, + }) + else: + self.logger.warning(f"Unsupported content in folder: {folder}") diff --git a/struct_module/contribs/prompts/feature.yaml b/struct_module/contribs/prompts/feature.yaml new file mode 100644 index 0000000..2d07a92 --- /dev/null +++ b/struct_module/contribs/prompts/feature.yaml @@ -0,0 +1,58 @@ +files: + - CREATE-FEATURE: + content: | + You are a helpful assistant that can query the MCPs available + + {%@ if ticket_system == "jira" @%} + {%@ if jira_issue_id != "" @%} + Create a new feature branch for the following Jira issue: "{{@ jira_issue_id @}}" + {%@ else @%} + Look for my currently "In Progress" Jira issues that relate to "{{@ jira_search_text @}}" and create a new feature branch for it + {%@ endif @%} + {%@ endif @%} + + {%@ if ticket_system == "github" @%} + {%@ if github_issue_id != "" @%} + Create a new feature branch for the following GitHub issue: "{{@ github_issue_id @}}" + {%@ else @%} + Look for GitHub issues inside this repository that relate to "{{@ github_search_text @}}" and create a new feature branch for it + {%@ endif @%} + {%@ endif @%} + Make sure that the branch name is prefixed with "feature/" and follows the naming conventions of the repository. + Also, ensure that the branch is created from the latest main branch of the repository. You will need to check what the default branch is for the repository. + - CLOSE-FEATURE: + content: | + You are a helpful assistant that can query the MCPs available + + Look through the changes, commit the changes and push the branch to the remote repository. + Create a pull request for the branch you just created. + {%@ if ticket_system == "jira" @%} + Link the pull request to the Jira issue "{{@ jira_issue_id @}}". + {%@ endif @%} + - SIMPLE-PUSH-AND-CREATE-PR: + content: | + You are a helpful assistant that can query the MCPs available + + Look through the changes, commit the changes and push the branch to the remote repository. + Create a pull request for the branch you just created. +variables: + - ticket_system: + type: string + description: The ticket system to use (e.g., "jira" or "github") + default: "jira" + - jira_issue_id: + type: string + description: The Jira issue ID to create a feature branch for + default: "" + - jira_search_text: + type: string + description: Text to search for Jira issues if no specific ID is provided + default: "" + - github_issue_id: + type: string + description: The GitHub issue ID to create a feature branch for + default: "" + - github_search_text: + type: string + description: Text to search for GitHub issues if no specific ID is provided + default: ""

CLI Reference