feat(constants): Version Scheme Constants (renovatebot#5159)

lib/config/definitions.ts

@@ -1,4 +1,24 @@
 import { RenovateConfigStage } from './common';
+import {
+  VERSION_SCHEME_CARGO,
+  VERSION_SCHEME_COMPOSER,
+  VERSION_SCHEME_DOCKER,
+  VERSION_SCHEME_GIT,
+  VERSION_SCHEME_HEX,
+  VERSION_SCHEME_HASHICORP,
+  VERSION_SCHEME_IVY,
+  VERSION_SCHEME_LOOSE,
+  VERSION_SCHEME_MAVEN,
+  VERSION_SCHEME_NODE,
+  VERSION_SCHEME_NPM,
+  VERSION_SCHEME_NUGET,
+  VERSION_SCHEME_PEP440,
+  VERSION_SCHEME_POETRY,
+  VERSION_SCHEME_REGEX,
+  VERSION_SCHEME_RUBY,
+  VERSION_SCHEME_SEMVER,
+  VERSION_SCHEME_SWIFT,
+} from '../constants/version-schemes';
 import {
   PLATFORM_TYPE_AZURE,
   PLATFORM_TYPE_BITBUCKET,
@@ -601,26 +621,26 @@ const options: RenovateOptions[] = [
     description: 'Version scheme to use for filtering and comparisons',
     type: 'string',
     allowedValues: [
-      'cargo',
-      'composer',
-      'docker',
-      'git',
-      'hashicorp',
-      'hex',
-      'ivy',
-      'loose',
-      'maven',
-      'node',
-      'npm',
-      'nuget',
-      'pep440',
-      'poetry',
-      'regex',
-      'ruby',
-      'semver',
-      'swift',
+      VERSION_SCHEME_CARGO,
+      VERSION_SCHEME_COMPOSER,
+      VERSION_SCHEME_DOCKER,
+      VERSION_SCHEME_GIT,
+      VERSION_SCHEME_HASHICORP,
+      VERSION_SCHEME_HEX,
+      VERSION_SCHEME_IVY,
+      VERSION_SCHEME_LOOSE,
+      VERSION_SCHEME_MAVEN,
+      VERSION_SCHEME_NODE,
+      VERSION_SCHEME_NPM,
+      VERSION_SCHEME_NUGET,
+      VERSION_SCHEME_PEP440,
+      VERSION_SCHEME_POETRY,
+      VERSION_SCHEME_REGEX,
+      VERSION_SCHEME_RUBY,
+      VERSION_SCHEME_SEMVER,
+      VERSION_SCHEME_SWIFT,
     ],
-    default: 'semver',
+    default: VERSION_SCHEME_SEMVER,
     cli: false,
     env: false,
   },
@@ -1379,7 +1399,7 @@ const options: RenovateOptions[] = [
     default: {
       fileMatch: ['(^|/)package.json$'],
       rollbackPrs: true,
-      versionScheme: 'npm',
+      versionScheme: VERSION_SCHEME_NPM,
       prBodyDefinitions: {
         Change:
           '[{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}](https://renovatebot.com/diffs/npm/{{{depNameEscaped}}}/{{{fromVersion}}}/{{{toVersion}}})',
@@ -1474,7 +1494,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)Gemfile$'],
-      versionScheme: 'ruby',
+      versionScheme: VERSION_SCHEME_RUBY,
     },
     mergeable: true,
   },
@@ -1485,7 +1505,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)\\.ruby-version$'],
-      versionScheme: 'ruby',
+      versionScheme: VERSION_SCHEME_RUBY,
     },
     mergeable: true,
     cli: false,
@@ -1499,7 +1519,7 @@ const options: RenovateOptions[] = [
       commitMessageTopic:
         'Terraform {{managerData.terraformDependencyType}} {{depNameShort}}',
       fileMatch: ['\\.tf$'],
-      versionScheme: 'hashicorp',
+      versionScheme: VERSION_SCHEME_HASHICORP,
     },
     mergeable: true,
   },
@@ -1510,7 +1530,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)mix\\.exs$'],
-      versionScheme: 'hex',
+      versionScheme: VERSION_SCHEME_HEX,
     },
     mergeable: true,
   },
@@ -1532,7 +1552,7 @@ const options: RenovateOptions[] = [
       commitMessageTopic: 'Rust crate {{depName}}',
       managerBranchPrefix: 'rust-',
       fileMatch: ['(^|/)Cargo.toml$'],
-      versionScheme: 'cargo',
+      versionScheme: VERSION_SCHEME_CARGO,
       rangeStrategy: 'bump',
     },
     mergeable: true,
@@ -1567,7 +1587,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['^.travis.yml$'],
-      versionScheme: 'node',
+      versionScheme: VERSION_SCHEME_NODE,
     },
     mergeable: true,
     cli: false,
