diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 87589eb..6daeff1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,4 @@ + ## Description ## TODO diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1c60aad..e416075 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,6 +19,17 @@ jobs: terraform_wrapper: false - run: terraform fmt -check -recursive -diff + markdownlint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + # Globs and rules come from .markdownlint-cli2.yaml. npm ci installs the + # exact tree from package-lock.json, so no markdownlint (or transitive) + # release can change rules or break CI without a repo change; bump the + # version deliberately via package.json. + - run: npm ci + - run: npx --no-install markdownlint-cli2 + validate: runs-on: ubuntu-latest strategy: diff --git a/.gitignore b/.gitignore index d551d84..29df53a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .terraform .terraform.lock.hcl tfplan +node_modules diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000..e0f860f --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,26 @@ +# markdownlint-cli2 configuration. See https://github.com/DavidAnson/markdownlint +# for the full rule reference. +config: + # Line length: prose, tables, and long links routinely exceed any fixed width. + line-length: false + # Bold-as-heading: the docs deliberately use bold text as inline labels. + no-emphasis-as-heading: false + # Table column style: enforces consistent cell padding across tables; + # cosmetic, tables render correctly either way. + table-column-style: false + # Duplicate headings: the CHANGELOG repeats Added/Changed/Fixed per release, + # which is the Keep a Changelog convention. Only flag duplicates under the + # same parent heading. + no-duplicate-heading: + siblings_only: true +# Lint every Markdown file in the repo. Both local runs and CI invoke +# markdownlint-cli2 with no glob arguments, so this is the single source of +# truth for which files are linted. +globs: + - "**/*.{md,markdown}" +# markdownlint-cli2 has no default exclusions, so vendored trees must be +# ignored explicitly: `terraform init` vendors registry modules (and their +# READMEs) under .terraform/, and npm installs under node_modules/. +ignores: + - "**/.terraform/**" + - "**/node_modules/**" diff --git a/CHANGELOG.md b/CHANGELOG.md index 6acde01..a23f8a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,6 +38,7 @@ Optional release notice. ## [1.6.0] - 2026-02-24 If you rely on the default `search_instance_type` / `search_dedicated_master_type`: + - Upgrading from a version prior to 1.5.0 will fail on `terraform apply`. Upgrade to 1.5.0 first. - If you have reserved m5 instances, pin the instance types explicitly to keep using them. diff --git a/OPERATIONS.md b/OPERATIONS.md index 651b619..4aa9d58 100644 --- a/OPERATIONS.md +++ b/OPERATIONS.md @@ -12,20 +12,24 @@ This document provides comprehensive operational procedures for cloud teams mana ### Daily Checklist -- [ ] Health check (5 min) - [Instructions](#daily-health-checks) +- [ ] Health check (5 min) - [Instructions](#daily-health-checks-5-minutes) - [ ] Monitor alerts - [Dashboard Links](#monitoring-dashboards) - [ ] Review logs - [Log Locations](#log-management) ### Weekly Checklist -- [ ] Backup verification (10 min) - [Instructions](#backup-verification) -- [ ] Security updates (15 min) - [Instructions](#security-updates) +- [ ] Backup verification (10 min) - [Instructions](#backup-verification-10-minutes) +- [ ] Security updates (15 min) - [Instructions](#security-updates-15-minutes) + + - [ ] Capacity review (10 min) - [Instructions](#capacity-monitoring) ### Monthly Checklist -- [ ] Capacity planning (20 min) - [Instructions](#capacity-planning) -- [ ] Cost review (15 min) - [Instructions](#cost-optimization) +- [ ] Capacity planning (20 min) - [Instructions](#capacity-planning-20-minutes) +- [ ] Cost review (15 min) - [Instructions](#cost-optimization-recommendations) + + - [ ] Security audit (30 min) - [Instructions](#security-audit) ## Installation Procedures diff --git a/README.md b/README.md index d40ca15..6220e22 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,20 @@ Deploy and maintain Quilt stacks with Terraform using this comprehensive Infrast - [Prerequisites](#prerequisites) - [Quick Start](#quick-start) - [Rightsize Your Search Domain](#rightsize-your-search-domain) + + - [Database Configuration](#database-configuration) + - [Network Configuration](#network-configuration) + - [CloudFormation Parameters](#cloudformation-parameters) + - [Complete Variable Reference](#complete-variable-reference) + - [Deployment Examples](#deployment-examples) -- [Troubleshooting](#troubleshooting) -- [Terraform Commands Reference](#terraform-commands-reference) +- [Troubleshooting](#troubleshooting-common-issues) +- [Terraform Commands Reference](#terraform-cheat-sheet) ## Cloud Team Operations Guide @@ -27,6 +34,7 @@ This section provides step-by-step instructions specifically for cloud teams to #### 1. Environment Preparation (15 minutes) **Step 1.1: Install Required Tools** + ```bash # Install Terraform (if not already installed) # macOS @@ -42,6 +50,7 @@ terraform --version # Should show >= 1.10.0 ``` **Step 1.2: Configure AWS CLI** + ```bash # Install AWS CLI (if not already installed) # macOS @@ -56,6 +65,7 @@ aws sts get-caller-identity ``` **Step 1.3: Set Up Terraform State Backend** + ```bash # Create S3 bucket for Terraform state (one-time setup) aws s3 mb s3://YOUR-COMPANY-terraform-state --region YOUR-AWS-REGION @@ -69,6 +79,7 @@ aws s3api put-bucket-versioning \ #### 2. SSL Certificate Setup (10 minutes) **Step 2.1: Request SSL Certificate** + ```bash # Request certificate in AWS Certificate Manager aws acm request-certificate \ @@ -81,6 +92,7 @@ aws acm request-certificate \ ``` **Step 2.2: Validate Certificate** + ```bash # Get validation records aws acm describe-certificate --certificate-arn "arn:aws:acm:YOUR-AWS-REGION:YOUR-ACCOUNT-ID:certificate/YOUR-CERT-ID" @@ -92,6 +104,7 @@ aws acm describe-certificate --certificate-arn "arn:aws:acm:YOUR-AWS-REGION:YOUR #### 3. Project Setup (10 minutes) **Step 3.1: Create Project Directory** + ```bash # Create project directory mkdir quilt-production @@ -102,6 +115,7 @@ git init ``` **Step 3.2: Download Template Files** + ```bash # Download the example configuration curl -o main.tf https://raw.githubusercontent.com/quiltdata/iac/main/examples/main.tf @@ -132,6 +146,7 @@ Contact your Quilt account manager to obtain the CloudFormation template file an #### Step 1: Configure Your Deployment **Edit main.tf with your specific values:** + ```bash # Open main.tf in your preferred editor vim main.tf # or code main.tf, nano main.tf, etc. @@ -140,6 +155,7 @@ vim main.tf # or code main.tf, nano main.tf, etc. **⚠️ CRITICAL: Replace ALL placeholder values before deployment** **Required changes:** + 1. **AWS Account ID**: Replace `"YOUR-ACCOUNT-ID"` with your AWS account ID 2. **AWS Region**: Replace `"YOUR-AWS-REGION"` with your preferred AWS region 3. **S3 Backend**: Replace `"YOUR-TERRAFORM-STATE-BUCKET"` with your bucket name @@ -152,6 +168,7 @@ vim main.tf # or code main.tf, nano main.tf, etc. > **⚠️ WARNING**: Do NOT run `terraform apply` with placeholder values. This will cause deployment failures and may create resources with incorrect configurations. **Choose ElasticSearch sizing based on your data volume:** + - **Small** (< 100GB): Use commented "Small" configuration - **Medium** (100GB-1TB): Use default configuration (already uncommented) - **Large** (1TB-5TB): Uncomment "Large" configuration @@ -208,6 +225,7 @@ curl -I https://data.YOUR-COMPANY.com # Should return 200 OK #### Daily Operations **Health Checks (5 minutes daily)** + ```bash # Check infrastructure status terraform refresh @@ -223,6 +241,7 @@ aws es describe-elasticsearch-domain --domain-name your-stack-name #### Weekly Maintenance **Backup Verification (10 minutes weekly)** + ```bash # Verify RDS automated backups aws rds describe-db-snapshots --db-instance-identifier your-stack-name @@ -232,6 +251,7 @@ aws es describe-elasticsearch-domain --domain-name your-stack-name ``` **Security Updates (15 minutes weekly)** + ```bash # Check for Terraform module updates # Visit: https://github.com/quiltdata/iac/releases @@ -244,6 +264,7 @@ aws es describe-elasticsearch-domain --domain-name your-stack-name #### Monthly Maintenance **Capacity Planning (20 minutes monthly)** + ```bash # Check ElasticSearch storage usage aws cloudwatch get-metric-statistics \ @@ -273,6 +294,7 @@ aws cloudwatch get-metric-statistics \ **When to Scale**: When storage utilization > 80% **Step 1: Plan the Scaling** + ```bash # Current configuration check terraform show | grep search_volume_size @@ -282,6 +304,7 @@ terraform show | grep search_volume_size ``` **Step 2: Update Configuration** + ```bash # Edit main.tf vim main.tf @@ -294,6 +317,7 @@ terraform plan -out=tfplan ``` **Step 3: Apply During Maintenance Window** + ```bash # Schedule during low-usage period # Scaling causes temporary performance impact @@ -307,6 +331,7 @@ aws es describe-elasticsearch-domain --domain-name your-stack-name #### Database Scaling **Vertical Scaling (Instance Size)** + ```bash # Edit main.tf # Update db_instance_class @@ -317,6 +342,7 @@ terraform apply tfplan # Causes brief downtime ``` **Storage Scaling** + ```bash # RDS storage scales automatically if enabled # Check current storage @@ -328,6 +354,7 @@ aws rds describe-db-instances --db-instance-identifier your-stack-name #### Backup Procedures **Database Backup** + ```bash # Create manual snapshot aws rds create-db-snapshot \ @@ -336,6 +363,7 @@ aws rds create-db-snapshot \ ``` **Configuration Backup** + ```bash # Backup Terraform state aws s3 cp s3://YOUR-TERRAFORM-STATE-BUCKET/quilt/terraform.tfstate \ @@ -348,6 +376,7 @@ tar -czf quilt-config-backup-$(date +%Y%m%d).tar.gz *.tf *.yml #### Recovery Procedures **Database Recovery** + ```bash # List available snapshots aws rds describe-db-snapshots --db-instance-identifier your-stack-name @@ -362,6 +391,7 @@ aws rds describe-db-snapshots --db-instance-identifier your-stack-name #### CloudWatch Alarms **ElasticSearch Monitoring** + ```bash # Create storage utilization alarm aws cloudwatch put-metric-alarm \ @@ -379,6 +409,7 @@ aws cloudwatch put-metric-alarm \ ``` **RDS Monitoring** + ```bash # Create CPU utilization alarm aws cloudwatch put-metric-alarm \ @@ -402,6 +433,7 @@ aws cloudwatch put-metric-alarm \ **Symptoms**: Terraform apply fails with database parameter errors **Solution**: + ```bash # Check current RDS version aws rds describe-db-instances --db-instance-identifier your-stack-name @@ -420,6 +452,7 @@ aws rds modify-db-instance \ **Symptoms**: "ValidationException: A change/update is in progress" **Solution**: + ```bash # Check domain status aws es describe-elasticsearch-domain --domain-name your-stack-name @@ -433,6 +466,7 @@ aws es describe-elasticsearch-domain --domain-name your-stack-name **Symptoms**: Certificate remains in "Pending Validation" status **Solution**: + ```bash # Check DNS validation records aws acm describe-certificate --certificate-arn your-cert-arn @@ -445,18 +479,21 @@ dig _validation-record.data.YOUR-COMPANY.com CNAME ### Security Best Practices #### Access Control + 1. **Use IAM roles** instead of access keys where possible 2. **Enable MFA** for all administrative accounts 3. **Rotate credentials** regularly (quarterly) 4. **Use least privilege** principle for all permissions #### Network Security + 1. **Use internal ALB** for VPN-only access when possible 2. **Configure WAF** with appropriate geofencing 3. **Enable VPC Flow Logs** for network monitoring 4. **Use private subnets** for all internal services #### Data Protection + 1. **Enable encryption at rest** for all storage services 2. **Use SSL/TLS** for all data in transit 3. **Configure CloudTrail** for audit logging @@ -465,6 +502,7 @@ dig _validation-record.data.YOUR-COMPANY.com CNAME ### Cost Optimization #### Regular Cost Reviews + ```bash # Check monthly costs by service aws ce get-cost-and-usage \ @@ -480,6 +518,7 @@ aws ce get-cost-and-usage \ ``` #### Optimization Strategies + 1. **Use Reserved Instances** for production workloads 2. **Right-size instances** based on actual usage 3. **Implement lifecycle policies** for S3 storage @@ -488,16 +527,19 @@ aws ce get-cost-and-usage \ ### Support and Escalation #### Internal Escalation Path + 1. **Level 1**: Cloud team member (daily operations) 2. **Level 2**: Senior cloud engineer (scaling, troubleshooting) 3. **Level 3**: Cloud architect (design changes, major issues) #### External Support + 1. **Quilt Support**: Contact your account manager for application issues 2. **AWS Support**: Use your AWS support plan for infrastructure issues 3. **Community**: GitHub issues for module-related problems #### Emergency Contacts + - **Cloud Team Lead**: [contact information] - **On-call Engineer**: [contact information] - **Quilt Account Manager**: [contact information] @@ -507,6 +549,7 @@ aws ce get-cost-and-usage \ > **📖 Additional Documentation**: For comprehensive enterprise installation guidance, refer to the official documentation at [docs.quilt.bio](https://docs.quilt.bio). This Terraform module complements the standard installation process with Infrastructure as Code automation. ### Required Tools + - **[Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)** >= 1.10.0 - **AWS CLI** >= 2.0 configured with appropriate permissions - **Git** for version control and configuration management @@ -515,7 +558,9 @@ aws ce get-cost-and-usage \ ### Required Resources #### CloudFormation Template + Quilt provides Terraform-compatible CloudFormation templates via email: + - **Initial Installation**: Template delivered in your installation welcome email from Quilt - **Platform Updates**: Updated templates sent regularly via platform update emails - **Template Location**: Save the template as `quilt-template.yml` in your project directory @@ -523,6 +568,7 @@ Quilt provides Terraform-compatible CloudFormation templates via email: - **Template Validation**: Verify template integrity before deployment #### AWS Infrastructure Requirements + - **AWS Account** with administrative permissions or specific IAM policies (see [AWS Permissions](#aws-permissions)) - **AWS Region** selection based on data residency and compliance requirements - **SSL Certificate** in AWS Certificate Manager for HTTPS access @@ -532,6 +578,7 @@ Quilt provides Terraform-compatible CloudFormation templates via email: #### Network Requirements **For Internet-Facing Deployments:** + - Public subnets in at least 2 Availability Zones for load balancer - Private subnets in at least 2 Availability Zones for application services - Isolated subnets in at least 2 Availability Zones for database and search @@ -539,12 +586,14 @@ Quilt provides Terraform-compatible CloudFormation templates via email: - NAT Gateways for private subnet internet access **For Internal/VPN-Only Deployments:** + - Private subnets in at least 2 Availability Zones for application services and load balancer - Isolated subnets in at least 2 Availability Zones for database and search - VPC Endpoints for AWS service access (S3, ECR, CloudWatch, etc.) - VPN or Direct Connect for user access **Security Groups:** + - Application Load Balancer security group (port 443 from users) - Application services security group (port 80 from ALB) - Database security group (port 5432 from application) @@ -553,16 +602,19 @@ Quilt provides Terraform-compatible CloudFormation templates via email: #### Capacity Planning **Minimum Requirements:** + - **Database**: db.t3.small (2 vCPU, 2GB RAM) for development - **ElasticSearch**: 1x m6g.large.elasticsearch (2 vCPU, 8GB RAM, 512GB storage) for development - **Application**: ECS Fargate tasks (0.5 vCPU, 1GB RAM per task) **Production Recommendations:** + - **Database**: db.t3.medium or larger (2+ vCPU, 4+ GB RAM) with Multi-AZ - **ElasticSearch**: 2x m6g.xlarge.elasticsearch (4 vCPU, 16GB RAM, 1TB+ storage) with zone awareness - **Application**: Multiple ECS Fargate tasks across availability zones **Storage Considerations:** + - **Database Storage**: 100GB minimum, auto-scaling enabled - **ElasticSearch Storage**: Size based on data volume (see [Rightsize Your Search Domain](#rightsize-your-search-domain)) - **Application Logs**: CloudWatch Logs with appropriate retention policies @@ -570,6 +622,7 @@ Quilt provides Terraform-compatible CloudFormation templates via email: ### AWS Permissions #### Required IAM Permissions + The deploying user or role needs the following AWS permissions: ```json @@ -618,7 +671,9 @@ The deploying user or role needs the following AWS permissions: ``` #### Service-Linked Roles + Ensure the following AWS service-linked roles exist (created automatically if missing): + - `AWSServiceRoleForElasticLoadBalancing` - `AWSServiceRoleForECS` - `AWSServiceRoleForRDS` @@ -627,18 +682,21 @@ Ensure the following AWS service-linked roles exist (created automatically if mi ### Security Considerations #### Network Security + - **VPC Flow Logs**: Enable for network monitoring and security analysis - **Security Groups**: Follow principle of least privilege - **NACLs**: Additional layer of network security (optional) - **WAF**: Web Application Firewall for additional protection (configured in CloudFormation) #### Data Protection + - **Encryption at Rest**: Enabled for RDS, ElasticSearch, and S3 - **Encryption in Transit**: TLS 1.2+ for all communications - **Key Management**: AWS KMS for encryption key management - **Backup Encryption**: All backups encrypted with KMS #### Access Control + - **IAM Roles**: Use IAM roles instead of access keys where possible - **MFA**: Multi-factor authentication for administrative access - **Audit Logging**: CloudTrail enabled for all API calls @@ -647,11 +705,13 @@ Ensure the following AWS service-linked roles exist (created automatically if mi ### Compliance Considerations #### Data Residency + - Choose AWS region based on data residency requirements - Consider AWS Local Zones for specific geographic requirements - Review AWS compliance certifications for your region #### Regulatory Compliance + - **SOC 2**: AWS infrastructure is SOC 2 compliant - **GDPR**: Configure data retention and deletion policies - **HIPAA**: Use HIPAA-eligible AWS services if handling PHI @@ -660,12 +720,14 @@ Ensure the following AWS service-linked roles exist (created automatically if mi ### Monitoring and Observability #### Required Monitoring + - **CloudWatch Metrics**: Infrastructure and application metrics - **CloudWatch Logs**: Application and infrastructure logs - **CloudWatch Alarms**: Proactive alerting for issues - **AWS X-Ray**: Distributed tracing (optional) #### Recommended Monitoring + - **AWS Config**: Configuration compliance monitoring - **AWS GuardDuty**: Threat detection - **AWS Security Hub**: Centralized security findings @@ -677,7 +739,7 @@ Ensure the following AWS service-linked roles exist (created automatically if mi Your project structure should look like this: -``` +```text quilt_stack/ ├── main.tf ├── variables.tf # Optional: for sensitive variables @@ -758,6 +820,7 @@ terraform apply tfplan | api_endpoint | For API Gateway when `create_new_vpc = false` | n/a | #### Example VPC Endpoint for API Gateway + This endpoint must be reachable by your VPN clients. ```hcl @@ -833,16 +896,19 @@ address (a license endpoint, a partner firewall, a SaaS IP allowlist) must be updated, or it breaks silently. ### Profile + You may wish to set a specific AWS profile before executing `terraform` commands. ```sh export AWS_PROFILE=your-aws-profile ``` + > We discourage the use of `provider.profile` in team environments > where profile names may differ across users and machines. ### Rightsize your search domain + Your primary consideration is the _total_ data node disk size. If you multiply your average document size (likely a function of the number of [deep-indexed](https://docs.quiltdata.com/catalog/searchquery#indexing) documents @@ -864,6 +930,7 @@ but requires time and may reduce quality of service during the blue/green update Below are known-good search sizes that you can set on the `quilt` module. #### Small + ```hcl search_dedicated_master_enabled = false search_zone_awareness_enabled = false @@ -873,6 +940,7 @@ search_volume_size = 512 ``` #### Medium (default) + ```hcl search_dedicated_master_enabled = true search_zone_awareness_enabled = true @@ -882,6 +950,7 @@ search_volume_size = 1024 ``` #### Large + ```hcl search_dedicated_master_enabled = true search_zone_awareness_enabled = true @@ -892,6 +961,7 @@ search_volume_type = "gp3" ``` #### X-Large + ```hcl search_dedicated_master_enabled = true search_zone_awareness_enabled = true @@ -903,6 +973,7 @@ search_volume_iops = 16000 ``` #### XX-Large + ```hcl search_dedicated_master_enabled = true search_zone_awareness_enabled = true @@ -914,6 +985,7 @@ search_volume_iops = 18750 ``` #### XXX-Large + ```hcl search_dedicated_master_enabled = true search_zone_awareness_enabled = true @@ -926,6 +998,7 @@ search_volume_throughput = 1187 ``` #### XXXX-Large + ```hcl search_dedicated_master_enabled = true search_zone_awareness_enabled = true @@ -938,25 +1011,28 @@ search_volume_throughput = 1187 ``` ## Deploying and updating Quilt + As a rule, `terraform apply` is sufficient to both deploy and update Quilt. ### Verify the plan + Before calling `apply` read `terraform plan` carefully to ensure that it does not inadvertently destroy and recreate the stack. The following modifications are known to cause issues (see [examples/main.tf](examples/main.tf) for context). -* Modifying `local.name`. -* Modifying `local.build_file_path`. -* Modifying `quilt.template_file`. +- Modifying `local.name`. +- Modifying `local.build_file_path`. +- Modifying `quilt.template_file`. And for older versions of Terraform and customers whose usage predates the present module: -* Modifying `template_url=` (in older versions of Terraform). +- Modifying `template_url=` (in older versions of Terraform). + +## Terraform cheat sheet -# Terraform cheat sheet +### Initialize -## Initialize ```sh terraform init ``` @@ -967,69 +1043,80 @@ If for instance you change the provider pinning you may need to `-upgrade`: terraform init -upgrade ``` -## Lint -``` +### Lint + +```sh terraform fmt ``` -## Validate +### Validate -``` +```sh terraform validate ``` -## Test +### Test Module tests are plan-only and mock the AWS provider, so they need no AWS credentials and create no infrastructure. Requires Terraform >= 1.7 (for `mock_provider`). Run from a module or test-wrapper directory, e.g. `modules/vpc` or `modules/quilt/tests/smoke`: -``` +```sh terraform init -backend=false terraform test ``` -## Plan -``` +### Plan + +```sh terraform plan -out tfplan ``` -## Apply +### Apply + If the plan is what you want: -``` + +```sh terraform apply tfplan ``` -## Output sensitive values +### Output sensitive values + Sensitive values must be named in order to display on the command line: -``` + +```sh terraform output admin_password ``` -## State +### State -### Inspect -``` +#### Inspect + +```sh terraform state list ``` Or, to show a specific entity: -``` + +```sh terraform state show 'thing.from.list' ``` -### Refresh -``` +#### Refresh + +```sh terraform refresh ``` -## Destroy -``` +### Destroy + +```sh terraform destroy ``` -## Routine updates +### Routine updates + 1. Start with a clean commit of the previous apply in your Quilt Terraform folder (nothing uncommitted). 1. In your `main.tf` file, do the following: @@ -1045,15 +1132,19 @@ terraform destroy 1. [Apply](#apply). 1. Commit the [appropriate files](#check-these-files-in). -## Git version control -### Check these files in -* `*.tf` -* `terraform.lock.hcl` -* Your Quilt `build_file` +### Git version control + +#### Check these files in + +- `*.tf` +- `terraform.lock.hcl` +- Your Quilt `build_file` + +#### Ignore these files -### Ignore these files You may wish to create a `.gitignore` file similar to the following: -``` + +```text .terraform tfplan ``` @@ -1062,15 +1153,15 @@ tfplan > [remote state](https://developer.hashicorp.com/terraform/language/state/remote) > so that no passwords are checked into version control. -# Known issues +## Known issues -## invalid error message +### invalid error message Due to how Terraform evaluates (or fails to evaluate) arguments in a precondition (e.g. `user_security_group = aws_security_group.lb_security_group.id`) you may see the following error message. Provide a static string instead of a dynamic value. -``` +```text │ 27: condition = !local.configuration_error │ ├──────────────── │ │ local.configuration_error is true @@ -1081,7 +1172,7 @@ see the following error message. Provide a static string instead of a dynamic va Provide a static string instead (e.g. `user_security_group = "123"`) and you should receive a more informative message similar to the following: -``` +```text │ In order to use an existing VPC (create_new_vpc == false) correct the following attributes: │ ❌ api_endpoint (required if var.internal == true, else must be null) │ ✅ create_new_vpc == false @@ -1093,9 +1184,9 @@ receive a more informative message similar to the following: │ ✅ vpc_id (required) ``` -## RDS InvalidParameterCombination +### RDS InvalidParameterCombination -> ``` +> ```text > InvalidParameterCombination: Cannot upgrade postgres from 11.X to 15.Y > ``` @@ -1110,8 +1201,9 @@ to automatically upgrade to 15.5 (without any manual steps). Engine version changes are applied _during the next maintenance window_, therefore you may not see them immediately in AWS Console. -## Elasticsearch ValidationException -> ``` +### Elasticsearch ValidationException + +> ```text > Error: updating Elasticsearch Domain (arn:aws:es:foo:bar/baz) config: > ValidationException: A change/update is in progress. Please wait for it to > complete before requesting another change. @@ -1133,6 +1225,7 @@ provider "aws" { } ``` -# References +## References + 1. [Terraform: AWS Provider Tutorial](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/aws-build) 1. [Terraform: Basic CLI Features](https://developer.hashicorp.com/terraform/cli/commands) diff --git a/VARIABLES.md b/VARIABLES.md index 3e7c366..4f54b74 100644 --- a/VARIABLES.md +++ b/VARIABLES.md @@ -178,6 +178,7 @@ The `parameters` map configures the Quilt application. Here are all available pa ## Configuration Examples by Use Case ### Development Environment + ```hcl # Minimal cost configuration db_instance_class = "db.t3.micro" @@ -191,6 +192,7 @@ search_volume_size = 512 ``` ### Production Environment + ```hcl # High availability configuration db_instance_class = "db.t3.medium" @@ -205,6 +207,7 @@ search_volume_type = "gp3" ``` ### Enterprise Environment + ```hcl # High performance configuration db_instance_class = "db.r5.xlarge" @@ -222,21 +225,25 @@ search_volume_iops = 18750 ## Variable Validation Rules ### Name Validation + - Must be ≤20 characters - Lowercase alphanumeric characters and hyphens only - Used as prefix for AWS resource names ### Network Validation + - CIDR blocks must allow ≥256 IP addresses (≤/24) - Subnet lists must contain exactly 2 subnet IDs when specified - VPC endpoints required for internal deployments with existing VPC ### ElasticSearch Validation + - `search_volume_iops` must be ≥3000 when specified - `search_volume_throughput` must be 125-1000 MiB/s for gp3 volumes - Master node count should be odd (3 or 5) for proper quorum ### Database Validation + - `db_network_type` must be "IPV4" or "DUAL" - Multi-AZ recommended for production environments - Deletion protection recommended for production databases @@ -244,6 +251,7 @@ search_volume_iops = 18750 ## Common Configuration Patterns ### Internet-Facing with New VPC + ```hcl internal = false create_new_vpc = true @@ -252,6 +260,7 @@ cidr = "10.0.0.0/16" ``` ### Internal with Existing VPC + ```hcl internal = true create_new_vpc = false @@ -264,6 +273,7 @@ api_endpoint = "vpce-existing" ``` ### High-Performance ElasticSearch + ```hcl search_instance_type = "m6g.4xlarge.elasticsearch" search_instance_count = 4 diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..9a76f29 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,1345 @@ +{ + "name": "add-markdownlint-ci", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "devDependencies": { + "markdownlint-cli2": "0.22.1" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@sindresorhus/merge-streams": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-4.0.0.tgz", + "integrity": "sha512-tlqY9xq5ukxTUZBmoOp+m61cqwQD5pHJtFY3Mn8CA8ps6yghLH/Hw8UPdqg4OLmFW3IFlcXnQNmo/dh8HzXYIQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@types/debug": { + "version": "4.1.13", + "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.13.tgz", + "integrity": "sha512-KSVgmQmzMwPlmtljOomayoR89W4FynCAi3E8PPs7vmDVPe84hT+vGPKkJfThkmXs0x0jAaa9U8uW8bbfyS2fWw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/ms": "*" + } + }, + "node_modules/@types/katex": { + "version": "0.16.8", + "resolved": "https://registry.npmjs.org/@types/katex/-/katex-0.16.8.tgz", + "integrity": "sha512-trgaNyfU+Xh2Tc+ABIb44a5AYUpicB3uwirOioeOkNPPbmgRNtcWyDeeFRzjPZENO9Vq8gvVqfhaaXWLlevVwg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/ms": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", + "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/unist": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz", + "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==", + "dev": true, + "license": "MIT" + }, + "node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/character-entities": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", + "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-reference-invalid": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", + "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/commander": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", + "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 12" + } + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decode-named-character-reference": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.3.0.tgz", + "integrity": "sha512-GtpQYB283KrPp6nRw50q3U9/VfOutZOe103qlN7BPP6Ad27xYnOIWv4lPzo8HCAL+mMZofJ9KEy30fq6MfaK6Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "character-entities": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "dev": true, + "license": "MIT", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fastq": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", + "dev": true, + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dev": true, + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/get-east-asian-width": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.6.0.tgz", + "integrity": "sha512-QRbvDIbx6YklUe6RxeTeleMR0yv3cYH6PsPZHcnVn7xv7zO1BHN8r0XETu8n6Ye3Q+ahtSarc3WgtNWmehIBfA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/globby": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-16.2.0.tgz", + "integrity": "sha512-QrJia2qDf5BB/V6HYlDTs0I0lBahyjLzpGQg3KT7FnCdTonAyPy2RtY802m2k4ALx6Dp752f82WsOczEVr3l6Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@sindresorhus/merge-streams": "^4.0.0", + "fast-glob": "^3.3.3", + "ignore": "^7.0.5", + "is-path-inside": "^4.0.0", + "slash": "^5.1.0", + "unicorn-magic": "^0.4.0" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ignore": { + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.5.tgz", + "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/is-alphabetical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", + "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-alphanumerical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", + "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-decimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", + "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-hexadecimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", + "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-path-inside": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-4.0.0.tgz", + "integrity": "sha512-lJJV/5dYS+RcL8uQdBDW9c9uWFLLBNRyFhnAKXw5tVqLlKZ4RMGZKv+YQ/IA3OhD+RpbJa1LLFM1FQPGyIXvOA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/js-yaml": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsonc-parser": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/jsonpointer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-5.0.1.tgz", + "integrity": "sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/katex": { + "version": "0.16.47", + "resolved": "https://registry.npmjs.org/katex/-/katex-0.16.47.tgz", + "integrity": "sha512-Eeo8Ys1doU1z+x8AZsPpQu+p/QcZBI5PeOo7QGQdy2x2m0MU/hYagBbGOmXwr5KVbEfVuWv9LpnQWeehogurjg==", + "dev": true, + "funding": [ + "https://opencollective.com/katex", + "https://github.com/sponsors/katex" + ], + "license": "MIT", + "dependencies": { + "commander": "^8.3.0" + }, + "bin": { + "katex": "cli.js" + } + }, + "node_modules/linkify-it": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.1.tgz", + "integrity": "sha512-wVoTjP4Q6R0NW5hiZkVJaFZPWgtXfoGF+6LucL3/FtiNjmcHhYjEr5f1Kqjirc1nBW07J/ZuRFumqr2oqccEWg==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], + "license": "MIT", + "dependencies": { + "uc.micro": "^2.0.0" + } + }, + "node_modules/markdown-it": { + "version": "14.1.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.1.tgz", + "integrity": "sha512-BuU2qnTti9YKgK5N+IeMubp14ZUKUUw7yeJbkjtosvHiP0AZ5c8IAgEMk79D0eC8F23r4Ac/q8cAIFdm2FtyoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, + "node_modules/markdownlint": { + "version": "0.40.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.40.0.tgz", + "integrity": "sha512-UKybllYNheWac61Ia7T6fzuQNDZimFIpCg2w6hHjgV1Qu0w1TV0LlSgryUGzM0bkKQCBhy2FDhEELB73Kb0kAg==", + "dev": true, + "license": "MIT", + "dependencies": { + "micromark": "4.0.2", + "micromark-core-commonmark": "2.0.3", + "micromark-extension-directive": "4.0.0", + "micromark-extension-gfm-autolink-literal": "2.1.0", + "micromark-extension-gfm-footnote": "2.1.0", + "micromark-extension-gfm-table": "2.1.1", + "micromark-extension-math": "3.1.0", + "micromark-util-types": "2.0.2", + "string-width": "8.1.0" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + } + }, + "node_modules/markdownlint-cli2": { + "version": "0.22.1", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.22.1.tgz", + "integrity": "sha512-X14ZbytybDCXAViDmtN4DKLt9ZTrRn+oOrxTYlg3a65jS6QcYYbAkGPh/En2L/GDNbFYJ6lKaQSUNrrbN1bPrw==", + "dev": true, + "license": "MIT", + "peer": true, + "dependencies": { + "globby": "16.2.0", + "js-yaml": "4.1.1", + "jsonc-parser": "3.3.1", + "jsonpointer": "5.0.1", + "markdown-it": "14.1.1", + "markdownlint": "0.40.0", + "markdownlint-cli2-formatter-default": "0.0.6", + "micromatch": "4.0.8", + "smol-toml": "1.6.1" + }, + "bin": { + "markdownlint-cli2": "markdownlint-cli2-bin.mjs" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + } + }, + "node_modules/markdownlint-cli2-formatter-default": { + "version": "0.0.6", + "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.6.tgz", + "integrity": "sha512-VVDGKsq9sgzu378swJ0fcHfSicUnMxnL8gnLm/Q4J/xsNJ4e5bA6lvAz7PCzIl0/No0lHyaWdqVD2jotxOSFMQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + }, + "peerDependencies": { + "markdownlint-cli2": ">=0.0.4" + } + }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true, + "license": "MIT" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromark": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", + "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/debug": "^4.0.0", + "debug": "^4.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", + "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-4.0.0.tgz", + "integrity": "sha512-/C2nqVmXXmiseSSuCdItCMho7ybwwop6RrrRPk0KbOHW21JKoCldC+8rFOaundDoRBUWBnJJcxeA/Kvi34WQXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "parse-entities": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz", + "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==", + "dev": true, + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==", + "dev": true, + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-table": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz", + "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-math": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-math/-/micromark-extension-math-3.1.0.tgz", + "integrity": "sha512-lvEqd+fHjATVs+2v/8kg9i5Q0AP2k85H0WUOwpIVvUML8BapsMvh1XAogmQjOCsLpoKRCVQqEkQBB3NhVBcsOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/katex": "^0.16.0", + "devlop": "^1.0.0", + "katex": "^0.16.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-factory-destination": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz", + "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz", + "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz", + "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz", + "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-chunked": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz", + "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz", + "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-combine-extensions": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz", + "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz", + "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-encode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-html-tag-name": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz", + "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-normalize-identifier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz", + "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-resolve-all": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz", + "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-subtokenize": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz", + "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-types": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", + "dev": true, + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/parse-entities": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz", + "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "^2.0.0", + "character-entities-legacy": "^3.0.0", + "character-reference-invalid": "^2.0.0", + "decode-named-character-reference": "^1.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0", + "is-hexadecimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/picomatch": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "dev": true, + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/slash": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-5.1.0.tgz", + "integrity": "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/smol-toml": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.6.1.tgz", + "integrity": "sha512-dWUG8F5sIIARXih1DTaQAX4SsiTXhInKf1buxdY9DIg4ZYPZK5nGM1VRIYmEbDbsHt7USo99xSLFu5Q1IqTmsg==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">= 18" + }, + "funding": { + "url": "https://github.com/sponsors/cyyynthia" + } + }, + "node_modules/string-width": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-8.1.0.tgz", + "integrity": "sha512-Kxl3KJGb/gxkaUMOjRsQ8IrXiGW75O4E3RPjFIINOVH8AMl2SQ/yWdTzWwF3FevIX9LcMAjJW+GRwAlAbTSXdg==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-east-asian-width": "^1.3.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/strip-ansi": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.2.2" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true, + "license": "MIT" + }, + "node_modules/unicorn-magic": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.4.0.tgz", + "integrity": "sha512-wH590V9VNgYH9g3lH9wWjTrUoKsjLF6sGLjhR4sH1LWpLmCOH0Zf7PukhDA8BiS7KHe4oPNkcTHqYkj7SOGUOw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..1aef722 --- /dev/null +++ b/package.json @@ -0,0 +1,6 @@ +{ + "private": true, + "devDependencies": { + "markdownlint-cli2": "0.22.1" + } +}