Merge pull request #58 from merative/ab/fix-linting-issues

Fix linting issues
merative · Apr 24, 2024 · 0ac7ce4 · 0ac7ce4
2 parents 1d0c614 + 1da2f43
commit 0ac7ce4
Show file tree

Hide file tree

Showing 20 changed files with 180 additions and 169 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,3 +1,6 @@
+cookbook/public/**
 cookbook/src/gatsby-theme-carbon/**
 dist/**
 node_modules/**
+reports/**
+storybook-static/**
diff --git a/gulpfile.js b/gulpfile.js
@@ -1,12 +1,9 @@
-
-
-/* eslint-disable  no-console */
-const path = require('path');
-const gulp = require('gulp');
-const shell = require('shelljs');
+const path = require("path");
+const gulp = require("gulp");
+const shell = require("shelljs");
 
 // Load env vars from the .env file.
-require('dotenv').config();
+require("dotenv").config();
 
 /*
  * This task generates a development bundle to the specified output folder.
@@ -24,29 +21,36 @@ require('dotenv').config();
  * before it is transpiled by Babel.
  */
 
-gulp.task('deploy:spm', async () => {
+gulp.task("deploy:spm", async () => {
   if (process.env.CLIENT_DIR) {
     const customComponentName = process.env.CUSTOM_COMPONENT_NAME || "custom";
-    const customComponentLocation = process.env.CLIENT_DIR + "/components/" + customComponentName + "/WebContent/CDEJ/jscript/SPMUIComponents";
-    shell.echo(`\n[INFO] Copying the generated files to custom component: ${customComponentLocation}`);
+    const customComponentLocation = `${process.env.CLIENT_DIR}/components/${customComponentName}/WebContent/CDEJ/jscript/SPMUIComponents`;
+    shell.echo(
+      `\n[INFO] Copying the generated files to custom component: ${customComponentLocation}`,
+    );
     shell.exec(
       `webpack --mode=development --devtool=eval-source-map\
       --output-path=${customComponentLocation}`,
-      { fatal: true }
+      { fatal: true },
     );
   } else {
-    throw new  Error("Env var CLIENT_DIR is not defined in the .env file. It should be set to the weblicent directory.")
+    throw new Error(
+      "Env var CLIENT_DIR is not defined in the .env file. It should be set to the weblicent directory.",
+    );
   }
 });
 
-gulp.task('dev:spm', () => {
+gulp.task("dev:spm", () => {
   if (!process.env.CLIENT_DIR) {
-    throw new  Error("Env var CLIENT_DIR is not defined in the .env file. It should be set to the weblicent directory.")
+    throw new Error(
+      "Env var CLIENT_DIR is not defined in the .env file. It should be set to the weblicent directory.",
+    );
   }
-  const cdejLocation = process.env.RELATIVE_PATH_TO_BUNDLE || "CDEJ/jscript/SPMUIComponents";
+  const cdejLocation =
+    process.env.RELATIVE_PATH_TO_BUNDLE || "CDEJ/jscript/SPMUIComponents";
   const output =
-    process.env.CLIENT_DIR + "/WebContent/" + cdejLocation ||
-    path.resolve(__dirname, '/dist');
+    `${process.env.CLIENT_DIR}/WebContent/${cdejLocation}` ||
+    path.resolve(__dirname, "/dist");
 
   shell.echo(`\n[INFO] Generating the dev bundle to path: ${output}
 [INFO] Any changes to the files will automatically trigger a new bundle generation.`);
@@ -55,22 +59,19 @@ gulp.task('dev:spm', () => {
     `webpack --mode=development --devtool=eval-source-map\
     --output-path=${output} --watch\
    `,
-    { fatal: true }
+    { fatal: true },
   );
 
-  shell.echo(`\n\n[INFO] Bundle Generated into ${output} \n[INFO] Watching for file changes`);
-
+  shell.echo(
+    `\n\n[INFO] Bundle Generated into ${output} \n[INFO] Watching for file changes`,
+  );
 });
 
-gulp.task('prod:spm', (done) => {
-  const output = path.resolve(__dirname, '/dist');
-  
+gulp.task("prod:spm", (done) => {
+  const output = path.resolve(__dirname, "/dist");
+
   shell.echo(`\n[INFO] Generating the dev bundle to path: ${output}.`);
 
-  shell.exec(
-    `webpack --mode production`,
-    { fatal: true}
-  );
+  shell.exec(`webpack --mode production`, { fatal: true });
   done();
 });
-
diff --git a/packages/carbon-addons-devenv/sample_renderers/index.js b/packages/carbon-addons-devenv/sample_renderers/index.js
@@ -1,8 +1,8 @@
 /*
- * Copyright Merative US L.P. 2020
+ * Copyright Merative US L.P. 2020, 2024
  */
 
-import PersonFolio from './PersonFolio';
-import Logo from './Logo';
+import PersonFolio from "./personFolio";
+import Logo from "./logo";
 
 export default { PersonFolio, Logo };
diff --git a/packages/carbon-addons-devenv/sample_renderers/logo/LogoRenderer.js b/packages/carbon-addons-devenv/sample_renderers/logo/LogoRenderer.js
@@ -1,15 +1,13 @@
-/* eslint-disable no-undef */
-/* eslint-disable no-console */
 /*
- * Copyright Merative US L.P. 2022
+ * Copyright Merative US L.P. 2022, 2024
  */
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
 // NOTE: from custom-carbon-addons package reference to Renderer would be he following
 // import { Renderer } from 'devenv_pkg/src/apollo-client-hooks';
-import { Renderer } from 'devenv_pkg/src/apollo-client-hooks';
+// eslint-disable-next-line import/no-unresolved
+import { Renderer } from "devenv_pkg/src/apollo-client-hooks";
 
 const render = async (containerId, config) => {
-  Renderer.create(containerId, config, 'LogoComponentApolloClientHook');
+  Renderer.create(containerId, config, "LogoComponentApolloClientHook");
 };
 
 export default render;
diff --git a/packages/carbon-addons-devenv/sample_renderers/personFolio/PersonFolioRenderer.js b/packages/carbon-addons-devenv/sample_renderers/personFolio/PersonFolioRenderer.js
@@ -1,15 +1,13 @@
-/* eslint-disable no-undef */
-/* eslint-disable no-console */
 /*
- * Copyright Merative US L.P. 2021, 2022
+ * Copyright Merative US L.P. 2021, 2024
  */
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
 // NOTE: from custom-carbon-addons package reference to Renderer would be he following
 // import { Renderer } from 'devenv_pkg/src/apollo-client-hooks';
-import { Renderer } from 'devenv_pkg/src/apollo-client-hooks';
+// eslint-disable-next-line import/no-unresolved
+import { Renderer } from "devenv_pkg/src/apollo-client-hooks";
 
 const render = async (containerId, config) => {
-  Renderer.create(containerId, config, 'PersonComponentApolloClientHook');
+  Renderer.create(containerId, config, "PersonComponentApolloClientHook");
 };
 
 export default render;
diff --git a/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Logo/LogoDataProvider.js b/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Logo/LogoDataProvider.js
@@ -1,27 +1,26 @@
 /*
- * Copyright Merative US L.P. 2021, 2022
+ * Copyright Merative US L.P. 2021, 2024
  */
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
-import React from 'react';
-import PropTypes from 'prop-types';
-// NOTE: 
+import React from "react";
+import PropTypes from "prop-types";
+// NOTE:
 // from custom-carbon-addons package reference to ApolloClientDataProvider  would be he following
 // import { ApolloClientDataProvider } from 'devenv_pkg/src/apollo-client-hooks';
-import ApolloClientDataProvider from 'devenv_pkg/src/apollo-client-hooks/core/ApolloClientDataProvider';
-import LogoQueryProvider from './LogoQueryProvider';
-
+// eslint-disable-next-line import/no-unresolved
+import ApolloClientDataProvider from "devenv_pkg/src/apollo-client-hooks/core/ApolloClientDataProvider";
+import LogoQueryProvider from "./LogoQueryProvider";
 
 const LogoDataProvider = ({ configuration, apolloClient }) => {
   return (
-    <ApolloClientDataProvider apolloClient={apolloClient} >
-      <LogoQueryProvider configuration={configuration}/>
+    <ApolloClientDataProvider apolloClient={apolloClient}>
+      <LogoQueryProvider configuration={configuration} />
     </ApolloClientDataProvider>
   );
 };
 
 LogoDataProvider.propTypes = {
   configuration: PropTypes.object.isRequired,
-  apolloClient: PropTypes.object.isRequired
-}
+  apolloClient: PropTypes.object.isRequired,
+};
 
 export default LogoDataProvider;
diff --git a/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Logo/LogoQueryProvider.js b/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Logo/LogoQueryProvider.js
@@ -1,25 +1,32 @@
 /*
- * Copyright Merative US L.P. 2021, 2022
+ * Copyright Merative US L.P. 2021, 2024
  */
 
-import React from 'react';
-import PropTypes from 'prop-types';
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
-import Logo  from 'devenv_pkg/src/react/addons_samples/Logo/Logo';
-// NOTE: 
+import React from "react";
+import PropTypes from "prop-types";
+// eslint-disable-next-line import/no-unresolved
+import Logo from "devenv_pkg/src/react/addons_samples/Logo/Logo";
+// NOTE:
 // from custom-carbon-addons package reference to ApolloClientQueryProvider would be he following
 // import { ApolloClientQueryProvider } from 'devenv_pkg/src/apollo-client-hooks';
-import ApolloClientQueryProvider from 'devenv_pkg/src/apollo-client-hooks/core/ApolloClientQueryProvider';
-import { useGetLogo } from './LogoQuery';
+// eslint-disable-next-line import/no-unresolved
+import ApolloClientQueryProvider from "devenv_pkg/src/apollo-client-hooks/core/ApolloClientQueryProvider";
+import { useGetLogo } from "./LogoQuery";
 
 const LogoQueryProvider = ({ configuration }) => {
-
   const { data } = useGetLogo(configuration.logoId);
-  const propertyName = 'logo';
+  const propertyName = "logo";
   // dataa in this instance is juts an oject rather than an array
-  const logo = (<>{data && data[propertyName] && (
-    <Logo key={data[propertyName].logoId} imageName={data[propertyName].name}/>
-   )}</>);
+  const logo = (
+    <>
+      {data && data[propertyName] && (
+        <Logo
+          key={data[propertyName].logoId}
+          imageName={data[propertyName].name}
+        />
+      )}
+    </>
+  );
 
   if (!data) return <></>;
 
@@ -28,7 +35,6 @@ const LogoQueryProvider = ({ configuration }) => {
       {logo}
     </ApolloClientQueryProvider>
   );
-
 };
 
 LogoQueryProvider.propTypes = {

diff --git a/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Logo/index.js b/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Logo/index.js
@@ -1,10 +1,10 @@
 /*
- * Copyright Merative US L.P. 2020, 2022
+ * Copyright Merative US L.P. 2020, 2024
  */
 
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
-import { ApolloClientHookTemplate } from 'devenv_pkg/src/apollo-client-hooks';
-import LogoDataProvider from './LogoDataProvider';
+// eslint-disable-next-line import/no-unresolved
+import { ApolloClientHookTemplate } from "devenv_pkg/src/apollo-client-hooks";
+import LogoDataProvider from "./LogoDataProvider";
 
 const LogoComponentApolloClientHook = (container, configuration) => {
   ApolloClientHookTemplate(container, configuration, LogoDataProvider);

diff --git a/...es/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Person/PersonDataProvider.js b/...es/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Person/PersonDataProvider.js
@@ -1,26 +1,26 @@
 /*
- * Copyright Merative US L.P. 2021, 2022
+ * Copyright Merative US L.P. 2021, 2024
  */
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
-import React from 'react';
-import PropTypes from 'prop-types';
-// NOTE: 
+import React from "react";
+import PropTypes from "prop-types";
+// NOTE:
 // from custom-carbon-addons package reference to ApolloClientDataProvider  would be he following
 // import { ApolloClientDataProvider } from 'devenv_pkg/src/apollo-client-hooks';
-import ApolloClientDataProvider from 'devenv_pkg/src/apollo-client-hooks/core/ApolloClientDataProvider';
-import PersonFolioQueryProvider from './PersonFolioQueryProvider';
+// eslint-disable-next-line import/no-unresolved
+import ApolloClientDataProvider from "devenv_pkg/src/apollo-client-hooks/core/ApolloClientDataProvider";
+import PersonFolioQueryProvider from "./PersonFolioQueryProvider";
 
 const PersonDataProvider = ({ configuration, apolloClient }) => {
   return (
-    <ApolloClientDataProvider apolloClient={apolloClient} >
-      <PersonFolioQueryProvider configuration={configuration}/>
+    <ApolloClientDataProvider apolloClient={apolloClient}>
+      <PersonFolioQueryProvider configuration={configuration} />
     </ApolloClientDataProvider>
   );
 };
 
 PersonDataProvider.propTypes = {
   configuration: PropTypes.object.isRequired,
-  apolloClient: PropTypes.object.isRequired
-}
+  apolloClient: PropTypes.object.isRequired,
+};
 
 export default PersonDataProvider;
diff --git a/...bon-addons-devenv/src/apollo-client-hooks/hook_samples/Person/PersonFolioQueryProvider.js b/...bon-addons-devenv/src/apollo-client-hooks/hook_samples/Person/PersonFolioQueryProvider.js
@@ -1,23 +1,34 @@
 /*
- * Copyright Merative US L.P. 2021, 2022
+ * Copyright Merative US L.P. 2021, 2024
  */
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
-import React from 'react';
-import PropTypes from 'prop-types';
-// NOTE: 
+import React from "react";
+import PropTypes from "prop-types";
+// NOTE:
 // from custom-carbon-addons package reference to ApolloClientQueryProvider would be he following
 // import { ApolloClientQueryProvider } from 'devenv_pkg/src/apollo-client-hooks';
-import ApolloClientQueryProvider from 'devenv_pkg/src/apollo-client-hooks/core/ApolloClientQueryProvider';
-import PersonFolio  from 'devenv_pkg/src/react/addons_samples/PersonFolio/PersonFolio';
-import { useGetPersons } from './PersonQuery';
+// eslint-disable-next-line import/no-unresolved
+import ApolloClientQueryProvider from "devenv_pkg/src/apollo-client-hooks/core/ApolloClientQueryProvider";
+// eslint-disable-next-line import/no-unresolved
+import PersonFolio from "devenv_pkg/src/react/addons_samples/PersonFolio/PersonFolio";
+import { useGetPersons } from "./PersonQuery";
 
 const PersonFolioQueryProvider = ({ configuration }) => {
-  const propertyName = 'persons';
+  const propertyName = "persons";
   const { data } = useGetPersons();
   // 'persons' from graphql query is an array so return as list
-  const personToRender = (<>{data && data[propertyName].map(person => (
-    <PersonFolio key={person.id} firstname={person.firstname} surname={person.surname} age={person.age}/>
-   ))}</>);
+  const personToRender = (
+    <>
+      {data &&
+        data[propertyName].map((person) => (
+          <PersonFolio
+            key={person.id}
+            firstname={person.firstname}
+            surname={person.surname}
+            age={person.age}
+          />
+        ))}
+    </>
+  );
 
   if (!data) return <></>;
 
@@ -26,7 +37,6 @@ const PersonFolioQueryProvider = ({ configuration }) => {
       {personToRender}
     </ApolloClientQueryProvider>
   );
-
 };
 
 PersonFolioQueryProvider.propTypes = {

diff --git a/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Person/index.js b/packages/carbon-addons-devenv/src/apollo-client-hooks/hook_samples/Person/index.js
@@ -1,12 +1,12 @@
 /*
- * Copyright Merative US L.P. 2021, 2022
+ * Copyright Merative US L.P. 2021, 2024
  */
-/* eslint import/no-unresolved: [2, { ignore: ['devenv_pkg*.'] }] */
-import { ApolloClientHookTemplate } from 'devenv_pkg/src/apollo-client-hooks';
-import PersonDataProvider from './PersonDataProvider';
+// eslint-disable-next-line import/no-unresolved
+import { ApolloClientHookTemplate } from "devenv_pkg/src/apollo-client-hooks";
+import PersonDataProvider from "./PersonDataProvider";
 
 const PersonComponentApolloClientHook = (container, config) => {
   ApolloClientHookTemplate(container, config, PersonDataProvider);
-}
+};
 
 export default PersonComponentApolloClientHook;