Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

24 rebase3 clean yourself #182

Merged
merged 25 commits into from
Jan 4, 2023
Merged

24 rebase3 clean yourself #182

merged 25 commits into from
Jan 4, 2023

Conversation

statnmap
Copy link
Collaborator

@statnmap statnmap commented Dec 21, 2022

Ongoing feature creation.

Continue from #169 after update with "main"

  • Retrieve file path created during inflate
  • Start to store in a yaml file
  • Register all previous files
  • Define df_to_config() to only bother about: path, R, tests and vignettes options in the config_fusen.yaml, to allow extra information to be stored, like state. And change all existing unit tests accordingly ?
    • Did not find any problem with this function today...
    • But created a new one: see tests on register_all_to_config() with a browser()
  • Transform inflate() to fill config_fusen.yaml file
  • Clean a directory of old files

Issue #24

Tags: feat, doc, test

Ongoing feature creation.

- Retrieve file path created during inflate
- Start to store in a yaml file

Issue #24
Tags: feat, test, doc

Why?

- Quarto qmd files are rendered with knitr and can be parsed with {parsermd}, so why not?

What?

- Allow to inflate a qmd file

Issue
issue #160
Tags: feat, doc, test

Why?

- To create a config file for already existing {fusen}, we need not to detect files that should not be deleted

What?

WIP:

- List all files and try to guess origin
- Show the user all files not registered and allow them to manually clean

issue #24
Tags: feat, test, doc

Why?

- Need to migrate package to the new config file management

What?

- Allow `df_to_config()` to run on the output of `check_not_registered_files()`

Issue #24
Tags: feat, test

Why ?

- inflate a function having two chunks of example duplicated the roxygen skeleton for that function

What?

- Multiple example chunks are now combined before being included in the function roxygen example

Fix issue #149
Tags: fix, tests

Why?

- config file needs to be shareable between devs

What?

- Be sure to transform all paths to relative when possible
Tags: fix, tests

Why?

- Missing License in a DESCRIPTION is now a note, and not a Warning anymore

What?

- Add License during test to avoid version mismatch
tags: feat, test, doc

Why?

- Users would want to use the new config file in the new fusen version, without having to write it themselves if coming from older version or classical package

What?

- Add `register_all_to_config()`

Issue #24
tags: doc

Why?

- Function is done, it can be inflated in the package

What?

- Just inflate

issue #24
tags: doc
tags: test

Why?

- {roxygen2} now returns warnings if the roxygen skeleton is malformed

What?

- Fix for missing title
- Add {attachment} as remotes while it is out of CRAN
tags: fix, doc, test

Why?

- All examples need to run properly

What?

- UPdate flat file for clean_fusen_files
- Update documentation to explain how it will work
- fix tests and examples

Issue #24
tags: fix, test

Why?

- Full path for MacOS changes on CI

What?

- Test only relative paths
tags: fix, test, doc

Why?

- `data.frame()` and `read.csv()` read string as factors in old R versions, preventing them to be used as file path

What?

- Added stringAsFactors = FALSE everywhere needed

issue #24
tags: fix, test

Why?

- Windows slash and path expand is different from other OS

What?

- Try to keep relative paths everywhere
tags: feat, doc, test

Why?

- More info needs to be stored in the config_fusen.yaml file.

What?

- Allow test to be ok with extra information
- TODO: define 'df_to_config()' to only bother about path, R, tests, vignette

issue #24
Keep both version when conflicts

Issue #24

Merge branch '24-rebase2-clean-yourself' into 24-rebase3-clean-yourself

# Conflicts:
#	R/inflate.R
#	tests/testthat/test-inflate-part2.R
tags: test

Why?

- Verify that registering half of the files coming from a common flat file works

What?

- wip: a test fails. Need to define if `register_all_to_config()` or `df_to_config()` need to account for existing files in the config
@statnmap statnmap mentioned this pull request Dec 21, 2022
6 tasks
tags: fix, feat, test, doc

Why?

- We may want to register some files after some manual modifications

issue #24
tags: chore, feat, test, doc

Why?

- It is time to integrate the new feature to the mainstream.
- The sets a major step towards the cleaning functions to be coming soon (#24)

What?

- Bump version but keep it as a .9000 to avoid updating vignettes in the pkgdown file
- Change path in "do not edit by hand" for a relative path that do not start with "/"

issue #24
tags: fix, test

Why?

- Unit test was failing with interactive
tags: chore

Why?

- Style package to keep it homogeneous
tags: chore, ci

Why?

- Actions for check is out-of-date
tags: test

Why?

- Testing "push on GitHub" with flat teaching template is strategic
@statnmap statnmap merged commit 2cb4b48 into main Jan 4, 2023
@statnmap statnmap deleted the 24-rebase3-clean-yourself branch January 4, 2023 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant