API de sistema de arquivos

As utilidades de sistema de arquivos estão disponíveis em ptool.fs e p.fs.

ptool.fs.read

v0.1.0 - Introduced.

ptool.fs.read(path) lê um arquivo como bytes brutos e retorna uma string Lua.

• path (string, obrigatório): O caminho do arquivo.
• Retorna: string.

Notas:

• A string Lua retornada contém exatamente os bytes armazenados em disco.
• Arquivos de texto continuam funcionando como antes, e agora arquivos binários também são suportados.

Exemplo:

local content = ptool.fs.read("README.md")
print(content)

local png = ptool.fs.read("logo.png")
print(#png)

ptool.fs.write

v0.1.0 - Introduced.

ptool.fs.write(path, content) grava uma string Lua em um arquivo como bytes brutos, sobrescrevendo o conteúdo existente.

• path (string, obrigatório): O caminho do arquivo.
• content (string, obrigatório): O conteúdo a gravar.

Notas:

• content é gravado byte por byte.
• Bytes NUL embutidos e bytes não UTF-8 são preservados.

Exemplo:

ptool.fs.write("tmp/hello.txt", "hello\n")
ptool.fs.write("tmp/blob.bin", "\x00\xffABC")

ptool.fs.mkdir

v0.1.0 - Introduced.

ptool.fs.mkdir(path) cria um diretório. Se diretórios pais não existirem, eles são criados recursivamente.

• path (string, obrigatório): O caminho do diretório.

Exemplo:

ptool.fs.mkdir("tmp/a/b")

ptool.fs.exists

v0.1.0 - Introduced.

ptool.fs.exists(path) verifica se um caminho existe.

• path (string, obrigatório): Um caminho de arquivo ou diretório.
• Retorna: boolean.

Exemplo:

if ptool.fs.exists("tmp/hello.txt") then
  print("exists")
end

ptool.fs.is_file

Unreleased - Introduced.

ptool.fs.is_file(path) verifica se um caminho existe e é um arquivo regular.

• path (string, obrigatório): O caminho a verificar.
• Retorna: boolean.

Exemplo:

if ptool.fs.is_file("tmp/hello.txt") then
  print("file")
end

ptool.fs.is_dir

Unreleased - Introduced.

ptool.fs.is_dir(path) verifica se um caminho existe e é um diretório.

• path (string, obrigatório): O caminho a verificar.
• Retorna: boolean.

Exemplo:

if ptool.fs.is_dir("tmp") then
  print("dir")
end

ptool.fs.remove

Unreleased - Introduced.

ptool.fs.remove(path[, options]) remove um arquivo, link simbólico ou diretório.

• path (string, obrigatório): O caminho a remover.
• options (table, opcional): Opções de remoção. Campos suportados:
  • recursive (boolean, opcional): Se diretórios devem ser removidos recursivamente. O padrão é false.
  • missing_ok (boolean, opcional): Se caminhos ausentes devem ser ignorados. O padrão é false.

Comportamento:

• Arquivos e links simbólicos podem ser removidos sem recursive.
• Diretórios exigem recursive = true quando não estão vazios.
• Nomes de opção desconhecidos ou tipos de valor inválidos geram erro.

Exemplo:

ptool.fs.remove("tmp/hello.txt")
ptool.fs.remove("tmp/cache", { recursive = true })
ptool.fs.remove("tmp/missing.txt", { missing_ok = true })

ptool.fs.glob

v0.2.0 - Introduced. v0.5.0 - Added the working_dir option.

ptool.fs.glob(pattern[, options]) corresponde caminhos do sistema de arquivos usando sintaxe glob no estilo Unix e retorna um array de strings com os caminhos correspondentes, ordenados lexicograficamente.

• pattern (string, obrigatório): Um padrão glob. Padrões relativos são resolvidos a partir do diretório de runtime atual do ptool, portanto seguem ptool.cd(...).
• options (table, opcional): Opções de glob. Campos suportados:
  • working_dir (string, opcional): Sobrescreve o diretório base usado para resolver padrões relativos. Valores relativos de working_dir são resolvidos a partir do diretório de runtime atual do ptool.
• Retorna: string[].
• Arquivos e diretórios ocultos só correspondem quando o componente de padrão correspondente começa explicitamente com ..

Exemplo:

ptool.cd("src")

local rust_files = ptool.fs.glob("**/*.rs")
local hidden = ptool.fs.glob("**/.secret/*.txt")
local lua_scripts = ptool.fs.glob("**/*.lua", {
  working_dir = "../scripts",
})