Merge pull request #261 from ThinkR-open/257-sepuku

257 sepuku

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: fusen
 Title: Build a Package from Rmarkdown Files
-Version: 0.6.0.9000
+Version: 0.6.0.9001
 Authors@R: c(
     person("Sebastien", "Rochette", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-1565-9313")),
@@ -48,7 +48,7 @@ Suggests:
     withr
 VignetteBuilder: 
     knitr
-Config/fusen/version: 0.6.0
+Config/fusen/version: 0.6.0.9000
 Config/testthat/edition: 3
 Config/testthat/parallel: false
 Encoding: UTF-8

NAMESPACE

@@ -19,11 +19,14 @@ export(inflate)
 export(inflate_all)
 export(inflate_all_no_check)
 export(init_share_on_github)
+export(list_flat_files)
 export(load_flat_functions)
 export(register_all_to_config)
 export(rename_flat_file)
+export(sepuku)
 importFrom(attachment,att_amend_desc)
 importFrom(cli,cat_rule)
+importFrom(cli,cli_abort)
 importFrom(cli,cli_alert_danger)
 importFrom(cli,cli_alert_info)
 importFrom(cli,cli_alert_success)

NEWS.md

@@ -1,4 +1,8 @@
-# fusen (development)
+# fusen (development version 0.6.0.9001)
+
+## New features
+
+- Adding `sepuku()`, allowing to remove all traces of a fusen-related files and tags in the package (#257 #258 #259) @ymansiaux
 
 # fusen 0.6.0
 
@@ -10,10 +14,10 @@
 ## New features
 
 - `draw_package_structure()` along with `get_package_structure()` allows to draw the package structure with
-all functions created in each R file, and whether they are exported (#189)
+  all functions created in each R file, and whether they are exported (#189)
 - `rename_flat_file()` allows to rename a flat file, and deals with config and inflated files
 - `deprecate_flat_file()` helps properly deprecate a flat file, modifies the config file
-and cleans the previously inflated files
+  and cleans the previously inflated files
 - `inflate()` detects functions renamed or removed and allow to clean the package repository (#24)
 - Allow `organisation` in `init_share_on_github()` to send to a GitHub organisation
 - Fix `load_flat_functions()` to work with VSCode
@@ -68,8 +72,6 @@ and cleans the previously inflated files
 - `create_fusen()` vaccinates created git project (#171)
 - Examples under function roxygen documentation are cleaned from extra spaces after empty `#'` to avoid git diff against code linters / stylers.
 
-
-
 # fusen 0.5.0
 
 ## New features
@@ -113,112 +115,111 @@ and cleans the previously inflated files
 
 ## New features
 
-* `inflate()` the current opened flat file if `flat_file` is empty (#138)
-* Add rmarkdown template for additional flat file for RStudio
-* Add wrappers around `add_flat_template()` for lazy devs: `add_additional()`, `add_full()`, `add_minimal()`
-* Show "flat_template" origin of files generated by {fusen} (@
-ALanguillaume)
-* Allow `inflate(vignette_name = c("Super title" = "01-Super Slug"))` for nice Title different from vignette Entry (#87)
-* Get the author and date from flat file to the vignette (#129)
+- `inflate()` the current opened flat file if `flat_file` is empty (#138)
+- Add rmarkdown template for additional flat file for RStudio
+- Add wrappers around `add_flat_template()` for lazy devs: `add_additional()`, `add_full()`, `add_minimal()`
+- Show "flat_template" origin of files generated by {fusen} (@
+  ALanguillaume)
+- Allow `inflate(vignette_name = c("Super title" = "01-Super Slug"))` for nice Title different from vignette Entry (#87)
+- Get the author and date from flat file to the vignette (#129)
 
 ## Bug fixes
 
-* Read DESCRIPTION file for package name when available (#144 @VincentGuyader)
-* Read `nyc_squirrels` with encoding to avoid encoding problems with `use_data()`
-* Allow flat files with `tests` only
-* Extract yaml metadata from flat file, like author or date to include in the inflated vignette
-* Simplify "flat_teaching" with a unique simple function
-* Fix `asciify_name()` to account for diacritics (@
-ALanguillaume)
-* Improve template 'full' for internal data use
-* Fix tests when git does not exists
+- Read DESCRIPTION file for package name when available (#144 @VincentGuyader)
+- Read `nyc_squirrels` with encoding to avoid encoding problems with `use_data()`
+- Allow flat files with `tests` only
+- Extract yaml metadata from flat file, like author or date to include in the inflated vignette
+- Simplify "flat_teaching" with a unique simple function
+- Fix `asciify_name()` to account for diacritics (@
+  ALanguillaume)
+- Improve template 'full' for internal data use
+- Fix tests when git does not exists
 
 # fusen 0.3.0
 
 ## Breaking changes
 
-* `add_flat_template()` superseeds `add_dev_history()` with more advanced possibilities
-* `add_dev_history()` is deprecated
-* Vignette name to create is now set with `inflate(vignette_name = "Get started")` instead of `name`
-* Flat name to inflate is now set with `inflate(flat_file = "dev/flat_full.Rmd")` instead of `rmd`
+- `add_flat_template()` superseeds `add_dev_history()` with more advanced possibilities
+- `add_dev_history()` is deprecated
+- Vignette name to create is now set with `inflate(vignette_name = "Get started")` instead of `name`
+- Flat name to inflate is now set with `inflate(flat_file = "dev/flat_full.Rmd")` instead of `rmd`
 
 ## Major changes
 
-* Check included now uses `devtools::check()` instead of `rcmdcheck()`
-* Avoid creating vignette with `inflate(vignette_name = NA)`
-* Decide whether or not to open vignette when inflate with `inflate(open_vignette = FALSE)`
-* Improve documentation included in flat templates to reflect changes in using dev_history file
-* Add RStudio Addin to insert a new flat template
-* Add RStudio Addin to insert chunks for new function (@ColinFay)
-* Deal with `\dontrun{}` in example chunks
-* Allow short names for chunks: dev, fun, ex, test
-* `create_fusen()` to create a {fusen} project from command line or with RStudio new project (@ALanguillaume)
-* Add "do not edit by hand" in files generated
+- Check included now uses `devtools::check()` instead of `rcmdcheck()`
+- Avoid creating vignette with `inflate(vignette_name = NA)`
+- Decide whether or not to open vignette when inflate with `inflate(open_vignette = FALSE)`
+- Improve documentation included in flat templates to reflect changes in using dev_history file
+- Add RStudio Addin to insert a new flat template
+- Add RStudio Addin to insert chunks for new function (@ColinFay)
+- Deal with `\dontrun{}` in example chunks
+- Allow short names for chunks: dev, fun, ex, test
+- `create_fusen()` to create a {fusen} project from command line or with RStudio new project (@ALanguillaume)
+- Add "do not edit by hand" in files generated
 
 ### Grouping functions under the same file
 
-* Group functions in same R file and test file if under same (level 1 + level 2) titles in the Rmd
-* Group functions in same R file and test file if they have the same `@rdname` roxygen tag
-* Group functions in same R file and test file if they have the same `@filename` roxygen tag (only recognized by 'fusen')
-* Group functions in same R file and test file if the function chunk get chunk option `{r function-my_func, filename = "my_filename"}`
-
+- Group functions in same R file and test file if under same (level 1 + level 2) titles in the Rmd
+- Group functions in same R file and test file if they have the same `@rdname` roxygen tag
+- Group functions in same R file and test file if they have the same `@filename` roxygen tag (only recognized by 'fusen')
+- Group functions in same R file and test file if the function chunk get chunk option `{r function-my_func, filename = "my_filename"}`
 
 ## Minor changes
 
-* `add_flat_template()` uses the `flat_name` to pre-fill the template with the first function name.
-* Fix .onLoad functions file creation
-* Allow `R6Class()` in `function` chunks
-* Fix inflate function chunks with data or package documentation only
-* Fix inflate with empty functions chunks
-* Fix filename to inflate in templates with new calls of `add_dev_history()` (@Cervangirard)
-* Default vignette name is now "Get started" creating "vignettes/get-started.Rmd"
-* All open files are saved when using `inflate()` where {RStudioapi} works
-* Ask to restart RStudio after first inflate
+- `add_flat_template()` uses the `flat_name` to pre-fill the template with the first function name.
+- Fix .onLoad functions file creation
+- Allow `R6Class()` in `function` chunks
+- Fix inflate function chunks with data or package documentation only
+- Fix inflate with empty functions chunks
+- Fix filename to inflate in templates with new calls of `add_dev_history()` (@Cervangirard)
+- Default vignette name is now "Get started" creating "vignettes/get-started.Rmd"
+- All open files are saved when using `inflate()` where {RStudioapi} works
+- Ask to restart RStudio after first inflate
 
 # fusen 0.2.4
 
-* Update vignette and tests
+- Update vignette and tests
 
 # fusen 0.2.3
 
-* Update unit tests
-* Show check outputs in console
-* Ask before overwriting everything
-* Check Description Title and description fields
-* Check if folder name is correct package name
+- Update unit tests
+- Show check outputs in console
+- Ask before overwriting everything
+- Check Description Title and description fields
+- Check if folder name is correct package name
 
 # fusen 0.2.2
 
-* Protect tests from older Pandoc versions
+- Protect tests from older Pandoc versions
 
 # fusen 0.2.1
 
-* Fix documentation issues for CRAN
-* Add templates for "dev_history.Rmd" file
-* Add more informative messages to users
-* New vignette to explain how to maintain a {fusen} package
+- Fix documentation issues for CRAN
+- Add templates for "dev_history.Rmd" file
+- Add more informative messages to users
+- New vignette to explain how to maintain a {fusen} package
 
 # fusen 0.2.0
 
-* Prepare for CRAN
+- Prepare for CRAN
 
 # fusen 0.1.1
 
 ## features
 
-* Allow non-clean vignette name
-* Allow different "dev_history" templates: "full", "minimal" and "additional"
+- Allow non-clean vignette name
+- Allow different "dev_history" templates: "full", "minimal" and "additional"
 
 ## documentation
 
-* Add vignette to explain how to maintain a package with {fusen}
-* Add vignette to explain how to deal with data
-* Added a `NEWS.md` file to track changes to the package.
+- Add vignette to explain how to maintain a package with {fusen}
+- Add vignette to explain how to deal with data
+- Added a `NEWS.md` file to track changes to the package.
 
 ## tests
 
-* Add tests for corner cases in Rmd templates
+- Add tests for corner cases in Rmd templates
 
 # fusen 0.1.0
 
-* First release
+- First release