oss/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft.git synced 2026-11-02 07:26:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve struct and field comments and incorporate into json schema (#4252)

Browse Source 
* improve struct and field comments and incorporate into json schema

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

* address review feedback

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

---------

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
This commit is contained in:
Alex Goodman
2025-10-03 17:01:56 +00:00
committed by GitHub
parent b96d3d20af
commit a77d24e379
57 changed files with 4241 additions and 1676 deletions
Download Patch File Download Diff File Expand all files Collapse all files
syft/pkg/r.go
+40 -19
View File
@@ -1,23 +1,44 @@
package pkg
type RDescription struct {
/*
Fields chosen by:
docker run --rm -it rocker/r-ver bash
$ install2.r ggplot2 # has a lot of dependencies
$ find /usr/local/lib/R -name DESCRIPTION | xargs cat | grep -v '^\s' | cut -d ':' -f 1 | sort | uniq -c | sort -nr
// Fields chosen by:
// docker run --rm -it rocker/r-ver bash
// $ install2.r ggplot2 # has a lot of dependencies
// $ find /usr/local/lib/R -name DESCRIPTION | xargs cat | grep -v '^\s' | cut -d ':' -f 1 | sort | uniq -c | sort -nr
//
// For more information on the DESCRIPTION file see https://r-pkgs.org/description.html
For more information on the DESCRIPTION file see https://r-pkgs.org/description.html
*/
Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"`
Author string `json:"author,omitempty"`
Maintainer string `json:"maintainer,omitempty"`
URL []string `json:"url,omitempty"`
Repository string `json:"repository,omitempty"`
Built string `json:"built,omitempty"`
NeedsCompilation bool `json:"needsCompilation,omitempty"`
Imports []string `json:"imports,omitempty"`
Depends []string `json:"depends,omitempty"`
Suggests []string `json:"suggests,omitempty"`
// RDescription represents metadata from an R package DESCRIPTION file containing package information, dependencies, and author details.
type RDescription struct {
// Title is short one-line package title
Title string `json:"title,omitempty"`
// Description is detailed package description
Description string `json:"description,omitempty"`
// Author is package author(s)
Author string `json:"author,omitempty"`
// Maintainer is current package maintainer
Maintainer string `json:"maintainer,omitempty"`
// URL is the list of related URLs
URL []string `json:"url,omitempty"`
// Repository is CRAN or other repository name
Repository string `json:"repository,omitempty"`
// Built is R version and platform this was built with
Built string `json:"built,omitempty"`
// NeedsCompilation is whether this package requires compilation
NeedsCompilation bool `json:"needsCompilation,omitempty"`
// Imports are the packages imported in the NAMESPACE
Imports []string `json:"imports,omitempty"`
// Depends are the packages this package depends on
Depends []string `json:"depends,omitempty"`
// Suggests are the optional packages that extend functionality
Suggests []string `json:"suggests,omitempty"`
}