Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/virgs/jsonPlaceholderReplacer
Typescript library/cli to replace placeholders in json
https://github.com/virgs/jsonPlaceholderReplacer
cli javascript javascript-library json library placeholder replacer substitution typescript
Last synced: 2 months ago
JSON representation
Typescript library/cli to replace placeholders in json
- Host: GitHub
- URL: https://github.com/virgs/jsonPlaceholderReplacer
- Owner: virgs
- License: mit
- Created: 2018-04-18T15:28:12.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T15:24:02.000Z (3 months ago)
- Last Synced: 2024-09-17T18:50:07.123Z (3 months ago)
- Topics: cli, javascript, javascript-library, json, library, placeholder, replacer, substitution, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/json-placeholder-replacer
- Size: 1.8 MB
- Stars: 9
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# jsonPlaceholderReplacer
[](https://badge.fury.io/js/json-placeholder-replacer)
[](https://app.circleci.com/pipelines/github/virgs/jsonPlaceholderReplacer)
[](https://codeclimate.com/github/lopidio/jsonPlaceholderReplacer/maintainability)
[](https://codeclimate.com/github/lopidio/jsonPlaceholderReplacer/test_coverage)
[](https://app.snyk.io/)
Lightweight yet really powerful typescript library/cli to replace placeholders in an javascript object/JSON.
By default, all you have to do is to use double curly brackets **{{**placeholderKey**}}** or angle brackets **<<**placeholderKey**>>**, interchangeably, to identify the placeholder.
Don't worry, if you don't like these default placeholders you can create your own.
## CLI usage
```shell
json-placeholder-replacer annotetad-json.json [...variableMaps]
```
### Example
$ json-placeholder-replacer [annotated.json](/annotated.json) [variable_map.json](/variable_map.json)
$ jpr [variable_map.json](/variable_map.json) < [annotated.json](/annotated.json)
$ cat [annotated.json](/annotated.json) | jpr [variable_map.json](/variable_map.json)
$ echo '{"curly": "{{key}}", "angle": "<>"}' | jpr variable_maps
### Would result
```shell
cat replaceable.json
# {
# "curly": "{{key}}",
# "angle": "<>"
# }
cat variable.map:
# {
# "key": 10,
# "not-mapped": 20
# }
json-placeholder-replacer replaceable.json variable.map
# {
# "curly": 10,
# "angle": 10,
# "not-mapped": 20
# }
```
## Library usage
```typescript
import { JsonPlaceholderReplacer } from "json-placeholder-replacer";
const placeHolderReplacer = new JsonPlaceholderReplacer();
placeHolderReplacer.addVariableMap({
key: 100,
otherKey: 200,
});
const afterReplace = placeHolderReplacer.replace({
replaceable: "{{key}}",
otherReplaceableWithSameKey: "<>",
otherReplaceable: "{{otherKey}}",
});
// afterReplace = {
// replaceable: 100,
// otherReplaceableWithSameKey: 100,
// otherReplaceable: 200
// }
```
> [!NOTE]
> An object passed to `.replace()` is mutated in-place:
>
> ```ts
> const beforeReplace = { some: "{{placeholder}}" };
> const afterReplace = placeHolderReplacer.replace(beforeReplace);
> // beforeReplace === afterReplace
> ```
### You can replace the default placeholders with some as cool as you want
```typescript
const placeHolderReplacer = new JsonPlaceholderReplacer({
delimiterTags: [{ begin: "@{{-", end: "-}}@" }],
});
placeHolderReplacer.addVariableMap({
key: "nice",
});
const afterReplace = placeHolderReplacer.replace({
replaceable: "@{{-key-}}@",
});
// afterReplace = {
// replaceable: "nice",
// }
```
### It's also possible to add more than one variables map
```typescript
placeHolderReplacer.addVariableMap({
firstMapKey: "1",
});
placeHolderReplacer.addVariableMap({
secondMapKey: 2,
});
const afterReplace = placeHolderReplacer.replace({
replaceable: "{{firstMapKey}}",
otherReplaceable: "<>",
});
// afterReplace = {
// replaceable: "1",
// otherReplaceable: 2
// }
```
### And the last added maps have higher priority (but non-nullish values will be preserved from previous map)
```typescript
placeHolderReplacer.addVariableMap({
id: "lowerPriority",
name: "Name",
});
placeHolderReplacer.addVariableMap({
id: "higherPriority",
name: undefined,
});
const afterReplace = placeHolderReplacer.replace({
id: "{{id}}",
name: "{{name}}",
});
// afterReplace = {
// id: "higherPriority"
// name: "Name"
// }
```
### It's possible to override global values map with `.setVariableMap()`
```typescript
placeHolderReplacer.addVariableMap({
id: "Id",
name: "Name",
});
placeHolderReplacer.setVariableMap({
// <- note setVariableMap() here
id: "New Id",
name: undefined,
});
const afterReplace = placeHolderReplacer.replace({
id: "{{id}}",
name: "{{name}}",
});
// afterReplace = {
// id: "New Id"
// name: "{{name}}"
// }
```
### It's possible to override global maps with local by `.replaceWith()`
```typescript
placeHolderReplacer.addVariableMap({
id: "Id",
name: "Name",
});
const afterReplace = placeHolderReplacer.replaceWith(
{
id: "{{id}}",
name: "{{name}}",
},
{ name: "New Name" },
);
// afterReplace = {
// id: "{{id}}"
// name: "New Name"
// }
```
### It keeps original variable types
If a variable in the map is boolean/string/number/object, it remains as boolean/string/number/object when it's replaced
```typescript
placeHolderReplacer.addVariableMap({
booleanKey: true,
stringKey: "string",
numberKey: 10,
objectKey: {
inner: "inner",
},
});
const afterReplace = placeHolderReplacer.replace({
booleanReplaceable: "{{booleanKey}}",
stringReplaceable: "{{stringKey}}",
numberReplaceable: "{{numberKey}}",
objectReplaceable: "{{objectKey}}",
});
// afterReplace = {
// booleanReplaceable: true,
// stringReplaceable: "string",
// numberReplaceable: 10,
// objectReplaceable: {
// inner: "inner"
// }
// }
```
### Just to make it clearer, it does not replace the placeholder Key
```typescript
placeHolderReplacer.addVariableMap({
key: "someValue",
});
const afterReplace = placeHolderReplacer.replace({
"{{key}}": "value",
});
// afterReplace = {
// "{{key}}": "value"
// }
```
### And, of course, it handles array substitution as well
```typescript
placeHolderReplacer.addVariableMap({
key: 987,
objectReplaceable: {
inner: "inner",
},
});
const afterReplace = placeHolderReplacer.replace({
array: ["string", "{{objectReplaceable}}", "{{key}}"],
});
// afterReplace = {
// array: ["string", { inner: "inner" }, 987]
// }
```
### Want to get nested elements? Go for it
```typescript
placeHolderReplacer.addVariableMap({
key: {
nested: "value",
},
});
const afterReplace: any = placeHolderReplacer.replace({
replaceable: "<>",
});
// afterReplace = {
// replaceable: "value"
// }
```
### This feature allows you to have default values in case you don't have them mapped
```typescript
placeHolderReplacer.addVariableMap({
key: "value",
});
const afterReplace: any = placeHolderReplacer.replace({
replaceable: "<>",
});
// afterReplace = {
// replaceable: "default-value"
// }
```
### Of course, you can also change what is the default value separator (defaults to ':')
```typescript
const placeHolderReplacer = new JsonPlaceholderReplacer({
defaultValueSeparator: ":=:",
});
placeHolderReplacer.addVariableMap({
key: "value",
});
const afterReplace: any = placeHolderReplacer.replace({
replaceable: "<>", // Note the ':=:'
});
// afterReplace = {
// replaceable: "default-value"
// }
```