Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,23 @@ local inspect = import "github.com/jsonnet-libs/xtd/inspect.libsonnet"

## Index

* [`fn deepMap(func, x)`](#fn-deepmap)
* [`fn diff(input1, input2)`](#fn-diff)
* [`fn filterKubernetesObjects(object, kind='')`](#fn-filterkubernetesobjects)
* [`fn filterObjects(filter_func, x)`](#fn-filterobjects)
* [`fn inspect(object, maxDepth)`](#fn-inspect)

## Fields

### fn deepMap

```ts
deepMap(func, x)
```

`deepMap` traverses the whole tree of `x` and applies `func(item)` indiscriminately.


### fn diff

```ts
Expand Down
18 changes: 18 additions & 0 deletions inspect.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -206,4 +206,22 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet';
function(o) o.kind == kind,
objects
),

'#deepMap':: d.fn(
|||
`deepMap` traverses the whole tree of `x` and applies `func(item)` indiscriminately.
|||,
args=[
d.arg('func', d.T.func),
d.arg('x', d.T.any),
]
),
deepMap(func, x):
func(
if std.isObject(x)
then std.mapWithKey(function(_, y) self.deepMap(func, y), x)
else if std.isArray(x)
then std.map(function(y) self.deepMap(func, y), x)
else x
),
}
39 changes: 39 additions & 0 deletions test/inspect_test.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,42 @@ test.new(std.thisFile)
)
)
)
+ (
local originalObj = {
key1: {
key1a: 'replace me',
key1b: [
{ key1bNested: 'replace me' },
],
},
key2: [
{ key2a: 'replace me' },
],
};

test.case.new(
name='deepmap',
test=
test.expect.eq(
actual=xtd.inspect.deepMap(
function(item)
if std.isString(item)
&& item == 'replace me'
then 'REPLACED'
else item,
originalObj,
),
expected={
key1: {
key1a: 'REPLACED',
key1b: [
{ key1bNested: 'REPLACED' },
],
},
key2: [
{ key2a: 'REPLACED' },
],
}
)
)
)
Loading