feat(formatters): move formatters to a separate package #2468

sennyeya · 2023-05-15T14:03:05Z

Fixes #2467. Moves the formatters to their own package that is then imported by @stoplight/spectral-cli.

Checklist

Tests added / updated
Docs added / updated

Existing tests should cover any issues, this PR is just a move with additional dependency work.

Does this PR introduce a breaking change?

Yes
No

The formatters for the CLI have been pulled out to their own package, not necessarily breaking for any contracts, but will require pulling in a new package on CLI version update.

Additional context

I wasn't sure if this should sit in packages/core or a separate package, I think it makes sense to pull it completely out as it's not core functionality and just a presentation layer, but I could go either way.

packages/formatters/CHANGELOG.md

packages/formatters/README.md

package.json

sennyeya · 2023-05-15T15:36:52Z

Couple of questions:

What is the commit message supposed to look like? Not sure I'm following from the error message.
Is there somewhere that the memfs is populated with the HTML files during Karma tests, getting a not found error locally and in the CI, but not sure where that would be solved?

sennyeya · 2023-05-16T20:18:32Z

@P0lip Any ideas on why the Karma tests are failing? I think it's related to memfs mocks, but it seems odd that moving the directory causes this issue in the same test case.

P0lip · 2023-05-17T14:27:16Z

