FilesExpand file tree

main

/

spdx.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

66 lines (59 loc) · 1.88 KB

main

/

spdx.ts

Copy path

Top

File metadata and controls

• Code
• Blame

66 lines (59 loc) · 1.88 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

import * as spdxlib from '@onebeyond/spdx-license-satisfies'

import spdxSatisfies from 'spdx-satisfies'

import parse from 'spdx-expression-parse'

/*

* NOTE: spdx-license-satisfies methods depend on spdx-expression-parse

* which throws errors in the presence of any syntax trouble, unknown

* license tokens, case sensitivity problems etc. to simplify handling

* you should pre-screen inputs to the satisfies* methods using isValid

*/

// accepts a pair of well-formed SPDX expressions. the

// candidate is tested against the constraint

export function satisfies(candidateExpr: string, allowList: string[]): boolean {

candidateExpr = cleanInvalidSPDX(candidateExpr)

try {

return spdxSatisfies(candidateExpr, allowList)

} catch {

return false

}

}

// accepts an SPDX expression and a non-empty list of licenses (not expressions)

export function satisfiesAny(

candidateExpr: string,

licenses: string[]

): boolean {

candidateExpr = cleanInvalidSPDX(candidateExpr)

try {

return spdxlib.satisfiesAny(candidateExpr, licenses)

} catch {

return false

}

}

// accepts an SPDX expression and a non-empty list of licenses (not expressions)

export function satisfiesAll(

candidateExpr: string,

licenses: string[]

): boolean {

candidateExpr = cleanInvalidSPDX(candidateExpr)

try {

return spdxlib.satisfiesAll(candidateExpr, licenses)

} catch {

return false

}

}

// accepts any SPDX expression

export function isValid(spdxExpr: string): boolean {

spdxExpr = cleanInvalidSPDX(spdxExpr)

try {

parse(spdxExpr)

return true

} catch {

return false

}

}

const replaceOtherRegex = /(?<![\w-])OTHER(?![\w-])/g

// adjusts license expressions to not include the invalid `OTHER`

// which ClearlyDefined adds to license strings

export function cleanInvalidSPDX(spdxExpr: string): string {

return spdxExpr.replace(replaceOtherRegex, 'LicenseRef-clearlydefined-OTHER')

}