Skip to content

Latest commit

 

History

History
132 lines (114 loc) · 5.69 KB

use_standalone.md

File metadata and controls

132 lines (114 loc) · 5.69 KB

standalone_header() works with various inputs

Code
  standalone_header("OWNER/REPO", "R/standalone-foo.R")
Output
  [1] "# Standalone file: do not edit by hand"                                  
  [2] "# Source: https://github.com/OWNER/REPO/blob/HEAD/R/standalone-foo.R"    
  [3] "# Generated by: usethis::use_standalone(\"OWNER/REPO\", \"foo\")"        
  [4] "# ----------------------------------------------------------------------"
  [5] "#"                                                                       

Code
  standalone_header("OWNER/REPO", "R/standalone-foo.R", ref = "blah")
Output
  [1] "# Standalone file: do not edit by hand"                                          
  [2] "# Source: https://github.com/OWNER/REPO/blob/blah/R/standalone-foo.R"            
  [3] "# Generated by: usethis::use_standalone(\"OWNER/REPO\", \"foo\", ref = \"blah\")"
  [4] "# ----------------------------------------------------------------------"        
  [5] "#"                                                                               

Code
  standalone_header("OWNER/REPO", "R/standalone-foo.R", host = "https://github.com")
Output
  [1] "# Standalone file: do not edit by hand"                                  
  [2] "# Source: https://github.com/OWNER/REPO/blob/HEAD/R/standalone-foo.R"    
  [3] "# Generated by: usethis::use_standalone(\"OWNER/REPO\", \"foo\")"        
  [4] "# ----------------------------------------------------------------------"
  [5] "#"                                                                       

Code
  standalone_header("OWNER/REPO", "R/standalone-foo.R", host = "https://github.acme.com")
Output
  [1] "# Standalone file: do not edit by hand"                                                              
  [2] "# Source: https://github.acme.com/OWNER/REPO/blob/HEAD/R/standalone-foo.R"                           
  [3] "# Generated by: usethis::use_standalone(\"OWNER/REPO\", \"foo\", host = \"https://github.acme.com\")"
  [4] "# ----------------------------------------------------------------------"                            
  [5] "#"                                                                                                   

Code
  standalone_header("OWNER/REPO", "R/standalone-foo.R", ref = "blah", host = "https://github.com")
Output
  [1] "# Standalone file: do not edit by hand"                                          
  [2] "# Source: https://github.com/OWNER/REPO/blob/blah/R/standalone-foo.R"            
  [3] "# Generated by: usethis::use_standalone(\"OWNER/REPO\", \"foo\", ref = \"blah\")"
  [4] "# ----------------------------------------------------------------------"        
  [5] "#"                                                                               

Code
  standalone_header("OWNER/REPO", "R/standalone-foo.R", ref = "blah", host = "https://github.acme.com")
Output
  [1] "# Standalone file: do not edit by hand"                                                                              
  [2] "# Source: https://github.acme.com/OWNER/REPO/blob/blah/R/standalone-foo.R"                                           
  [3] "# Generated by: usethis::use_standalone(\"OWNER/REPO\", \"foo\", ref = \"blah\", host = \"https://github.acme.com\")"
  [4] "# ----------------------------------------------------------------------"                                            
  [5] "#"

can offer choices

Code
  standalone_choose("tidyverse/forcats", ref = "v1.0.0")
Condition
  Error:
  ! No standalone files found in tidyverse/forcats.
Code
  standalone_choose("r-lib/rlang", ref = "4670cb233ecc8d11")
Condition
  Error:
  ! `file` is absent, but must be supplied.
  i Possible options are cli, downstream-deps, lazyeval, lifecycle, linked-version, obj-type, purrr, rlang, s3-register, sizes, types-check, vctrs, or zeallot.

can extract imports/suggests

Code
  extract_pkgs("# imports: rlang (== 1.0.0)", "imports")
Condition
  Error in `extract_pkgs()`:
  ! Version specification must use `>=`.
Code
  extract_pkgs("# suggests: rlang (== 1.0.0)", "suggests")
Output
  # A data frame: 1 x 3
    pkg   cmp   ver  
    <chr> <chr> <chr>
  1 rlang ==    1.0.0
Code
  extract_pkgs("# imports: rlang (>= 1.0.0), purrr", "imports")
Condition
  Error in `extract_pkgs()`:
  ! Version field can't contain comma.
  i Do you need to wrap in a list?
Code
  extract_pkgs("# suggests: rlang (>= 1.0.0), purrr", "suggests")
Condition
  Error in `extract_pkgs()`:
  ! Version field can't contain comma.
  i Do you need to wrap in a list?
Code
  extract_pkgs("# imports: foo (>=0.0.0)", "imports")
Condition
  Error in `extract_pkgs()`:
  ! Can't parse version `foo (>=0.0.0)` in `imports:` field.
  i Example of expected version format: `rlang (>= 1.0.0)`.
Code
  extract_pkgs("# suggests: foo (>=0.0.0)", "suggests")
Condition
  Error in `extract_pkgs()`:
  ! Can't parse version `foo (>=0.0.0)` in `imports:` field.
  i Example of expected version format: `rlang (>= 1.0.0)`.

errors on malformed dependencies

Code
  standalone_dependencies(c(), "test.R")
Condition
  Error:
  ! Can't find yaml metadata in 'test.R'.
Code
  standalone_dependencies(c("# ---", "# dependencies: 1", "# ---"), "test.R")
Condition
  Error:
  ! Invalid dependencies specification in 'test.R'.