Add eslint plugin to detect / fix missing copyright headers

Template defined in config_frontend/copyright.txt `npm run lint` will detect any files missing a header matching the template `npm run lint:fix` will add the header to any files missing it Set `nonMatchingTolerance: 0.95` to allow minor variations from the template, e.g. date ranges instead of single year
dippynark · Sep 3, 2019 · c82a077 · c82a077
1 parent fe6c4d4
commit c82a077
Show file tree

Hide file tree

Showing 16 changed files with 184 additions and 0 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -23,6 +23,7 @@ module.exports = {
       "sourceType": "module"
   },
   "plugins": [
+      "notice",
       "react"
   ],
   "rules": {
@@ -32,6 +33,9 @@ module.exports = {
     "jsx-a11y/anchor-is-valid": "off",
     "no-case-declarations": "off",
     "no-template-curly-in-string": "off",
+    "notice/notice": [
+      "error", { "templateFile": "config_frontend/copyright.txt", nonMatchingTolerance: 0.95 }
+    ],
     "react/jsx-filename-extension": "off",
     "react/destructuring-assignment": "off",
     "react/prop-types": "off",

diff --git a/config_frontend/__mocks__/fileMock.js b/config_frontend/__mocks__/fileMock.js
@@ -1 +1,14 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
+
 module.exports = 'test-file-stub';
diff --git a/config_frontend/__mocks__/styleMock.js b/config_frontend/__mocks__/styleMock.js
@@ -1 +1,14 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
+
 module.exports = {};
diff --git a/config_frontend/copyright.txt b/config_frontend/copyright.txt
@@ -0,0 +1,12 @@
+/*
+Copyright <%= YEAR %> The Tekton Authors
+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.
+*/
diff --git a/config_frontend/setupTests.js b/config_frontend/setupTests.js
@@ -1,3 +1,16 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
+
 import 'react-testing-library/cleanup-after-each';
 import fetchMock from 'fetch-mock';
 

diff --git a/docs/samples/extension/server.js b/docs/samples/extension/server.js
@@ -1,3 +1,16 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
+
 const express = require('express');
 
 // Constants

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -70,6 +70,7 @@
     "eslint-loader": "^2.1.2",
     "eslint-plugin-import": "^2.16.0",
     "eslint-plugin-jsx-a11y": "^6.2.1",
+    "eslint-plugin-notice": "^0.8.9",
     "eslint-plugin-prettier": "^3.0.1",
     "eslint-plugin-react": "^7.12.4",
     "fetch-mock": "^7.3.1",

diff --git a/packages/components/src/components/LogoutButton/LogoutButton.js b/packages/components/src/components/LogoutButton/LogoutButton.js
@@ -1,3 +1,16 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
+
 import LogoutIcon from '@carbon/icons-react/lib/logout/20';
 import { Button } from 'carbon-components-react';
 import { injectIntl } from 'react-intl';

diff --git a/packages/components/src/components/Rebuild/Rebuild.test.js b/packages/components/src/components/Rebuild/Rebuild.test.js
@@ -1,3 +1,16 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
+
 import React from 'react';
 import { fireEvent, waitForElement } from 'react-testing-library';
 import { renderWithRouter } from '../../utils/test';

diff --git a/src/constants/index.js b/src/constants/index.js
@@ -1,3 +1,15 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
 export const messages = {
   en: {
     'dashboard.pipelineRuns.transitionTime': 'Last Transition Time',

diff --git a/src/containers/Extension/actions.js b/src/containers/Extension/actions.js
@@ -1,3 +1,15 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
 export { fetchNamespaces } from '../../actions/namespaces';
 export { fetchPipeline, fetchPipelines } from '../../actions/pipelines';
 export { fetchSecrets } from '../../actions/secrets';

diff --git a/src/containers/SideNav/index.js b/src/containers/SideNav/index.js
@@ -1 +1,13 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
 export { default } from './SideNav';
diff --git a/webpack.common.js b/webpack.common.js
@@ -1,3 +1,15 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
 const path = require('path');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
 

diff --git a/webpack.dev.js b/webpack.dev.js
@@ -1,3 +1,15 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
 const merge = require('webpack-merge');
 
 const common = require('./webpack.common.js');

diff --git a/webpack.prod.js b/webpack.prod.js
@@ -1,3 +1,15 @@
+/*
+Copyright 2019 The Tekton Authors
+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.
+*/
 const merge = require('webpack-merge');
 const path = require('path');
 const webpack = require('webpack');