Support reading `cspell.json` from a URL

[Nightblade]

Description

Can't use cspell.json from a URL.

To Reproduce

1. Create a minimal cspell-action.yml in a repo (note the config: param) :

name: 'cspell-action-test'

on:
  pull_request:
  push:
  workflow_dispatch:

jobs:
  spellcheck:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repo
        uses: actions/checkout@v3

      - name: Run cspell-action
        uses: streetsidesoftware/cspell-action@v2.4.0
        with:
          config: 'https://raw.githubusercontent.com/Nightblade/pob-dict/main/cspell.json'

2. Run the action.
3. Check the action's log.
4. See error: Error: Configuration file "https://raw.githubusercontent.com/Nightblade/pob-dict/main/cspell.json" not found.
5. Details: https://github.com/Nightblade/PathOfBuilding/runs/7643610725?check_suite_focus=true

Expected behavior

Allow using cspell.json (and dictionaries) from a URL.

[Nightblade]

Sorry, I just realised I probably should've put this in https://github.com/streetsidesoftware/cspell-action
Happy to re-create it there if you prefer.

On reflection, this is probably a feature request as well... I'm winning today already!

[nicorikken]

This would be great. I'm now looking to deploy a default cspell action in my organization. Now I'd have to wrap the cspell-action in a action that takes care of writing/copying the organization-default cspell.json and installing dictionaries. Having that be part of cspell or cspell-action would be great.

[quicksketch]

If you dictionary file and cspell.json are both in the same repository, you can just check out both this action and the dictionary/configuration in a single GitHub workflow like this:

  spellcheck:
    name: Check spelling
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
      name: Checkout code
    - uses: actions/checkout@v4
      name: Checkout cspell config
      with:
        repository: backdrop-ops/cspell
        path: .cspell
    - uses: streetsidesoftware/cspell-action@v5
      name: Run CSpell
      with:
        incremental_files_only: true
        config: '.cspell/cspell.json'

Then you don't need to use remote URLs at all, because the files you need are checked out into the local directory before the action is run.

That's what we are about to do over in backdrop/backdrop-issues#6280.

[Nightblade]

If you dictionary file and cspell.json are both in the same repository

They aren't, but thanks.

edit: I misunderstood what you were saying at first (I barely have any brain left).

Good suggestion, thanks.

[quicksketch]

Yes, sorry my explanation was not clear. I just meant you could pull down your cspell.json file from a separate repo using multiple uses: actions/checkout definitions.

In our situation we put cspell.json and a the dictionary file in a stand-alone repository so it could be used by multiple projects.