Merge pull request #111 from AFatNiBBa/exportName

Added and handled the `PluginOptions.exportName` property

Author: activeguild

README.md

@@ -29,6 +29,7 @@ we have confirmed that it does not work with the [sass](https://www.npmjs.com/pa
 | global.generate       | boolean                                | Outputs the common style set in <b>additionalData</b> of <b>preprocessorOptions</b> as a global type definition file.                                                                                                                                                                                                                                                 |
 | global.outputFilePath | string                                 | Specify the file that outputs the global common style with an absolute path.Relative paths will be supported.                                                                                                                                                                                                                                                         |
 | typeName.replacement  | string \| (fileName: string) => string | Type name can be changed to any value. (default is the classname key as a string. e.g. `theClassName: 'theClassName';`)                                                                                                                                                                                                                                               |
+| exportName.replacement  | string \| (fileName: string) => string | Export name can be changed to any value. (default is 'classNames'. e.g. `declare const classNames: { ... };`)                                                                                                                                                                                                                                               |
 | outputDir             | string                                 | An absolute path to the output directory. If undefined, declaration files will be generated in the source directories. `)                                                                                                                                                                                                                                             |
 | sourceDir             | string                                 | An absolute path to your source code directory. The plugin will replace this path with `outputDir` option when writing declaration files. `)                                                                                                                                                                                                                          |
 | esmExport             | boolean                                | Specify dts export type. If enabled, going to use ESM style export `export default ...`. Otherwise `export = ...`.                                                                                                                                                                                                                                                    |

src/type.ts

@@ -10,7 +10,8 @@ export type AdditionalData =
 export type PluginOptions = {
   enabledMode?: ('development' | 'production')[]
   global?: { generate: boolean; outputFilePath: string }
-  typeName?: { replacement: string | ((fileName: string) => string) }
+  typeName?: ContentReplacer
+  exportName?: ContentReplacer
   esmExport?: boolean
   outputDir?: string
   sourceDir?: string
@@ -28,6 +29,10 @@ export type CSSJSObj = Record<
 
 export type GetParseCaseFunction = ((target: string) => string) | undefined
 
+export type ContentReplacer = {
+  replacement: string | ((fileName: string) => string)
+}
+
 export type CssUrlReplacer = (
   url: string,
   importer?: string

src/write.ts

@@ -4,7 +4,7 @@ import prettier from 'prettier'
 const { format } = prettier
 
 import { type Options } from 'prettier'
-import { PluginOptions } from 'type'
+import { ContentReplacer, PluginOptions } from 'type'
 import { getRelativePath } from './util'
 import path from 'path'
 import { mkdir } from 'node:fs/promises'
@@ -15,12 +15,15 @@ export const writeToFile = async (
   classNameKeys: Map<string, boolean>,
   options?: PluginOptions
 ) => {
-  const typeName = getTypeName(path.basename(fileName), options)
+  const baseName = path.basename(fileName)
+  const typeName = getReplacerResult(baseName, options?.typeName)
+  const exportName =
+    getReplacerResult(baseName, options?.exportName) ?? 'classNames'
   let exportTypes = ''
   let namedExports = ''
   const exportStyle = options?.esmExport
-    ? 'export default classNames;'
-    : 'export = classNames;'
+    ? `export default ${exportName};`
+    : `export = ${exportName};`
   for (const classNameKey of classNameKeys.keys()) {
     exportTypes = `${exportTypes}\n${formatExportType(classNameKey, typeName)}`
     namedExports = `${namedExports}\nexport const ${classNameKey}: '${
@@ -38,12 +41,12 @@ export const writeToFile = async (
       options.global.outputFilePath
     )
     outputFileString = `import globalClassNames from '${relativePath}${exportTypeFileName}'\n`
-    outputFileString = `declare const classNames: typeof globalClassNames & {${exportTypes}\n};\n${exportStyle}`
+    outputFileString = `declare const ${exportName}: typeof globalClassNames & {${exportTypes}\n};\n${exportStyle}`
     if (options?.useNamedExport) {
       outputFileString = `${outputFileString}\n${namedExports}\n\n`
     }
   } else {
-    outputFileString = `declare const classNames: {${exportTypes}\n};\n${exportStyle}`
+    outputFileString = `declare const ${exportName}: {${exportTypes}\n};\n${exportStyle}`
     if (options?.useNamedExport) {
       outputFileString = `${outputFileString}\n\n${namedExports}`
     }
@@ -66,12 +69,15 @@ export const writeToFile = async (
   })
 }
 
-export const getTypeName = (fileName: string, options?: PluginOptions) => {
-  if (options && options.typeName && options.typeName.replacement) {
-    if (typeof options.typeName.replacement === 'function') {
-      return options.typeName.replacement(fileName)
+export const getReplacerResult = (
+  fileName: string,
+  replacer?: ContentReplacer
+) => {
+  if (replacer && replacer.replacement) {
+    if (typeof replacer.replacement === 'function') {
+      return replacer.replacement(fileName)
     } else {
-      return options.typeName.replacement
+      return replacer.replacement
     }
   }