Skip to content

Bump @types/js-yaml from 3.12.5 to 4.0.6 in /extensions/ql-vscode#2847

Merged
koesie10 merged 9 commits intomainfrom
dependabot/npm_and_yarn/extensions/ql-vscode/types/js-yaml-4.0.6
Sep 26, 2023
Merged

Bump @types/js-yaml from 3.12.5 to 4.0.6 in /extensions/ql-vscode#2847
koesie10 merged 9 commits intomainfrom
dependabot/npm_and_yarn/extensions/ql-vscode/types/js-yaml-4.0.6

Conversation

@dependabot
Copy link
Copy Markdown
Contributor

@dependabot dependabot bot commented on behalf of github Sep 21, 2023

Bumps @types/js-yaml from 3.12.5 to 4.0.6.

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [@types/js-yaml](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/js-yaml) from 3.12.5 to 4.0.6.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/js-yaml)

---
updated-dependencies:
- dependency-name: "@types/js-yaml"
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot requested a review from a team as a code owner September 21, 2023 13:06
@dependabot dependabot bot added the Update dependencies Dependabot update PRs label Sep 21, 2023
@koesie10 koesie10 requested a review from a team as a code owner September 25, 2023 12:58
After the upgrade to the correct types for js-yaml, the return type
of `load` is correctly typed as `unknown`. This means that we can't
use the return value directly, but need to validate it first.

This adds such validation by generating a JSON schema for a newly
created typed. The JSON schema generation is very similar to how we do
it in https://github.com/github/codeql-variant-analysis-action.
@koesie10 koesie10 force-pushed the dependabot/npm_and_yarn/extensions/ql-vscode/types/js-yaml-4.0.6 branch from ecb7876 to c55e87c Compare September 25, 2023 13:25
@koesie10
Copy link
Copy Markdown
Member

@github/code-scanning-secexp-reviewers I've made quite some changes to this PR to make the TypeScript compiler happy. We need to upgrade these types since the @types/js-yaml and js-yaml package are out of sync in main, so I'd appreciate a review on this.

packFS.fileContents(packFileName).toString("utf-8"),
);
) as ExtensionPackMetadata & {
dependencies: Record<string, string>;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there be a type for the { dependencies: Record<string, string>} stuff we're doing in a few places? I'm not sure what these are.. is it part of a qlpack file?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are indeed part of the qlpack file, but since they are only used in tests I don't think it's worth it to create a type for it.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had missed that, thanks for spotting it. I'll introduce a type for the qlpack file.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah okay thanks, I wasn't sure. I'm happy to not introduce a type too, but I think it would be helpful.

Copy link
Copy Markdown
Contributor

@charisk charisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for sorting this.

@koesie10 koesie10 enabled auto-merge September 26, 2023 09:58
@koesie10 koesie10 merged commit cbb1de4 into main Sep 26, 2023
@koesie10 koesie10 deleted the dependabot/npm_and_yarn/extensions/ql-vscode/types/js-yaml-4.0.6 branch September 26, 2023 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Update dependencies Dependabot update PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants