add option to make sbom reproducible & more privates & various fixes #288

jkowalleck · 2022-04-24T12:01:16Z

Added
- Environment variable BOM_REPRODUCIBLE cause resulting files to be more reproducible
  by omitting time/rand-based, and sorting lists. (via [add option to make sbom reproducible & more privates & various fixes #288])
- Method Component.compare() compares self by purl or group/name/version. (via [add option to make sbom reproducible & more privates & various fixes #288])
- Method ExternalReference.compare() compares self by type/url. (via [add option to make sbom reproducible & more privates & various fixes #288])
- Method Hash.compare() compares self by algorithm/value. (via [add option to make sbom reproducible & more privates & various fixes #288])
- JSDoc for ExternalReference, ExternalReferenceList, Hash, HashList. (via [add option to make sbom reproducible & more privates & various fixes #288])
Fixed
- ExternalReference.url is now correctly treated as mandatory. (via [add option to make sbom reproducible & more privates & various fixes #288])
- Hash.value is now correctly treated as mandatory. (via [add option to make sbom reproducible & more privates & various fixes #288])
- ExternalReferenceList.isEligibleHomepage now returns the correct result, was inverted. (via [add option to make sbom reproducible & more privates & various fixes #288])
Changed
- Private properties of ExternalReference, ExternalReferenceList, Hash, HashList
  became inaccessible. ([use private properties with # #233] via [add option to make sbom reproducible & more privates & various fixes #288])

model/HashList.js

model/Hash.js

model/ExternalReference.js

model/Hash.js

model/ExternalReference.js

model/Hash.js

model/ExternalReference.js

model/Hash.js

model/HashList.js

model/Hash.js

model/HashList.js

model/ExternalReference.js

model/HashList.js

model/ExternalReference.js

sonatype-lift · 2022-04-24T13:39:34Z

model/Hash.js

  }

  toXML () {
-    return { hash: { '@alg': this._algorithm, '#text': this._value } }
+    return { hash: { '@alg': this.#algorithm, '#text': this.#value } }


E020: Expected '}' to match '{' from line 89 and instead saw 'algorithm'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:35Z

model/Hash.js

  }

  toJSON () {
-    return { alg: this._algorithm, content: this._value }
+    return { alg: this.#algorithm, content: this.#value }


E020: Expected '}' to match '{' from line 85 and instead saw 'algorithm'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:36Z

model/HashList.js

+    const hashes = this.#hashes.length > 0 && process.env.BOM_REPRODUCIBLE
+      ? Array.from(this.#hashes).sort((a, b) => a.compare(b))
+      : this.#hashes
+    return hashes.map(h => h.toJSON())


E030: Expected an identifier and instead saw ')'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:37Z

model/ExternalReferenceList.js

@@ -20,8 +20,11 @@
 const ExternalReference = require('./ExternalReference')

 class ExternalReferenceList {
+  /** @type {Array<ExternalReference>} */
+  #externalReferences
+
  constructor (pkg) {


E054: Class properties must be methods. Expected '(' but instead saw 'constructor'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:39Z

model/Hash.js

  }

  toJSON () {
-    return { alg: this._algorithm, content: this._value }
+    return { alg: this.#algorithm, content: this.#value }


E020: Expected '}' to match '{' from line 84 and instead saw ':'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:40Z

model/ExternalReferenceList.js

-    return this._externalReferences
-      ? this._externalReferences.length
+    return this.#externalReferences
+      ? this.#externalReferences.length
      : 0


E020: Expected '}' to match '{' from line 37 and instead saw ':'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:41Z

model/HashList.js

@@ -21,8 +21,11 @@ const ssri = require('ssri')
 const Hash = require('./Hash')

 class HashList {
+  /** @type {Array<Hash>} */
+  #hashes


E024: Unexpected '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:42Z

model/ExternalReference.js

  }

  toXML () {
-    return { reference: { '@type': this._type, url: this._url } }
+    return { reference: { '@type': this.#type, url: this.#url } }


E041: Unrecoverable syntax error. (86% scanned).

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:43Z

model/HashList.js

-    return this._hashes
-      ? this._hashes.length
+    return this.#hashes
+      ? this.#hashes.length
      : 0
  }


E054: Class properties must be methods. Expected '(' but instead saw '}'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:44Z

model/ExternalReference.js

  }

  toXML () {
-    return { reference: { '@type': this._type, url: this._url } }
+    return { reference: { '@type': this.#type, url: this.#url } }


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:45Z

model/ExternalReference.js

  }

  toXML () {
-    return { reference: { '@type': this._type, url: this._url } }
+    return { reference: { '@type': this.#type, url: this.#url } }


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:46Z

model/ExternalReference.js

  }

  toJSON () {
-    return { type: this._type, url: this._url }
+    return { type: this.#type, url: this.#url }


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:47Z

model/ExternalReference.js

  set comment (value) {
-    this._comment = this.validateType('Comment', value, String)
+    this.#comment = this.validateType('Comment', value, String)


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:48Z

model/ExternalReference.js

  get comment () {
-    return this._comment
+    return this.#comment


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:49Z

model/ExternalReference.js

  set type (value) {
-    this._type = this.validateChoice('Reference type', value, this.validChoices())
+    this.#type = this.validateChoice('Reference type', value, this.validChoices())


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:50Z

model/ExternalReference.js

  get type () {
-    return this._type
+    return this.#type


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:51Z

model/ExternalReference.js

  set url (value) {
-    this._url = this.validateType('URL', value, String)
+    this.#url = this.validateType('URL', value, String, true)


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:52Z

model/ExternalReference.js

  get url () {
-    return this._url
+    return this.#url


E030: Expected an identifier and instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:54Z

model/ExternalReference.js

+  /** @type {ExternalReference.ExternalReferenceType} */
+  #type
+  /** @type {string} */
+  #url


E054: Class properties must be methods. Expected '(' but instead saw '#'.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:55Z

model/ExternalReference.js

  }

  toJSON () {
-    return { type: this._type, url: this._url }
+    return { type: this.#type, url: this.#url }


E058: Missing semicolon.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:56Z

model/ExternalReference.js

  set comment (value) {
-    this._comment = this.validateType('Comment', value, String)
+    this.#comment = this.validateType('Comment', value, String)


E058: Missing semicolon.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:57Z

model/ExternalReference.js

  get comment () {
-    return this._comment
+    return this.#comment


E058: Missing semicolon.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:58Z

model/ExternalReference.js

  set type (value) {
-    this._type = this.validateChoice('Reference type', value, this.validChoices())
+    this.#type = this.validateChoice('Reference type', value, this.validChoices())


E058: Missing semicolon.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:39:59Z

model/ExternalReference.js

  get type () {
-    return this._type
+    return this.#type


E058: Missing semicolon.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:40:00Z

model/ExternalReference.js

  set url (value) {
-    this._url = this.validateType('URL', value, String)
+    this.#url = this.validateType('URL', value, String, true)


E058: Missing semicolon.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-04-24T13:40:01Z

model/ExternalReference.js

  get url () {
-    return this._url
+    return this.#url


E058: Missing semicolon.

(at-me in a reply with help or ignore)

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]