Skip to content

[Roadmap ‐ v0.6]

Jump to bottom
Sébastien Rochette edited this page May 7, 2024 · 7 revisions

✅ Remove {parsermd} dependency before it is removed from CRAN

See "dev/dev_history_parse.Rmd"

  • ⚠️ May be mandatory

✅ Clean the project

As a dev, I'd like to know if there are files in my R, tests, vignettes directories, that are not linked to any flat files, and were not defined by the developers to be kept ("keep" field in "config_fusen.yml") => check_not_registered_files() As a dev, I'd like a function to delete all files listed by previous function.

=> See clean_obsolete_files() issue #24

  • verify if flat files still exist
  • verify if all listed files still exist
  • lists all files that will be cleaned and ask
  • recommend to commit before clean
  • cleans all files listed after yes
  • Verify that all files listed in config_file still exist

=> There is no need to verify if functions are still there or not, because everything happens at the scale of the filename

✅ Clean package during inflate() function:

As a dev, I would like inflate() to delete previous R, test or vignettes files if they are not produced anymore by the flat file. For instance, in case I change the name of a main function or I delete one of them, or I decide I do not want to output a vignette.

  • updates the part dedicated to the corresponding flat file with all files created.

  • List filenames (from this specific flat file) that are removed during this update, verify if they still exists

  • Inflate proposes to delete the obsolete files detected

✅ Allow to deprecate a flat_file:

=> deprecate_flat_file()

  • Move it to "dev/flat_history/flat_..."
  • Change the path of this file in the config file
  •  Change status in the config file to "deprecated"
  • Clean the "do not edit by hand" => "Originally created from dev/dev_history/flat_..."
  • Add "do not edit by hand" and "do not inflate" in the flat file, and comment the complete "inflate" chunk.

✅ Allow to rename a flat file properly

  • Change the path of this file in the config file
  • Change names in the flat file itself
  • Change names in the inflated files

✅ visual representation of the structure of my package

Others

Clone this wiki locally