chore: enforce license header (#434)

jkowalleck · web-flow · commit b1f10ffb83c0 · 2023-01-25T23:36:39.000+01:00
Signed-off-by: Jan Kowalleck &lt;jan.kowalleck@gmail.com&gt;

Signed-off-by: Jan Kowalleck &lt;jan.kowalleck@gmail.com&gt;
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
@@ -35,7 +34,9 @@ module.exports = {
   },
   plugins: [
     /* see https://github.com/lydell/eslint-plugin-simple-import-sort#readme */
-    'simple-import-sort'
+    'simple-import-sort',
+    /* see https://github.com/Stuk/eslint-plugin-header#readme */
+    'header'
   ],
   env: {
     commonjs: true,
@@ -58,9 +59,12 @@ module.exports = {
     {
       files: ['*.js'],
       rules: {
+        // region docs
+        /* see https://github.com/gajus/eslint-plugin-jsdoc */
         'jsdoc/require-param-type': 'error',
         'jsdoc/require-property-type': 'error',
         'jsdoc/require-returns-type': 'error'
+        // region docs
       },
       settings: {
         jsdoc: {
@@ -101,8 +105,12 @@ module.exports = {
     'jsdoc/require-throws': 'error',
     'jsdoc/require-yields': 0,
     'jsdoc/require-yields-check': 'error',
-    'jsdoc/sort-tags': 'warn'
+    'jsdoc/sort-tags': 'warn',
     // endregion docs
+    // region license-header
+    /* see https://github.com/Stuk/eslint-plugin-header#readme */
+    'header/header': ['error', '.license-header.js']
+    // endregion license-header
   },
   settings: {
     jsdoc: {
diff --git a/.license-header.js b/.license-header.js
@@ -0,0 +1,18 @@
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
diff --git a/.mocharc.js b/.mocharc.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/libs/universal-node-xml/index.js b/libs/universal-node-xml/index.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/libs/universal-node-xml/stringifiers/helpers.js b/libs/universal-node-xml/stringifiers/helpers.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/libs/universal-node-xml/stringifiers/xmlbuilder2.js b/libs/universal-node-xml/stringifiers/xmlbuilder2.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/libs/universal-node-xml/stringifiers/xmlbuilder2.spec.js b/libs/universal-node-xml/stringifiers/xmlbuilder2.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -51,6 +51,7 @@
     "deepmerge": "^4.2.2",
     "eslint": "^8.23.0",
     "eslint-config-standard-with-typescript": "^31.0.0",
+    "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-jsdoc": "^39.6.2",
     "eslint-plugin-simple-import-sort": "^9.0.0",
     "mocha": "10.2.0",
diff --git a/tests/_data/models.js b/tests/_data/models.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/_data/normalize.js b/tests/_data/normalize.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/_data/serialize.js b/tests/_data/serialize.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/_data/spdx.js b/tests/_data/spdx.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/_data/specLoader.js b/tests/_data/specLoader.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/_helpers/stringFunctions.js b/tests/_helpers/stringFunctions.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/_helpers/stringFunctions.spec.js b/tests/_helpers/stringFunctions.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/Enums.ComponentScope.spec.js b/tests/functional/Enums.ComponentScope.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/Enums.ComponentType.spec.js b/tests/functional/Enums.ComponentType.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/Enums.ExternalReferenceType.spec.js b/tests/functional/Enums.ExternalReferenceType.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/Enums.HashAlogorithms.spec.js b/tests/functional/Enums.HashAlogorithms.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/Resources.node.spec.js b/tests/functional/Resources.node.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/SPDX.spec.js b/tests/functional/SPDX.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/Spec.SpecVersionDict.spec.js b/tests/functional/Spec.SpecVersionDict.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/functional/helpers.sortable.spec.js b/tests/functional/helpers.sortable.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Builders.FromNodePackageJson.ComponentBuilder.test.js b/tests/integration/Builders.FromNodePackageJson.ComponentBuilder.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Builders.FromNodePackageJson.ToolBuilders.test.js b/tests/integration/Builders.FromNodePackageJson.ToolBuilders.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Factories.FromNodePackageJson.ExternalReferenceFactory.test.js b/tests/integration/Factories.FromNodePackageJson.ExternalReferenceFactory.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Factories.FromNodePackageJson.PackageUrlFactory.test.js b/tests/integration/Factories.FromNodePackageJson.PackageUrlFactory.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Factories.LicenseFactory.test.js b/tests/integration/Factories.LicenseFactory.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Factories.PackageUrlFactory.test.js b/tests/integration/Factories.PackageUrlFactory.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Serialize.JsonNormalize.test.js b/tests/integration/Serialize.JsonNormalize.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Serialize.JsonSerialize.test.js b/tests/integration/Serialize.JsonSerialize.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Serialize.XmlNormalize.test.js b/tests/integration/Serialize.XmlNormalize.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/integration/Serialize.XmlSerialize.test.js b/tests/integration/Serialize.XmlSerialize.test.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Builders.FromNodePackageJson.ComponentBuilder.spec.js b/tests/unit/Builders.FromNodePackageJson.ComponentBuilder.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Builders.FromNodePackageJson.ToolBuilder.spec.js b/tests/unit/Builders.FromNodePackageJson.ToolBuilder.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Factories.PackageUrlFactory.spec.js b/tests/unit/Factories.PackageUrlFactory.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Models.Bom.spec.js b/tests/unit/Models.Bom.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Models.Component.spec.js b/tests/unit/Models.Component.spec.js
@@ -1,5 +1,3 @@
-'use strict'
-
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/SPDX.spec.js b/tests/unit/SPDX.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Serialize.BomRefDiscriminator.spec.js b/tests/unit/Serialize.BomRefDiscriminator.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Serialize.JsonSerializer.spec.js b/tests/unit/Serialize.JsonSerializer.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Serialize.XmlBaseSerializer.spec.js b/tests/unit/Serialize.XmlBaseSerializer.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Serialize.XmlSerializer.spec.js b/tests/unit/Serialize.XmlSerializer.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/tests/unit/Types.cpe.spec.js b/tests/unit/Types.cpe.spec.js
@@ -1,4 +1,3 @@
-'use strict'
 /*!
 This file is part of CycloneDX JavaScript Library.
 
diff --git a/webpack.config.js b/webpack.config.js
@@ -1,5 +1,3 @@
-'use strict'
-
 /*!
 This file is part of CycloneDX JavaScript Library.
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-'use strict'`
`2`	`1`	`/*!`
`3`	`2`	`This file is part of CycloneDX JavaScript Library.`
`4`	`3`