Add installation steps of OS-specific dependencies by badouralix · Pull Request #247 · REditorSupport/languageserver

badouralix · 2020-05-03T17:00:42Z

What does this PR do ?

Embed three changes, with the dependency commands being the most important one :

Fix typos in README
Detail how to install requirements before installing languageserver package
Add table of content in README

Motivation

Second commit is here to help troubleshooting installation problems on common distros. As remote development becomes more common, installing a language server in a container should be as smooth as possible. See for instance https://code.visualstudio.com/docs/remote/containers

Third commit eases readability of the repo main page

Testing Guidelines

All tests were run inside docker images, as summarized in https://github.com/badouralix/dockerfiles/tree/master/r-languageserver

Besides missing compiling tools, namely three errors occurred with fairly easy fixes

All of them showed up when I ran the following command ( see curl, openssl and xml2 dependencies )

$ Rscript -e 'install.packages("languageserver", repos="https://cloud.r-project.org/")'
Installing package into '/usr/local/lib/R/site-library'
(as 'lib' is unspecified)
also installing the dependencies 'prettyunits', 'sys', 'pkgbuild', 'askpass', 'ps', 'lazyeval', 'remotes', 'ellipsis', 'evaluate', 'pkgload', 'praise', 'curl', 'mime', 'openssl', 'highr', 'markdown', 'stringr', 'yaml', 'Rcpp', 'fansi', 'utf8', 'vctrs', 'glue', 'R.methodsS3', 'R.oo', 'R.utils', 'lifecycle', 'pkgconfig', 'processx', 'assertthat', 'crayon', 'rprojroot', 'rex', 'cyclocomp', 'testthat', 'digest', 'rstudioapi', 'httr', 'knitr', 'htmltools', 'pillar', 'base64enc', 'backports', 'cli', 'magrittr', 'purrr', 'R.cache', 'rematch2', 'rlang', 'tibble', 'withr', 'xfun', 'callr', 'collections', 'desc', 'fs', 'jsonlite', 'lintr', 'R6', 'repr', 'stringi', 'styler', 'xml2', 'xmlparsedata'

libcurl

* installing *source* package ‘curl’ ...
** package ‘curl’ successfully unpacked and MD5 sums checked
** using staged installation
Using PKG_CFLAGS=
Using PKG_LIBS=-lcurl
------------------------- ANTICONF ERROR ---------------------------
Configuration failed because libcurl was not found. Try installing:
 * deb: libcurl4-openssl-dev (Debian, Ubuntu, etc)
 * rpm: libcurl-devel (Fedora, CentOS, RHEL)
 * csw: libcurl_dev (Solaris)
If libcurl is already installed, check that 'pkg-config' is in your
PATH and PKG_CONFIG_PATH contains a libcurl.pc file. If pkg-config
is unavailable you can set INCLUDE_DIR and LIB_DIR manually via:
R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'
--------------------------------------------------------------------
ERROR: configuration failed for package ‘curl’
* removing ‘/usr/lib/R/library/curl’

libssl

* installing *source* package 'openssl' ...
** package 'openssl' successfully unpacked and MD5 sums checked
Using PKG_CFLAGS=
------------------------- ANTICONF ERROR ---------------------------
Configuration failed because openssl was not found. Try installing:
 * deb: libssl-dev (Debian, Ubuntu, etc)
 * rpm: openssl-devel (Fedora, CentOS, RHEL)
 * csw: libssl_dev (Solaris)
 * brew: openssl@1.1 (Mac OSX)
If openssl is already installed, check that 'pkg-config' is in your
PATH and PKG_CONFIG_PATH contains a openssl.pc file. If pkg-config
is unavailable you can set INCLUDE_DIR and LIB_DIR manually via:
R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'
--------------------------------------------------------------------
ERROR: configuration failed for package 'openssl'
* removing '/usr/local/lib/R/site-library/openssl'

libxml2

* installing *source* package 'xml2' ...
** package 'xml2' successfully unpacked and MD5 sums checked
Using PKG_CFLAGS=
Using PKG_LIBS=-lxml2
------------------------- ANTICONF ERROR ---------------------------
Configuration failed because libxml-2.0 was not found. Try installing:
 * deb: libxml2-dev (Debian, Ubuntu, etc)
 * rpm: libxml2-devel (Fedora, CentOS, RHEL)
 * csw: libxml2_dev (Solaris)
If libxml-2.0 is already installed, check that 'pkg-config' is in your
PATH and PKG_CONFIG_PATH contains a libxml-2.0.pc file. If pkg-config
is unavailable you can set INCLUDE_DIR and LIB_DIR manually via:
R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'
--------------------------------------------------------------------
ERROR: configuration failed for package 'xml2'
* removing '/usr/local/lib/R/site-library/xml2'

