Skip to content

Commit

Permalink
feat: Create sprintf package to replace util.format (#856)
Browse files Browse the repository at this point in the history
This adds a new `@arcjet/sprintf` package to this monorepo, which provides a platform-independent formatter function. This will allow us to move closer to #51 by replacing the `util.format` import!

I've kept the implementation pretty close to the [reference library](https://github.com/pinojs/quick-format-unescaped) because [pino](https://github.com/pinojs/pino) uses it for formatting strings and we want pino to be a drop-in replacement for our logger when users want to [swap in structured logging](#855).
  • Loading branch information
blaine-arcjet authored Jun 4, 2024
1 parent 96bbe94 commit 160a16e
Show file tree
Hide file tree
Showing 16 changed files with 995 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/.release-please-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@
"logger": "1.0.0-alpha.13",
"protocol": "1.0.0-alpha.13",
"rollup-config": "1.0.0-alpha.13",
"sprintf": "1.0.0-alpha.13",
"tsconfig": "1.0.0-alpha.13"
}
4 changes: 4 additions & 0 deletions .github/release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@
"component": "@arcjet/rollup-config",
"skip-github-release": true
},
"sprintf": {
"component": "@arcjet/sprintf",
"skip-github-release": true
},
"tsconfig": {
"component": "@arcjet/tsconfig",
"skip-github-release": true
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@ find a specific one through the categories and descriptions below.
with information.
- [`@arcjet/duration`](./duration/README.md): Utilities for parsing duration
strings into seconds integers.
- [`@arcjet/sprintf`](./sprintf/README.md): Platform-independent replacement for
`util.format`.

### Internal development

Expand Down
21 changes: 21 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions sprintf/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/.turbo/
/coverage/
/node_modules/
*.d.ts
*.js
!*.config.js
4 changes: 4 additions & 0 deletions sprintf/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
root: true,
extends: ["@arcjet/eslint-config"],
};
135 changes: 135 additions & 0 deletions sprintf/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# Generated files
index.js
index.d.ts
test/*.js
Loading

0 comments on commit 160a16e

Please sign in to comment.