feat: improve code splitting by introducing subpackage entry points

.eslintrc

@@ -16,7 +16,7 @@
     "import/no-extraneous-dependencies": [
       "error",
       {
-        "devDependencies": ["test/**", "**/*.test.js", "**/*.test.ts"],
+        "devDependencies": ["test/**", "**/*.test.js", "**/*.test.ts", "tsup.config.ts"],
         "packageDir": ["./"]
       }
     ],

docs/dialect.md

@@ -5,7 +5,8 @@ Specifies the SQL dialect to use.
 ## Usage
 
 ```ts
-import { formatDialect, sqlite } from 'sql-formatter';
+import { formatDialect } from 'sql-formatter/dialect';
+import sqlite from 'sql-formatter/languages/sqlite';
 
 const result = formatDialect('SELECT * FROM tbl', { dialect: sqlite });
 ```
@@ -49,7 +50,7 @@ Better to always pick something more specific if possible.
 The `dialect` parameter can also be used to specify a custom SQL dialect configuration:
 
 ```ts
-import { formatDialect, DialectOptions } from 'sql-formatter';
+import { formatDialect, DialectOptions } from 'sql-formatter/dialect';
 
 const myDialect: DialectOptions {
   name: 'my_dialect',

package.json

@@ -11,6 +11,14 @@
     ".": {
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./dialect": {
+      "import": "./dist/dialect.js",
+      "require": "./dist/dialect.cjs"
+    },
+    "./languages/*": {
+      "import": "./dist/languages/*/index.js",
+      "require": "./dist/languages/*/index.cjs"
     }
   },
   "bin": {
@@ -62,7 +70,7 @@
     "prepare": "yarn clean && yarn grammar && yarn fix && yarn check && yarn build",
     "pre-commit": "npm-run-all --parallel ts:changes lint:changes",
     "grammar": "nearleyc src/parser/grammar.ne -o src/parser/grammar.ts",
-    "build:tsup": "tsup src/index.ts --format cjs,esm --sourcemap --dts",
+    "build:tsup": "tsup",
     "build:webpack": "webpack --config webpack.prod.js && cp dist/sql-formatter.min.cjs dist/sql-formatter.min.js",
     "build": "yarn grammar && npm-run-all --parallel build:tsup build:webpack",
     "release": "release-it"

src/FormatOptions.ts

@@ -12,18 +12,70 @@ export type FunctionCase = KeywordCase;
 export type LogicalOperatorNewline = 'before' | 'after';
 
 export interface FormatOptions {
+  /**
+   * Number of spaces per indentation level. Defaults to `2`
+   */
   tabWidth: number;
+  /**
+   * Use tabs for indentation instead of spaces. Defaults to `false`
+   */
   useTabs: boolean;
+  /**
+   * Transform case of keywords. Defaults to `"preserve"`
+   */
   keywordCase: KeywordCase;
+  /**
+   * Transform case of identifiers. Defaults to `"preserve"`
+   */
   identifierCase: IdentifierCase;
+  /**
+   * Transform case of data types. Defaults to `"preserve"`
+   */
   dataTypeCase: DataTypeCase;
+  /**
+   * Transform case of function names. Defaults to `"preserve"`
+   */
   functionCase: FunctionCase;
+  /**
+   * Indentation style. Defaults to `"standard"`
+   */
   indentStyle: IndentStyle;
+  /**
+   * Position of logical operators in multiline conditions. Defaults to `"before"`
+   */
   logicalOperatorNewline: LogicalOperatorNewline;
+  /**
+   * Maximum length of expressions before breaking into multiple lines. Defaults to `50`
+   */
   expressionWidth: number;
+  /**
+   * Number of blank lines between queries. Defaults to `1`
+   */
   linesBetweenQueries: number;
+  /**
+   * Remove spaces around operators. Defaults to `false`
+   */
   denseOperators: boolean;
+  /**
+   * Place semicolon on new line. Defaults to `false`
+   */
   newlineBeforeSemicolon: boolean;
+
   params?: ParamItems | string[];
   paramTypes?: ParamTypes;
 }
+
+export const defaultFormatOptions: FormatOptions = {
+  tabWidth: 2,
+  useTabs: false,
+  keywordCase: 'preserve',
+  identifierCase: 'preserve',
+  dataTypeCase: 'preserve',
+  functionCase: 'preserve',
+  indentStyle: 'standard',
+  logicalOperatorNewline: 'before',
+  expressionWidth: 50,
+  linesBetweenQueries: 1,
+  denseOperators: false,
+  newlineBeforeSemicolon: false,
+};

src/allDialects.ts

@@ -1,18 +1,19 @@
-export { bigquery } from './languages/bigquery/bigquery.formatter.js';
-export { db2 } from './languages/db2/db2.formatter.js';
-export { db2i } from './languages/db2i/db2i.formatter.js';
-export { hive } from './languages/hive/hive.formatter.js';
-export { mariadb } from './languages/mariadb/mariadb.formatter.js';
-export { mysql } from './languages/mysql/mysql.formatter.js';
-export { tidb } from './languages/tidb/tidb.formatter.js';
-export { n1ql } from './languages/n1ql/n1ql.formatter.js';
-export { plsql } from './languages/plsql/plsql.formatter.js';
-export { postgresql } from './languages/postgresql/postgresql.formatter.js';
-export { redshift } from './languages/redshift/redshift.formatter.js';
-export { spark } from './languages/spark/spark.formatter.js';
-export { sqlite } from './languages/sqlite/sqlite.formatter.js';
-export { sql } from './languages/sql/sql.formatter.js';
-export { trino } from './languages/trino/trino.formatter.js';
-export { transactsql } from './languages/transactsql/transactsql.formatter.js';
-export { singlestoredb } from './languages/singlestoredb/singlestoredb.formatter.js';
-export { snowflake } from './languages/snowflake/snowflake.formatter.js';
+// When adding a new dialect, be sure to add it to the list of exports below.
+export { default as bigquery } from './languages/bigquery/index.js';
+export { default as db2 } from './languages/db2/index.js';
+export { default as db2i } from './languages/db2i/index.js';
+export { default as hive } from './languages/hive/index.js';
+export { default as mariadb } from './languages/mariadb/index.js';
+export { default as mysql } from './languages/mysql/index.js';
+export { default as tidb } from './languages/tidb/index.js';
+export { default as n1ql } from './languages/n1ql/index.js';
+export { default as plsql } from './languages/plsql/index.js';
+export { default as postgresql } from './languages/postgresql/index.js';
+export { default as redshift } from './languages/redshift/index.js';
+export { default as spark } from './languages/spark/index.js';
+export { default as sqlite } from './languages/sqlite/index.js';
+export { default as sql } from './languages/sql/index.js';
+export { default as trino } from './languages/trino/index.js';
+export { default as transactsql } from './languages/transactsql/index.js';
+export { default as singlestoredb } from './languages/singlestoredb/index.js';
+export { default as snowflake } from './languages/snowflake/index.js';

src/dialect.ts

@@ -5,6 +5,10 @@ import {
 import Tokenizer from './lexer/Tokenizer.js';
 import { TokenizerOptions } from './lexer/TokenizerOptions.js';
 
+import { defaultFormatOptions, FormatOptions } from './FormatOptions.js';
+import Formatter from './formatter/Formatter.js';
+import { validateConfig } from './validateConfig.js';
+
 export interface DialectOptions {
   name: string;
   tokenizerOptions: TokenizerOptions;
@@ -46,3 +50,31 @@ const processDialectFormatOptions = (
     (options.tabularOnelineClauses ?? options.onelineClauses).map(name => [name, true])
   ),
 });
+
+export type FormatOptionsWithDialect = Partial<FormatOptions> & {
+  dialect: DialectOptions;
+};
+
+/**
+ * Formats and SQL query string similar to `format` function, however it works directly with dialect objects instead of dialect names.
+ * Provides better bundling performance and control over the formatting process.
+ *
+ * @param {string} query - The SQL query string to format
+ * @param {FormatOptionsWithDialect} options - Configuration options
+ * @return {string} formatted query
+ */
+export const formatDialect = (
+  query: string,
+  { dialect, ...cfg }: FormatOptionsWithDialect
+): string => {
+  if (typeof query !== 'string') {
+    throw new Error('Invalid query argument. Expected string, instead got ' + typeof query);
+  }
+
+  const options = validateConfig({
+    ...defaultFormatOptions,
+    ...cfg,
+  });
+
+  return new Formatter(createDialect(dialect), options).format(query);
+};

src/index.ts

@@ -1,34 +1,10 @@
-export { supportedDialects, format, formatDialect } from './sqlFormatter.js';
+export { supportedDialects, format } from './sqlFormatter.js';
 export { expandPhrases } from './expandPhrases.js';
 export { ConfigError } from './validateConfig.js';
 
-// When adding a new dialect, be sure to add it to the list of exports below.
-export { bigquery } from './languages/bigquery/bigquery.formatter.js';
-export { db2 } from './languages/db2/db2.formatter.js';
-export { db2i } from './languages/db2i/db2i.formatter.js';
-export { hive } from './languages/hive/hive.formatter.js';
-export { mariadb } from './languages/mariadb/mariadb.formatter.js';
-export { mysql } from './languages/mysql/mysql.formatter.js';
-export { tidb } from './languages/tidb/tidb.formatter.js';
-export { n1ql } from './languages/n1ql/n1ql.formatter.js';
-export { plsql } from './languages/plsql/plsql.formatter.js';
-export { postgresql } from './languages/postgresql/postgresql.formatter.js';
-export { redshift } from './languages/redshift/redshift.formatter.js';
-export { spark } from './languages/spark/spark.formatter.js';
-export { sqlite } from './languages/sqlite/sqlite.formatter.js';
-export { sql } from './languages/sql/sql.formatter.js';
-export { trino } from './languages/trino/trino.formatter.js';
-export { transactsql } from './languages/transactsql/transactsql.formatter.js';
-export { singlestoredb } from './languages/singlestoredb/singlestoredb.formatter.js';
-export { snowflake } from './languages/snowflake/snowflake.formatter.js';
-
 // NB! To re-export types the "export type" syntax is required by webpack.
 // Otherwise webpack build will fail.
-export type {
-  SqlLanguage,
-  FormatOptionsWithLanguage,
-  FormatOptionsWithDialect,
-} from './sqlFormatter.js';
+export type { SqlLanguage, FormatOptionsWithLanguage } from './sqlFormatter.js';
 export type {
   IndentStyle,
   KeywordCase,
@@ -40,4 +16,3 @@ export type {
 } from './FormatOptions.js';
 export type { ParamItems } from './formatter/Params.js';
 export type { ParamTypes } from './lexer/TokenizerOptions.js';
-export type { DialectOptions } from './dialect.js';

src/languages/bigquery/index.ts

@@ -0,0 +1,3 @@
+import { bigquery } from './bigquery.formatter.js';
+
+export default bigquery;

src/languages/db2/index.ts

@@ -0,0 +1,3 @@
+import { db2 } from './db2.formatter.js';
+
+export default db2;

src/languages/db2i/index.ts

@@ -0,0 +1,3 @@
+import { db2i } from './db2i.formatter.js';
+
+export default db2i;

src/languages/hive/index.ts

@@ -0,0 +1,3 @@
+import { hive } from './hive.formatter.js';
+
+export default hive;

src/languages/mariadb/index.ts

@@ -0,0 +1,3 @@
+import { mariadb } from './mariadb.formatter.js';
+
+export default mariadb;

src/languages/mysql/index.ts

@@ -0,0 +1,3 @@
+import { mysql } from './mysql.formatter.js';
+
+export default mysql;

src/languages/n1ql/index.ts

@@ -0,0 +1,3 @@
+import { n1ql } from './n1ql.formatter.js';
+
+export default n1ql;

src/languages/plsql/index.ts

@@ -0,0 +1,3 @@
+import { plsql } from './plsql.formatter.js';
+
+export default plsql;

src/languages/postgresql/index.ts

@@ -0,0 +1,3 @@
+import { postgresql } from './postgresql.formatter.js';
+
+export default postgresql;

src/languages/redshift/index.ts

@@ -0,0 +1,3 @@
+import { redshift } from './redshift.formatter.js';
+
+export default redshift;

src/languages/singlestoredb/index.ts

@@ -0,0 +1,3 @@
+import { singlestoredb } from './singlestoredb.formatter.js';
+
+export default singlestoredb;

src/languages/snowflake/index.ts

@@ -0,0 +1,3 @@
+import { snowflake } from './snowflake.formatter.js';
+
+export default snowflake;

src/languages/spark/index.ts

@@ -0,0 +1,3 @@
+import { spark } from './spark.formatter.js';
+
+export default spark;

src/languages/sql/index.ts

@@ -0,0 +1,3 @@
+import { sql } from './sql.formatter.js';
+
+export default sql;

src/languages/sqlite/index.ts

@@ -0,0 +1,3 @@
+import { sqlite } from './sqlite.formatter.js';
+
+export default sqlite;

src/languages/tidb/index.ts

@@ -0,0 +1,3 @@
+import { tidb } from './tidb.formatter.js';
+
+export default tidb;

src/languages/transactsql/index.ts

@@ -0,0 +1,3 @@
+import { transactsql } from './transactsql.formatter.js';
+
+export default transactsql;

src/languages/trino/index.ts

@@ -0,0 +1,3 @@
+import { trino } from './trino.formatter.js';
+
+export default trino;