Feature/enforce license notice in each file via eslint rule (#304)

* [ESLint] Add "eslint-plugin-header" as dev dependency

* [ESLint::eslint-plugin-header] Setup rule

* [ESLint::eslint-plugin-header] Fix errors

.eslintrc.js

@@ -1,10 +1,26 @@
 module.exports = {
     extends: ['airbnb', 'airbnb-typescript', 'prettier'],
-    plugins: ['@typescript-eslint', 'no-relative-import-paths', 'prettier'],
+    plugins: ['@typescript-eslint', 'no-relative-import-paths', 'prettier', 'header'],
     parserOptions: {
         project: './tsconfig.json',
     },
     rules: {
+        'header/header': [
+            'error',
+            'block', // comment type
+            [ // expected file header comment
+                // the spaces are important, otherwise, the rule will mark it as an error
+                '',
+                ' * Copyright (C) Contributors to the Suwayomi project',
+                ' *',
+                ' * This Source Code Form is subject to the terms of the Mozilla Public',
+                ' * License, v. 2.0. If a copy of the MPL was not distributed with this',
+                ' * file, You can obtain one at https://mozilla.org/MPL/2.0/.',
+                ' ',
+            ],
+            2, // number of new lines after comment
+        ],
+
         'prettier/prettier': 'error',
 
         'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],

package.json

@@ -62,6 +62,7 @@
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-no-relative-import-paths": "^1.5.2",

src/App.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { Container } from '@mui/material';
 import CssBaseline from '@mui/material/CssBaseline';

src/components/ExtensionCard.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useState } from 'react';
 import Card from '@mui/material/Card';

src/components/MangaCard.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React from 'react';
 import Card from '@mui/material/Card';

src/components/MangaGrid.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useEffect, useLayoutEffect, useRef, useState } from 'react';
 import Grid from '@mui/material/Grid';

src/components/SourceCard.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { CardActionArea } from '@mui/material';
 import Avatar from '@mui/material/Avatar';

src/components/atoms/LoadingIconButton.tsx

@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) Contributors to the Suwayomi project
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
 import { CircularProgress, IconButton, IconButtonProps } from '@mui/material';
 import React, { useState } from 'react';
 

src/components/context/DarkTheme.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React from 'react';
 

src/components/context/LibraryOptionsContext.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useContext } from 'react';
 import { LibraryOptions } from 'typings';

src/components/context/NavbarContext.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useContext, useEffect } from 'react';
 import { INavbarOverride } from 'typings';

src/components/library/LibraryOptionsPanel.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { FormLabel, RadioGroup } from '@mui/material';
 import CheckboxInput from 'components/atoms/CheckboxInput';

src/components/library/LibraryOptionsProvider.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import LibraryOptionsContext, { DefaultLibraryOptions } from 'components/context/LibraryOptionsContext';
 import React, { useMemo } from 'react';

src/components/library/LibraryToolbarMenu.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import FilterList from '@mui/icons-material/FilterList';
 import { IconButton } from '@mui/material';

src/components/library/UpdateChecker.tsx

@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) Contributors to the Suwayomi project
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
 import React, { useEffect, useState } from 'react';
 import IconButton from '@mui/material/IconButton';
 import RefreshIcon from '@mui/icons-material/Refresh';

src/components/library/useSubscription.ts

@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) Contributors to the Suwayomi project
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
 import { useEffect, useState } from 'react';
 
 const baseWebsocketUrl = JSON.parse(window.localStorage.getItem('serverBaseURL')!).replace('http', 'ws');

src/components/manga/ChapterCard.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import BookmarkIcon from '@mui/icons-material/Bookmark';
 import BookmarkAdd from '@mui/icons-material/BookmarkAdd';

src/components/manga/ChapterList.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { Button, CircularProgress, Stack } from '@mui/material';
 import Typography from '@mui/material/Typography';

src/components/manga/ChapterOptions.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { RadioGroup } from '@mui/material';
 import RadioInput from 'components/atoms/RadioInput';

src/components/manga/ChaptersToolbarMenu.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import FilterList from '@mui/icons-material/FilterList';
 import { IconButton } from '@mui/material';

src/components/manga/MangaDetails.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import FavoriteIcon from '@mui/icons-material/Favorite';
 import FavoriteBorderIcon from '@mui/icons-material/FavoriteBorder';

src/components/manga/MangaToolbarMenu.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import Label from '@mui/icons-material/Label';
 import MoreHoriz from '@mui/icons-material/MoreHoriz';

src/components/manga/ResumeFAB.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React from 'react';
 import { Link } from 'react-router-dom';

src/components/manga/SelectionFAB.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import MoreHoriz from '@mui/icons-material/MoreHoriz';
 import { Fab, Menu } from '@mui/material';

src/components/manga/SelectionFABActionItem.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import BookmarkAdd from '@mui/icons-material/BookmarkAdd';
 import BookmarkRemove from '@mui/icons-material/BookmarkRemove';

src/components/manga/hooks.ts

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { useCallback, useState } from 'react';
 import { mutate } from 'swr';

src/components/manga/util.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { t } from 'i18next';
 import { useReducerLocalStorage } from 'util/useLocalStorage';

src/components/molecules/OptionsPanel.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { Drawer } from '@mui/material';
 import { Box } from '@mui/system';

src/components/molecules/OptionsTabs.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import { Stack, Tab, Tabs } from '@mui/material';
 import TabPanel from 'components/util/TabPanel';

src/components/navbar/DefaultNavBar.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useContext } from 'react';
 import AppBar from '@mui/material/AppBar';

src/components/navbar/NavBarContextProvider.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useCallback, useMemo, useState } from 'react';
 import NavBarContext from 'components/context/NavbarContext';

src/components/navbar/ReaderNavBar.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import IconButton from '@mui/material/IconButton';
 import CloseIcon from '@mui/icons-material/Close';

src/components/navbar/action/CategorySelect.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useMemo } from 'react';
 import Button from '@mui/material/Button';

src/components/navbar/action/LangSelect.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React, { useState } from 'react';
 import Button from '@mui/material/Button';

src/components/navbar/navigation/DesktopSideBar.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React from 'react';
 import { ListItem, ListItemIcon, Tooltip } from '@mui/material';

src/components/navbar/navigation/MobileBottomBar.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React from 'react';
 import { ListItem } from '@mui/material';

src/components/reader/DoublePage.tsx

@@ -3,7 +3,8 @@
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
 
 import React from 'react';
 import { Box, styled } from '@mui/system';