https://github.com/circleci/fs
https://github.com/circleci/fs
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/circleci/fs
- Owner: circleci
- Created: 2016-08-31T17:51:59.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-09T21:05:29.000Z (about 2 years ago)
- Last Synced: 2025-06-16T07:07:37.010Z (about 1 year ago)
- Language: Clojure
- Homepage:
- Size: 43.9 KB
- Stars: 3
- Watchers: 46
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
======================================
fs - File system utilities for Clojure
======================================
.. Attention:: Anthony Grimes (Raynes) is now the maintainer of this project.
It is now hosted at https://github.com/Raynes/fs.
This repository is here for "historical" reasons only :)
About
=====
This library tries to provide Clojure code for handling the file system.
It has most of the functionality found in `java.io.File`_ influenced by Python's
`os.path`_ and `shutil`_.
.. _`java.io.File`: http://java.sun.com/javase/6/docs/api/java/io/File.html
.. _`os.path`: http://docs.python.org/library/os.path.html
.. _`shutil`: http://docs.python.org/library/shutil.html
API
===
abspath
Return absolute path
basename
Return the last part of path
chdir
Change directory. This only changes the value of *cwd* since Java does not
support changing directories.
chmod
Set/unset permission on path
copy
Copy a file, return path to destination
copy+
Copy a files, create directories if needed
copy-tree
Copy directory tree, return path of created directory
cwd
Return the current working directory
delete
Delete path, return path
deltree
Delete directory tree, return path
directory?
True if path is a directory
dirname
Return directory name
executable?
Check if path is executable
exists?
Check if path exists
extension
Return the extension part of path
file?
True if path is a file
glob
`ls` like operator
home
User home directory
iterdir
Return a sequence of [root dirs files] from path
join
Join part to path
listdir
List files under directory
mkdir
Create directory, return its path
mtime
File modification time
mkdirs
Create directory tree
normpath
Return normalized (canonical) path
readable?
Check if path is readable
rename
Rename path, return path of the new file
separator
Path separator
size
File size
split
Split path to parts
tempdir
Create temporary directory, return its path
tempfile
Create temporary file, return its path
touch
Change file modification time, return its path
walk
Walk over directory structure, calling function on every step
with-cwd
Temporary change directory and execute body.
writeable?
Check if path is writable
Authors
=======
* Miki Tebeka
* Justin Kramer (glob->regexp)
* Steve Miner (http://goo.gl/st7MJ) most of "extension" code
* Bronsa (with-cwd)
Changes
=======
See here_.
.. _here: https://bitbucket.org/tebeka/fs/src/tip/ChangeLog
License
=======
Copyright (C) 2010,2011 Miki Tebeka
Distributed under the Eclipse Public License, the same as Clojure.