tools-golang – github.com/spdx/tools-golang Directories

tools-golang/ directory

Directories

PathSynopsis
builderPackage builder is used to create tools-golang data structures for a given directory path's contents, with hashes, etc.
convert
examples
examples/10-jsonloaderThis example demonstrates loading an SPDX JSON document from disk into memory, and then logging some attributes to the console.
examples/11-yamltotv
examples/12-tvtoyamlThis example demonstrates loading an SPDX tag-value file from disk into memory, and re-saving it to a different json file on disk.
examples/13-yamlloaderThis example demonstrates loading an SPDX YAML document from disk into memory, and then logging some attributes to the console.
examples/1-load
examples/2-load-save
examples/3-build
examples/4-search
examples/5-reportThis example demonstrates loading an SPDX tag-value file from disk into memory, generating a basic report listing counts of the concluded licenses for its files, and printing the report to standard output.
examples/6-licensediffThis example demonstrates loading two SPDX tag-value files from disk into memory, and generating a diff of the concluded licenses for Files in Packages with matching IDs in each document.
examples/7-rdfloaderSPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later Run project: go run exampleRDFLoader.go ../sample-docs/rdf/SPDXRdfExample-v2.2.spdx.rdf
examples/8-jsontotvThis example demonstrates loading an SPDX json from disk into memory, and then re-saving it to a different file on disk in tag-value format .
examples/9-tvtojsonThis example demonstrates loading an SPDX tag-value file from disk into memory, and re-saving it to a different json file on disk.
idsearcherPackage idsearcher is used to search for short-form IDs in files within a directory, and to build an SPDX Document containing those license findings.
json
licensediffPackage licensediff is used to generate a "diff" between the concluded licenses in two SPDX Packages, using the filename as the match point.
rdf
reporterPackage reporter contains functions to generate a basic license count report from an in-memory SPDX Package section whose Files have been analyzed.
spdxPackage spdx contains references to the latest spdx version
spdx/common
spdxlibPackage spdxlib contains convenience and utility functions for working with an SPDX document that has already been created in memory.
spdx/v2
spdx/v2/common
spdx/v2/v2_1Package spdx contains the struct definition for an SPDX Document and its constituent parts.
spdx/v2/v2_1/tagvalue
spdx/v2/v2_1/tagvalue/readerPackage parser2v1 contains functions to read, load and parse SPDX tag-value files.
spdx/v2/v2_1/tagvalue/writerPackage saver2v1 contains functions to render and write a tag-value formatted version of an in-memory SPDX document and its sections (version 2.1).
spdx/v2/v2_2Package spdx contains the struct definition for an SPDX Document and its constituent parts.
spdx/v2/v2_2/example
spdx/v2/v2_2/json
spdx/v2/v2_2/rdf
spdx/v2/v2_2/rdf/readerSPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later copied from tvloader/parser2v2/types.go
spdx/v2/v2_2/tagvalue
spdx/v2/v2_2/tagvalue/readerPackage parser2v2 contains functions to read, load and parse SPDX tag-value files, version 2.2.
spdx/v2/v2_2/tagvalue/writerPackage saver2v2 contains functions to render and write a tag-value formatted version of an in-memory SPDX document and its sections (version 2.2).
spdx/v2/v2_2/yaml
spdx/v2/v2_3Package v2_3 Package contains the struct definition for an SPDX Document and its constituent parts.
spdx/v2/v2_3/example
spdx/v2/v2_3/json
spdx/v2/v2_3/rdf
spdx/v2/v2_3/rdf/readerSPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later copied from tvloader/parser2v3/types.go
spdx/v2/v2_3/tagvalue
spdx/v2/v2_3/tagvalue/readerPackage reader contains functions to read, load and parse SPDX tag-value files.
spdx/v2/v2_3/tagvalue/writerPackage saver2v3 contains functions to render and write a tag-value formatted version of an in-memory SPDX document and its sections.
spdx/v2/v2_3/yaml
tagvaluePackage tvloader is used to load and parse SPDX tag-value documents into tools-golang data structures.
tagvalue/reader
utilsPackage utils contains various utility functions to support the main tools-golang packages.
yaml
Version
v0.5.1
Published
May 26, 2023
Platform
js/wasm
Last checked
now

Tools for package owners.