@stencila/dockta

Execute the given regex against the line and return the first match. If there is no match, return null.

Builds a Docker image from a nixDockerfile

Convert a list of classifiers to a Map between main classification and sub classification(s). e.g: ['A :: B', 'A :: C', 'D :: E'] => {'A': ['B', 'C'], 'D': ['E']}

Generates a default.nix and a nixDockerfile for a SoftwareEnvironment

Print an error to stderr

Executes nix-shell inside a Docker image from nixDockerfile with a Docker data volume for /nix store

Execute the REQUIREMENTS_EDITABLE_SOURCE_REGEX against a line and return the first result (or null if no match). This is used to find a requirements.txt line of a URL source (e.g. including a package from github).

Execute the REQUIREMENTS_INCLUDE_PATH_REGEX against a line and return the first result (or null if no match). This is used to find a requirements.txt line that includes another requirements file.

Execute the REQUIREMENTS_STANDARD_REGEX against a line and return the first result (or null if no match). This is used to find "standard" requirements.txt lines.

Specify the [folder] argument settings

Return true if the passed in line is a requirements.txt comment (starts with "#" which might be preceded by spaces).

Log an error to logga

Print output to stdout

Convert a string containing an operating system name into an array of OperatingSystems. In some instances the description may map to multiple OperatingSystems, e.g. "Unix" => Linux and macOS.

Parse an array of PyPI formatted topics into unique lists, returns a tuple of top level and optionally second level topics. This is because PyPI will repeat top level Topics in sub topics, e.g. the list might contain: ["Topic :: Game", "Topic :: Game :: Arcade"] hence "Game" is defined twice.

Run a method of DockerCompiler

Split a requirement line into name and then version. For example "package==1.0.1" => ["package", "==1.0.1"] The version specifier can be ==, <=, >=, ~=, < or >.

Each PyPI "Topic" might contain multiple levels of categorisation separated by "::". E.g. "Topic :: Category :: Secondary Category :: Tertiary Category". This will split into an array of strings of the same length as the number of categories, i.e. ["Category", "Secondary Category", "Tertiary Category"]

Convert an object to a string (maybe to go to stdout or back over HTTP)

Parses a value and converts it to a Map (recursively) if it is a plain JavaScript object, otherwise just return the value

Compare semantic version numbers

List the people your project depends upon.