npmpackage.info

Approximately 800 new packages are uploaded to the npm registry every day. This number can vary, but it reflects the active and growing nature of the JavaScript development community.

spdx-expression-parse

parse SPDX license expressions

4.0.0

MIT

JavaScript

4.30 kB

5,709,240,326

3.4

Installations

npm install spdx-expression-parse

Score

99.2

Supply Chain Risk

99.5

Quality

78.8

Maintenance

100

Vulnerability

Pull Requests

Open

4

Total

19

Closed

3

Merged

12

Issues

Open

4

Total

15

Closed

11

Contributors

View all 10 contributors

Developer

jslicense

Statistics

43 Stars

169 Commits

23 Forks

10 Watching

6 Branches

10 Contributors

Updated on 07 Sept 2024

Bundle Size

11.42 kB

Minified

4.30 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

5,709,240,326

Last day

1.2%

1,166,991

Compared to previous day

Last week

4.2%

26,260,884

Compared to previous week

Last month

-2.4%

106,007,433

Compared to previous month

Last year

9.9%

1,253,399,658

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

spdx-exceptions spdx-license-ids

Dev Dependencies

defence-cli replace-require-self standard

Versions

This package parses SPDX license expression strings describing license terms, like package.json license strings, into consistently structured ECMAScript objects. The npm command-line interface depends on this package, as do many automatic license-audit tools.

In a nutshell:

var parse = require('spdx-expression-parse')
var assert = require('assert')

assert.deepEqual(
  // Licensed under the terms of the Two-Clause BSD License.
  parse('BSD-2-Clause'),
  {license: 'BSD-2-Clause'}
)

assert.throws(function () {
  // An invalid SPDX license expression.
  // Should be `Apache-2.0`.
  parse('Apache 2')
})

assert.deepEqual(
  // Dual licensed under either:
  // - LGPL 2.1
  // - a combination of Three-Clause BSD and MIT
  parse('(LGPL-2.1 OR BSD-3-Clause AND MIT)'),
  {
    left: {license: 'LGPL-2.1'},
    conjunction: 'or',
    right: {
      left: {license: 'BSD-3-Clause'},
      conjunction: 'and',
      right: {license: 'MIT'}
    }
  }
)

The syntax comes from the Software Package Data eXchange (SPDX), a standard from the Linux Foundation for shareable data about software package license terms. SPDX aims to make sharing and auditing license data easy, especially for users of open-source software.

The bulk of the SPDX standard describes syntax and semantics of XML metadata files. This package implements two lightweight, plain-text components of that larger standard:

The license list, a mapping from specific string identifiers, like Apache-2.0, to standard form license texts and bolt-on license exceptions. The spdx-license-ids and spdx-exceptions packages implement the license list. spdx-expression-parse depends on and require()s them.

Any license identifier from the license list is a valid license expression:

var identifiers = []
  .concat(require('spdx-license-ids'))
  .concat(require('spdx-license-ids/deprecated'))
  .filter(function (id) { return id[id.length - 1] !== '+' })

identifiers.forEach(function (id) {
  assert.deepEqual(parse(id), {license: id})
})

So is any license identifier WITH a standardized license exception:

identifiers.forEach(function (id) {
  require('spdx-exceptions').forEach(function (e) {
    assert.deepEqual(
      parse(id + ' WITH ' + e),
      {license: id, exception: e}
    )
  })
})

The license expression language, for describing simple and complex license terms, like MIT for MIT-licensed and (GPL-2.0 OR Apache-2.0) for dual-licensing under GPL 2.0 and Apache 2.0. spdx-expression-parse itself implements license expression language, exporting a parser.

assert.deepEqual(
  // Licensed under a combination of:
  // - the MIT License AND
  // - a combination of:
  //   - LGPL 2.1 (or a later version) AND
  //   - Three-Clause BSD
  parse('(MIT AND (LGPL-2.1+ AND BSD-3-Clause))'),
  {
    left: {license: 'MIT'},
    conjunction: 'and',
    right: {
      left: {license: 'LGPL-2.1', plus: true},
      conjunction: 'and',
      right: {license: 'BSD-3-Clause'}
    }
  }
)

This package differs slightly from the SPDX standard in allowing lower- and mixed-case AND, OR, and WITH operators:

assert.deepEqual(
  parse('MIT or BSD-2-Clause'),
  { left: { license: 'MIT' }, conjunction: 'or', right: { license: 'BSD-2-Clause' } }
)
assert.deepEqual(
  parse('GPL-2.0 with GCC-exception-2.0'),
  { license: 'GPL-2.0', exception: 'GCC-exception-2.0' }
)

The Linux Foundation and its contributors license the SPDX standard under the terms of the Creative Commons Attribution License 3.0 Unported (SPDX: "CC-BY-3.0"). "SPDX" is a United States federally registered trademark of the Linux Foundation. The authors of this package license their work under the terms of the MIT License.

10

License

Determines if the project has defined a license.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2024-10-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to spdx-expression-parse

@types/spdx-expression-parse

3.0.5

TypeScript definitions for spdx-expression-parse