fix: rename makeTable to printTable

examples/basic.ts

@@ -1,7 +1,7 @@
 import ansis from 'ansis'
 import terminalLink from 'terminal-link'
 
-import {TableProps, makeTable} from '../src/index.js'
+import {TableProps, printTable} from '../src/index.js'
 
 const data = [
   {
@@ -40,4 +40,4 @@ const basic: TableProps<(typeof data)[number]> = {
   verticalAlignment: 'center',
 }
 
-makeTable(basic)
+printTable(basic)

examples/multiple.ts

@@ -1,4 +1,4 @@
-import {TableProps, makeTables} from '../src/index.js'
+import {TableProps, printTables} from '../src/index.js'
 
 const description =
   'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
@@ -110,7 +110,7 @@ const projectsTable: TableProps<(typeof projects)[number]> = {
   },
 }
 
-makeTables([employeesTable, stocksTable, projectsTable], {
+printTables([employeesTable, stocksTable, projectsTable], {
   alignItems: 'center',
   columnGap: 1,
   margin: 1,

examples/orientation.ts

@@ -1,4 +1,4 @@
-import {makeTable} from '../src/index.js'
+import {printTable} from '../src/index.js'
 
 const description =
   'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
@@ -21,7 +21,7 @@ const data = [
   },
 ]
 
-makeTable({
+printTable({
   columns: ['item', 'description', 'url'],
   data,
   headerOptions: {
@@ -33,7 +33,7 @@ makeTable({
   titleOptions: {bold: true},
 })
 
-makeTable({
+printTable({
   columns: ['item', 'description', 'url'],
   data,
   headerOptions: {

examples/overflow.ts

@@ -1,4 +1,4 @@
-import {makeTable} from '../src/index.js'
+import {printTable} from '../src/index.js'
 
 const description =
   'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
@@ -24,7 +24,7 @@ const data = [
   },
 ]
 
-makeTable({
+printTable({
   columns: ['id', 'name', 'age', 'description'],
   data,
   headerOptions: {
@@ -36,7 +36,7 @@ makeTable({
   titleOptions: {bold: true},
 })
 
-makeTable({
+printTable({
   columns: ['id', 'name', 'age', 'description'],
   data,
   headerOptions: {

examples/sf-specific/deploy.ts

@@ -1,4 +1,4 @@
-import {TableProps, makeTable} from '../../src'
+import {TableProps, printTable} from '../../src'
 
 const deployResult = [
   {
@@ -969,4 +969,4 @@ const deploy: TableProps<(typeof deployResult)[number]> = {
   verticalAlignment: 'center',
 }
 
-makeTable(deploy)
+printTable(deploy)

examples/sf-specific/versions.ts

@@ -1,4 +1,4 @@
-import {makeTable} from '../../src'
+import {printTable} from '../../src'
 
 const versions = [
   {
@@ -838,7 +838,7 @@ const versions = [
   },
 ]
 
-makeTable({
+printTable({
   borderColor: 'greenBright',
   borderStyle: 'headers-only-with-underline',
   columns: ['version', 'channel', 'location'],

examples/sort-and-filter.ts

@@ -1,4 +1,4 @@
-import {makeTable} from '../src/index.js'
+import {printTable} from '../src/index.js'
 
 const data = [
   {age: 25, id: '10245', name: 'Bob'},
@@ -9,7 +9,7 @@ const data = [
   {age: 35, id: '30345', name: 'Chris'},
 ]
 
-makeTable({
+printTable({
   columns: ['id', 'name', 'age'],
   data,
   headerOptions: {
@@ -21,7 +21,7 @@ makeTable({
   titleOptions: {bold: true},
 })
 
-makeTable({
+printTable({
   columns: ['id', 'name', 'age'],
   data,
   headerOptions: {
@@ -33,7 +33,7 @@ makeTable({
   titleOptions: {bold: true},
 })
 
-makeTable({
+printTable({
   columns: ['id', 'name', 'age'],
   data,
   headerOptions: {
@@ -45,7 +45,7 @@ makeTable({
   titleOptions: {bold: true},
 })
 
-makeTable({
+printTable({
   columns: ['id', 'name', 'age'],
   data,
   filter: (record) => record.age > 25,

examples/styles.ts

@@ -1,4 +1,4 @@
-import {makeTable} from '../src/index.js'
+import {printTable} from '../src/index.js'
 import {BORDER_STYLES} from '../src/skeletons.js'
 
 const data = [
@@ -20,7 +20,7 @@ const data = [
 ]
 
 for (const borderStyle of BORDER_STYLES) {
-  makeTable({
+  printTable({
     borderStyle,
     columns: ['id', {key: 'name', name: 'First Name'}, 'age'],
     data,

src/index.ts

@@ -1,2 +1,2 @@
-export {makeTable, makeTables} from './table.js'
-export type {TableProps} from './types.js'
+export {printTable, printTables} from './table.js'
+export type {ScalarDict, TableProps} from './types.js'

src/table.tsx

@@ -334,7 +334,7 @@ export function Skeleton(props: React.PropsWithChildren & {readonly height?: num
  * Renders a table with the given data.
  * @param options see {@link TableProps}
  */
-export function makeTable<T extends ScalarDict>(options: TableProps<T>): void {
+export function printTable<T extends ScalarDict>(options: TableProps<T>): void {
   const instance = render(<Table {...options} />)
   instance.unmount()
 }
@@ -347,7 +347,7 @@ function Container(props: ContainerProps) {
   )
 }
 
-export function makeTables<T extends ScalarDict[]>(
+export function printTables<T extends ScalarDict[]>(
   tables: {[P in keyof T]: TableProps<T[P]>},
   options?: Omit<ContainerProps, 'children'>,
 ): void {

src/types.ts

@@ -162,16 +162,16 @@ export type TableProps<T extends ScalarDict> = {
    * ]
    *
    * // sort the name column in ascending order
-   * makeTable({data, sort: {name: 'asc'}})
+   * printTable({data, sort: {name: 'asc'}})
    *
    * // sort the name column in descending order
-   * makeTable({data, sort: {name: 'desc'}})
+   * printTable({data, sort: {name: 'desc'}})
    *
    * // sort by name in ascending order and age in descending order
-   * makeTable({data, sort: {name: 'asc', age: 'desc'}})
+   * printTable({data, sort: {name: 'asc', age: 'desc'}})
    *
    * // sort by name in ascending order and age in descending order using a custom sort function
-   * makeTable({data, sort: {name: 'asc', age: (a, b) => b - a}})
+   * printTable({data, sort: {name: 'asc', age: (a, b) => b - a}})
    * ```
    */
   sort?: Sort<T>