From b4033f6d1b691ad451634baed9466865311ac18b Mon Sep 17 00:00:00 2001 From: olivroy <52606734+olivroy@users.noreply.github.com> Date: Tue, 22 Oct 2024 17:52:47 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20olivroy/?= =?UTF-8?q?reuseme@0f3addf4788631a4bdb8947523b14f3bdfd14d5e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- LICENSE-text.html | 2 +- LICENSE.html | 2 +- index.html | 16 +++++++++++----- news/index.html | 2 +- pkgdown.yml | 2 +- reference/link_gh_issue.html | 2 +- reference/outline.html | 16 ++++++++-------- reference/rename_files2.html | 2 +- reference/solve_file_name_conflict.html | 2 +- search.json | 2 +- 10 files changed, 27 insertions(+), 21 deletions(-) diff --git a/LICENSE-text.html b/LICENSE-text.html index e41860d..d738eed 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -32,7 +32,7 @@

License

-
YEAR: 2023
+
YEAR: 2024
 COPYRIGHT HOLDER: reuseme authors
 

 
diff --git a/LICENSE.html b/LICENSE.html
index 14c84a7..d426ed2 100644
--- a/LICENSE.html
+++ b/LICENSE.html
@@ -34,7 +34,7 @@ 
MIT License

 
 

 
-
Copyright (c) 2023 reuseme authors

+
Copyright (c) 2024 reuseme authors

 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

 
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

 
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

diff --git a/index.html b/index.html
index 4479364..e8c5166 100644
--- a/index.html
+++ b/index.html
@@ -55,12 +55,14 @@
 

 
Installation
 

-
You can install the development version of reuseme like so:

+
You can install reuseme like so:

 
-# R-universe
+# Cran
+install.package("reuseme")
+# R-universe (dev)
 install.packages('reuseme', repos = c('https://olivroy.r-universe.dev', 'https://cloud.r-project.org'))
 
-# From GitHub
+# From GitHub (dev)
 pak::pak("olivroy/reuseme")

 

 

@@ -203,7 +205,7 @@ 
Outline speed#> # A tibble: 1 × 6
 #>   expression                     min   median `itr/sec` mem_alloc `gc/sec`
 #>   <bch:expr>                <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
-#> 1 outline <- proj_outline()    453ms    459ms      2.18    22.5MB     4.36
+#> 1 outline <- proj_outline() 757ms 757ms 1.32 22.1MB 2.64
Example outline

@@ -211,6 +213,8 @@

Outline speed
 outline
 #> 
+#> ── `cran-comments.md`  R CMD check results
+#> 
 #> ── `inst/example-file/outline-script.R`  Example for `file_outline()`
 #> `i` Load packages
 #> `i` Wrangle + visualize data
@@ -232,10 +236,12 @@ 
Outline speed#> ── `R/files-conflicts.R`
 #> `i` TODO insert in either proj_outline, or rename_file
 #> `i` FIXME in Rbuilignore, change `^_pkgdown\.yml$` to `_pkgdown.yml` to make sure it works
+#> `i` FIXME Support _pkgdown when you want it. will likely require adjustments, not worth the effort for now.
 #> `i` TODO probably needs a `detect_genuine_path()`
 #> `i` Helpers
 #> `i` TODO Add false positive references
 #> `i` TODO fs::path and file.path should be handled differently
+#> `i` TODO refine extraction rules as needed. for now, we are ignoring.
 #> 
 #> ── `R/import-standalone-types-check.R`
 #> `i` Scalars
@@ -308,6 +314,7 @@ 
Outline speed#> `i` Write my streets
 #> `i` TODO Create a new version
 #> `i` 'R/my-file.R'
+#> `i` **A table title**
 #> `i` Section title
 #> `i` A section
 #> `i` The last section
@@ -452,7 +459,6 @@ 
Outline speed#> `i` TODO delete generated files
 #> `i` TODO [check_referenced_files] doesn't check for 'R/file.R'
 #> `i` TODO browse_pkg should open by default if no vignettes are found, because there is not much to do in the R-session.
-#> `i` TODO exclude _files from `proj_list()`
 #> `i` TODO rename_files should be less noisy about project name file
 #> `i` TODO add_to_tricks(). when detecting TRICK like complete todo, but not remove line. requires a scheme. moves the item to tricks.md at the correct place. (copy to clipboard is probably enough)
 #> `i` TODO use vapply() instead of purrr::map
diff --git a/news/index.html b/news/index.html
index 455e06c..1749233 100644
--- a/news/index.html
+++ b/news/index.html
@@ -38,7 +38,7 @@ 
Breaking change

 
  • To facilitate piping, path / proj is now the first argument of proj_outline(), file_outline(), and dir_outline().
    • 
 
  • If you previously relied on specifying pattern without naming it, you will have to get used to the opposite. Naming pattern, but not path.
    • 
