Added license headers to TypeScript files. (#311)

* Added license headers jest linter.

Signed-off-by: dblock <[email protected]>

CHANGELOG.md

@@ -11,6 +11,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added workflow to determine API changes ([#297](https://github.com/opensearch-project/opensearch-api-specification/pull/297))
 - Added link checking ([#269](https://github.com/opensearch-project/opensearch-api-specification/pull/269))
 - Added API coverage ([#210](https://github.com/opensearch-project/opensearch-api-specification/pull/210))
+- Added license headers to TypeScript code ([#311](https://github.com/opensearch-project/opensearch-api-specification/pull/311))
 
 ### Changed
 

eslint.config.mjs

@@ -2,6 +2,7 @@ import path from 'path'
 import { fileURLToPath } from 'url'
 import { FlatCompat } from '@eslint/eslintrc'
 import pluginJs from '@eslint/js'
+import licenseHeader from 'eslint-plugin-license-header'
 
 // mimic CommonJS variables -- not needed if using CommonJS
 const _filename = fileURLToPath(import.meta.url)
@@ -13,6 +14,9 @@ export default [
   ...compat.extends('standard-with-typescript'),
   {
     files: ['**/*.{js,ts}'],
+    plugins: {
+      'license-header': licenseHeader
+    },
     rules: {
       '@typescript-eslint/consistent-indexed-object-style': 'error',
       '@typescript-eslint/consistent-type-assertions': 'error',
@@ -51,7 +55,20 @@ export default [
       'array-callback-return': 'off',
       'new-cap': 'off',
       'no-return-assign': 'error',
-      'object-shorthand': 'error'
+      'object-shorthand': 'error',
+      'license-header/header': [
+        'error',
+        [
+          '/*',
+          '* Copyright OpenSearch Contributors',
+          '* SPDX-License-Identifier: Apache-2.0',
+          '*',
+          '* The OpenSearch Contributors require contributions made to',
+          '* this file be licensed under the Apache-2.0 license or a',
+          '* compatible open source license.',
+          '*/'
+        ]
+      ]
     }
   }
 ]

jest.config.js

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
   preset: 'ts-jest',

package.json

@@ -36,6 +36,7 @@
     "eslint": "^8.57.0",
     "eslint-config-standard-with-typescript": "^43.0.1",
     "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-license-header": "^0.6.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.1.1",
     "globals": "^15.0.0",

tools/helpers.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import fs from 'fs'
 import path from 'path'
 import YAML from 'yaml'

tools/src/Logger.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 export enum LogLevel {
   error = 1,
   warn = 2,

tools/src/coverage/CoverageCalculator.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import { type OpenAPIV3 } from 'openapi-types'
 import { HTTP_METHODS, read_yaml, write_json } from '../../helpers'
 

tools/src/coverage/coverage.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import { Command, Option } from '@commander-js/extra-typings'
 import CoverageCalculator from './CoverageCalculator'
 import { resolve } from 'path'

tools/src/dump-cluster-spec/dump-cluster-spec.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import { Command, Option } from '@commander-js/extra-typings'
 import { resolve } from 'path'
 import axios from 'axios'

tools/src/linter/InlineObjectSchemaValidator.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import type NamespacesFolder from './components/NamespacesFolder'
 import type SchemasFolder from './components/SchemasFolder'
 import { type ValidationError } from 'types'

tools/src/linter/SchemaRefsValidator.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import type NamespacesFolder from './components/NamespacesFolder'
 import type SchemasFolder from './components/SchemasFolder'
 import { type ValidationError } from 'types'

tools/src/linter/SchemasValidator.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import AJV from 'ajv'
 import addFormats from 'ajv-formats'
 import OpenApiMerger from '../merger/OpenApiMerger'

tools/src/linter/SpecValidator.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import SchemasFolder from './components/SchemasFolder'
 import NamespacesFolder from './components/NamespacesFolder'
 import { type ValidationError } from 'types'

tools/src/linter/components/InfoFile.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import FileValidator from './base/FileValidator'
 
 export default class InfoFile extends FileValidator {

tools/src/linter/components/NamespaceFile.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import { type OpenAPIV3 } from 'openapi-types'
 import { type OperationSpec, type ValidationError } from 'types'
 import OperationGroup from './OperationGroup'

tools/src/linter/components/NamespacesFolder.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import NamespaceFile from './NamespaceFile'
 import { type ValidationError } from 'types'
 import FolderValidator from './base/FolderValidator'

tools/src/linter/components/Operation.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import { type OperationSpec, type ValidationError } from 'types'
 import _ from 'lodash'
 import ValidatorBase from './base/ValidatorBase'

tools/src/linter/components/OperationGroup.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import type Operation from './Operation'
 import { type ValidationError } from 'types'
 import ValidatorBase from './base/ValidatorBase'

tools/src/linter/components/Schema.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import ValidatorBase from './base/ValidatorBase'
 import { type OpenAPIV3 } from 'openapi-types'
 import { type ValidationError } from 'types'

tools/src/linter/components/SchemaFile.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import FileValidator from './base/FileValidator'
 import { type ValidationError } from 'types'
 import Schema from './Schema'

tools/src/linter/components/SchemasFolder.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import SchemaFile from './SchemaFile'
 import FolderValidator from './base/FolderValidator'
 import { type ValidationError } from 'types'

tools/src/linter/components/SupersededOperationsFile.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import FileValidator from './base/FileValidator'
 
 export default class SupersededOperationsFile extends FileValidator {

tools/src/linter/components/base/FileValidator.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import ValidatorBase from './ValidatorBase'
 import { type ValidationError } from 'types'
 import { type OpenAPIV3 } from 'openapi-types'

tools/src/linter/components/base/FolderValidator.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import fs from 'fs'
 import ValidatorBase from './ValidatorBase'
 import type FileValidator from './FileValidator'

tools/src/linter/components/base/ValidatorBase.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import { type ValidationError } from 'types'
 export default class ValidatorBase {
   file: string

tools/src/linter/lint.ts

@@ -1,3 +1,12 @@
+/*
+* Copyright OpenSearch Contributors
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+
 import { Command, Option } from '@commander-js/extra-typings'
 import SpecValidator from './SpecValidator'
 import { resolve } from 'path'