Export Vocabularies in a Package

[karl-cardenas-coding]

I am working on creating a custom Vale package for our organization. One area I'm a bit unclear on is if it's possible to also include a set of vocabularies.

In the release notes for 3.0.0, I see a statement stating that all these folders support distribution through packages. However, in the main docs I am unable to find a clear example of how this would work.

I tried adding myStyle/vocabularies/accept.txtin the package zip I created. But I'm not sure how to reference this in my vale.ini file. If I do the following in my main vale.ini I get an error:

StylesPath = vale/styles
Vocab = myStyle/vocabularies

MinAlertLevel = suggestion

Packages = https://github.com/example/custom-vale/releases/latest/download/myStyle.zip

[*.md]
BasedOnStyles = myStyle

I've also tried:

Vocab = myStyle

But the above also fails because it's looking for it in vale/styles/config/vocabularies/. Any guidance would be greatly appreciated 😄

[jdkato]

Your package should look like this

$ tree -a MyPackage                                                                                                       
├── .vale.ini # You can include any config here, but at minimum it needs `StylesPath = styles`.
└── styles
    ├── MyStyle
    │   └── MyRule.yml
    └── config
        └── vocabularies
            └── MyVocab
                ├── accept.txt
                └── reject.txt

Then in the remote project's .vale.ini:

StylesPath = styles

Packages = MyPackage.zip

Vocab = MyVocab

[*.md]
BasedOnStyles = MyStyle

[karl-cardenas-coding]

Hey @jdkato, thanks for the additional guidance. I am however, unable to trigger Vocabs failures.

Here is my package structure:

spectrocloud-docs-internal/
└── styles
    ├── config
    │   └── vocabularies
    │       └── spectrocloud-vocab
    │           ├── accept.txt
    │           └── reject.txt
    └── spectrocloud-docs-internal
        ├── ableism.yml
        ├── acronym.yml
        ├── admonitions.yml
        ├── colon.yml
        ├── condescending.yml
        ├── direction.yml
        ├── file-type.yml
        ├── future.yml
        ├── gender.yml
        ├── headings-title.yml
        ├── inclusive.yml
        ├── longform.yml
        ├── oxford-comma.yml
        ├── plural-parantheses.yaml
        ├── product-ui.yml
        ├── spectrocloud.yml
        └── we.yaml

The package spectrocloud-docs-internal has a .vale.ini with the minimum expected values:

StylesPath = styles

My remote project consumes the spectrocloud-docs-internal package through the following .vale.ini config:

StylesPath = vale/styles
MinAlertLevel = suggestion
Packages = https://github.com/spectrocloud/spectro-vale-pkg/releases/latest/download/spectrocloud-docs-internal.zip
[*.md]
BasedOnStyles =  spectrocloud-docs-internal
Vocab = spectrocloud-vocab

Everything looks as expected, expect Vocab terms are not getting triggered. I am using version 3.5.0.

Here is the remote projects, Vale structure after vale sync:

vale/
└── styles
    ├── config
    │   └── vocabularies
    │       └── spectrocloud-vocab
    │           ├── accept.txt
    │           └── reject.txt
    └── spectrocloud-docs-internal
        ├── ableism.yml
        ├── acronym.yml
        ├── admonitions.yml
        ├── colon.yml
        ├── condescending.yml
        ├── direction.yml
        ├── file-type.yml
        ├── future.yml
        ├── gender.yml
        ├── headings-title.yml
        ├── inclusive.yml
        ├── longform.yml
        ├── oxford-comma.yml
        ├── plural-parantheses.yaml
        ├── product-ui.yml
        ├── spectrocloud.yml
        └── we.yaml

[jdkato]

You want this:

StylesPath = vale/styles
MinAlertLevel = suggestion

Packages = https://github.com/spectrocloud/spectro-vale-pkg/releases/latest/download/spectrocloud-docs-internal.zip

# `Vocab` is a global setting
Vocab = spectrocloud-vocab

[*.md]
# The vocab rules, `Vale.Avoid` and `Vale.Terms`, require the `Vale` style to be enabled.
BasedOnStyles = Vale, spectrocloud-docs-internal

[karl-cardenas-coding]

Thank you @jdkato that did the trick. If you want to, I'd be happy to open a docs PR and add an example to the package section.