How to structure the archive for a Vale package with scripts and dictionaries

[jdbaldry]

I'm looking to create regular releases the Vale style in https://github.com/grafana/writers-toolkit/tree/main/vale/Grafana but I'm struggling to find the correct archive file structure so that the external script in SmartQuotes.yml and the external dictionary en_US-grafana.dic are installed when a user runs a vale sync.

Reading https://vale.sh/docs/topics/packages/#complete, I believe the format should be:

.vale.ini
Grafana/SmartQuotes.yml
styles/scripts/SmartQuotes.tengo
styles/dictionaries/en_US-grafana.dic

Where .vale.ini has the contents:

Packages = https://github.com/errata-ai/Hugo/releases/download/v0.2.0/Hugo.zip, Readability
StylesPath = styles

[*]
BasedOnStyles = Grafana
TokenIgnores = (<http[^\n]+>+?), \*\*[^\n]+\*\*

However, when I use vale sync in a test directory, I don't see the scripts or dictionaries and instead just:

.vale/styles
├── .vale-config
│   ├── 0-Grafana.ini
│   └── 1-Hugo.ini
├── Grafana
│   └── SmartQuotes.yml
└── Readability
    ├── AutomatedReadability.yml
    ├── ColemanLiau.yml
    ├── FleschKincaid.yml
    ├── FleschReadingEase.yml
    ├── GunningFog.yml
    ├── LIX.yml
    ├── SMOG.yml
    └── meta.json

What is the correct layout to package up a style with its supporting scripts and dictionaries?

[jdkato]

In +v3.0, all non-style resources are store under <StylesPath>/config:

$ tree -a MyPackage
MyPackage
├── .vale.ini
└── styles
    ├── MyStyle
    │   └── MyRule.yml
    └── config
        ├── dictionaries
        │   └── MyDic.dic
        ├── scripts
        │   └── MyScript.tengo
        └── vocabularies
            └── MyVocab
                ├── accept.txt
                └── reject.txt

I will add an example to the docs.