🚨(eslint) enable import/order rule

jbpenrath · jbpenrath · commit e91110939904 · 2022-07-22T10:25:13.000+02:00
import/order is a rule of eslint-plugin-import. It sorts import by type then
alphabetically.
diff --git a/.eslintrc b/.eslintrc
@@ -7,9 +7,15 @@
     "plugin:prettier/recommended",
     "plugin:react/recommended"
   ],
-  "plugins": ["@typescript-eslint","react","import","jsx-a11y"],
+  "plugins": ["@typescript-eslint","import","jsx-a11y","react"],
   "rules": {
     "@typescript-eslint/no-unused-vars": "error",
+    "import/order": ["error", {
+      "alphabetize": {
+        "order": "asc",
+        "caseInsensitive": true
+      }
+    }],
     "linebreak-style": "warn",
     "no-duplicate-imports": "error",
     "no-console": ["error"],
diff --git a/examples/playground/src/App.tsx b/examples/playground/src/App.tsx
@@ -1,16 +1,16 @@
+import { VernaProvider, type VernaJSONSchemaType } from '@openfun/verna';
+import type { UiSchema } from '@rjsf/core';
 import { Suspense, useState } from 'react';
 import { FormattedMessage, useIntl, defineMessages } from 'react-intl';
-import type { UiSchema } from '@rjsf/core';
-import { VernaProvider, type VernaJSONSchemaType } from '@openfun/verna';
+import transformErrors from './ErrorCustom';
 import FormWrapper from './FormWrapper';
-import TextWidget from './widgets/TextWidget';
+import CheckboxWidget from './widgets/CheckboxWidget';
+import NumberWidget from './widgets/NumberWidget';
 import PasswordWidget from './widgets/PasswordWidget';
 import QuizWidget from './widgets/QuizWidget';
-import NumberWidget from './widgets/NumberWidget';
 import SelectWidget from './widgets/SelectWidget';
 import TextareaWidget from './widgets/TextareaWidget';
-import CheckboxWidget from './widgets/CheckboxWidget';
-import transformErrors from './ErrorCustom';
+import TextWidget from './widgets/TextWidget';
 import ':/styles/verna.scss';
 
 const messages = defineMessages({
diff --git a/examples/playground/src/FormWrapper.tsx b/examples/playground/src/FormWrapper.tsx
@@ -1,15 +1,15 @@
 import { useVerna, VernaForm, VernaToolbar } from '@openfun/verna';
 import { JSONSchema7 } from 'json-schema';
 import { defineMessages, FormattedMessage } from 'react-intl';
-import TextWidget from './widgetToolbarItems/TextWidget';
+import { useLocale } from './providers/LocaleProvider';
+import CheckboxesWidget from './widgetToolbarItems/CheckboxesWidget';
+import CheckboxWidget from './widgetToolbarItems/CheckboxWidget';
+import NumberWidget from './widgetToolbarItems/NumberWidget';
 import PasswordWidget from './widgetToolbarItems/PasswordWidget';
 import QuizWidget from './widgetToolbarItems/QuizWidget';
-import TextareaWidget from './widgetToolbarItems/TextareaWidget';
-import NumberWidget from './widgetToolbarItems/NumberWidget';
-import CheckboxWidget from './widgetToolbarItems/CheckboxWidget';
 import SelectWidget from './widgetToolbarItems/SelectWidget';
-import CheckboxesWidget from './widgetToolbarItems/CheckboxesWidget';
-import { useLocale } from './providers/LocaleProvider';
+import TextareaWidget from './widgetToolbarItems/TextareaWidget';
+import TextWidget from './widgetToolbarItems/TextWidget';
 
 interface FormWrapperProps {
   toggleEditorMode: () => void;
diff --git a/examples/playground/src/providers/TranslationProvider.tsx b/examples/playground/src/providers/TranslationProvider.tsx
@@ -1,5 +1,5 @@
-import { IntlProvider } from 'react-intl';
 import { PropsWithChildren } from 'react';
+import { IntlProvider } from 'react-intl';
 import { useLocale } from './LocaleProvider';
 import en from ':/translations/en-US.json';
 import fr from ':/translations/fr-FR.json';
diff --git a/examples/playground/src/widgets/QuizWidget.tsx b/examples/playground/src/widgets/QuizWidget.tsx
@@ -1,5 +1,5 @@
-import { ChangeEvent, useState } from 'react';
 import type { VernaWidgetProps } from '@openfun/verna/dist/types/Widgets';
+import { ChangeEvent, useState } from 'react';
 
 export default function QuizWidget(props: VernaWidgetProps) {
   const choices = ['a', 'b', 'c', 'd'] as const;
diff --git a/examples/playground/src/widgets/templates/TextTemplateWidget.tsx b/examples/playground/src/widgets/templates/TextTemplateWidget.tsx
@@ -1,5 +1,5 @@
-import Field, { FieldProps } from './Field';
 import { ChangeEventHandler, InputHTMLAttributes } from 'react';
+import Field, { FieldProps } from './Field';
 
 interface TextTemplateWidgetProps extends InputHTMLAttributes<unknown>, FieldProps {
   label: string;
diff --git a/lib/src/components/EditorFieldTemplate/DropZone.tsx b/lib/src/components/EditorFieldTemplate/DropZone.tsx
@@ -1,8 +1,8 @@
 import React, { useState } from 'react';
 import { v4 as uuidv4 } from 'uuid';
+import { useVerna } from ':/providers/VernaProvider';
 import ShowCaseWidgetProps from ':/types/Widgets';
 import { addWidget } from ':/utils/schema';
-import { useVerna } from ':/providers/VernaProvider';
 
 export interface DropZoneProps {
   id: string;
diff --git a/lib/src/components/EditorFieldTemplate/index.tsx b/lib/src/components/EditorFieldTemplate/index.tsx
@@ -1,12 +1,12 @@
-import React, { useState } from 'react';
 import type { FieldTemplateProps } from '@rjsf/core';
+import React, { useState } from 'react';
 import { defineMessages, FormattedMessage } from 'react-intl';
 import { v4 as uuidv4 } from 'uuid';
-import ShowCaseWidgetProps from ':/types/Widgets';
-import { RJSF_ID_SEPARATOR } from ':/settings';
+import WidgetPropertiesForm from ':/components/PropertiesForms/WidgetPropertiesForm';
 import { useVerna } from ':/providers/VernaProvider';
+import { RJSF_ID_SEPARATOR } from ':/settings';
+import ShowCaseWidgetProps from ':/types/Widgets';
 import { addWidget, addSection, removeSection, removeWidget } from ':/utils/schema';
-import WidgetPropertiesForm from ':/components/PropertiesForms/WidgetPropertiesForm';
 
 const messages = defineMessages({
   addInput: {
diff --git a/lib/src/components/Fields/Section.tsx b/lib/src/components/Fields/Section.tsx
@@ -1,8 +1,8 @@
-import { defineMessages, FormattedMessage } from 'react-intl';
 import type { ObjectFieldTemplateProps } from '@rjsf/core';
 import React, { useState } from 'react';
-import { useVerna } from ':/providers/VernaProvider';
+import { defineMessages, FormattedMessage } from 'react-intl';
 import SectionPropertiesForm from ':/components/PropertiesForms/SectionPropertiesForm';
+import { useVerna } from ':/providers/VernaProvider';
 
 const messages = defineMessages({
   parameters: {
diff --git a/lib/src/components/PropertiesForms/SectionPropertiesForm.tsx b/lib/src/components/PropertiesForms/SectionPropertiesForm.tsx
@@ -1,11 +1,11 @@
 import Form, { type ISubmitEvent, type UiSchema } from '@rjsf/core';
-import { defineMessages, useIntl } from 'react-intl';
 import { FormEvent, useMemo } from 'react';
+import { defineMessages, useIntl } from 'react-intl';
 import { useVerna } from ':/providers/VernaProvider';
 import { RJSF_ID_SEPARATOR } from ':/settings';
-import { DEFAULT_PROPERTY_TRANSLATION } from ':/utils/translation';
 import { sectionParametersSchema } from ':/templates';
 import { SectionParameters, updateSectionProperties } from ':/utils/schema/updateSectionProperties';
+import { DEFAULT_PROPERTY_TRANSLATION } from ':/utils/translation';
 
 interface SectionPropertiesFormProps {
   onClose: () => void;
diff --git a/lib/src/components/PropertiesForms/WidgetPropertiesForm.tsx b/lib/src/components/PropertiesForms/WidgetPropertiesForm.tsx
@@ -1,15 +1,15 @@
 import Form, { type ISubmitEvent, type UiSchema } from '@rjsf/core';
-import { defineMessages, useIntl } from 'react-intl';
-import { FormEvent, useMemo } from 'react';
 import _ from 'lodash';
+import { FormEvent, useMemo } from 'react';
+import { defineMessages, useIntl } from 'react-intl';
 import { useVerna } from ':/providers/VernaProvider';
-import { getUiWidgetName } from ':/utils';
 import { RJSF_ID_SEPARATOR } from ':/settings';
+import { defaultWidgetProps } from ':/templates';
 import type VernaJSONSchemaType from ':/types/rjsf';
+import { Maybe } from ':/types/utils';
+import { getUiWidgetName } from ':/utils';
 import { Properties, updateWidgetProperties } from ':/utils/schema';
 import { DEFAULT_PROPERTY_TRANSLATION } from ':/utils/translation';
-import { Maybe } from ':/types/utils';
-import { defaultWidgetProps } from ':/templates';
 
 interface WidgetPropertiesFormProps {
   onClose: () => void;
diff --git a/lib/src/components/VernaForm/index.spec.tsx b/lib/src/components/VernaForm/index.spec.tsx
@@ -1,16 +1,16 @@
 import { type UiSchema } from '@rjsf/core';
 import { screen, render, waitFor } from '@testing-library/react';
-import { Suspense } from 'react';
-import _ from 'lodash';
 import userEvent from '@testing-library/user-event';
+import _ from 'lodash';
+import { Suspense } from 'react';
+import VernaForm from ':/components/VernaForm';
 import VernaProvider, { WidgetsType } from ':/providers/VernaProvider';
 import {
   schemaFactory,
   translationsFactory,
   uiSchemaFactory,
   widgetsFactory,
 } from ':/tests/mocks/factories';
-import VernaForm from ':/components/VernaForm';
 import { resolvePromisesOneByOne } from ':/tests/utils';
 
 describe('VernaForm', () => {
diff --git a/lib/src/components/VernaForm/index.tsx b/lib/src/components/VernaForm/index.tsx
@@ -1,6 +1,6 @@
 import Form from '@rjsf/core';
-import { useIntl } from 'react-intl';
 import { useMemo } from 'react';
+import { useIntl } from 'react-intl';
 import { useVerna } from ':/providers/VernaProvider';
 import { RJSF_ID_SEPARATOR } from ':/settings';
 import { translateSchema } from ':/utils/translation';
diff --git a/lib/src/index.ts b/lib/src/index.ts
@@ -1,7 +1,7 @@
+import Section from ':/components/Fields/Section';
 import VernaForm from ':/components/VernaForm';
-import VernaProvider, { useVerna } from ':/providers/VernaProvider';
 import VernaToolbar from ':/components/VernaToolbar';
-import Section from ':/components/Fields/Section';
+import VernaProvider, { useVerna } from ':/providers/VernaProvider';
 import type VernaJSONSchemaType from ':/types/rjsf';
 
 export { VernaForm, VernaProvider, useVerna, VernaToolbar, Section };
diff --git a/lib/src/providers/TranslationProvider/index.tsx b/lib/src/providers/TranslationProvider/index.tsx
@@ -1,8 +1,8 @@
 import { PropsWithChildren, useMemo } from 'react';
 import { createIntl, createIntlCache, RawIntlProvider, type ResolvedIntlConfig } from 'react-intl';
-import resourceLoader, { type ResourceLoader } from ':/utils/suspense/resourceLoader';
 import { VERNA_SUPPORTED_LOCALES } from ':/settings';
 import { TranslationType } from ':/types/translations';
+import resourceLoader, { type ResourceLoader } from ':/utils/suspense/resourceLoader';
 
 interface TranslationProviderProps {
   defaultLocale?: string;
diff --git a/lib/src/providers/VernaProvider/index.spec.tsx b/lib/src/providers/VernaProvider/index.spec.tsx
@@ -1,13 +1,13 @@
 import { render, screen, waitFor } from '@testing-library/react';
 import { Suspense } from 'react';
+import VernaProvider, { type VernaProviderProps } from '.';
+import VernaForm from ':/components/VernaForm';
 import {
   schemaFactory,
   translationsFactory,
   uiSchemaFactory,
   widgetsFactory,
 } from ':/tests/mocks/factories';
-import VernaForm from ':/components/VernaForm';
-import VernaProvider, { type VernaProviderProps } from '.';
 
 describe('custom render components', () => {
   const VernaSuspenseWrapper = (props: Partial<VernaProviderProps>) => (
diff --git a/lib/src/providers/VernaProvider/index.tsx b/lib/src/providers/VernaProvider/index.tsx
@@ -1,37 +1,37 @@
+import type {
+  FieldTemplateProps,
+  FormProps,
+  ISubmitEvent,
+  ObjectFieldTemplateProps,
+  UiSchema,
+  Widget,
+} from '@rjsf/core';
 import React, {
-  createContext,
   FormEvent,
   PropsWithChildren,
+  createContext,
   useContext,
   useEffect,
   useMemo,
   useState,
 } from 'react';
 import { type ResolvedIntlConfig } from 'react-intl';
-import type {
-  FieldTemplateProps,
-  FormProps,
-  ISubmitEvent,
-  ObjectFieldTemplateProps,
-  UiSchema,
-  Widget,
-} from '@rjsf/core';
+import EditorFieldTemplate from ':/components/EditorFieldTemplate';
+import {
+  default as DefaultDropZone,
+  DropZoneProps,
+} from ':/components/EditorFieldTemplate/DropZone';
+import { default as DefaultSection } from ':/components/Fields/Section';
+import TranslationProvider from ':/providers/TranslationProvider';
 import { defaultVernaWidgets } from ':/templates';
 import VernaJSONSchemaType from ':/types/rjsf';
+import { TranslationType } from ':/types/translations';
 import {
   cleanUiSchema,
   getSelectedDefaultValues,
   getSelectedSchema,
   getSelectedUiSchema,
 } from ':/utils/schema';
-import { TranslationType } from ':/types/translations';
-import TranslationProvider from ':/providers/TranslationProvider';
-import { default as DefaultSection } from ':/components/Fields/Section';
-import EditorFieldTemplate from ':/components/EditorFieldTemplate';
-import {
-  default as DefaultDropZone,
-  DropZoneProps,
-} from ':/components/EditorFieldTemplate/DropZone';
 
 function functionNotSet() {
   throw new Error('function context not set');
diff --git a/lib/src/tests/Sections.spec.tsx b/lib/src/tests/Sections.spec.tsx
@@ -1,6 +1,7 @@
 import { fireEvent, render, screen, waitFor } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { Suspense } from 'react';
+import VernaForm from ':/components/VernaForm';
 import VernaProvider from ':/providers/VernaProvider';
 import {
   selectSchemaFactory,
@@ -9,7 +10,6 @@ import {
   confSchemaFactory,
   widgetsFactory,
 } from ':/tests/mocks/factories';
-import VernaForm from ':/components/VernaForm';
 import VernaJSONSchemaType from ':/types/rjsf';
 
 describe('section properties edition', () => {
diff --git a/lib/src/tests/Widgets.spec.tsx b/lib/src/tests/Widgets.spec.tsx
@@ -1,6 +1,7 @@
 import { fireEvent, render, screen, waitFor } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { Suspense } from 'react';
+import VernaForm from ':/components/VernaForm';
 import VernaProvider from ':/providers/VernaProvider';
 import {
   selectSchemaFactory,
@@ -9,7 +10,6 @@ import {
   confSchemaFactory,
   widgetsFactory,
 } from ':/tests/mocks/factories';
-import VernaForm from ':/components/VernaForm';
 import VernaJSONSchemaType from ':/types/rjsf';
 
 describe('widget properties edition', () => {
diff --git a/lib/src/tests/errors.spec.tsx b/lib/src/tests/errors.spec.tsx
@@ -1,15 +1,15 @@
-import userEvent from '@testing-library/user-event';
 import type { AjvError } from '@rjsf/core';
+import { render, screen, waitFor } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
 import { Suspense } from 'react';
+import VernaForm from ':/components/VernaForm';
+import VernaProvider from ':/providers/VernaProvider';
 import {
   schemaFactory,
   translationsFactory,
   uiSchemaFactory,
   widgetsFactory,
 } from ':/tests/mocks/factories';
-import { render, screen, waitFor } from '@testing-library/react';
-import VernaProvider from ':/providers/VernaProvider';
-import VernaForm from ':/components/VernaForm';
 
 describe('custom errors', () => {
   function transformErrors(errors: AjvError[]): AjvError[] {
diff --git a/lib/src/tests/mocks/factories.ts b/lib/src/tests/mocks/factories.ts
@@ -1,9 +1,9 @@
 import type { UiSchema } from '@rjsf/core';
 import { merge } from 'lodash';
+import NumberWidget from './NumberWidget';
+import SelectWidget from './SelectWidget';
 import VernaJSONSchemaType from ':/types/rjsf';
 import { TranslationType } from ':/types/translations';
-import SelectWidget from './SelectWidget';
-import NumberWidget from './NumberWidget';
 
 const schemaFactory = (): VernaJSONSchemaType => ({
   description: 'root_description',
diff --git a/lib/src/tests/mocks/templates/TextTemplateWidget.tsx b/lib/src/tests/mocks/templates/TextTemplateWidget.tsx
@@ -1,5 +1,5 @@
-import Field, { FieldProps } from './Field';
 import { ChangeEventHandler, InputHTMLAttributes } from 'react';
+import Field, { FieldProps } from './Field';
 
 interface TextTemplateWidgetProps extends InputHTMLAttributes<unknown>, FieldProps {
   label: string;
diff --git a/lib/src/types/Widgets.ts b/lib/src/types/Widgets.ts
@@ -1,5 +1,5 @@
-import { JSONSchema7TypeName } from 'json-schema';
 import type { WidgetProps } from '@rjsf/core';
+import { JSONSchema7TypeName } from 'json-schema';
 import { ChangeEventHandler } from 'react';
 
 export default interface ShowCaseWidgetProps {
diff --git a/lib/src/utils/schema/adders.ts b/lib/src/utils/schema/adders.ts
@@ -1,10 +1,10 @@
-import { v4 as uuidv4 } from 'uuid';
-import React from 'react';
 import type { ObjectFieldTemplateProps } from '@rjsf/core';
-import { getWidgetName, getSectionName } from ':/utils';
+import React from 'react';
+import { v4 as uuidv4 } from 'uuid';
 import { VernaContextProps } from ':/providers/VernaProvider';
 import { sectionDefinition, stringDefinition } from ':/templates';
 import ShowCaseWidgetProps from ':/types/Widgets';
+import { getWidgetName, getSectionName } from ':/utils';
 
 function addWidgetToUiSchemaWithSelector(
   verna: VernaContextProps,
diff --git a/lib/src/utils/schema/cleaners.ts b/lib/src/utils/schema/cleaners.ts
@@ -1,7 +1,7 @@
-import React from 'react';
 import type { ObjectFieldTemplateProps, UiSchema } from '@rjsf/core';
-import VernaJSONSchemaType from ':/types/rjsf';
+import React from 'react';
 import Section from ':/components/Fields/Section';
+import VernaJSONSchemaType from ':/types/rjsf';
 import { Maybe } from ':/types/utils';
 
 /**
diff --git a/lib/src/utils/schema/updateWidgetProperties.ts b/lib/src/utils/schema/updateWidgetProperties.ts
@@ -1,8 +1,8 @@
 import _ from 'lodash';
+import { updateProperty, updateRequired } from './widgetPropertyUpdaters';
 import { VernaContextProps } from ':/providers/VernaProvider';
 import { RJSF_ID_SEPARATOR } from ':/settings';
 import VernaJSONSchemaType from ':/types/rjsf';
-import { updateProperty, updateRequired } from './widgetPropertyUpdaters';
 
 type Maybe<T> = T | undefined;
 export type Properties = {
diff --git a/lib/src/utils/schema/widgetPropertyUpdaters.ts b/lib/src/utils/schema/widgetPropertyUpdaters.ts
@@ -1,8 +1,8 @@
+import type { Properties } from './updateWidgetProperties';
 import { VernaContextProps } from ':/providers/VernaProvider';
-import VernaJSONSchemaType from ':/types/rjsf';
 import { RJSF_ID_SEPARATOR } from ':/settings';
+import VernaJSONSchemaType from ':/types/rjsf';
 import { Maybe } from ':/types/utils';
-import type { Properties } from './updateWidgetProperties';
 
 /**
  * Generate the translation key based on those parameters
diff --git a/lib/src/utils/translation/index.spec.tsx b/lib/src/utils/translation/index.spec.tsx
