Skip to content

Commit 83168c6

Browse files
hejnyhejny
committed
Rename replaceParameters -> templateParameters 
1 parent 7c919cf commit 83168c6

15 files changed

+188
-239
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -653,6 +653,7 @@ Editing and templates
653653
- `fetch` is passed through `ExecutionTools` to allow proxying in browser
654654
- Make new package [`@promptbook/editable`](https://www.npmjs.com/package/@promptbook/editable) and move misc editing tools there
655655
- Make new package [`@promptbook/templates`](https://www.npmjs.com/package/@promptbook/templates) and add function `getBookTemplate`
656+
- Rename `replaceParameters` -> `templateParameters`
656657

657658
## Drafts
658659

‎packages/utils/README.md

+10-47
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,26 @@
22

33
# ❄ Promptbook
44

5-
6-
7-
85
[![NPM Version of ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
96
[![Quality of package ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
107
[![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
118
[![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
129

13-
14-
15-
16-
1710
## ❄ New Features
1811

1912
- 💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
2013
- 🖤 Run books from CLI - `npx ptbk run path/to/your/book`
2114
- 📚 Support of `.docx`, `.doc` and `.pdf` documents
2215
- ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
2316

24-
25-
2617
<blockquote style="color: #ff8811">
2718
<b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
2819
</blockquote>
2920

3021
## 📦 Package `@promptbook/utils`
3122

32-
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
33-
- This package `@promptbook/utils` is one part of the promptbook ecosystem.
23+
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
24+
- This package `@promptbook/utils` is one part of the promptbook ecosystem.
3425

3526
To install this package, run:
3627

@@ -74,20 +65,20 @@ unwrapResult('Best greeting for the user is "Hi Pavol!"'); // 'Hi Pavol!'
7465

7566
## Templating
7667

77-
There is a function `replaceParameters` which is used to replace the parameters in given template optimized to LLM prompt templates.
68+
There is a function `templateParameters` which is used to replace the parameters in given template optimized to LLM prompt templates.
7869

7970
```typescript
80-
import { replaceParameters } from '@promptbook/utils';
71+
import { templateParameters } from '@promptbook/utils';
8172

82-
replaceParameters('Hello, {name}!', { name: 'world' }); // 'Hello, world!'
73+
templateParameters('Hello, {name}!', { name: 'world' }); // 'Hello, world!'
8374
```
8475

8576
And also multiline templates with blockquotes
8677

8778
```typescript
88-
import { replaceParameters, spaceTrim } from '@promptbook/utils';
79+
import { templateParameters, spaceTrim } from '@promptbook/utils';
8980

90-
replaceParameters(
81+
templateParameters(
9182
spaceTrim(`
9283
Hello, {name}!
9384
@@ -156,23 +147,17 @@ console.log(normalizeTo['kebab-case']('Hello, world!')); // 'hello-world'
156147

157148
See also the documentation for all the functions in the `@promptbook/utils` package, every function is documented by jsdoc, typed by typescript and tested by jest.
158149

159-
160-
161150
`assertsExecutionSuccessful`,
162151
`checkExpectations`,
163152
`executionReportJsonToString`,
164153
`isPassingExpectations`,
165154
`isValidJsonString`,
166-
`parseNumber`
167-
155+
`parseNumber`
168156

169157
---
170158

171159
Rest of the documentation is common for **entire promptbook ecosystem**:
172160

173-
174-
175-
176161
## 🤍 The Book Abstract
177162

178163
**It's time for a paradigm shift! The future of software is in plain English, French or Latin.**
@@ -187,8 +172,6 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
187172

188173
**Join us in this journey!**
189174

190-
191-
192175
## 🚀 Get started
193176

194177
Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
@@ -197,9 +180,6 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
197180
- [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
198181
- [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
199182

200-
201-
202-
203183
## 💜 The Promptbook Project
204184

205185
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
@@ -253,13 +233,8 @@ Also we have a community of developers and users:
253233
- [Landing page](https://ptbk.io)
254234
- [Github discussions](https://github.com/webgptorg/promptbook/discussions)
255235

256-
257-
258236
## 💙 Book language _(for prompt-engineer)_
259237

260-
261-
262-
263238
## 💙 The blueprint of book language
264239

265240
Following is the documentation and blueprint of the Book language.
@@ -335,8 +310,6 @@ Todo todo
335310

336311
### Examples
337312

338-
339-
340313
## 📦 Packages _(for developers)_
341314

342315
This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -360,7 +333,7 @@ Or you can install them separately:
360333
- _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
361334
- **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
362335
- **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
363-
- **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
336+
- **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
364337
- **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
365338
- **[@promptbook/google](https://www.npmjs.com/package/@promptbook/google)** - Integration with Google's Gemini API
366339
- **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
@@ -377,11 +350,6 @@ Or you can install them separately:
377350
- **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
378351
- **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
379352

380-
381-
382-
383-
384-
385353
## 📚 Dictionary
386354

387355
### 📚 Dictionary
@@ -464,8 +432,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
464432
- Anonymous mode
465433
- Application mode
466434

467-
468-
469435
## 🔌 Usage in Typescript / Javascript
470436

471437
- [Simple usage](./examples/usage/simple-script)
@@ -530,11 +496,8 @@ See [CHANGELOG.md](./CHANGELOG.md)
530496

531497
See [TODO.md](./TODO.md)
532498

533-
534-
535-
536499
## 🖋️ Contributing
537500

538501
I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can [☕ buy me a coffee](https://www.buymeacoffee.com/hejny) or [donate via cryptocurrencies](https://github.com/hejny/hejny/blob/main/documents/crypto.md).
539502

540-
You can also ⭐ star the promptbook package, [follow me on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).
503+
You can also ⭐ star the promptbook package, [follow me on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).

‎src/_packages/utils.index.ts

+76-84
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
// ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
22
// `@promptbook/utils`
33

4-
import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
54
import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
65
import { extractVariablesFromScript } from '../conversion/utils/extractVariablesFromScript';
76
import { deserializeError } from '../errors/utils/deserializeError';
@@ -13,21 +12,18 @@ import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
1312
import { $isRunningInJest } from '../utils/environment/$isRunningInJest';
1413
import { $isRunningInNode } from '../utils/environment/$isRunningInNode';
1514
import { $isRunningInWebWorker } from '../utils/environment/$isRunningInWebWorker';
16-
import { CHARACTERS_PER_STANDARD_LINE } from '../utils/expectation-counters/constants';
17-
import { LINES_PER_STANDARD_PAGE } from '../utils/expectation-counters/constants';
15+
import { CHARACTERS_PER_STANDARD_LINE, LINES_PER_STANDARD_PAGE } from '../utils/expectation-counters/constants';
1816
import { countCharacters } from '../utils/expectation-counters/countCharacters';
1917
import { countLines } from '../utils/expectation-counters/countLines';
2018
import { countPages } from '../utils/expectation-counters/countPages';
2119
import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
22-
import { splitIntoSentences } from '../utils/expectation-counters/countSentences';
23-
import { countSentences } from '../utils/expectation-counters/countSentences';
20+
import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
2421
import { countWords } from '../utils/expectation-counters/countWords';
2522
import { CountUtils } from '../utils/expectation-counters/index';
2623
import { capitalize } from '../utils/normalization/capitalize';
2724
import { decapitalize } from '../utils/normalization/decapitalize';
2825
import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
29-
import type { string_keyword } from '../utils/normalization/IKeywords';
30-
import type { Keywords } from '../utils/normalization/IKeywords';
26+
import type { Keywords, string_keyword } from '../utils/normalization/IKeywords';
3127
import { isValidKeyword } from '../utils/normalization/isValidKeyword';
3228
import { nameToUriPart } from '../utils/normalization/nameToUriPart';
3329
import { nameToUriParts } from '../utils/normalization/nameToUriParts';
@@ -49,7 +45,7 @@ import { searchKeywords } from '../utils/normalization/searchKeywords';
4945
import { titleToName } from '../utils/normalization/titleToName';
5046
import { spaceTrim } from '../utils/organization/spaceTrim';
5147
import { extractParameterNames } from '../utils/parameters/extractParameterNames';
52-
import { replaceParameters } from '../utils/parameters/replaceParameters';
48+
import { templateParameters } from '../utils/parameters/templateParameters';
5349
import { parseNumber } from '../utils/parseNumber';
5450
import { $randomSeed } from '../utils/random/$randomSeed';
5551
import { removeEmojis } from '../utils/removeEmojis';
@@ -76,84 +72,80 @@ import { isUrlOnPrivateNetwork } from '../utils/validators/url/isUrlOnPrivateNet
7672
import { isValidPipelineUrl } from '../utils/validators/url/isValidPipelineUrl';
7773
import { isValidUrl } from '../utils/validators/url/isValidUrl';
7874
import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
79-
75+
import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
8076

8177
// Note: Exporting version from each package
8278
export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
8379

84-
8580
// Note: Entities of the `@promptbook/utils`
86-
export { renderPromptbookMermaid };
87-
export { extractVariablesFromScript };
88-
export { deserializeError };
89-
export { serializeError };
90-
export { forEachAsync };
91-
export { isValidJsonString };
92-
export { $getCurrentDate };
93-
export { $isRunningInBrowser };
94-
export { $isRunningInJest };
95-
export { $isRunningInNode };
96-
export { $isRunningInWebWorker };
97-
export { CHARACTERS_PER_STANDARD_LINE };
98-
export { LINES_PER_STANDARD_PAGE };
99-
export { countCharacters };
100-
export { countLines };
101-
export { countPages };
102-
export { countParagraphs };
103-
export { splitIntoSentences };
104-
export { countSentences };
105-
export { countWords };
106-
export { CountUtils };
107-
export { capitalize };
108-
export { decapitalize };
109-
export { DIACRITIC_VARIANTS_LETTERS };
110-
export type { string_keyword };
111-
export type { Keywords };
112-
export { isValidKeyword };
113-
export { nameToUriPart };
114-
export { nameToUriParts };
115-
export type { string_kebab_case };
116-
export { normalizeToKebabCase };
117-
export type { string_camelCase };
118-
export { normalizeTo_camelCase };
119-
export type { string_PascalCase };
120-
export { normalizeTo_PascalCase };
121-
export type { string_SCREAMING_CASE };
122-
export { normalizeTo_SCREAMING_CASE };
123-
export { normalizeTo_snake_case };
124-
export { normalizeWhitespaces };
125-
export { orderJson };
126-
export { parseKeywords };
127-
export { parseKeywordsFromString };
128-
export { removeDiacritics };
129-
export { searchKeywords };
130-
export { titleToName };
131-
export { spaceTrim };
132-
export { extractParameterNames };
133-
export { replaceParameters };
134-
export { parseNumber };
135-
export { $randomSeed };
136-
export { removeEmojis };
137-
export { removeQuotes };
138-
export { $deepFreeze };
139-
export { checkSerializableAsJson };
140-
export { clonePipeline };
141-
export { deepClone };
142-
export { exportJson };
143-
export { isSerializableAsJson };
144-
export { difference };
145-
export { intersection };
146-
export { union };
147-
export { trimCodeBlock };
148-
export { trimEndOfCodeBlock };
149-
export { unwrapResult };
150-
export { isValidEmail };
151-
export { isValidFilePath };
152-
export { isValidJavascriptName };
153-
export { isValidPromptbookVersion };
154-
export { isValidSemanticVersion };
155-
export { isHostnameOnPrivateNetwork };
156-
export { isUrlOnPrivateNetwork };
157-
export { isValidPipelineUrl };
158-
export { isValidUrl };
159-
export { isValidUuid };
81+
export {
82+
$deepFreeze,
83+
$getCurrentDate,
84+
$isRunningInBrowser,
85+
$isRunningInJest,
86+
$isRunningInNode,
87+
$isRunningInWebWorker,
88+
$randomSeed,
89+
capitalize,
90+
CHARACTERS_PER_STANDARD_LINE,
91+
checkSerializableAsJson,
92+
clonePipeline,
93+
countCharacters,
94+
countLines,
95+
countPages,
96+
countParagraphs,
97+
countSentences,
98+
CountUtils,
99+
countWords,
100+
decapitalize,
101+
deepClone,
102+
deserializeError,
103+
DIACRITIC_VARIANTS_LETTERS,
104+
difference,
105+
exportJson,
106+
extractParameterNames,
107+
extractVariablesFromScript,
108+
forEachAsync,
109+
intersection,
110+
isHostnameOnPrivateNetwork,
111+
isSerializableAsJson,
112+
isUrlOnPrivateNetwork,
113+
isValidEmail,
114+
isValidFilePath,
115+
isValidJavascriptName,
116+
isValidJsonString,
117+
isValidKeyword,
118+
isValidPipelineUrl,
119+
isValidPromptbookVersion,
120+
isValidSemanticVersion,
121+
isValidUrl,
122+
isValidUuid,
123+
LINES_PER_STANDARD_PAGE,
124+
nameToUriPart,
125+
nameToUriParts,
126+
normalizeTo_camelCase,
127+
normalizeTo_PascalCase,
128+
normalizeTo_SCREAMING_CASE,
129+
normalizeTo_snake_case,
130+
normalizeToKebabCase,
131+
normalizeWhitespaces,
132+
orderJson,
133+
parseKeywords,
134+
parseKeywordsFromString,
135+
parseNumber,
136+
removeDiacritics,
137+
removeEmojis,
138+
removeQuotes,
139+
renderPromptbookMermaid,
140+
searchKeywords,
141+
serializeError,
142+
spaceTrim,
143+
splitIntoSentences,
144+
templateParameters,
145+
titleToName,
146+
trimCodeBlock,
147+
trimEndOfCodeBlock,
148+
union,
149+
unwrapResult,
150+
};
151+
export type { Keywords, string_camelCase, string_kebab_case, string_keyword, string_PascalCase, string_SCREAMING_CASE };

0 commit comments

Comments
 (0)