Inso CLI lint spec with .spectral.yml error

[ponsakorn30214]

I'm trying to use inso lint spec with a custom linting rule in .spectral.yml file.
However, using inso cli 9.3.1 causes errors:

$ inso lint spec petstore.yaml
 Load api specification with identifier petstore.yaml from data store
› Found 0.
› Linting specification from file /home/petstore.yaml
› Loading ruleset from .spectral.yml

 FATAL  Failed to read "/home/petstore.yaml"

I tested this setup with Insomnia 8.6.1 and it works normally.
Are there any update I'm missing on inso CLI 9.x?

[subnetmarco]

Prioritizing for 9.3.2 this week.

[jackkav]

Can you try it with spectral cli directly, as I said we're just a wrapper. So I suspect you'll get the same issue with spectral but perhaps with better logging.

This case works fine in our tests run from within the insomnia git directory, but it fails when I run it in my home folder even when i create folders there too. I think .spectral.js is searching for an import of some kind but I'm not familiar with the code to know where to look.

I also found when changing the content extends of the .spectral.yml to [] this issue would go away, since we fallback to spectral:oas that could be a workaround

this is the error we get when spectral tries to read the .spectral.yml

stderr: '/Users/jack/deleteme/deleteme2' is imported by ../../../../deleteme/deleteme2/.spectral.js, but could not be resolved – treating it as an external dependency

stderr: q_ [Error]: Ruleset must have rules or extends or overrides defined
    at H5t (/snapshot/insomnia/packages/insomnia-inso/dist/index.js)
    at new e (/snapshot/insomnia/packages/insomnia-inso/dist/index.js)
    at /snapshot/insomnia/packages/insomnia-inso/dist/index.js
    at Array.reduce (<anonymous>)
    at new e (/snapshot/insomnia/packages/insomnia-inso/dist/index.js)
    at vkt (/snapshot/insomnia/packages/insomnia-inso/dist/index.js)
    at async fOe (/snapshot/insomnia/packages/insomnia-inso/dist/index.js)
    at async Promise.all (index 0) {
  code: 'invalid-ruleset-definition',
  path: []
}

[ponsakorn30214]

Can you try it with spectral cli directly

I run spectral lint petstore.yaml and get the following result (spectral 6.11.1, maybe I can try your version) :

/home/petstore.yaml
  2:6   warning  info-contact           Info object must have "contact" object.                        info
  2:6   warning  info-description       Info "description" must be present and non-empty string.       info
  11:9  warning  operation-description  Operation "description" must be present and non-empty string.  paths./pets.get
 15:11  warning  operation-tag-defined  Operation tags must be defined in global tags.                 paths./pets.get.tags[0]
 43:10  warning  operation-description  Operation "description" must be present and non-empty string.  paths./pets.post
 47:11  warning  operation-tag-defined  Operation tags must be defined in global tags.                 paths./pets.post.tags[0]
  64:9  warning  operation-description  Operation "description" must be present and non-empty string.  paths./pets/{petId}.get
 68:11  warning  operation-tag-defined  Operation tags must be defined in global tags.                 paths./pets/{petId}.get.tags[0]

✖ 8 problems (0 errors, 8 warnings, 0 infos, 0 hints)

running inso lint spec petstore.yaml at the same place got me the Failed to read "/home/petstore.yaml" error.

but it fails when I run it in my home folder even when i create folders there too.

yeah, I tested at different places and even run as root but got the same error.

I also found when changing the content extends of the .spectral.yml to [] this issue would go away

Not for me tho, leaving .spectral.yml to just extends: [] still give me the Failed to read error

[jackkav]

I have a suspicion it could be a pathing/external dependency issue during bundling since it continues to work as expected when bundled and packaged within the insomnia project directory. Perhaps its searching for a node_module in the parent folder? The method of importing spectral.yml with spectral code is causing the indirection and making debugging difficult here. I'll keep you updated if we find a solution.

[jackkav]

I found a workaround, it would appear that by installing a spectral node modules near the file you want to run it is able to work.
for example I have a spec and custom lint ruleset at path /home/git/project/spec.yml and /home/git/project/.spectral.yml

cd /home/git/project
npm i @stoplight/spectral-ruleset-bundler
inso lint spec /home/git/project/spec.yml

Will run successfully because the spectral ruleset bundler is expecting internal js files to be available near the .spectral.yml location, ignoring that this dependency is packaged with inso, perhaps because it is packaged with errors, the root cause is still unclear.

Related issue: stoplightio/spectral#1956