Developed specifically to improve documentation in REditorSupport/languageserver#247

badouralix · 2020-05-03T17:14:07Z

Failing the CI while there is no actual code change 😂

trying URL 'https://cloud.r-project.org/bin/macosx/el-capitan/contrib/3.6/rlang_0.4.5.tgz'
Error in download.file(url, destfile, method, mode = "wb", ...) : 
  (converted from warning) cannot open URL 'https://cloud.r-project.org/bin/macosx/el-capitan/contrib/3.6/rlang_0.4.5.tgz': HTTP status was '404 Not Found'
Error in download.packages(pkgs, destdir = tmpd, available = available,  : 
  (converted from warning) download of package ‘rlang’ failed
Calls: <Anonymous> ... force -> i.p -> .install.macbinary -> download.packages
Execution halted

Something seems off... The package is there https://cran.r-project.org/web/packages/rlang/index.html but for R 4.0 while we fetch the package for R 3.6

https://cran.r-project.org/bin/macosx/contrib/ doesn't provide packages for R 3.6
https://cran.r-project.org/bin/macosx/el-capitan/contrib/3.6/ provides rlang_0.4.6.tgz instead of rlang_0.4.5.tgz since today

…it-dependencies

eitsupi · 2021-10-17T06:05:53Z

@randy3k @renkun-ken Is there any reason not to merge this pull request? I think #487 is related to this (Linux users get confused trying to install the languageserver package without understanding the need for library installation).

renkun-ken · 2021-10-17T06:13:22Z

Not sure why we haven't merged this.

renkun-ken

LGTM

renkun-ken · 2021-10-17T06:29:34Z

README.md

+dnf install --assumeyes --setopt=install_weak_deps=False @development-tools libcurl-devel libxml2-devel openssl-devel R
+
+# On Alpine
+apk add --no-cache curl-dev g++ gcc libxml2-dev linux-headers make R R-dev


Should we also cover macOS if the package is built from source?

Good idea ! I don't know what packages are needed on macOS, happy to add them if someone can provide them
We can also cover macOS in a subsequent pull request

On macOS, the R dependencies are most likely to be installed from pre-built binary packages. So I think we don't need to put them here at the moment.

badouralix added 2 commits May 3, 2020 18:42

Lint readme

996a8d9

Add OS-specific dependencies

aae4d44

badouralix added a commit to badouralix/dockerfiles that referenced this pull request May 3, 2020

[r-languageserver] commit for a dream

6174dcd

Developed specifically to improve documentation in REditorSupport/languageserver#247

Add table of content

a2e340c

badouralix force-pushed the badouralix/explicit-dependencies branch from ae3089d to a2e340c Compare May 9, 2020 02:08

Merge remote-tracking branch 'upstream/master' into badouralix/explic…

d32bacd

…it-dependencies

renkun-ken and others added 2 commits October 17, 2021 14:25

Merge branch 'master' into badouralix/explicit-dependencies

315a1bb

Update README.md

3309ab5

renkun-ken approved these changes Oct 17, 2021

View reviewed changes

renkun-ken reviewed Oct 17, 2021

View reviewed changes

renkun-ken merged commit 4019bab into REditorSupport:master Oct 17, 2021

shirdekel mentioned this pull request Nov 26, 2021

Failed openssl installation on Mac #499

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add installation steps of OS-specific dependencies#247

Add installation steps of OS-specific dependencies#247
renkun-ken merged 6 commits intoREditorSupport:masterfrom
badouralix:badouralix/explicit-dependencies

badouralix commented May 3, 2020 •

edited

Loading

Uh oh!

badouralix commented May 3, 2020 •

edited

Loading

Uh oh!

eitsupi commented Oct 17, 2021

Uh oh!

renkun-ken commented Oct 17, 2021

Uh oh!

renkun-ken left a comment

Uh oh!

renkun-ken Oct 17, 2021 •

edited

Loading

Uh oh!

badouralix Oct 17, 2021

Uh oh!

renkun-ken Oct 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

badouralix commented May 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do ?

Motivation

Testing Guidelines

libcurl

libssl

libxml2

Uh oh!

badouralix commented May 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eitsupi commented Oct 17, 2021

Uh oh!

renkun-ken commented Oct 17, 2021

Uh oh!

renkun-ken left a comment

Choose a reason for hiding this comment

Uh oh!

renkun-ken Oct 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

badouralix Oct 17, 2021

Choose a reason for hiding this comment

Uh oh!

renkun-ken Oct 17, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

badouralix commented May 3, 2020 •

edited

Loading

badouralix commented May 3, 2020 •

edited

Loading

renkun-ken Oct 17, 2021 •

edited

Loading