SchemaStore / SchemaStore/schemastore

Migration to strict validation

Open
#6,038 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
3.8k
Forks
2.3k
Avg merge
20h 23m
Merged PRs (30d)
124

Description

Description of the feature / enhancement.

Where possible, all (local) schemas should avoid using the ajvNotStrictMode property in src/schema-validation.jsonc. This issue will document progress in such a large migration. Due to the ongoing progress in pre-existing efforts, schemas listed in #6019 which don't presently use strict validation will not be listed here, to better divide tasks.

Progress
  • anywork-ac-1.0.json: #6123
  • anywork-ac-1.1.json: #6123
  • appsettings.json: #5982
  • asmdef.json: #6187
  • aurora-1.0.json: #6188
  • aurora-1.1.json: #6188
  • aurora-1.2.json: #6188
  • aurora-1.3.json: #6188
  • aurora-2.0.json: #6188
  • azure-deviceupdate-import-manifest-4.0.json: #6189
  • azure-deviceupdate-import-manifest-5.0.json: #6189
  • azure-deviceupdate-update-manifest-4.json: #6189
  • azure-deviceupdate-update-manifest-5.json: #6189
  • backportrc.json: #6191
  • behat.json: #6191
  • bitrise-step.json: #6191
  • bitrise.json: #6191
  • boyka-config.json: #6191
  • bukkit-plugin.json: #6191
  • bxci.schema-1.0.1.json: #6191
  • bxci.schema-1.0.json: #6191
  • bxci.schema-2.0.0.json: #6191
  • bxci.schema-2.x.json: #6191
  • catalog-info.json: #6191
  • chisel-slices.json: #6191
  • chrome-manifest.json: #5983
  • cinnamon-spice-settings.json: #6191
  • cloud-sdk-pipeline-config-schema.json: #6191
  • cloudify.json: #6191
  • codecov.json: #5981
  • codeship-services.json: #6191
  • codeship-steps.json: #6191
  • commitlintrc.json: #6191
  • dart-test.json: #6191
  • datalogic-scan2deploy-android.json: #6191
  • datalogic-scan2deploy-ce.json: #6191
  • deployed.json: #6191
  • dofigen.json: #6191
  • drone.json: #6191
  • drupal-recipe.json: #6191
  • electron-builder.json: #6191
  • enonic-xp-admin-extension-8.0.0-B4.json: #6201
  • enonic-xp-admin-extension-8.0.0-B5.json: #6201
  • enonic-xp-admin-extension-8.0.0.json: #6201
  • enonic-xp-admin-tool-8.0.0-B4.json: #6201
  • enonic-xp-admin-tool-8.0.0-B5.json: #6201
  • enonic-xp-admin-tool-8.0.0.json: #6201
  • enonic-xp-api-8.0.0-B4.json: #6201
  • enonic-xp-api-8.0.0-B5.json: #6201
  • enonic-xp-api-8.0.0.json: #6201
  • enonic-xp-application-8.0.0-B4.json: #6201
  • enonic-xp-application-8.0.0-B5.json: #6201
  • enonic-xp-application-8.0.0.json: #6201
  • enonic-xp-cms-8.0.0-B4.json: #6201
  • enonic-xp-cms-8.0.0-B5.json: #6201
  • enonic-xp-cms-8.0.0.json: #6201
  • enonic-xp-content-type-8.0.0-B4.json: #6201
  • enonic-xp-content-type-8.0.0-B5.json: #6201
  • enonic-xp-content-type-8.0.0.json: #6201
  • enonic-xp-form-fragment-8.0.0-B4.json: #6201
  • enonic-xp-form-fragment-8.0.0-B5.json: #6201
  • enonic-xp-form-fragment-8.0.0.json: #6201
  • enonic-xp-idprovider-8.0.0-B4.json: #6201
  • enonic-xp-idprovider-8.0.0-B5.json: #6201
  • enonic-xp-idprovider-8.0.0.json: #6201
  • enonic-xp-layout-8.0.0-B4.json: #6201
  • enonic-xp-layout-8.0.0-B5.json: #6201
  • enonic-xp-layout-8.0.0.json: #6201
  • enonic-xp-macro-8.0.0-B4.json: #6201
  • enonic-xp-macro-8.0.0-B5.json: #6201
  • enonic-xp-macro-8.0.0.json: #6201
  • enonic-xp-mixin-8.0.0-B4.json: #6201
  • enonic-xp-mixin-8.0.0-B5.json: #6201
  • enonic-xp-mixin-8.0.0.json: #6201
  • enonic-xp-page-8.0.0-B4.json: #6201
  • enonic-xp-page-8.0.0-B5.json: #6201
  • enonic-xp-page-8.0.0.json: #6201
  • enonic-xp-part-8.0.0-B4.json: #6201
  • enonic-xp-part-8.0.0-B5.json: #6201
  • enonic-xp-part-8.0.0.json: #6201
  • enonic-xp-service-8.0.0-B4.json: #6201
  • enonic-xp-service-8.0.0-B5.json: #6201
  • enonic-xp-service-8.0.0.json: #6201
  • enonic-xp-site-8.0.0-B4.json: #6201
  • enonic-xp-site-8.0.0-B5.json: #6201
  • enonic-xp-site-8.0.0.json: #6201
  • enonic-xp-style-8.0.0-B4.json: #6201
  • enonic-xp-style-8.0.0-B5.json: #6201
  • enonic-xp-style-8.0.0.json: #6201
  • enonic-xp-task-8.0.0-B4.json: #6201
  • enonic-xp-task-8.0.0-B5.json: #6201
  • enonic-xp-task-8.0.0.json: #6201
  • enonic-xp-webapp-8.0.0-B4.json: #6201
  • enonic-xp-webapp-8.0.0-B5.json: #6201
  • enonic-xp-webapp-8.0.0.json: #6201
  • esmrc.json: #6191
  • flatpak-manifest.json: #6191
  • foundryvtt-module-manifest.json: #6306
  • foundryvtt-system-manifest.json: #6306
  • foundryvtt-world-manifest.json: #6306
  • gaspar-1.0.json: #6191
  • gaspar-3.0.json: #6191
  • github-action.json: #6270
  • github-funding.json: #6237
  • github-workflow.json: #6270
  • github-workflow-template-properties: #6235
  • glazewm.json: #6191
  • helmfile.json: #6191
  • hemtt-0.6.2.json: #6191
  • install.json: #6191
  • jest.json: #6191
  • jfrog-pipelines.json: #6272
  • jovo-language-model.json: #6279
  • jsdoc-1.0.0.json: #6297
  • jsone.json: #6296
  • kestra-0.18.0.json: #6191
  • kestra-0.18.1.json: #6191
  • kestra-0.18.2.json: #6191
  • kestra-0.18.3.json: #6191
  • kestra-0.19.0.json: #6191
  • lerna.json: #6297
  • libman.json: #6297
  • lintstagedrc.schema.json: #6297
  • lsdlschema-3.4.json: #6208
  • lsdlschema-3.5.json: #6208
  • lsdlschema-4.0.json: #6208
  • lsdlschema-4.1.json: #6208
  • metaschema-draft-07-unofficial-strict.json: #6297
  • metricshub-connector.json: #6297
  • metricshub.json: #6297
  • minecraft-advancement.json: #6297
  • minecraft-biome.json: #6297
  • minecraft-dimension.json: #6297
  • minecraft-item-modifier.json: #6297
  • minecraft-loot-table.json: #6297
  • minecraft-predicate.json: #6297
  • minecraft-recipe.json: #6297
  • minecraft-template-pool.json: #6297
  • mprocs-0.6.4.json: #6360
  • mtad.json: #6360
  • nest-cli.json: #6360
  • netlify.json: #6360
  • ninjs-2.0.json
  • nodemon.json: #6360
  • openhab-5.1.json: #6360
  • opensrm.json: #6360
  • opspec-io-0.1.7.json
  • package.json
  • paper-plugin.json: #6360
  • partial-eslint-plugins.json: #6360
  • partial-pyright.json: #6360
  • pep-723.json: #6360
  • phrase.json: #6360
  • pnpm-workspace.json: #6360
  • podman-desktop-extension-1.27.json
  • podman-desktop-extension.json
  • pre-commit-config.json: #6360
  • prisma.json
  • prometheus.json: #6360
  • pull-request-labeler-5.json: #6073
  • pull-request-labeler.json: #6073
  • putout.json
  • pylock.json: #6360
  • pyproject.json: #6360
  • pyrseas-0.8.json: #6360
  • renovate-41.json: #6075
  • renovate-42.json: #6075
  • renovate-global-schema-41.json: #6075
  • renovate-global-schema-42.json: #6075
  • renovate-inherited-schema-42.json: #6075
  • sarif-2.1.0-rtm.0.json: #6081
  • sarif-2.1.0-rtm.1.json: #6081
  • sarif-2.1.0-rtm.2.json: #6081
  • sarif-2.1.0-rtm.3.json: #6081
  • sarif-2.1.0-rtm.4.json: #6081
  • sarif-2.1.0-rtm.5.json: #6081
  • sarif-2.1.0-rtm.6.json: #6081
  • sarif-2.1.0.json: #6081
  • sarif-external-property-file-2.1.0-rtm.0.json: #6081
  • sarif-external-property-file-2.1.0-rtm.1.json: #6081
  • sarif-external-property-file-2.1.0-rtm.2.json: #6081
  • sarif-external-property-file-2.1.0-rtm.3.json: #6081
  • sarif-external-property-file-2.1.0-rtm.4.json: #6081
  • sarif-external-property-file-2.1.0-rtm.5.json: #6081
  • sarif-external-property-file-2.1.0.json: #6081
  • sarif-external-property-file.json: #6081
  • sigmacv.json
  • size-limit.json: #6360
  • starlake.json: #6360
  • stylelintrc.json
  • template.json
  • tmlanguage.json: #6360
  • tslint.json
  • typo3.json
  • utam-page-object-1.5.0.json: #6281
  • utam-page-object-2.0.3.json: #6281
  • utam-page-object-2.2.0.json: #6281
  • utam-page-object.json: #6281
  • utcm-monitor.json
  • vector.json
  • vss-extension.json: #6297
  • vtesttree-schema-v1.0.0.json: #6302
  • vtesttree-schema-v2.0.0.json: #6302
  • vtesttree-schema-v2.1.0.json: #6302
  • vtesttree-schema-v2.2.0.json: #6302
  • vtesttree-schema-v2.3.0.json: #6302
  • vtesttree-schema-v2.4.0.json: #6302
  • webextension.json: #6297
  • winget-pkgs-singleton-0.1.json: #6297
  • workflows.json: #6297
  • xs-app.json: #6297
  • yamllint.json: #6297
  • youtrack-app.json: #6297
Ignored

When a schema uses format with a type other than "number" or "string", removing them is required to enforce AJV's strict validation. These schemas set unknownFormats in schema-validation.jsonc and use at least one such format within an illegal type, defining information that we can't change unless it's removed downstream.

  • lsdlschema-0.7.json
  • lsdlschema-1.0.json
  • lsdlschema-1.2.json
  • lsdlschema-2.0.json
  • lsdlschema-3.0.json
  • lsdlschema-3.1.json
  • lsdlschema-3.2.json
  • lsdlschema-3.3.json
  • lsdlschema.json
  • xs-app.json
Are you making a PR for this?

Yes, I will create a PR.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/schema-validation.jsonc and the unchecked schema entries in the Progress list, while reviewing the linked completed issues for the migration pattern. Check each remaining schema for ajvNotStrictMode and determine whether strict validation can be enabled without changing unsupported downstream formats. Done means applicable schemas no longer require that property and the checklist is updated with the resulting work.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.