refactor: Standardized options.ts

Author: ijlee2

src/options.ts

@@ -1,29 +1,29 @@
-import type { Node } from '@babel/types';
 import type {
   BooleanSupportOption,
   ParserOptions,
   SupportOptions,
 } from 'prettier';
 
-export interface Options extends ParserOptions<Node | undefined> {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export interface PluginOptions<T = any> extends ParserOptions<T> {
   templateExportDefault?: boolean;
   templateSingleQuote?: boolean;
 }
 
 const templateExportDefault: BooleanSupportOption = {
   category: 'Format',
-  type: 'boolean',
   default: false,
   description:
     'Prepend default export template tags with "export default". Since 0.1.0.',
+  type: 'boolean',
 };
 
 /**
  * Extracts a valid `templateSingleQuote` option out of the provided options. If
  * `templateSingleQuote` is defined, it will be used, otherwise the value for
  * `singleQuote` will be inherited.
  */
-export function getTemplateSingleQuote(options: Options): boolean {
+export function getTemplateSingleQuote(options: PluginOptions): boolean {
   const { singleQuote, templateSingleQuote } = options;
   return typeof templateSingleQuote === 'boolean'
     ? templateSingleQuote
@@ -32,9 +32,9 @@ export function getTemplateSingleQuote(options: Options): boolean {
 
 const templateSingleQuote: BooleanSupportOption = {
   category: 'Format',
-  type: 'boolean',
   description:
     'Use single quotes instead of double quotes within template tags. Since 0.0.3.',
+  type: 'boolean',
 };
 
 export const options: SupportOptions = {

src/parse/index.ts

@@ -9,7 +9,7 @@ import type {
 import type { Parser } from 'prettier';
 import { parsers as babelParsers } from 'prettier/plugins/babel.js';
 
-import type { Options } from '../options.js';
+import type { PluginOptions } from '../options.js';
 import { assert } from '../utils/assert.js';
 import { PRINTER_NAME } from '../utils/index.js';
 import { preprocess, type Template } from './preprocess.js';
@@ -94,7 +94,7 @@ export const parser: Parser<Node | undefined> = {
   ...typescript,
   astFormat: PRINTER_NAME,
 
-  async parse(code: string, options: Options): Promise<Node> {
+  async parse(code: string, options: PluginOptions): Promise<Node> {
     const preprocessed = preprocess(code, options.filepath);
 
     const ast = await typescript.parse(preprocessed.code, options);

src/print/ambiguity.ts

@@ -2,7 +2,7 @@ import type { Node } from '@babel/types';
 import type { AstPath, doc, Printer } from 'prettier';
 import { printers as estreePrinters } from 'prettier/plugins/estree.js';
 
-import type { Options } from '../options.js';
+import type { PluginOptions } from '../options.js';
 import { flattenDoc } from '../utils/doc.js';
 
 const estreePrinter = estreePrinters['estree'] as Printer<Node | undefined>;
@@ -31,7 +31,7 @@ export function saveCurrentPrintOnSiblingNode(
 export function fixPreviousPrint(
   previousTemplatePrinted: doc.builders.Doc[],
   path: AstPath<Node | undefined>,
-  options: Options,
+  options: PluginOptions,
   print: (path: AstPath<Node | undefined>) => doc.builders.Doc,
   args: unknown,
 ): void {

src/print/index.ts

@@ -7,7 +7,7 @@ import type {
 } from 'prettier';
 import { printers as estreePrinters } from 'prettier/plugins/estree.js';
 
-import type { Options } from '../options.js';
+import type { PluginOptions } from '../options.js';
 import {
   isGlimmerTemplate,
   isGlimmerTemplateParent,
@@ -34,7 +34,7 @@ export const printer: Printer<Node | undefined> = {
 
   print(
     path: AstPath<Node | undefined>,
-    options: Options,
+    options: PluginOptions,
     print: (path: AstPath<Node | undefined>) => doc.builders.Doc,
     args: unknown,
   ) {
@@ -98,22 +98,22 @@ export const printer: Printer<Node | undefined> = {
     return async (textToDoc) => {
       if (node && isGlimmerTemplate(node)) {
         if (checkPrettierIgnore(path)) {
-          return printRawText(path, embedOptions as Options);
+          return printRawText(path, embedOptions as PluginOptions);
         }
 
         try {
           const content = await printTemplateContent(
             node.extra.template.contents,
             textToDoc,
-            embedOptions as Options,
+            embedOptions as PluginOptions,
           );
 
           const printed = printTemplateTag(content);
           saveCurrentPrintOnSiblingNode(path, printed);
           return printed;
         } catch (error) {
           console.error(error);
-          const printed = [printRawText(path, embedOptions as Options)];
+          const printed = [printRawText(path, embedOptions as PluginOptions)];
           saveCurrentPrintOnSiblingNode(path, printed);
           return printed;
         }
@@ -138,7 +138,7 @@ function trimPrinted(printed: doc.builders.Doc[]): void {
 
 function printRawText(
   { node }: AstPath<Node | undefined>,
-  options: Options,
+  options: PluginOptions,
 ): string {
   if (!node) {
     return '';

src/print/template.ts

@@ -1,7 +1,7 @@
 import type { Options as PrettierOptions } from 'prettier';
 import { doc } from 'prettier';
 
-import type { Options } from '../options.js';
+import type { PluginOptions } from '../options.js';
 import { getTemplateSingleQuote } from '../options.js';
 import { flattenDoc } from '../utils/doc.js';
 import { TEMPLATE_TAG_CLOSE, TEMPLATE_TAG_OPEN } from '../utils/index.js';
@@ -25,7 +25,7 @@ export async function printTemplateContent(
     // should normalize them into standard Prettier options at this point.
     options: PrettierOptions,
   ) => Promise<doc.builders.Doc>,
-  options: Options,
+  options: PluginOptions,
 ): Promise<doc.builders.Doc> {
   return await textToDoc(text.trim(), {
     ...options,

tests/helpers/ambiguous.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'vitest';
 
-import type { Options } from '../../src/options.js';
+import type { PluginOptions } from '../../src/options.js';
 import { parse } from '../../src/utils/content-tag.js';
 import type { TestCase } from '../helpers/cases.js';
 import { getAllCases } from '../helpers/cases.js';
@@ -89,7 +89,7 @@ export function makeAmbiguousExpressionTest(
 
 async function behavesLikeFormattedAmbiguousCase(
   code: string,
-  formatOptions: Partial<Options> = {},
+  formatOptions: Partial<PluginOptions> = {},
 ): Promise<void> {
   try {
     const result = await format(code, formatOptions);

tests/helpers/format.ts

@@ -2,9 +2,9 @@ import type { Plugin } from 'prettier';
 import { format as prettierFormat } from 'prettier';
 
 import plugin from '../../src/main.js';
-import type { Options } from '../../src/options.js';
+import type { PluginOptions } from '../../src/options.js';
 
-const DEFAULT_OPTIONS: Partial<Options> = {
+const DEFAULT_OPTIONS: Partial<PluginOptions> = {
   parser: 'ember-template-tag',
   plugins: [plugin as Plugin],
 };
@@ -17,7 +17,7 @@ const DEFAULT_OPTIONS: Partial<Options> = {
  */
 export async function format(
   code: string,
-  overrides: Partial<Options> = {},
+  overrides: Partial<PluginOptions> = {},
 ): Promise<string> {
   return await prettierFormat(code, {
     ...DEFAULT_OPTIONS,

tests/helpers/make-suite.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'vitest';
 
-import type { Options } from '../../src/options.js';
+import type { PluginOptions } from '../../src/options.js';
 import {
   AMBIGUOUS_PLACEHOLDER,
   getAmbiguousCases,
@@ -12,7 +12,7 @@ import { format } from './format.js';
 
 export interface Config {
   name: string;
-  options?: Partial<Options>;
+  options?: Partial<PluginOptions>;
 }
 
 /**