Skip to content

Commit

Permalink
feat: update version to 0.7.0 and add sepuku() function for package c…
Browse files Browse the repository at this point in the history
…leanup
  • Loading branch information
statnmap committed Jan 14, 2025
1 parent 145ae38 commit 3947e0d
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 22 deletions.
12 changes: 7 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Package: fusen
Title: Build a Package from Rmarkdown Files
Version: 0.6.0.9005
Version: 0.7.0
Authors@R: c(
person("Sebastien", "Rochette", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-1565-9313")),
person("Yohann", "Mansiaux", , "[email protected]", role = "aut"),
person("Sebastien", "Rochette", , "[email protected]", role = "aut",
comment = c(ORCID = "0000-0002-1565-9313", "creator")),
person("Vincent", "Guyader", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-0671-9270")),
person("Yohann", "Mansiaux", , "[email protected]", role = "aut"),
person("ThinkR", role = "cph")
)
Description: Use Rmarkdown First method to build your package. Start your
Expand Down Expand Up @@ -50,7 +52,7 @@ Suggests:
withr
VignetteBuilder:
knitr
Config/fusen/version: 0.6.0.9004
Config/fusen/version: 0.7.0
Config/testthat/edition: 3
Config/testthat/parallel: false
Encoding: UTF-8
Expand Down
15 changes: 6 additions & 9 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
# fusen (development version 0.6.0.9003)
# fusen 0.7.0

## New features

- Adding `sepuku()`, allowing to remove all traces of a fusen-related files and tags in the package (#257 #258 #259) @ymansiaux
- `inflate` and `inflate_all()` proposes to compute the package code coverage using `covr::package_coverage()` using the `codecov` parameter (default is FALSE)

# fusen (development version 0.6.0.9002)

## New features

- RStudio Addin "Fusen : Add fusen chunks" as well as `fusen::add_fusen_chunks()` add a development chunk in complement to the "function", "example" and "test" chunks already provided (#255) @ymansiaux

## Minor changes

# fusen (development version 0.6.0.9001)
- Add `# nolint: line_length_linter` in created files to avoid line length linter warnings (#278) @LBeaulaton

## New features
## Bug fixes

- Adding `sepuku()`, allowing to remove all traces of a fusen-related files and tags in the package (#257 #258 #259) @ymansiaux
- Fix `grep()` calls in unit tests (#271) @statnmap

# fusen 0.6.0

Expand Down
3 changes: 2 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ _Note that the `"flat*.Rmd"` files created with templates `full` and `teaching`
There is a dedicated vignette to answer this: https://thinkr-open.github.io/fusen/articles/Maintain-packages-with-fusen.html

- **Option 1**: After a first inflate of your flat file, you can continue developing in the "flat_template.Rmd" file, and then inflate it using `fusen::inflate_all()`
- **Option 2**: After you're done with inflating, you can decide to deprecate your flat file with `fusen::deprecate_flat_file()` and develop in the package files directly, as for any other R package. 'fusen' has no impact on the structure of a classical package once inflated.
- **Option 2**: After you're done with inflating, you can decide to deprecate your flat file with `fusen::deprecate_flat_file()` and develop in the package files directly, as for any other R package. 'fusen' has no impact on the structure of a classical package once inflated. You can even use `sepuku()` to remove all traces of 'fusen'.

> Advice: Use git as soon as possible, this will avoid losing your work if you made some modifications in the wrong place
Expand Down Expand Up @@ -175,6 +175,7 @@ Write them all in the same file while you explore the possibilities and let {fus
- Can I inflate a Quarto qmd file?
- Can I use {fusen} with {golem}?
- How can I know if R files were created from a flat or not ?
- How can I get rid of everything related to 'fusen' in my package ?

=> See vignette Tips and Tricks: https://thinkr-open.github.io/fusen/articles/tips-and-tricks.html

Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

<!-- badges: start -->

[![fusen status
Expand Down Expand Up @@ -174,7 +173,7 @@ There is a dedicated vignette to answer this:
deprecate your flat file with `fusen::deprecate_flat_file()` and
develop in the package files directly, as for any other R package.
‘fusen’ has no impact on the structure of a classical package once
inflated.
inflated. You can even use `sepuku()` to remove all traces of ‘fusen’.

> Advice: Use git as soon as possible, this will avoid losing your work
> if you made some modifications in the wrong place
Expand Down Expand Up @@ -233,6 +232,7 @@ place.
- Can I inflate a Quarto qmd file?
- Can I use {fusen} with {golem}?
- How can I know if R files were created from a flat or not ?
- How can I get rid of everything related to ‘fusen’ in my package ?

=\> See vignette Tips and Tricks:
<https://thinkr-open.github.io/fusen/articles/tips-and-tricks.html>
Expand All @@ -250,12 +250,9 @@ in a specific way so that at the end, you can magically `inflate()` it
to let a nice package appear.

<details>

<summary>

Click here to fold your {fusen}…
</summary>

<img src="man/figures/fusen-fold-origami.gif" />
</details>

Expand Down
5 changes: 3 additions & 2 deletions man/fusen-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions vignettes/tips-and-tricks.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -425,3 +425,7 @@ Although default {golem} "dev/" files already contain the main actions to mainta

You can draw the structure of your package with `fusen:::draw_package_structure().
Read vignette "Draw a tree of your package files and functions"" for more details.

# How can I get rid of everything related to 'fusen' in my package ?

You can use `sepuku()` to remove all the flat files, the fusen tags in the R files and the fusen configuration file. Hence, you will get a project that looks like any other R package.

0 comments on commit 3947e0d

Please sign in to comment.