@@ -1579,7 +1599,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['^.nvmrc$'],
-      versionScheme: 'node',
+      versionScheme: VERSION_SCHEME_NODE,
     },
     mergeable: true,
     cli: false,
@@ -1591,7 +1611,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)pubspec\\.ya?ml$'],
-      versionScheme: 'npm',
+      versionScheme: VERSION_SCHEME_NPM,
     },
     mergeable: true,
     cli: false,
@@ -1602,7 +1622,7 @@ const options: RenovateOptions[] = [
     stage: 'package',
     type: 'object',
     default: {
-      versionScheme: 'docker',
+      versionScheme: VERSION_SCHEME_DOCKER,
       managerBranchPrefix: 'docker-',
       commitMessageTopic: '{{{depName}}} Docker tag',
       major: { enabled: false },
@@ -1742,7 +1762,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)([\\w-]*)composer.json$'],
-      versionScheme: 'composer',
+      versionScheme: VERSION_SCHEME_COMPOSER,
     },
     mergeable: true,
     cli: false,
@@ -1754,7 +1774,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       enabled: false,
-      versionScheme: 'git',
+      versionScheme: VERSION_SCHEME_GIT,
       fileMatch: ['(^|/).gitmodules$'],
     },
     mergeable: true,
@@ -1808,7 +1828,7 @@ const options: RenovateOptions[] = [
     stage: 'package',
     type: 'object',
     default: {
-      versionScheme: 'poetry',
+      versionScheme: VERSION_SCHEME_POETRY,
       fileMatch: ['(^|/)pyproject\\.toml$'],
     },
     mergeable: true,
@@ -1819,7 +1839,7 @@ const options: RenovateOptions[] = [
     stage: 'package',
     type: 'object',
     default: {
-      versionScheme: 'pep440',
+      versionScheme: VERSION_SCHEME_PEP440,
     },
     mergeable: true,
     cli: false,
@@ -1832,7 +1852,7 @@ const options: RenovateOptions[] = [
     default: {
       fileMatch: ['\\.sbt$', 'project/[^/]*.scala$'],
       timeout: 300,
-      versionScheme: 'ivy',
+      versionScheme: VERSION_SCHEME_IVY,
     },
     mergeable: true,
     cli: false,
@@ -1845,7 +1865,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)project\\.clj$'],
-      versionScheme: 'maven',
+      versionScheme: VERSION_SCHEME_MAVEN,
     },
     mergeable: true,
     cli: false,
@@ -1858,7 +1878,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)deps\\.edn$'],
-      versionScheme: 'maven',
+      versionScheme: VERSION_SCHEME_MAVEN,
     },
     mergeable: true,
     cli: false,
@@ -1888,7 +1908,7 @@ const options: RenovateOptions[] = [
     default: {
       fileMatch: ['\\.gradle(\\.kts)?$', '(^|/)gradle.properties$'],
       timeout: 600,
-      versionScheme: 'maven',
+      versionScheme: VERSION_SCHEME_MAVEN,
     },
     mergeable: true,
     cli: false,
@@ -1911,7 +1931,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['\\.pom\\.xml$', '(^|/)pom\\.xml$'],
-      versionScheme: 'maven',
+      versionScheme: VERSION_SCHEME_MAVEN,
     },
     mergeable: true,
     cli: false,
