Adds legacy flag (defaults to true) (#1409)

Author: jmgomez

src/nimble.nim

@@ -834,7 +834,7 @@ proc processLockedDependencies(pkgInfo: PackageInfo, options: Options):
   # their local file system directories and other packages from the Nimble
   # cache. If a package with required checksum is missing from the local cache
   # installs it by downloading it from its repository.
-  if options.isVNext:
+  if not options.isLegacy:
     return options.satResult.pkgs
 
   let developModeDeps = getDevelopDependencies(pkgInfo, options, raiseOnValidationErrors = false)
@@ -1046,15 +1046,15 @@ proc execBackend(pkgInfo: PackageInfo, options: Options) =
   nimScriptHint(pkgInfo)
 
   let deps = 
-    if options.isVNext:
+    if not options.isLegacy:
       options.satResult.pkgs
     else:
       pkgInfo.processAllDependencies(options)
   if not execHook(options, options.action.typ, true):
     raise nimbleError("Pre-hook prevented further execution.")
 
   var args = @["-d:NimblePkgVersion=" & $pkgInfo.basicInfo.version]
-  if options.isVNext:
+  if not options.isLegacy:
     for path in options.getPathsAllPkgs():
       args.add("--path:" & path.quoteShell)
   else:
@@ -1726,7 +1726,7 @@ proc updateSyncFile(dependentPkg: PackageInfo, options: Options)
 
 proc updatePathsFile(pkgInfo: PackageInfo, options: Options) =
   let paths = 
-    if options.isVNext: 
+    if not options.isLegacy: 
       #TODO improve this (or better the alternative, getDependenciesPaths, so it returns the same type)
       var pathsPaths = initHashSet[seq[string]]()
       for path in options.getPathsAllPkgs():
@@ -2029,11 +2029,11 @@ proc lock(options: var Options) =
   # Clear package info cache to ensure we read the latest nimble file
   # This is important when the nimble file has been modified since the last read
   # In vnext mode, the cache clearing is done before runVNext is called
-  if not options.isVNext:
+  if options.isLegacy:
     options.pkgInfoCache.clear()
 
   let
-    pkgInfo = if options.isVNext:
+    pkgInfo = if not options.isLegacy:
       options.satResult.rootPackage
     else:
       getPkgInfo(currentDir, options)
@@ -2042,7 +2042,7 @@ proc lock(options: var Options) =
 
   var 
      baseDeps =       
-      if options.isVNext:
+      if not options.isLegacy:
         options.satResult.pkgs.toSeq
       elif options.useSATSolver:
         processFreeDependenciesSAT(pkgInfo, options).toSeq        
@@ -2081,7 +2081,7 @@ proc lock(options: var Options) =
     # Now build graph for all dependencies
     taskOptions.checkSatisfied(taskDeps)
 
-  if options.isVNext:
+  if not options.isLegacy:
     # vnext path: generate lockfile from solved packages
     # Check for develop dependency validation errors
     # Create a minimal graph for error checking - only include actual dependencies, not root package
@@ -2312,7 +2312,7 @@ proc sync(options: Options) =
 
   let currentDir = getCurrentDir()
   let pkgInfo = 
-    if options.isVNext:
+    if not options.isLegacy:
       options.satResult.rootPackage
     else:
       getPkgInfo(currentDir, options)
@@ -2457,12 +2457,12 @@ proc setup(options: Options) =
 proc getAlteredPath(options: Options): string =
 
   let pkgInfo = 
-    if options.isVNext:
+    if not options.isLegacy:
       options.satResult.rootPackage
     else:
       getPkgInfo(getCurrentDir(), options)
   var pkgs =
-    if options.isVNext:
+    if not options.isLegacy:
       options.satResult.pkgs.toSeq.toOrderedSet
     else:
       pkgInfo.processAllDependencies(options).toSeq.toOrderedSet
@@ -2507,7 +2507,7 @@ proc getPackageForAction(pkgInfo: PackageInfo, options: Options): PackageInfo =
   if options.package.len == 0 or pkgInfo.basicInfo.name == options.package:
     return pkgInfo
 
-  if options.isVNext:
+  if not options.isLegacy:
     # Search through the SAT result packages as the packages are already solved
     for pkg in options.satResult.pkgs:
       if pkg.basicInfo.name == options.package:
@@ -2526,7 +2526,7 @@ proc getPackageForAction(pkgInfo: PackageInfo, options: Options): PackageInfo =
 
 proc run(options: Options) =
   var pkgInfo: PackageInfo
-  if options.isVNext: #At this point we already ran the solver
+  if not options.isLegacy: #At this point we already ran the solver
     pkgInfo = options.satResult.rootPackage
     pkgInfo = getPackageForAction(pkgInfo, options)
   else:
@@ -2540,7 +2540,7 @@ proc run(options: Options) =
   if binary notin pkgInfo.bin:
     raise nimbleError(binaryNotDefinedInPkgMsg(binary, pkgInfo.basicInfo.name))
 
-  if options.isVNext:
+  if not options.isLegacy:
     # In vnext path, build develop mode packages (similar to old code path)
     if pkgInfo.isLink:
       # Use vnext buildPkg for develop mode packages
@@ -2662,7 +2662,7 @@ proc doAction(options: var Options) =
   of actionRefresh:
     refresh(options)
   of actionInstall:
-    if not options.isVNext:
+    if options.isLegacy:
       let (_, pkgInfo) = install(options.action.packages, options,
                                 doPrompt = true,
                                 first = true,
@@ -2690,7 +2690,7 @@ proc doAction(options: var Options) =
   of actionPath:
     listPaths(options)
   of actionBuild:
-    if not options.isVNext:
+    if options.isLegacy:
       build(options)
   of actionClean:
     clean(options)
@@ -2744,7 +2744,7 @@ proc doAction(options: var Options) =
       # Make sure we have dependencies for the task.
       # We do that here to make sure that any binaries from dependencies
       # are installed
-      if not optsCopy.isVNext:
+      if optsCopy.isLegacy:
         discard pkgInfo.processAllDependencies(optsCopy)
       # If valid task defined in nimscript, run it
       var execResult: ExecutionResult[bool]
@@ -2881,7 +2881,7 @@ when isMainModule:
       actionShellEnv, actionShell, actionUpgrade
     }
 
-    if opt.isVNext and opt.action.typ in vNextSupportedActions:
+    if not opt.isLegacy and opt.action.typ in vNextSupportedActions:
       # For actionCustom, set the task name before calling runVNext
       if opt.action.typ == actionCustom:
         opt.task = opt.action.command.normalize

src/nimblepkg/developfile.nim

@@ -172,7 +172,7 @@ proc validatePackage(pkgPath: Path, options: Options):
   ##                 not a valid package directory.
 
   try:
-    if options.isVnext: #TODO add and test fallback to nimVM parser (i.e. dev pkgList would need to be reloaded)
+    if not options.isLegacy: #TODO add and test fallback to nimVM parser (i.e. dev pkgList would need to be reloaded)
       if options.satResult.pass == satNimSelection:
         result.pkgInfo = getPkgInfoFromDirWithDeclarativeParser(string(pkgPath), options)
         #TODO find a way to validate the package, for now just mark the declarativeParser as failed

src/nimblepkg/download.nim

@@ -524,7 +524,7 @@ proc downloadPkg*(url: string, verRange: VersionRange,
     modUrl, downloadDir, verRange, downMethod, options, vcsRevision)
 
   var pkgInfo: PackageInfo
-  if validateRange and verRange.kind notin {verSpecial, verAny} or options.isVNext:
+  if validateRange and verRange.kind notin {verSpecial, verAny} or not options.isLegacy:
     ## Makes sure that the downloaded package's version satisfies the requested
     ## version range.
     pkginfo = if options.satResult.pass in {satNimSelection, satFallbackToVmParser}: #TODO later when in vnext we should just use this code path and fallback inside the toRequires if we can

src/nimblepkg/nimblesat.nim

@@ -615,7 +615,7 @@ proc getPackageMinimalVersionsFromRepo*(repoDir: string, pkg: PkgTuple, version:
         displayWarning(
           &"Error reading tag {tag}: for package {name}. This may not be relevant as it could be an old version of the package. \n {e.msg}",
            HighPriority)
-    if not (options.isVNext and options.satResult.pass == satNimSelection and options.satResult.declarativeParseFailed):
+    if not (not options.isLegacy and options.satResult.pass == satNimSelection and options.satResult.declarativeParseFailed):
       #Dont save tagged versions if we are in vNext and the declarative parser failed as this could cache the incorrect versions.
       #its suboptimal in the sense that next packages after failure wont be saved in the first past but there is a guarantee that there is a second pass in the case 
       #the declarative parser fails so they will be saved then.

src/nimblepkg/options.nim

@@ -70,6 +70,7 @@ type
     features*: seq[string] # Features to be activated. Only used when using the declarative parser
     ignoreSubmodules*: bool # Whether to ignore submodules when cloning a repository
     satResult*: SatResult
+    legacy*: bool # Whether to use the legacy code path.
 
   ActionType* = enum
     actionNil, actionRefresh, actionInit, actionDump, actionPublish, actionUpgrade
@@ -282,7 +283,7 @@ Nimble Options:
       --parser:declarative|nimvm  Use the declarative parser or the nimvm parser (default).
       --features                  Activate features. Only used when using the declarative parser.
       --ignoreSubmodules          Ignore submodules when cloning a repository.
-      --vnext                     Temporary flag (not shipped) to use the new code path where we assume solver is SAT and declarative parser are enabled. Later on, when both are enabled `vnext` code path will be used.
+      --legacy                    Use the legacy code path (pre nimble 1.0.0)
 For more information read the GitHub readme:
   https://github.com/nim-lang/nimble#readme
 """
@@ -634,6 +635,7 @@ proc parseFlag*(flag, val: string, result: var Options, kind = cmdLongOption) =
   of "package", "p": result.package = val
   of "lockfile": result.lockFileName = val
   of "usesystemnim": result.useSystemNim = true
+  of "legacy": result.legacy = true
   of "developfile":
     if result.developFile.len == 0:
       result.developFile = val.normalizedPath
@@ -798,6 +800,7 @@ proc initOptions*(): Options =
     maxTaggedVersions: 4,
     useSatSolver: true,
     useDeclarativeParser: false,
+    legacy: true, #default to legacy code path for nimble < 1.0.0
     satResult: SatResult()
   )
 
@@ -823,6 +826,10 @@ proc handleUnknownFlags(options: var Options) =
     for flag in unknownFlags:
       parseFlag(flag[1], flag[2], options, flag[0])
 
+  if not options.legacy: 
+    #default to declarative parser for new code path.
+    options.useDeclarativeParser = true 
+
   # Any unhandled flags?
   if options.unknownFlags.len > 0:
     let flag = options.unknownFlags[0]
@@ -968,5 +975,9 @@ proc isDevelopment*(pkg: PackageInfo, options: Options): bool =
   ### A development package is a root package that is not installed.
   not pkg.myPath.parentDir.startsWith(options.getPkgsDir())
 
-proc isVNext*(options: Options): bool =
-  options.useDeclarativeParser
+proc isLegacy*(options: Options): bool =
+  let isVnext = not options.legacy or options.useDeclarativeParser
+  if isVnext:
+    once: 
+      displayWarning("Using the new code path. This is experimental and may break in the future.")
+  return not isVnext

src/nimblepkg/packageinfo.nim

@@ -482,7 +482,7 @@ proc iterInstallFiles*(realDir: string, pkgInfo: PackageInfo,
 
   # Create a mapping of lowercase filesystem names to metadata names
   var metadataNameMap: Table[string, string]
-  if options.isVNext:
+  if not options.isLegacy:
     #in vnext we dont use the whitelist mode as we install all files since we want to build the package in the 
     #install dir. BUT we need to respect package metadata naming for specific files.
     whitelistMode = false
@@ -554,7 +554,7 @@ proc iterInstallFiles*(realDir: string, pkgInfo: PackageInfo,
         let skip = pkgInfo.checkInstallFile(realDir, file)
         if skip: 
           # In vnext mode, don't skip .nim files that are needed for binary compilation
-          if options.isVNext and file.splitFile.ext == ".nim":
+          if not options.isLegacy and file.splitFile.ext == ".nim":
             let fileName = file.splitFile.name
             var isNeededForBinary = false
             for binName, srcName in pkgInfo.bin:
@@ -568,7 +568,7 @@ proc iterInstallFiles*(realDir: string, pkgInfo: PackageInfo,
             continue
 
         # In vnext mode, skip binary files that match package binary names to avoid conflicts
-        if options.isVNext:
+        if not options.isLegacy:
           let fileName = file.splitFile.name
           let fileExt = file.splitFile.ext
           var skipBinary = false
@@ -581,7 +581,7 @@ proc iterInstallFiles*(realDir: string, pkgInfo: PackageInfo,
           if skipBinary: continue
 
         # For vnext: Handle symbolic links and case sensitivity
-        if options.isVNext:
+        if not options.isLegacy:
           let relativePath = file.relativePath(realDir)
           let normalizedPath = relativePath.toLowerAscii()
 
@@ -609,7 +609,7 @@ proc needsRebuild*(pkgInfo: PackageInfo, bin: string, dir: string, options: Opti
   if options.action.typ != actionInstall:
     return true
 
-  if options.isVNext:
+  if not options.isLegacy:
     if options.action.noRebuild:
       if not fileExists(bin):
         return true  

src/nimblepkg/packageparser.nim

@@ -261,7 +261,7 @@ proc inferInstallRules(pkgInfo: var PackageInfo, options: Options) =
   # installed.)
   let installInstructions =
     pkgInfo.installDirs.len + pkgInfo.installExt.len + pkgInfo.installFiles.len
-  if installInstructions == 0 and pkgInfo.bin.len > 0 and pkgInfo.basicInfo.name != "nim" and not options.isVNext: #dont skip nim files for vnext. We build in the install directory
+  if installInstructions == 0 and pkgInfo.bin.len > 0 and pkgInfo.basicInfo.name != "nim" and options.isLegacy: #dont skip nim files for vnext. We build in the install directory
     pkgInfo.skipExt.add("nim")
 
   # When a package doesn't specify a `srcDir` it's fair to assume that

src/nimblepkg/topologicalsort.nim

@@ -42,7 +42,7 @@ proc deleteStaleDependencies*(packages: seq[PackageInfo],
   # For lock operations in vnext mode, only include packages that are actual dependencies
   # This filters out packages in the develop file that are not real dependencies
   # Only apply this filtering for direct lock operations (no packages specified), not for upgrade operations
-  if options.action.typ == actionLock and options.isVNext and options.action.packages.len == 0:
+  if options.action.typ == actionLock and not options.isLegacy and options.action.packages.len == 0:
     let all = allDependencies(concat(rootPackage.requires,
                                      rootPackage.taskRequires.getOrDefault(options.task)),
                               packages,

src/nimblepkg/vnext.nim

@@ -554,7 +554,7 @@ proc getDepsPkgInfo(satResult: SATResult, pkgInfo: PackageInfo, options: Options
 
 proc expandPaths*(pkgInfo: PackageInfo, options: Options): seq[string] =
   var pkgInfo = pkgInfo.toFullInfo(options) #TODO is this needed in VNEXT? I dont think so
-  if options.isVNext: 
+  if not options.isLegacy: 
     pkgInfo = pkgInfo.toRequiresInfo(options)
   let baseDir = pkgInfo.getRealDir()
   result = @[baseDir]