Rename skipchars to skipuntil

Per discussion in #36132, I believe this name is much clearer. Another
option is "seekuntil".

Closes #36132

Author: non-Jedi

base/deprecated.jl

@@ -208,3 +208,9 @@ macro get!(h, key0, default)
 end
 
 # END 1.5 deprecations
+
+# BEGIN 1.6 deprecations
+
+@deprecate skipchars(pred, io::IO; linecomment=nothing) skipuntil(pred, io::IO; linecomment=linecomment)
+
+# END 1.5 deprecations

base/exports.jl

@@ -821,7 +821,7 @@ export
     seekend,
     seekstart,
     skip,
-    skipchars,
+    skipuntil,
     take!,
     truncate,
     unmark,

base/io.jl

@@ -433,7 +433,7 @@ The delimiter can be a `UInt8`, `AbstractChar`, string, or vector.
 Keyword argument `keep` controls whether the delimiter is included in the result.
 The text is assumed to be encoded in UTF-8.
 
-See also: [`skipchars`](@ref)
+See also: [`skipuntil`](@ref)
 
 # Examples
 ```jldoctest
@@ -1014,7 +1014,7 @@ end
 
 Return an iterable object yielding [`read(io, T)`](@ref).
 
-See also: [`skipchars`](@ref), [`eachline`](@ref), [`readuntil`](@ref)
+See also: [`skipuntil`](@ref), [`eachline`](@ref), [`readuntil`](@ref)
 
 # Examples
 ```jldoctest
@@ -1109,7 +1109,7 @@ Commit all currently buffered writes to the given stream.
 flush(io::IO) = nothing
 
 """
-    skipchars(predicate, io::IO; linecomment=nothing)
+    skipuntil(predicate, io::IO; linecomment=nothing)
 
 Advance the stream `io` such that the next-read character will be the first remaining for
 which `predicate` returns `false`. If the keyword argument `linecomment` is specified, all
@@ -1122,14 +1122,14 @@ See also: [`readuntil`](@ref)
 julia> buf = IOBuffer("    text")
 IOBuffer(data=UInt8[...], readable=true, writable=false, seekable=true, append=false, size=8, maxsize=Inf, ptr=1, mark=-1)
 
-julia> skipchars(isspace, buf)
+julia> skipuntil(isspace, buf)
 IOBuffer(data=UInt8[...], readable=true, writable=false, seekable=true, append=false, size=8, maxsize=Inf, ptr=5, mark=-1)
 
 julia> String(readavailable(buf))
 "text"
 ```
 """
-function skipchars(predicate, io::IO; linecomment=nothing)
+function skipuntil(predicate, io::IO; linecomment=nothing)
     while !eof(io)
         c = read(io, Char)
         if c === linecomment

doc/src/base/io-network.md

@@ -44,7 +44,7 @@ Base.redirect_stdin
 Base.redirect_stdin(::Function, ::Any)
 Base.readchomp
 Base.truncate
-Base.skipchars
+Base.skipuntil
 Base.countlines
 Base.PipeBuffer
 Base.readavailable

stdlib/REPL/src/LineEdit.jl

@@ -1118,7 +1118,7 @@ end
 
 function edit_replace_word_right(buf::IOBuffer, replace::Function)
     # put the cursor at the beginning of the next word
-    skipchars(is_non_word_char, buf)
+    skipuntil(is_non_word_char, buf)
     b = position(buf)
     char_move_word_right(buf)
     e = position(buf)

test/iobuffer.jl

@@ -275,27 +275,27 @@ let io = IOBuffer()
     @test Base.buffer_writes(io) === io
 end
 
-@testset "skipchars" begin
+@testset "skipuntil" begin
     io = IOBuffer("")
-    @test eof(skipchars(isspace, io))
+    @test eof(skipuntil(isspace, io))
 
     io = IOBuffer("   ")
-    @test eof(skipchars(isspace, io))
+    @test eof(skipuntil(isspace, io))
 
     io = IOBuffer("#    \n     ")
-    @test eof(skipchars(isspace, io, linecomment='#'))
+    @test eof(skipuntil(isspace, io, linecomment='#'))
 
     io = IOBuffer("      text")
-    skipchars(isspace, io)
+    skipuntil(isspace, io)
     @test String(readavailable(io)) == "text"
 
     io = IOBuffer("   # comment \n    text")
-    skipchars(isspace, io, linecomment='#')
+    skipuntil(isspace, io, linecomment='#')
     @test String(readavailable(io)) == "text"
 
     for char in ['@','߷','࿊','𐋺']
         io = IOBuffer("alphabeticalstuff$char")
-        @test !eof(skipchars(isletter, io))
+        @test !eof(skipuntil(isletter, io))
         @test read(io, Char) == char
     end
 end

test/iostream.jl

@@ -1,6 +1,6 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
-@testset "skipchars for IOStream" begin
+@testset "skipuntil for IOStream" begin
     mktemp() do path, file
         function append_to_file(str)
             mark(file)
@@ -9,31 +9,31 @@
             reset(file)
         end
         # test it doesn't error on eof
-        @test eof(skipchars(isspace, file))
+        @test eof(skipuntil(isspace, file))
 
         # test it correctly skips
         append_to_file("    ")
-        @test eof(skipchars(isspace, file))
+        @test eof(skipuntil(isspace, file))
 
         # test it correctly detects comment lines
         append_to_file("#    \n   ")
-        @test eof(skipchars(isspace, file, linecomment='#'))
+        @test eof(skipuntil(isspace, file, linecomment='#'))
 
         # test it stops at the appropriate time
         append_to_file("   not a space")
-        @test !eof(skipchars(isspace, file))
+        @test !eof(skipuntil(isspace, file))
         @test read(file, Char) == 'n'
 
         # test it correctly ignores the contents of comment lines
         append_to_file("  #not a space \n   not a space")
-        @test !eof(skipchars(isspace, file, linecomment='#'))
+        @test !eof(skipuntil(isspace, file, linecomment='#'))
         @test read(file, Char) == 'n'
 
         # test it correctly handles unicode
         for (byte, char) in zip(1:4, ('@','߷','࿊','𐋺'))
             append_to_file("abcdef$char")
             @test ncodeunits(char) == byte
-            @test !eof(skipchars(isletter, file))
+            @test !eof(skipuntil(isletter, file))
             @test read(file, Char) == char
         end
     end