@@ -2102,7 +2122,7 @@ const options: RenovateOptions[] = [
     type: 'object',
     default: {
       fileMatch: ['(^|/)Package\\.swift'],
-      versionScheme: 'swift',
+      versionScheme: VERSION_SCHEME_SWIFT,
       rangeStrategy: 'bump',
     },
     mergeable: true,

lib/constants/version-schemes.ts

@@ -0,0 +1,18 @@
+export const VERSION_SCHEME_SEMVER = 'semver';
+export const VERSION_SCHEME_NPM = 'npm';
+export const VERSION_SCHEME_NODE = 'node';
+export const VERSION_SCHEME_HASHICORP = 'hashicorp';
+export const VERSION_SCHEME_COMPOSER = 'composer';
+export const VERSION_SCHEME_GIT = 'git';
+export const VERSION_SCHEME_POETRY = 'poetry';
+export const VERSION_SCHEME_MAVEN = 'maven';
+export const VERSION_SCHEME_SWIFT = 'swift';
+export const VERSION_SCHEME_RUBY = 'ruby';
+export const VERSION_SCHEME_HEX = 'hex';
+export const VERSION_SCHEME_CARGO = 'cargo';
+export const VERSION_SCHEME_DOCKER = 'docker';
+export const VERSION_SCHEME_PEP440 = 'pep440';
+export const VERSION_SCHEME_IVY = 'ivy';
+export const VERSION_SCHEME_LOOSE = 'loose';
+export const VERSION_SCHEME_NUGET = 'nuget';
+export const VERSION_SCHEME_REGEX = 'regex';

lib/datasource/index.ts

@@ -31,6 +31,7 @@ import {
   ReleaseResult,
   DigestConfig,
 } from './common';
+import { VERSION_SCHEME_SEMVER } from '../constants/version-schemes';
 
 export * from './common';
 
@@ -105,7 +106,9 @@ export async function getPkgReleases(
     return res;
   }
   const versionScheme =
-    config && config.versionScheme ? config.versionScheme : 'semver';
+    config && config.versionScheme
+      ? config.versionScheme
+      : VERSION_SCHEME_SEMVER;
   // Filter by version scheme
   const version = versioning.get(versionScheme);
   // Return a sorted list of valid Versions

lib/manager/ansible/extract.ts

@@ -1,6 +1,7 @@
 import { logger } from '../../logger';
 import { getDep } from '../dockerfile/extract';
 import { PackageFile, PackageDependency } from '../common';
+import { VERSION_SCHEME_DOCKER } from '../../constants/version-schemes';
 
 export default function extractPackageFile(
   content: string
@@ -22,7 +23,7 @@ export default function extractPackageFile(
         'Docker image inside ansible'
       );
       dep.managerData = { lineNumber };
-      dep.versionScheme = 'docker';
+      dep.versionScheme = VERSION_SCHEME_DOCKER;
       deps.push(dep);
     }
     lineNumber += 1;

lib/manager/bazel/extract.ts

@@ -4,6 +4,7 @@ import { parse as _parse } from 'url';
 import { logger } from '../../logger';
 import { PackageDependency, PackageFile } from '../common';
 import { regEx } from '../../util/regex';
+import { VERSION_SCHEME_DOCKER } from '../../constants/version-schemes';
 import {
   DATASOURCE_DOCKER,
   DATASOURCE_GITHUB,
@@ -241,8 +242,8 @@ export function extractPackageFile(content: string): PackageFile | null {
       dep.currentDigest = digest;
       dep.currentValue = currentValue;
       dep.depName = depName;
+      dep.versionScheme = VERSION_SCHEME_DOCKER;
       dep.datasource = DATASOURCE_DOCKER;
-      dep.versionScheme = 'docker';
       dep.lookupName = repository;
       deps.push(dep);
     } else {

lib/manager/circleci/extract.ts

@@ -1,6 +1,7 @@
 import { logger } from '../../logger';
 import { getDep } from '../dockerfile/extract';
 import { PackageFile, PackageDependency } from '../common';
+import { VERSION_SCHEME_NPM } from '../../constants/version-schemes';
 import { DATASOURCE_ORB } from '../../constants/data-binary-source';
 
 export function extractPackageFile(content: string): PackageFile | null {
@@ -32,7 +33,7 @@ export function extractPackageFile(content: string): PackageFile | null {
               datasource: DATASOURCE_ORB,
               lookupName: orbName,
               commitMessageTopic: '{{{depName}}} orb',
-              versionScheme: 'npm',
+              versionScheme: VERSION_SCHEME_NPM,
               rangeStrategy: 'pin',
             };
             deps.push(dep);

lib/manager/github-actions/extract.ts

@@ -1,6 +1,7 @@
 import { logger } from '../../logger';
 import { getDep } from '../dockerfile/extract';
 import { PackageFile, PackageDependency } from '../common';
+import { VERSION_SCHEME_DOCKER } from '../../constants/version-schemes';
 
 export function extractPackageFile(content: string): PackageFile | null {
   logger.debug('github-actions.extractPackageFile()');
@@ -24,7 +25,7 @@ export function extractPackageFile(content: string): PackageFile | null {
         'Docker image inside GitHub Actions'
       );
       dep.managerData = { lineNumber };
-      dep.versionScheme = 'docker';
+      dep.versionScheme = VERSION_SCHEME_DOCKER;
       deps.push(dep);
     }
     lineNumber += 1;

lib/manager/gradle-wrapper/extract.ts

@@ -1,6 +1,7 @@
 import { coerce } from 'semver';
 import { logger } from '../../logger';
 import { PackageFile, PackageDependency } from '../common';
+import { VERSION_SCHEME_SEMVER } from '../../constants/version-schemes';
 import { DATASOURCE_GRADLE_VERSION } from '../../constants/data-binary-source';
 
 export function extractPackageFile(fileContent: string): PackageFile | null {
@@ -19,7 +20,7 @@ export function extractPackageFile(fileContent: string): PackageFile | null {
         depName: 'gradle',
         currentValue: coerce(match[1]).toString(),
         managerData: { lineNumber, gradleWrapperType: match[3] },
-        versionScheme: 'semver',
+        versionScheme: VERSION_SCHEME_SEMVER,
       };
 
       let shaLineNumber = 0;