-
  • Removed work_only argument from file_outline(), use pattern = "WORK" to acheive the same result.
    • 
+
  • Removed work_only argument from file_outline(), use pattern = "WORK" to achieve the same result.
    • 
 
  • In proj_outline(), proj has been renamed path, but still accepts a project name, that will passed on to proj_list()
    • 
 
  • Removed dir_common from file_outline() (#35)
    • 
 
  • file_outline() result is now a simpler data frame. The cli links are now created in the print method. (which makes more sense for truncation)
    • 
diff --git a/pkgdown.yml b/pkgdown.yml
index f1247e8..4da3ac6 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.1.11
 pkgdown: 2.1.1
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-10-10T12:49Z
+last_built: 2024-10-22T17:52Z
 urls:
   reference: https://olivroy.github.io/reuseme/reference
   article: https://olivroy.github.io/reuseme/articles
diff --git a/reference/link_gh_issue.html b/reference/link_gh_issue.html
index 5c4b112..e034c55 100644
--- a/reference/link_gh_issue.html
+++ b/reference/link_gh_issue.html
@@ -64,7 +64,7 @@ 
    Value
    
     
    Details
    
     
    Note: doesn't (yet) support without /
    
-
    Basically trransform repo/org#xx -> repo/org#xx.
    
+
    Basically transform repo/org#xx -> [repo/org#xx](https://github.com/repo/org/issues/xx).
    
 
    Afterwards, we use markup_href() to create a cli link
    
     
     
    
diff --git a/reference/outline.html b/reference/outline.html
index 42cf4a7..eea923d 100644
--- a/reference/outline.html
+++ b/reference/outline.html
@@ -8,8 +8,8 @@
 TODO items
 Parse cli hyperlinks
 Plot or table titles
-FIgures caption in Quarto documents (limited support for multiline caption currently)
-test names
+Figures caption in Quarto documents (limited support for multiline caption currently)
+Test names
 Indicator of recent modification
 Colored output for
 URL and gh issue detection and link creation.
@@ -29,8 +29,8 @@
 TODO items
 Parse cli hyperlinks
 Plot or table titles
-FIgures caption in Quarto documents (limited support for multiline caption currently)
-test names
+Figures caption in Quarto documents (limited support for multiline caption currently)
+Test names
 Indicator of recent modification
 Colored output for
 URL and gh issue detection and link creation.
@@ -84,8 +84,8 @@ 
    Print interactive outline of file sections
    
 
  • TODO items
    • 
 
  • Parse cli hyperlinks
    • 
 
  • Plot or table titles
    • 
-
  • FIgures caption in Quarto documents (limited support for multiline caption currently)
    • 
-
  • test names
    • 
+
  • Figures caption in Quarto documents (limited support for multiline caption currently)
    • 
+
  • Test names
    • 
 
  • Indicator of recent modification
    • 
 
  • Colored output for
    • 
 
  • URL and gh issue detection and link creation.
    • 
@@ -170,7 +170,7 @@ 
    Value
    Details

     
proj_outline() and dir_outline() are wrapper of file_outline().

 
In proj_outline(), path accepts project names, see proj_list() for how to
-set up reuseme to regognize your projects' locations.

+set up reuseme to recognize your projects' locations.

 
The parser is very opinionated and is not very robust as it is based on regexps.
 For a better file parser, explore other options, like lightparser for Quarto,  {roxygen2}

 
Will show TODO items and will offer a link to mark them as complete.

@@ -188,7 +188,7 @@ 
Examples#> `i` Load packages
 #> `i` Wrangle + visualize data
 #> `i` A great title
-#> `i` TODO improve this Viz!
+#> `i` TODO improve this Vizual!
 
 # Remove todo items
 file_outline(file, print_todo = FALSE, alpha = TRUE)
diff --git a/reference/rename_files2.html b/reference/rename_files2.html
index 87bfae6..ac01758 100644
--- a/reference/rename_files2.html
+++ b/reference/rename_files2.html
@@ -63,7 +63,7 @@ 
Argumentsold, new
-
Old and new file names (with or without extensions).

+
Old and new file names (with or without .R extensions).

 
 
 
warn_conflicts

diff --git a/reference/solve_file_name_conflict.html b/reference/solve_file_name_conflict.html
index 8966fc8..487b8e6 100644
--- a/reference/solve_file_name_conflict.html
+++ b/reference/solve_file_name_conflict.html
@@ -80,7 +80,7 @@ 
Arguments
     
Value

     
Mostly called for its side-effects, but will return the number of matches
-(0 if no referenced files are problmatic)

+(0 if no referenced files are problematic)