Run with --noNimblePath when there is a lock file (#1062)

Fixes #1004

src/nimble.nim

@@ -1854,35 +1854,50 @@ proc setupNimbleConfig(options: Options) =
   ## dependencies. Includes it in `config.nims` file to make them available
   ## for the compiler.
   const
-    configFileVersion = 1
+    configFileVersion = 2
+    sectionEnd = "# end Nimble config"
+    sectionStart = "# begin Nimble config"
     configFileHeader = &"# begin Nimble config (version {configFileVersion})\n"
-    configFileContent = fmt"""
-when fileExists("{nimblePathsFileName}"):
+    configFileContentNoLock = fmt"""
+{configFileHeader}
+when system.fileExists("{nimblePathsFileName}"):
   include "{nimblePathsFileName}"
-# end Nimble config
+{sectionEnd}
+"""
+    configFileContentWithLock = fmt"""
+{configFileHeader}
+--noNimblePath
+when system.fileExists("{nimblePathsFileName}"):
+  include "{nimblePathsFileName}"
+{sectionEnd}
 """
 
   let
     currentDir = getCurrentDir()
     pkgInfo = getPkgInfo(currentDir, options)
+    lockFileExists = options.lockFile(currentDir).fileExists
+    configFileContent = if lockFileExists: configFileContentWithLock
+                        else: configFileContentNoLock
 
   updatePathsFile(pkgInfo, options)
 
   var
     writeFile = false
     fileContent: string
 
-  proc appendNimbleConfigFileHeaderAndContent =
-    fileContent.append(configFileHeader)
-    fileContent.append(configFileContent)
-
   if fileExists(nimbleConfigFileName):
     fileContent = readFile(nimbleConfigFileName)
-    if not fileContent.contains(configFileHeader):
-      appendNimbleConfigFileHeaderAndContent()
+    if not fileContent.contains(configFileContent):
+      let
+        startIndex = fileContent.find(sectionStart)
+        endIndex = fileContent.find(sectionEnd)
+      if startIndex >= 0 and endIndex >= 0:
+        fileContent.delete(startIndex..endIndex + sectionEnd.len - 1)
+
+      fileContent.append(configFileContent)
       writeFile = true
   else:
-    appendNimbleConfigFileHeaderAndContent()
+    fileContent.append(configFileContent)
     writeFile = true
 
   if writeFile:

tests/setupproject/demo.nimble

@@ -0,0 +1,8 @@
+# Package
+
+version       = "0.1.0"
+author        = "Ivan Yonchovski"
+description   = "A new awesome nimble package"
+license       = "MIT"
+srcDir        = "src"
+bin           = @["demo"]

tests/setupproject/src/demo.nim

@@ -0,0 +1 @@
+# echo

tests/tsetupcommand.nim

@@ -52,3 +52,20 @@ suite "setup command":
         # build the project.
         let (_, nimExitCode) = execCmdEx("nim c -r dependent")
         check nimExitCode == QuitSuccess
+
+  test "Check if upgrading of setup section":
+    cd "setupproject":
+      cleanFiles nimblePathsFileName, nimbleConfigFileName, "nimble.lock", ".gitignore"
+      discard execNimble("setup")
+      var configFileContent = nimbleConfigFileName.readFile
+      check not configFileContent.contains("--noNimblePath")
+      let (_, developExitCode) = execNimble("lock")
+      check developExitCode == QuitSuccess
+
+      # update of the section works
+      discard execNimble("setup")
+      check fileExists("nimble.lock")
+      configFileContent = nimbleConfigFileName.readFile
+      check configFileContent.contains("--noNimblePath")
+
+      cleanFiles nimblePathsFileName, nimbleConfigFileName, "nimble.lock", ".gitignore"