# Copyright (c) Microsoft Corporation and contributors. All rights reserved. # Licensed under the MIT License. indent: "\t" # Custom types are used to define additional fields in package.json that contain versions that should be # checked/synced. See https://jamiemason.github.io/syncpack/config/custom-types for more details. customTypes: engines: path: "engines" strategy: "versionsByName" packageManager: path: "packageManager" strategy: "name@version" # Expose optionalDependencies so the version group below can ban them. # Syncpack has no built-in dependency type for this field. optional: path: "optionalDependencies" strategy: "versionsByName" # SemverGroups are used to ensure that groups of packages use the same semver range for dependencies. # # semverGroup rules are applied in order to package/dep combinations. First matching rule applies. When running # `syncpack lint-semver-ranges`, the output is grouped by label. semverGroups: # Workaround for compatibility issues. # Ideally this section would be empty (and removed). # Items should be removed from here when possible. - label: "Version compatibility workarounds should be used, or removed from .syncpackrc.yml if no longer needed." dependencies: - "@oclif/core" dependencyTypes: - "pnpmOverrides" packages: - "**" range: "~" # The internal codec helpers in packages/dds/tree/src/util/typebox.ts depend on TypeBox's record metadata and memory construction. # Allow patch fixes, but require explicit validation of behavior, types, and bundle size before minor upgrades. # Keep the CLI example aligned with Tree; remove this exception when the helpers use supported public builders. - label: "TypeBox helper compatibility requires tilde dependency ranges" dependencies: - "typebox" dependencyTypes: - "prod" packages: - "@fluidframework/tree" - "@fluid-example/tree-cli-app" range: "~" - label: "engines.node should always use >= ranges" dependencyTypes: - "engines" dependencies: - "node" packages: - "**" range: ">=" - label: "engines.npm should always use caret ranges" dependencyTypes: - "engines" dependencies: - "npm" packages: - "**" range: "^" - label: "packageManager should always use exact dependency ranges" dependencyTypes: - "packageManager" dependencies: - "**" packages: - "**" range: "" # PropertyDDS packages' dependencies are ignored because they use a lot of exact deps. - dependencies: - "**" packages: - "@fluid-experimental/property-*" isIgnored: true - label: "Overridden server dependencies should always be exact versions" dependencyTypes: - "pnpmOverrides" dependencies: - "@fluidframework/gitresources" - "@fluidframework/protocol-base" - "@fluidframework/server-*" packages: - "**" range: "" - label: "Deps in pnpm overrides can use whatever dependency ranges they need" dependencyTypes: - "pnpmOverrides" dependencies: - "**" packages: - "**" isIgnored: true - label: "Must use exact dependency ranges" dependencies: - "@tiny-calc/*" # @tylerbu/markdown-magic is currently pinned to a tagged prerelease (e.g. 2.4.0-tylerbu-1); a caret range on a # prerelease won't include other prereleases, so an exact pin is the intended behavior. - "@tylerbu/markdown-magic" - "@graphql-codegen/cli" - "@graphql-codegen/typescript" - "@material-ui/*" # api-extractor is patched, so it must use an exact version to avoid the patch breaking when updating. - "@microsoft/api-extractor" - "@types/chrome" - "@types/codemirror" - "@types/jest" - "@types/url-parse" - "fake-indexeddb" - "json-stringify-safe" - "yargs" packages: - "**" range: "" # Some dependencies, like typescript and eslint, recommend to use tilde deps because minors introduce # changes that may break linting - label: "Must use tilde dependency ranges" dependencies: - "@biomejs/biome" - "@eslint-community/*" - "@eslint/*" - "@rushstack/eslint-*" - "@typescript-eslint/*" - "eslint-config-*" - "eslint-config-prettier" - "eslint-import-resolver-typescript" - "eslint-plugin-*" - "eslint" - "less" - "prettier" - "typescript" - "typescript-eslint" - "vue" - "webpack-dev-server" # pinned since newer versions (2.3 through 2.6) refuse to work on NodeJS other than 10 || 12 || 14 due to https://github.com/cerner/terra-toolkit/issues/828 - "@cerner/duplicate-package-checker-webpack-plugin" packages: - "**" range: "~" # Dev dependencies on -previous (used for type tests) should use exact versions - label: "Type-tests 'previous' deps should use exact versions" dependencies: - "**/*previous" # Not sure why just "**previous" doesn't work dependencyTypes: - "dev" packages: - "**" range: "" # @fluid-example/typescript-versions-host typescript versions should use ~ - label: "@fluid-example/typescript-versions-host typescript versions should use ~" dependencies: - "typescript-*" dependencyTypes: - "dev" packages: - "@fluid-example/typescript-versions-host" range: "~" # `@types` packages should often use `~` to avoid pulling in newer types with more features than the code they are the types for. - label: "Must use tilde dependency ranges" dependencies: - "@types/node" packages: - "**" range: "~" # eslint-config-fluid is an independent workspace linked via the link: protocol, # which syncpack cannot resolve. Ignore it from semver range checks. - label: "Ignore eslint-config-fluid (independent workspace with link: protocol)" dependencies: - "@fluidframework/eslint-config-fluid" packages: - "**" isIgnored: true # All non-workspace deps should use caret ranges unless previously overridden. # workspace: protocol ranges are enforced by the pinned version group below, # not by this semverGroups rule. - label: "Dependencies should use caret dependency ranges" dependencies: - "**" dependencyTypes: - "dev" - "peer" - "prod" packages: - "**" range: "^" # VersionGroups are used to ensure that groups of packages use the same version of dependencies. # # versionGroup rules are applied in order to package/dep combinations. First matching rule applies. When running # `syncpack list-mismatches`, the output is grouped by label. versionGroups: # Ban optional dependencies before any pinning or ignore rules can match them. # If we decide we want to allow them, this can be removed. - label: "Optional dependencies are not allowed" dependencyTypes: - "optional" isBanned: true # Within a workspace, our packages are allowed to depend on `@internal` APIs which do not follow semver and thus must not have version skew across minors. # This is enforced using `~` dependencies. # # Keep this before the Fluid interdependency ignore rule. # https://syncpack.dev/version-groups/pinned/ - label: "Workspace dependencies must use workspace:~" specifierTypes: - "workspace-protocol" pinVersion: "workspace:~" # Workaround for compatibility issues. # Ideally this section would be empty (and removed). # Items should be removed from here when possible. - label: "Version compatibility workarounds should be used, or removed from .syncpackrc.yml if no longer needed." dependencies: - "react-virtualized-auto-sizer" - "@types/react" - "@types/react-dom" # "quill-delta" 5 does not support CommonJS so @fluid-experimental/ot is stuck on version 4 for its dev-dep. # Other use of quill delta is in our react package for text editing, which is ESM only and uses up to date quill packages. # This results in us being stuck using 2 versions as long as @fluid-experimental/ot tests support CommonJS and use quill-delta. - "quill-delta" packages: - "**" isIgnored: true # eslint-config-fluid is an independent workspace linked via the link: protocol, # which syncpack cannot resolve. Ignore it from version matching. - label: "Ignore eslint-config-fluid (independent workspace with link: protocol)" dependencies: - "@fluidframework/eslint-config-fluid" packages: - "**" isIgnored: true - label: "Versions of common Fluid packages should all match" dependencies: - "@fluid-tools/benchmark" - "@fluid-tools/build-cli" - "@fluidframework/build-common" - "@fluidframework/build-tools" - "@fluidframework/common-utils" # Can be re-enabled once the package is using a proper feed dependency instead of a file: # reference to the local package. # - "@fluidframework/eslint-config-fluid" - "@fluidframework/protocol-definitions" - "@fluidframework/test-tools" packages: - "**" - label: "Versions in engines field should all match" dependencyTypes: - "engines" dependencies: - "**" packages: - "**" - label: "Versions in packageManager field should all match" dependencyTypes: - "packageManager" dependencies: - "**" packages: - "**" - label: "Ignore interdependencies on other Fluid packages. This is needed because syncpack doesn't understand our >= < semver ranges" isIgnored: true packages: - "@fluid-example/**" - "@fluid-experimental/**" - "@fluid-internal/**" - "@fluid-private/**" - "@fluid-tools/**" - "@fluidframework/**" - "fluid-framework" dependencies: - "@fluid-example/**" - "@fluid-experimental/**" - "@fluid-internal/**" - "@fluid-private/**" - "@fluid-tools/**" - "@fluidframework/**" - "fluid-framework"