📜 Added configuration for jsdoc + better-docs

This commit is contained in:
2022-06-12 22:54:36 -07:00
parent f308ec0f01
commit 15c0840c63
12 changed files with 1694 additions and 77 deletions

View File

@@ -1,31 +1,28 @@
module.exports = {
extends: [
"plugin:react/recommended", // Uses the recommended rules from @eslint-plugin-react
"plugin:@typescript-eslint/recommended", // Uses the recommended rules from the @typescript-eslint/eslint-plugin
"plugin:prettier/recommended", // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors.
"plugin:css-modules/recommended",
],
extends: ["plugin:react/recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended", "plugin:css-modules/recommended", "plugin:storybook/recommended", "plugin:storybook/recommended"],
parser: "@typescript-eslint/parser",
parserOptions: {
sourceType: "module",
ecmaVersion: 2020,
ecmaFeatures: {
jsx: true, // Allows for the parsing of JSX
},
jsx: true // Allows for the parsing of JSX
}
},
plugins: ["@typescript-eslint", "css-modules"],
settings: {
"import/resolver": {
node: {
extensions: [".js", ".jsx", ".ts", ".tsx"],
},
extensions: [".js", ".jsx", ".ts", ".tsx"]
}
},
react: {
version: "detect", // Tells eslint-plugin-react to automatically detect the version of React to use
},
version: "detect" // Tells eslint-plugin-react to automatically detect the version of React to use
}
},
// Fine tune rules
rules: {
"@typescript-eslint/no-var-requires": 0,
},
};
"@typescript-eslint/no-var-requires": 0
}
};

9
.parcelrc Normal file
View File

@@ -0,0 +1,9 @@
{
"extends": "@parcel/config-default",
"transformers": {
"*.{js,mjs,jsx,cjs,ts,tsx}": [
"@parcel/transformer-js",
"@parcel/transformer-react-refresh-wrap"
]
}
}

View File

@@ -1,7 +0,0 @@
LOGGER=true
LOGLEVEL=info
SERVICEDIR=dist/services
PWD=./
TRANSPORTER=redis://redis:6379
CACHER=Memory

View File

@@ -8,7 +8,7 @@
},
"source": {
"include": [
"./src/"
"./src/client"
],
"includePattern": "\\.(jsx|js|ts|tsx)$"
},

View File

@@ -20,7 +20,9 @@
"@bluelovers/fast-glob": "https://github.com/rishighan/fast-glob-v2-api.git",
"@dnd-kit/core": "^4.0.0",
"@dnd-kit/sortable": "^5.0.0",
"@dnd-kit/utilities": "^3.2.0",
"@fortawesome/fontawesome-free": "^6.1.1",
"@parcel/config-default": "^2.6.0",
"@redux-devtools/extension": "^3.2.2",
"@types/mime-types": "^2.1.0",
"@types/react": "^17.0.3",
@@ -32,8 +34,11 @@
"@types/socket.io-client": "^3.0.0",
"airdcpp-apisocket": "^2.4.4",
"array-sort-by": "^1.2.1",
"axios": "^0.27.2",
"axios-rate-limit": "^1.3.0",
"axios-simple-cache-adapter": "^1.1.0",
"babel-polyfill": "^6.26.0",
"better-docs": "^2.7.2",
"comlink-loader": "^2.0.0",
"compromise": "^13.11.3",
"compromise-dates": "^2.2.1",
@@ -48,8 +53,12 @@
"final-form": "^4.20.2",
"final-form-arrays": "^3.0.2",
"html-to-text": "^8.1.0",
"jsdoc": "^3.6.10",
"lodash": "^4.17.21",
"opds-extra": "^3.0.9",
"pretty-bytes": "^5.6.0",
"prop-types": "^15.8.1",
"qs": "^6.10.5",
"react": "^18.1.0",
"react-collapsible": "^2.9.0",
"react-comic-viewer": "^0.3.5",
@@ -107,8 +116,6 @@
"@typescript-eslint/eslint-plugin": "^4.17.0",
"@typescript-eslint/parser": "^4.17.0",
"awesome-typescript-loader": "^5.2.1",
"axios": "^0.21.1",
"axios-rate-limit": "^1.3.0",
"babel-eslint": "^10.0.0",
"babel-loader": "^8.2.2",
"babel-plugin-transform-class-properties": "^6.24.1",
@@ -138,13 +145,11 @@
"image-webpack-loader": "^8.1.0",
"install": "^0.13.0",
"jest": "^26.6.3",
"lodash": "^4.17.21",
"mini-css-extract-plugin": "^1.4.1",
"node-sass": "^7.0.1",
"nodemon": "^1.17.3",
"npm": "^8.11.0",
"prettier": "^2.2.1",
"qs": "^6.10.1",
"react-refresh": "^0.13.0",
"rimraf": "^3.0.2",
"sass-loader": "^11.0.1",

View File

@@ -294,3 +294,5 @@ export const ComicDetail = (data: ComicDetailProps): ReactElement => {
</section>
);
};
export default ComicDetail;

View File

@@ -3,18 +3,6 @@ import React, { createContext, useEffect, useMemo, useState } from "react";
import { SETTINGS_SERVICE_BASE_URI } from "../constants/endpoints";
import AirDCPPSocket from "../services/DcppSearchService";
/**
* Component for setting up and sharing the AirDC++ socket context.
*
* @component
* @example
* const age = 21
* const name = 'Jitendra Nirnejak'
* return (
* <User age={age} name={name} />
* )
*/
const AirDCPPSocketContext = createContext({});
const AirDCPPSocketContextProvider = ({ children }) => {
const [airDCPPConfiguration, setValue] = useState({});

View File

View File

View File

@@ -1,9 +0,0 @@
LOGGER=true
LOGLEVEL=info
SERVICEDIR=dist/services
MONGO_URI=mongodb://db:27017/threetwo
REDIS_URI=redis://redis:6379
TRANSPORTER=redis://redis:6379
CALIBRE_EBOOK_META_PATH=/opt/calibre/ebook-meta
CACHER=Memory

View File

@@ -11,7 +11,10 @@
"outDir": "./dist/",
"skipLibCheck": true,
"resolveJsonModule": true,
"lib": ["dom", "dom.iterable", "esnext", "webworker"]
"lib": ["dom", "dom.iterable", "esnext", "webworker"],
"baseUrl": ".",
"esModuleInterop": true,
"strict": true
},
"settings": {
"eslint.workingDirectories": [

1685
yarn.lock

File diff suppressed because it is too large Load Diff