Yeah, that is most likely due to the HTML formatter relying on fs and it not being available in Karma launcher we use (it's plain Chrome browser in headless mode, we use webpack to bundle things and have some basic fs mock).
I'll try to update HTML formatter to not depend on fs at all so that we don't need to worry about anything.

P0lip · 2023-05-17T15:11:25Z

#2474 - WIP

sennyeya · 2023-05-17T16:00:36Z

Great, thanks!

P0lip · 2023-05-18T18:46:12Z

@sennyeya could you merge the latest changes when you have a minute? 🙏 that should unblock test-browser 🤞

packages/formatters/package.json

sennyeya · 2023-05-18T20:04:56Z

@P0lip It looks like cliui is having issues with the Karma browser tests, which I think is expected as it's just a nodejs module. I think this was excluded originally by including packages/ci/** in the karma.config.ts exclude section. As you'll be updating this package to be all environment friendly, I think it makes sense to skip this for now.

Other than that, everything should be good minus the commit message (what's the format for those?)

Signed-off-by: Aramis Sennyey <[email protected]>

P0lip · 2023-05-19T21:29:41Z

Other than that, everything should be good minus the commit message (what's the format for those?)

it has to be accepted by commitlint per its config here https://github.com/stoplightio/spectral/blob/develop/commitlint.config.js

P0lip · 2023-05-19T21:30:05Z

I'll take a final look on Monday, and if it's all good I will proceed and merge it.
Thanks a lot of your time and contribution. Appreciate it a lot.

sennyeya · 2023-05-23T18:37:14Z

@P0lip Thanks for your help pushing this through!

# [6.7.0](v6.6.0...v6.7.0) (2023-05-23) ### Bug Fixes * **core:** improve deep ruleset inheritance ([#2326](#2326)) ([378b4b8](378b4b8)) * **core:** more accurate ruleset error paths ([66b3ca7](66b3ca7)) * **core:** reset path in fn context ([#2389](#2389)) ([3d47ec4](3d47ec4)) * **ref-resolver:** bump @stoplight/json-ref-resolver from ~3.1.4 to ~3.1.5 ([#3635](https://github.com/stoplightio/spectral/issues/3635)) ([215ae93](215ae93)) * **ruleset-bundler:** defaults should be last one ([#2403](#2403)) ([8780cfa](8780cfa)) * **ruleset-bundler:** remove extraneous 'external dependency' warnings ([#2475](#2475)) ([e791534](e791534)) * **ruleset-migrator:** avoid positive lookbehinds ([#2349](#2349)) ([455c324](455c324)) * **ruleset-migrator:** transform functions under overrides ([#2459](#2459)) ([45e817f](45e817f)) * **ruleset-migrator:** use module for require.resolve ([#2405](#2405)) ([d7c0fa4](d7c0fa4)) * **rulesets:** avoid false errors from ajv ([#2408](#2408)) ([92dab78](92dab78)) * **rulesets:** length.min said "must not be longer than" ([#2355](#2355)) ([df3b6f9](df3b6f9)) ### Features * **core:** relax formats validation ([#2151](#2151)) ([de16b4c](de16b4c)) * **core:** support end-user extensions in the rule definitions ([#2345](#2345)) ([365fced](365fced)) * **core:** support x- extensions in the ruleset ([#2440](#2440)) ([964151e](964151e)) * **formats:** support AsyncAPI 2.6.0 ([#2391](#2391)) ([b8e51b4](b8e51b4)) * **formatters:** move formatters to a separate package ([#2468](#2468)) ([664e259](664e259)) * **rulesets:** add traits array path to headers rule ([#2460](#2460)) ([9ceabca](9ceabca)) * **rulesets:** support AsyncAPI 2.6.0 ([#2391](#2391)) ([94a7801](94a7801))

stoplight-bot · 2023-05-23T22:14:10Z

🎉 This PR is included in version 6.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

stoplight-bot · 2023-07-07T14:56:52Z

🎉 This PR is included in version 1.18.1 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

# [1.8.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-functions-v1.7.2...@stoplight/spectral-functions-1.8.0) (2024-06-07) ### Bug Fixes * **cli:** choose proxy agent based on requester protocol ([#2521](#2521)) ([056f2e1](056f2e1)) * **cli:** clarify usage of --format ([#2575](#2575)) ([96eee89](96eee89)) * **core:** dedupe paths containing special characters correctly ([758de21](758de21)) * **core:** invalid then produced by Rule#toJSON ([#2496](#2496)) ([db91553](db91553)) * **core:** more accurate ruleset error paths ([66b3ca7](66b3ca7)) * **core:** pointer in overrides are applied too broadly ([#2511](#2511)) ([69403c1](69403c1)) * **core:** reset path in fn context ([#2389](#2389)) ([3d47ec4](3d47ec4)) * **parsers:** update @stoplight/json from ~3.20.1 to ~3.21.0 ([e906d20](e906d20)) * **parsers:** update @stoplight/yaml from ~4.2.3 to ~4.3.0 ([91fdded](91fdded)) * **ref-resolver:** bump @stoplight/json-ref-resolver from ~3.1.4 to ~3.1.5 ([#3635](https://github.com/stoplightio/spectral/issues/3635)) ([215ae93](215ae93)) * **ref-resolver:** update @stoplight/json-ref-resolver from ~3.1.5 to ~3.1.6 ([6f73151](6f73151)) * **ruleset-bundler:** defaults should be last one ([#2403](#2403)) ([8780cfa](8780cfa)) * **ruleset-bundler:** remove extraneous 'external dependency' warnings ([#2475](#2475)) ([e791534](e791534)) * **ruleset-migrator:** correct package.json's browser field ([#2497](#2497)) ([89a6a67](89a6a67)) * **ruleset-migrator:** transform functions under overrides ([#2459](#2459)) ([45e817f](45e817f)) * **ruleset-migrator:** update @stoplight/json from ~3.20.1 to ~3.21.0 ([3f7eebc](3f7eebc)) * **ruleset-migrator:** use module for require.resolve ([#2405](#2405)) ([d7c0fa4](d7c0fa4)) * **rulesets:** avoid false errors from ajv ([#2408](#2408)) ([92dab78](92dab78)) * **rulesets:** example validation for required readOnly and writeOnly properties ([#2573](#2573)) ([ae1fea5](ae1fea5)) * **rulesets:** oasExample should clean id fields from non-schema objects ([#2561](#2561)) ([7f7583e](7f7583e)) * **rulesets:** tweak server variables function ([#2533](#2533)) ([244cbda](244cbda)) ### Features * **cli:** add sarif formatter ([#2532](#2532)) ([959a86a](959a86a)) * **cli:** require newer version of all Spectral dependencies ([10ddd97](10ddd97)) * **cli:** use hpagent ([#2513](#2513)) ([9b2d347](9b2d347)) * **core:** relax formats validation ([#2151](#2151)) ([de16b4c](de16b4c)) * **core:** support x- extensions in the ruleset ([#2440](#2440)) ([964151e](964151e)) * **formats:** jsonSchemaLoose format should search for enum keyword ([#2551](#2551)) ([0835545](0835545)) * **formats:** support AsyncAPI 2.6.0 ([#2391](#2391)) ([b8e51b4](b8e51b4)) * **formatters:** add export entrypoint for utils ([#2482](#2482)) ([d4b883c](d4b883c)) * **formatters:** add GitHub Actions formatter ([#2508](#2508)) ([6904927](6904927)) * **formatters:** add sarif formatter ([#2532](#2532)) ([908c308](908c308)) * **formatters:** move formatters to a separate package ([#2468](#2468)) ([664e259](664e259)) * **rulesets:** add multiple xor ([#2614](#2614)) ([af9c742](af9c742)) * **rulesets:** add new rule that requires sibling items field for type array ([#2632](#2632)) ([24198bc](24198bc)) * **rulesets:** add oas3_1-servers-in-webhook and oas3_1-callbacks-in… ([#2581](#2581)) ([7a8cc0e](7a8cc0e)) * **rulesets:** add oas3-server-variables rule ([#2526](#2526)) ([4c4de85](4c4de85)) * **rulesets:** add scope validation to oas{2,3}-operation-security-defined rules ([#2538](#2538)) ([68aacd6](68aacd6)) * **rulesets:** add traits array path to headers rule ([#2460](#2460)) ([9ceabca](9ceabca)) * **rulesets:** improve {oas2,oas3}-valid-schema rule ([#2574](#2574)) ([8df2c36](8df2c36)) * **rulesets:** support AsyncAPI 2.6.0 ([#2391](#2391)) ([94a7801](94a7801))

# [1.6.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-ruleset-bundler-v1.5.2...@stoplight/spectral-ruleset-bundler-1.6.0) (2024-09-12) ### Bug Fixes * **cli:** choose proxy agent based on requester protocol ([#2521](#2521)) ([056f2e1](056f2e1)) * **cli:** clarify usage of --format ([#2575](#2575)) ([96eee89](96eee89)) * **core:** dedupe paths containing special characters correctly ([758de21](758de21)) * **core:** invalid then produced by Rule#toJSON ([#2496](#2496)) ([db91553](db91553)) * **core:** pointer in overrides are applied too broadly ([#2511](#2511)) ([69403c1](69403c1)) * **parsers:** update @stoplight/json from ~3.20.1 to ~3.21.0 ([e906d20](e906d20)) * **parsers:** update @stoplight/yaml from ~4.2.3 to ~4.3.0 ([91fdded](91fdded)) * **ref-resolver:** update @stoplight/json-ref-resolver from ~3.1.5 to ~3.1.6 ([6f73151](6f73151)) * **repo:** remove discord link and fix typo in github bug template ([#2642](#2642)) ([048924d](048924d)) * **ruleset-migrator:** correct package.json's browser field ([#2497](#2497)) ([89a6a67](89a6a67)) * **ruleset-migrator:** update @stoplight/json from ~3.20.1 to ~3.21.0 ([3f7eebc](3f7eebc)) * **rulesets:** example validation for required readOnly and writeOnly properties ([#2573](#2573)) ([ae1fea5](ae1fea5)) * **rulesets:** fixed array-items type property selector ([#2638](#2638)) ([0845fb5](0845fb5)) * **rulesets:** oasExample should clean id fields from non-schema objects ([#2561](#2561)) ([7f7583e](7f7583e)) * **rulesets:** tweak server variables function ([#2533](#2533)) ([244cbda](244cbda)) ### Features * **cli:** add sarif formatter ([#2532](#2532)) ([959a86a](959a86a)) * **cli:** require newer version of all Spectral dependencies ([10ddd97](10ddd97)) * **cli:** use hpagent ([#2513](#2513)) ([9b2d347](9b2d347)) * **formats:** add arazzo format ([#2663](#2663)) ([dc1a8ef](dc1a8ef)) * **formats:** jsonSchemaLoose format should search for enum keyword ([#2551](#2551)) ([0835545](0835545)) * **formatters:** add export entrypoint for utils ([#2482](#2482)) ([d4b883c](d4b883c)) * **formatters:** add GitHub Actions formatter ([#2508](#2508)) ([6904927](6904927)) * **formatters:** add sarif formatter ([#2532](#2532)) ([908c308](908c308)) * **formatters:** move formatters to a separate package ([#2468](#2468)) ([664e259](664e259)) * **rulesets:** add multiple xor ([#2614](#2614)) ([af9c742](af9c742)) * **rulesets:** add new rule that requires sibling items field for type array ([#2632](#2632)) ([24198bc](24198bc)) * **rulesets:** add oas3_1-servers-in-webhook and oas3_1-callbacks-in… ([#2581](#2581)) ([7a8cc0e](7a8cc0e)) * **rulesets:** add oas3-server-variables rule ([#2526](#2526)) ([4c4de85](4c4de85)) * **rulesets:** add scope validation to oas{2,3}-operation-security-defined rules ([#2538](#2538)) ([68aacd6](68aacd6)) * **rulesets:** improve {oas2,oas3}-valid-schema rule ([#2574](#2574)) ([8df2c36](8df2c36)) * **rulesets:** initial rulesets for the Arazzo Specification ([#2672](#2672)) ([8443232](8443232))

sennyeya requested review from a team as code owners May 15, 2023 14:03

sennyeya requested a review from pamgoodrich May 15, 2023 14:03

sennyeya commented May 15, 2023

View reviewed changes

packages/formatters/CHANGELOG.md Outdated Show resolved Hide resolved

P0lip reviewed May 15, 2023

View reviewed changes

packages/formatters/README.md Outdated Show resolved Hide resolved

packages/formatters/README.md Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

sennyeya force-pushed the formatters branch 2 times, most recently from bcb7afb to eb169fc Compare May 15, 2023 15:33

sennyeya force-pushed the formatters branch from eb169fc to fd4548c Compare May 15, 2023 15:47

sennyeya changed the title ~~feat(formatters): Update where formatters are stored.~~ feat(formatters): move formatters to a separate package May 15, 2023

sennyeya force-pushed the formatters branch from fd4548c to b2fc6f6 Compare May 18, 2023 18:53

P0lip reviewed May 18, 2023

View reviewed changes

packages/formatters/package.json Outdated Show resolved Hide resolved

P0lip reviewed May 18, 2023

View reviewed changes

packages/formatters/package.json Outdated Show resolved Hide resolved

P0lip reviewed May 18, 2023

View reviewed changes

packages/formatters/package.json Outdated Show resolved Hide resolved

sennyeya force-pushed the formatters branch 2 times, most recently from 0c14d35 to 8ffedc8 Compare May 18, 2023 20:04

feat(formatters): pull formatters into their own package

92db109

Signed-off-by: Aramis Sennyey <[email protected]>

sennyeya force-pushed the formatters branch from 8ffedc8 to 92db109 Compare May 18, 2023 20:05

P0lip added 4 commits May 22, 2023 21:11

chore(repo): dedupe dependencies

935765b

chore(formatters): setup exports

9b71db0

chore(formatters): align types

40bf56f

chore(formatters): import

5814961

P0lip previously approved these changes May 23, 2023

View reviewed changes

revert(core): changes to core

5b39c15

P0lip dismissed their stale review via 5b39c15 May 23, 2023 18:05

P0lip force-pushed the formatters branch from 8d1c99d to 5b39c15 Compare May 23, 2023 18:05

P0lip approved these changes May 23, 2023

View reviewed changes

Merge branch 'develop' into formatters

1538985

P0lip merged commit 664e259 into stoplightio:develop May 23, 2023

stoplight-bot added the released label May 23, 2023

stoplightio deleted a comment from stoplight-bot Jul 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(formatters): move formatters to a separate package #2468

feat(formatters): move formatters to a separate package #2468

sennyeya commented May 15, 2023

sennyeya commented May 15, 2023

sennyeya commented May 16, 2023

P0lip commented May 17, 2023

P0lip commented May 17, 2023

sennyeya commented May 17, 2023

P0lip commented May 18, 2023

sennyeya commented May 18, 2023

P0lip commented May 19, 2023

P0lip commented May 19, 2023 •

edited

Loading

sennyeya commented May 23, 2023

stoplight-bot commented May 23, 2023

stoplight-bot commented Jul 7, 2023

feat(formatters): move formatters to a separate package #2468

feat(formatters): move formatters to a separate package #2468

Conversation

sennyeya commented May 15, 2023

sennyeya commented May 15, 2023

sennyeya commented May 16, 2023

P0lip commented May 17, 2023

P0lip commented May 17, 2023

sennyeya commented May 17, 2023

P0lip commented May 18, 2023

sennyeya commented May 18, 2023

P0lip commented May 19, 2023

P0lip commented May 19, 2023 • edited Loading

sennyeya commented May 23, 2023

stoplight-bot commented May 23, 2023

stoplight-bot commented Jul 7, 2023

P0lip commented May 19, 2023 •

edited

Loading