feat: format lookup by source #1348
Conversation
src/spectral.ts
Outdated
| @@ -111,7 +111,7 @@ export class Spectral { | |||
|
|
|||
| if (document.formats === void 0) { | |||
| const registeredFormats = Object.keys(this.formats); | |||
| const foundFormats = registeredFormats.filter(format => this.formats[format](inventory.resolved)); | |||
| const foundFormats = registeredFormats.filter(format => this.formats[format](inventory.resolved, opts.source)); | |||
There was a problem hiding this comment.
| const foundFormats = registeredFormats.filter(format => this.formats[format](inventory.resolved, opts.source)); | |
| const foundFormats = registeredFormats.filter(format => this.formats[format](inventory.resolved, document.source)); |
src/types/spectral.ts
Outdated
| @@ -31,6 +31,7 @@ export interface IRunOpts { | |||
| resolve?: { | |||
| documentUri?: string; | |||
| }; | |||
| source?: string; | |||
There was a problem hiding this comment.
| source?: string; |
| @@ -53,7 +54,7 @@ export interface IResolver { | |||
| resolve(source: unknown, opts?: IResolveOpts): Promise<ResolveResult>; | |||
| } | |||
|
|
|||
| export type FormatLookup = (document: unknown) => boolean; | |||
| export type FormatLookup = (document: unknown, source?: string) => boolean; | |||
There was a problem hiding this comment.
| export type FormatLookup = (document: unknown, source?: string) => boolean; | |
| export type FormatLookup = (document: unknown, source: string | null) => boolean; |
document.source is either null or string.
There was a problem hiding this comment.
That would make it a breaking change, wouldn't it?
I'd keep it this way and just do this.formats[format](inventory.resolved, document.source ?? void 0)
There was a problem hiding this comment.
Aye, that'd be indeed a breaking change.
Sounds good. Let's do it this way. Perhaps leave a comment for me so that I revisit it when we release a major version.
There was a problem hiding this comment.
| export type FormatLookup = (document: unknown, source?: string) => boolean; | |
| // todo(@p0lip): make it string | null when working on 6.0 | |
| export type FormatLookup = (document: unknown, source?: string) => boolean; |
There was a problem hiding this comment.
@P0lip Just out of curiosity, why favoring null when it can already be undefined?
There was a problem hiding this comment.
Cause document.source is either a null or string, so we won't need to do ?? void 0 thing.
docs/guides/3-javascript.md
Outdated
| { | ||
| 'foo-bar': true, | ||
| x: false | ||
| }, | ||
| { | ||
| source: '/foo/bar', | ||
| } |
There was a problem hiding this comment.
| { | |
| 'foo-bar': true, | |
| x: false | |
| }, | |
| { | |
| source: '/foo/bar', | |
| } | |
| new Document(`foo-bar: true\nx: false`, Parsers.Yaml, '/foo/bar'), |
make sure to test it and format correctly. I didn't 😆
docs/guides/3-javascript.md
Outdated
| Alternatively you may lookup for certain format by optional `source`, which could be passed in `run` options. | ||
|
|
||
| ```js | ||
| const { Spectral } = require('@stoplight/spectral'); |
There was a problem hiding this comment.
| const { Spectral } = require('@stoplight/spectral'); | |
| const { Spectral, Document } = require('@stoplight/spectral'); |
src/__tests__/linter.test.ts
Outdated
| }); | ||
|
|
||
| const result = await spectral.run( | ||
| { |
* feat: format lookup by source * chore: update docs * chore: use source from document * chore: todo comment
Adds support for looking up formats by source (filename, uri) additionally to document content.
Checklist
Does this PR introduce a breaking change?