Adding comment about importing lodash library (#78156)

* added comment about importing lodash library

* fixed space with prefer

* cleaned up extra space and removed comments for lodash/fp

* took out the comment in server files

* Remove newlines

Co-authored-by: Nathan L Smith <smith@nlsmith.com>

Author: brittanyjoiner15

.eslintrc.js

@@ -1229,5 +1229,20 @@ module.exports = {
         '@typescript-eslint/prefer-ts-expect-error': 'error',
       },
     },
+    {
+      files: [
+        '**/public/**/*.{js,mjs,ts,tsx}',
+        '**/common/**/*.{js,mjs,ts,tsx}',
+        'packages/**/*.{js,mjs,ts,tsx}',
+      ],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          {
+            patterns: ['lodash/*', '!lodash/fp'],
+          },
+        ],
+      },
+    },
   ],
 };

packages/kbn-std/src/merge.ts

@@ -16,6 +16,8 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import isPlainObject from 'lodash/isPlainObject';
 /**
  * Deeply merges two objects, omitting undefined values, and not deeply merging Arrays.

x-pack/plugins/apm/public/components/app/ServiceMap/Cytoscape.tsx

@@ -6,6 +6,8 @@
 
 import cytoscape from 'cytoscape';
 import dagre from 'cytoscape-dagre';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import isEqual from 'lodash/isEqual';
 import React, {
   createContext,

x-pack/plugins/apm/public/components/app/ServiceMap/use_cytoscape_event_handlers.ts

@@ -5,6 +5,8 @@
  */
 
 import cytoscape from 'cytoscape';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import debounce from 'lodash/debounce';
 import { useEffect } from 'react';
 import { EuiTheme, useUiTracker } from '../../../../../observability/public';

x-pack/plugins/enterprise_search/public/applications/workplace_search/components/shared/source_icon/source_icon.tsx

@@ -6,6 +6,8 @@
 
 import React from 'react';
 
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import _camelCase from 'lodash/camelCase';
 
 import { images } from '../assets';

x-pack/plugins/enterprise_search/public/applications/workplace_search/components/shared/source_row/source_row.tsx

@@ -7,6 +7,8 @@
 import React from 'react';
 
 import classNames from 'classnames';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import _kebabCase from 'lodash/kebabCase';
 import { Link } from 'react-router-dom';
 

x-pack/plugins/grokdebugger/public/components/grok_debugger/grok_debugger.js

@@ -5,6 +5,8 @@
  */
 import React from 'react';
 import { i18n } from '@kbn/i18n';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import isEmpty from 'lodash/isEmpty';
 
 import './brace_imports';

x-pack/plugins/index_lifecycle_management/public/application/services/policies/policy_serialization.test.ts

@@ -3,6 +3,8 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import cloneDeep from 'lodash/cloneDeep';
 import { serializePolicy } from './policy_serialization';
 import {

x-pack/plugins/index_lifecycle_management/public/application/services/policies/shared/serialize_phase_with_allocation.ts

@@ -4,6 +4,8 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import cloneDeep from 'lodash/cloneDeep';
 
 import {

x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx

@@ -5,6 +5,8 @@
  */
 
 import { i18n } from '@kbn/i18n';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import flowRight from 'lodash/flowRight';
 import React from 'react';
 import { Redirect, RouteComponentProps } from 'react-router-dom';