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 <[email protected]>

.eslintrc.js

@@ -1233,5 +1233,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';

x-pack/plugins/licensing/public/services/feature_usage_service.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 isDate from 'lodash/isDate';
 import type { HttpSetup, HttpStart } from 'src/core/public';
 import { LicenseType } from '../../common/types';

x-pack/plugins/ml/common/util/job_utils.ts

@@ -4,9 +4,17 @@
  * 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 isEmpty from 'lodash/isEmpty';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import isEqual from 'lodash/isEqual';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import pick from 'lodash/pick';
 
 import semver from 'semver';

x-pack/plugins/ml/public/application/components/annotations/annotations_table/annotations_table.js

@@ -10,6 +10,8 @@
  * getting the annotations via props (used in Anomaly Explorer and Single Series Viewer).
  */
 
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import uniq from 'lodash/uniq';
 
 import PropTypes from 'prop-types';

x-pack/plugins/ml/public/application/components/anomalies_table/anomalies_table.js

@@ -9,6 +9,8 @@
  */
 
 import PropTypes from 'prop-types';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 
 import React, { Component } from 'react';

x-pack/plugins/ml/public/application/components/anomalies_table/anomalies_table_columns.js

@@ -7,6 +7,8 @@
 import { EuiButtonIcon, EuiLink, EuiScreenReaderOnly } from '@elastic/eui';
 
 import React from 'react';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 
 import { i18n } from '@kbn/i18n';

x-pack/plugins/ml/public/application/components/anomalies_table/anomaly_details.js

@@ -11,7 +11,11 @@
 
 import PropTypes from 'prop-types';
 import React, { Component, Fragment } from 'react';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import pick from 'lodash/pick';
 import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n/react';

x-pack/plugins/ml/public/application/components/anomalies_table/influencers_cell.js

@@ -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 each from 'lodash/each';
 import PropTypes from 'prop-types';
 import React, { Component } from 'react';

x-pack/plugins/ml/public/application/components/anomalies_table/links_menu.js

@@ -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 moment from 'moment';
 import rison from 'rison-node';

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/analytics_list/use_table_settings.ts

@@ -6,7 +6,11 @@
 
 import { useState } from 'react';
 import { Direction, EuiBasicTableProps, EuiTableSortingType } from '@elastic/eui';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import sortBy from 'lodash/sortBy';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 
 const PAGE_SIZE = 10;

x-pack/plugins/ml/public/application/datavisualizer/file_based/components/combined_fields/geo_point.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 debounce from 'lodash/debounce';
 import { FormattedMessage } from '@kbn/i18n/react';
 import React, { ChangeEvent, Component, Fragment } from 'react';

x-pack/plugins/ml/public/application/explorer/explorer_charts/explorer_charts_container_service.js

@@ -11,11 +11,23 @@
  * and manages the layout of the charts in the containing div.
  */
 
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import find from 'lodash/find';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import sortBy from 'lodash/sortBy';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import map from 'lodash/map';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import reduce from 'lodash/reduce';
 
 import { buildConfig } from './explorer_chart_config_builder';

x-pack/plugins/ml/public/application/explorer/explorer_charts/explorer_charts_container_service.test.js

@@ -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 mockAnomalyChartRecords from './__mocks__/mock_anomaly_chart_records.json';

x-pack/plugins/ml/public/application/explorer/explorer_swimlane.tsx

@@ -10,8 +10,14 @@
 
 import React from 'react';
 import './_explorer.scss';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import isEqual from 'lodash/isEqual';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import uniq from 'lodash/uniq';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 import d3 from 'd3';
 import moment from 'moment';

x-pack/plugins/ml/public/application/jobs/jobs_list/components/jobs_list/jobs_list.js

@@ -7,6 +7,8 @@
 import PropTypes from 'prop-types';
 import React, { Component } from 'react';
 
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import sortBy from 'lodash/sortBy';
 import moment from 'moment';
 

x-pack/plugins/ml/public/application/services/forecast_service.js

@@ -6,8 +6,14 @@
 
 // Service for carrying out requests to run ML forecasts and to obtain
 // data on forecasts that have been performed.
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import find from 'lodash/find';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import each from 'lodash/each';
 import { map } from 'rxjs/operators';
 

x-pack/plugins/ml/public/application/services/job_service.js

@@ -4,10 +4,20 @@
  * 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';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import find from 'lodash/find';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import isNumber from 'lodash/isNumber';
 import moment from 'moment';
 import { i18n } from '@kbn/i18n';

x-pack/plugins/ml/public/application/services/mapping_service.js

@@ -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 each from 'lodash/each';
 
 import { ml } from './ml_api_service';

x-pack/plugins/ml/public/application/services/results_service/result_service_rx.ts

@@ -13,7 +13,11 @@
 // Returned response contains a results property containing the requested aggregation.
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 import { Dictionary } from '../../../../common/types/common';
 import { ML_MEDIAN_PERCENTS } from '../../../../common/util/job_utils';

x-pack/plugins/ml/public/application/services/results_service/results_service.js

@@ -4,7 +4,11 @@
  * 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 each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 
 import { ML_MEDIAN_PERCENTS } from '../../../../common/util/job_utils';

x-pack/plugins/ml/public/application/timeseriesexplorer/components/forecasting_modal/forecasting_modal.js

@@ -9,6 +9,8 @@
  */
 
 import PropTypes from 'prop-types';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 
 import React, { Component } from 'react';

x-pack/plugins/ml/public/application/timeseriesexplorer/components/timeseries_chart/timeseries_chart.js

@@ -12,9 +12,17 @@
 import PropTypes from 'prop-types';
 import React, { Component } from 'react';
 import useObservable from 'react-use/lib/useObservable';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import isEqual from 'lodash/isEqual';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import reduce from 'lodash/reduce';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
 import d3 from 'd3';
 import moment from 'moment';

x-pack/plugins/ml/public/application/timeseriesexplorer/timeseries_search_service.ts

@@ -4,9 +4,17 @@
  * 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 each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import find from 'lodash/find';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import filter from 'lodash/filter';
 
 import { Observable } from 'rxjs';

x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer_utils/timeseriesexplorer_utils.js

@@ -10,8 +10,14 @@
  * Viewer dashboard.
  */
 
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import each from 'lodash/each';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import get from 'lodash/get';
+// Prefer importing entire lodash library, e.g. import { get } from "lodash"
+// eslint-disable-next-line no-restricted-imports
 import find from 'lodash/find';
 import moment from 'moment-timezone';