R/notes_management.R

In vgherard/scribblr: A Notepad Inside RStudio

# scribblr
# Copyright (C) 2021  Valerio Gherardi
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

#' @title Delete a \code{scribblr} note
#'
#' @author Valerio Gherardi
#'
#' @description Delete a \code{scribblr} note.
#' @param note a length one character (not NA). Note to be deleted.
#' @return returns \code{NULL}, invisibly. Used for side-effects.
#' @examples
#' \dontrun{
#' scribblr_delete("todo")
#' }
#' @seealso \link{scribble}
#' @export
scribblr_delete <- function(note) {
	path <- scribblr_note_path(note)

	if (!file.exists(path)) {
		warn_missing_note()
		return(invisible(NULL))
	}

	# Warn about erasing notes
	cat("This operation will erase your {scribblr} note and cannot be undone.")
	if (ask_yesno_qn("Do you want to proceed?"))
		fs::dir_delete(dirname(path))

	return(invisible(NULL))
}

#' @title List \code{scribblr} notes
#'
#' @author Valerio Gherardi
#'
#' @description List all \code{scribblr} notes.
#' @return a character vector.
#' @examples
#' \dontrun{
#' scribblr_list("todo")
#' }
#' @seealso \link{scribble}
#' @export
scribblr_list <- function() {
	if (!dir.exists(scribblr_dir())) {
		warn_missing_scribblr_dir()
		return(character())
	}

	path <- file.path(scribblr_dir(), "notes")

	basename(fs::dir_ls(path, type = "directory"))
}