first commit

2024-03-11 18:35:09 -04:00
commit 481c17499d
1371 changed files with 206438 additions and 0 deletions
@@ -0,0 +1,63 @@
+# pupa [![Build Status](https://travis-ci.org/sindresorhus/pupa.svg?branch=master)](https://travis-ci.org/sindresorhus/pupa)
+
+> Simple micro templating
+
+Useful when all you need is to fill in some placeholders.
+
+
+## Install
+
+```
+$ npm install pupa
+```
+
+
+## Usage
+
+```js
+const pupa = require('pupa');
+
+pupa('The mobile number of {name} is {phone.mobile}', {
+	name: 'Sindre',
+	phone: {
+		mobile: '609 24 363'
+	}
+});
+//=> 'The mobile number of Sindre is 609 24 363'
+
+pupa('I like {0} and {1}', ['🦄', '🐮']);
+//=> 'I like 🦄 and 🐮'
+
+// Double braces encodes the HTML entities to avoid code injection
+pupa('I like {{0}} and {{1}}', ['<br>🦄</br>', '<i>🐮</i>']);
+//=> 'I like &lt;br&gt;🦄&lt;/br&gt; and &lt;i&gt;🐮&lt;/i&gt;'
+```
+
+
+## API
+
+### pupa(template, data)
+
+#### template
+
+Type: `string`
+
+Text with placeholders for `data` properties.
+
+#### data
+
+Type: `object | unknown[]`
+
+Data to interpolate into `template`.
+
+
+## FAQ
+
+### What about template literals?
+
+Template literals expand on creation. This module expands the template on execution, which can be useful if either or both template and data are lazily created or user-supplied.
+
+
+## Related
+
+- [pupa-cli](https://github.com/sindresorhus/pupa-cli) - CLI for this module