refactor: extract Snippet union types to break import cycle

Author: ice-chillios

CHANGELOG.md

@@ -45,10 +45,6 @@ First release under the **r5n** publisher with full React 17–19 support and a
 - Babel/Jest ESLint plugins and `@babel/eslint-parser` (unused — repo has no test suite or `.js` source files).
 - Legacy `@babel/cli`, `@babel/preset-typescript` devDependencies.
 
-### Known issues
-
-- Circular dependency between `src/helpers/parseSnippetToBody.ts` and `src/helpers/generateSnippets.ts` (type-only import of `Snippet`). Currently surfaced as a lint warning; will be fixed before `5.0.0` GA by extracting shared types to `src/types.ts`.
-
 ## [4.4.0] - 2020-12-18
 
 - Enable extension after startup finish to respect and parse snippets on settings change.

src/helpers/generateSnippets.ts

@@ -1,24 +1,17 @@
 import path from 'path';
 import { window } from 'vscode';
 
-import componentsSnippets, {
-  ComponentsSnippet,
-} from '../sourceSnippets/components';
-import consoleSnippets, { ConsoleSnippet } from '../sourceSnippets/console';
-import hooksSnippets, { HooksSnippet } from '../sourceSnippets/hooks';
-import importsSnippets, { ImportsSnippet } from '../sourceSnippets/imports';
-import othersSnippets, { OthersSnippet } from '../sourceSnippets/others';
-import propTypesSnippets, {
-  PropTypesSnippet,
-} from '../sourceSnippets/propTypes';
-import reactNativeSnippets, {
-  ReactNativeSnippet,
-} from '../sourceSnippets/reactNative';
-import reduxSnippets, { ReduxSnippet } from '../sourceSnippets/redux';
-import testsSnippets, { TestsSnippet } from '../sourceSnippets/tests';
-import typescriptSnippets, {
-  TypescriptSnippet,
-} from '../sourceSnippets/typescript';
+import componentsSnippets from '../sourceSnippets/components';
+import consoleSnippets from '../sourceSnippets/console';
+import hooksSnippets from '../sourceSnippets/hooks';
+import importsSnippets from '../sourceSnippets/imports';
+import othersSnippets from '../sourceSnippets/others';
+import propTypesSnippets from '../sourceSnippets/propTypes';
+import reactNativeSnippets from '../sourceSnippets/reactNative';
+import reduxSnippets from '../sourceSnippets/redux';
+import testsSnippets from '../sourceSnippets/tests';
+import typescriptSnippets from '../sourceSnippets/typescript';
+import { Snippets } from '../snippetTypes';
 import { writeFile } from 'fs/promises';
 
 import extensionConfig from './extensionConfig';
@@ -49,34 +42,6 @@ const validateLanguageScopes = (scopes: string) => {
   return valid.length > 0 ? valid.join(',') : VALID_LANGUAGE_SCOPES.join(',');
 };
 
-export type SnippetKeys =
-  | OthersSnippet['key']
-  | HooksSnippet['key']
-  | ImportsSnippet['key']
-  | ReactNativeSnippet['key']
-  | TypescriptSnippet['key']
-  | ReduxSnippet['key']
-  | ComponentsSnippet['key']
-  | ConsoleSnippet['key']
-  | PropTypesSnippet['key']
-  | TestsSnippet['key'];
-
-export type Snippet =
-  | OthersSnippet
-  | HooksSnippet
-  | ImportsSnippet
-  | ReactNativeSnippet
-  | TypescriptSnippet
-  | ReduxSnippet
-  | ComponentsSnippet
-  | ConsoleSnippet
-  | PropTypesSnippet
-  | TestsSnippet;
-
-export type Snippets = {
-  [key in SnippetKeys]: Snippet;
-};
-
 const getSnippets = () => {
   const { typescript, languageScopes: rawScopes } = extensionConfig();
   const languageScopes = validateLanguageScopes(rawScopes);

src/helpers/parseSnippetToBody.ts

@@ -1,5 +1,6 @@
+import { Snippet } from '../snippetTypes';
+
 import extensionConfig from './extensionConfig';
-import { Snippet } from './generateSnippets';
 import replaceOrRemoveReactImport from './replaceOrRemoveReactImport';
 
 const parseSnippetToBody = (snippet: Snippet) => {

src/helpers/snippetSearch.ts

@@ -3,8 +3,9 @@ import { commands, SnippetString, window } from 'vscode';
 
 import { readFile } from 'fs/promises';
 
+import { Snippet } from '../snippetTypes';
+
 import { parseSnippet } from './formatters';
-import { Snippet } from './generateSnippets';
 
 const snippetSearch = async () => {
   const { showQuickPick, activeTextEditor } = window;

src/snippetTypes.ts

@@ -0,0 +1,38 @@
+import { ComponentsSnippet } from './sourceSnippets/components';
+import { ConsoleSnippet } from './sourceSnippets/console';
+import { HooksSnippet } from './sourceSnippets/hooks';
+import { ImportsSnippet } from './sourceSnippets/imports';
+import { OthersSnippet } from './sourceSnippets/others';
+import { PropTypesSnippet } from './sourceSnippets/propTypes';
+import { ReactNativeSnippet } from './sourceSnippets/reactNative';
+import { ReduxSnippet } from './sourceSnippets/redux';
+import { TestsSnippet } from './sourceSnippets/tests';
+import { TypescriptSnippet } from './sourceSnippets/typescript';
+
+export type SnippetKeys =
+  | OthersSnippet['key']
+  | HooksSnippet['key']
+  | ImportsSnippet['key']
+  | ReactNativeSnippet['key']
+  | TypescriptSnippet['key']
+  | ReduxSnippet['key']
+  | ComponentsSnippet['key']
+  | ConsoleSnippet['key']
+  | PropTypesSnippet['key']
+  | TestsSnippet['key'];
+
+export type Snippet =
+  | OthersSnippet
+  | HooksSnippet
+  | ImportsSnippet
+  | ReactNativeSnippet
+  | TypescriptSnippet
+  | ReduxSnippet
+  | ComponentsSnippet
+  | ConsoleSnippet
+  | PropTypesSnippet
+  | TestsSnippet;
+
+export type Snippets = {
+  [key in SnippetKeys]: Snippet;
+};