565694 - Add mkpath and rmdir to jetpack-core/file

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect, P1)

Description

[Drew Willcoxon :adw]

Attachment: patch

Simple storage needs to create and remove directories.  file.mkdir() creates a directory, creating subdirectories first if needed, and rmdir() removes an empty directory.  (Simple storage also needs to access the profile directory.  I almost added file.profileDir() to this patch, but maybe we should give more thought to exposing the directory service in its entirety?)

Comment 1

[Atul Varma [:atul]]

Comment on attachment 445135 [details] [diff] [review]
patch

>diff --git a/packages/jetpack-core/docs/file.md b/packages/jetpack-core/docs/file.md
>+<code>file.**mkdir**(*path*)</code>
>+
>+Makes a new directory named by the given path.  Any subdirectories that do not
>+exist are also created.  `mkdir` can be called multiple times on the same path.
>+

I'm wondering if we actually want to call this mkpath() instead of mkdir(), simply because the convention of functions/commands called mkdir() is to *not* create subdirectories that don't exist. Perl and Python both have functions called mkpath() that does create intermediate subdirectories... Either way, not really a big deal, you can ignore this suggestion if you like. It would probably be weird to have a file.mkpath() and file.rmdir(), but no file.mkdir() or file.rmpath(), I suppose.

Other than that, this looks great!

Comment 2

[Drew Willcoxon :adw]

Attachment: patch v2

Thanks Atul, good idea.  This patch renames mkdir to mkpath.  I've left rmdir alone for now.  If a rmpath would come in handy later, we can add it.

Comment 3

[Drew Willcoxon :adw]

http://hg.mozilla.org/labs/jetpack-sdk/rev/f20786cab0d5

Comment 4

[Myk Melez [:myk] [@mykmelez]]

The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".