Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support reading dictionary files over http. #3150

Merged
merged 7 commits into from
Jun 28, 2022
Merged

Conversation

Jason3S
Copy link
Collaborator

@Jason3S Jason3S commented Jun 28, 2022

Related to #236

Example json

{
    "dictionaryDefinitions": [
        {
            "name": "cities-remote",
            "path": "https://github.com/streetsidesoftware/cspell/raw/main/packages/cspell-io/samples/cities.txt.gz",
            "type": "W"
        }
    ],
    "dictionaries": ["cities-remote"]
}

Limitation

  • Note: the @cspell/eslint-plugin cannot support remote dictionaries because eslint only supports synchronous linting of files. At the moment, an eslint-plugin cannot use any async methods. Reading data over http can only be done in an async fashion.
  • addWords dictionary option is not supported for remote dictionaries. It is not clear how to update the remote source.

@github-actions github-actions bot added the fix label Jun 28, 2022
@Jason3S Jason3S changed the title fix: Support reading files over http. feat: Support reading dictionary files over http. Jun 28, 2022
@Jason3S Jason3S added feature and removed fix labels Jun 28, 2022
@Jason3S Jason3S linked an issue Jun 28, 2022 that may be closed by this pull request
@Jason3S Jason3S merged commit 7ba81e6 into main Jun 28, 2022
@Jason3S Jason3S deleted the dev-http-dict branch June 28, 2022 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow sourcing custom dictionaries from a URL
1 participant