Rename printMessage to formatMessage

close #43

pkg/README.md

@@ -74,7 +74,7 @@ console.log(messages)
 Extra utilities are exported under `publint/utils`:
 
 ```js
-import { printMessage } from 'publint/utils'
+import { formatMessage } from 'publint/utils'
 import fs from 'node:fs/promises'
 
 const pkg = JSON.parse(
@@ -84,7 +84,7 @@ const pkg = JSON.parse(
 for (const message of messages) {
   // Prints default message in Node.js. Always a no-op in browsers.
   // Useful for re-implementing the CLI in a programmatic way.
-  printMessage(message, pkg)
+  console.log(formatMessage(message, pkg))
 }
 ```
 

pkg/lib/cli.js

@@ -7,7 +7,7 @@ import { createRequire } from 'node:module'
 import sade from 'sade'
 import c from 'picocolors'
 import { publint } from './node.js'
-import { printMessage } from '../src/message.js'
+import { formatMessage } from '../src/message.js'
 import { createPromiseQueue } from '../src/utils.js'
 
 const version = createRequire(import.meta.url)('../package.json').version
@@ -126,23 +126,23 @@ async function lintDir(pkgDir, level, strict, compact = false) {
     if (suggestions.length) {
       logs.push(c.bold(c.blue('Suggestions:')))
       suggestions.forEach((m, i) =>
-        logs.push(c.dim(`${i + 1}. `) + printMessage(m, rootPkg))
+        logs.push(c.dim(`${i + 1}. `) + formatMessage(m, rootPkg))
       )
     }
 
     const warnings = messages.filter((v) => v.type === 'warning')
     if (warnings.length) {
       logs.push(c.bold(c.yellow('Warnings:')))
       warnings.forEach((m, i) =>
-        logs.push(c.dim(`${i + 1}. `) + printMessage(m, rootPkg))
+        logs.push(c.dim(`${i + 1}. `) + formatMessage(m, rootPkg))
       )
     }
 
     const errors = messages.filter((v) => v.type === 'error')
     if (errors.length) {
       logs.push(c.bold(c.red('Errors:')))
       errors.forEach((m, i) =>
-        logs.push(c.dim(`${i + 1}. `) + printMessage(m, rootPkg))
+        logs.push(c.dim(`${i + 1}. `) + formatMessage(m, rootPkg))
       )
       process.exitCode = 1
     }

pkg/lib/utils-node.js

@@ -1,2 +1,2 @@
 export { formatMessagePath, getPkgPathValue } from '../src/utils.js'
-export { printMessage } from '../src/message.js'
+export { formatMessage } from '../src/message.js'

pkg/lib/utils.js

@@ -2,8 +2,8 @@ export { formatMessagePath, getPkgPathValue } from '../src/utils.js'
 
 /**
  * no-op. leave users to implement themselves.
- * @type {import('../utils.d.ts').printMessage}
+ * @type {import('../utils.d.ts').formatMessage}
  */
-export function printMessage() {
+export function formatMessage() {
   return
 }

pkg/src/message.js

@@ -5,7 +5,7 @@ import { formatMessagePath as fp, getPkgPathValue } from './utils.js'
  * @param {import('../index.d.ts').Message} m
  * @param {import('./utils.js').Pkg} pkg
  */
-export function printMessage(m, pkg) {
+export function formatMessage(m, pkg) {
   /** @param {string[]} path */
   const pv = (path) => getPkgPathValue(pkg, path)
 

pkg/tests/playground.js

@@ -3,7 +3,7 @@ import path from 'node:path'
 import { test } from 'uvu'
 import { equal } from 'uvu/assert'
 import { publint } from '../lib/node.js'
-import { printMessage } from '../lib/utils-node.js'
+import { formatMessage } from '../lib/utils-node.js'
 
 testFixture('exports-styles', [
   'EXPORTS_VALUE_INVALID',
@@ -131,7 +131,7 @@ function testFixture(name, expectCodes, options) {
       )
       console.log()
       console.log('Logs:', name)
-      messages.forEach((m) => console.log(printMessage(m, pkg)))
+      messages.forEach((m) => console.log(formatMessage(m, pkg)))
       console.log()
     }
 

pkg/utils.d.ts

@@ -4,4 +4,4 @@ type Pkg = Record<string, any>
 
 export declare function formatMessagePath(path: string[]): string
 export declare function getPkgPathValue(pkg: Pkg, path: string[]): any
-export declare function printMessage(msg: Message, pkg: Pkg): string | undefined
+export declare function formatMessage(msg: Message, pkg: Pkg): string | undefined

site/src/components/PkgNode.svelte

@@ -6,7 +6,7 @@
   import { getContext, setContext } from 'svelte'
   import { messageTypeToColor } from '../utils/colors'
   import { isArrayEqual } from '../utils/common'
-  import { printMessage } from '../utils/message'
+  import { formatMessage } from '../utils/message'
 
   /** @type {string | number} */
   export let key = ''
@@ -77,7 +77,7 @@
     <div class="-mx-4">
       {#each shownMessages as msg}
         <div class="{messageTypeToColor(msg.type)} border-4 px-4 py-2">
-          {@html printMessage(msg, pkg)}
+          {@html formatMessage(msg, pkg)}
         </div>
       {/each}
       {#if shownMessages.length < matchedMessages.length && !showAllMessages}

site/src/utils/message.js

@@ -4,7 +4,7 @@ import { formatMessagePath as fp, getPkgPathValue } from 'publint/utils'
  * @param {import('publint').Message} m
  * @param {Record<string, any>} pkg
  */
-export function printMessage(m, pkg) {
+export function formatMessage(m, pkg) {
   let str = messageToString(m, pkg)
   if (str) {
     str += ` (<a href="/rules.html#${m.code.toLowerCase()}">More info</a>)`