nixpkgs/lib/generators.nix at 3ec636362e1816bc2f0888fa0fa2c69f1bc9e504 · NixOS/nixpkgs

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

/**

Functions that generate widespread file

formats from nix data structures.

They all follow a similar interface:

```nix

generator { config-attrs } data

```

`config-attrs` are “holes” in the generators

with sensible default implementations that

can be overwritten. The default implementations

are mostly generators themselves, called with

their respective default values; they can be reused.

Tests can be found in ./tests/misc.nix

Further Documentation can be found [here](#sec-generators).

{ lib }:

let

inherit (lib)

addErrorContext

any

attrNames

attrValues

concatLists

concatMap

concatMapStringsSep

concatStrings

concatStringsSep

const

elem

escape

filter

flatten

foldl

functionArgs # Note: not the builtin; considers `__functor` in attrsets.

gvariant

hasInfix

head

init

isAttrs

isBool

isDerivation

isFloat

isFunction # Note: not the builtin; considers `__functor` in attrsets.

isInt

isList

isPath

isString

last

length

genAttrs

mapAttrs

mapAttrsToList

optionals

recursiveUpdate

replaceStrings

reverseList

splitString

tail

;

inherit (lib.strings)

escapeNixIdentifier

floatToString

match

split

toJSON

typeOf

escapeXML

;

## -- HELPER FUNCTIONS & DEFAULTS --

rec {

/**

Convert a value to a sensible default string representation.

The builtin `toString` function has some strange defaults,

suitable for bash scripts but not much else.

# Inputs

Options

: Empty set, there may be configuration options in the future

`v`

: 2\. Function argument

mkValueStringDefault =

let

err = t: v: abort ("generators.mkValueStringDefault: " + "${t} not supported: ${toPretty { } v}");

{ }:

if isInt v then

toString v

# convert derivations to store paths

else if isDerivation v then

toString v

# we default to not quoting strings

else if isString v then

# isString returns "1", which is not a good default

else if true == v then

"true"

# here it returns to "", which is even less of a good default

else if false == v then

"false"

else if null == v then

"null"

# if you have lists you probably want to replace this

else if isList v then

err "lists" v

# same as for lists, might want to replace

else if isAttrs v then

err "attrsets" v

# functions can’t be printed of course

else if isFunction v then

err "functions" v

# Floats currently can't be converted to precise strings,

# condition warning on nix version once this isn't a problem anymore

# See https://github.com/NixOS/nix/pull/3480

else if isFloat v then

floatToString v

else

err "this value is" (toString v);

/**

Generate a line of key `k` and value `v`, separated by

character `sep`. If `sep` appears in `k`, it is escaped.

Helper for syntaxes with different separators.

`mkValueString` specifies how values should be formatted.

```nix

mkKeyValueDefault {} ":" "f:oo" "bar"

> "f\:oo:bar"

```

# Inputs

Structured function argument

: mkValueString (optional, default: `mkValueStringDefault {}`)

: Function to convert values to strings

`sep`

: 2\. Function argument

`k`

: 3\. Function argument

`v`

: 4\. Function argument

mkKeyValueDefault =

{

mkValueString ? mkValueStringDefault { },

sep:

let

escapeSeparator = escape [ sep ];

k: v: "${escapeSeparator k}${sep}${mkValueString v}";

## -- FILE FORMAT GENERATORS --

/**

Generate a key-value-style config file from an attrset.

# Inputs

Structured function argument

: mkKeyValue (optional, default: `mkKeyValueDefault {} "="`)

: format a setting line from key and value

: listsAsDuplicateKeys (optional, default: `false`)

: allow lists as values for duplicate keys

: indent (optional, default: `""`)

: Initial indentation level

toKeyValue =

{

mkKeyValue ? mkKeyValueDefault { } "=",

listsAsDuplicateKeys ? false,

indent ? "",

let

mkLine = k: v: indent + mkKeyValue k v + "\n";

mkLines =

if listsAsDuplicateKeys then

k: v: map (mkLine k) (if isList v then v else [ v ])

else

k: v: [ (mkLine k v) ];

attrs: concatStrings (concatLists (mapAttrsToList mkLines attrs));

/**

Generate an INI-style config file from an

attrset of sections to an attrset of key-value pairs.

# Inputs

Structured function argument

: mkSectionName (optional, default: `(name: escape [ "[" "]" ] name)`)

: apply transformations (e.g. escapes) to section names

: mkKeyValue (optional, default: `{} "="`)

: format a setting line from key and value

: listsAsDuplicateKeys (optional, default: `false`)

: allow lists as values for duplicate keys

# Examples

:::{.example}

## `lib.generators.toINI` usage example

```nix

generators.toINI {} {

foo = { hi = "${pkgs.hello}"; ciao = "bar"; };

baz = { "also, integers" = 42; };

}

> [baz]

> also, integers=42

> [foo]

> ciao=bar

> hi=/nix/store/y93qql1p5ggfnaqjjqhxcw0vqw95rlz0-hello-2.10

```

The mk* configuration attributes can generically change

the way sections and key-value strings are generated.

For more examples see the test cases in ./tests/misc.nix.

:::

toINI =

let

# map function to string for each key val

mapAttrsToStringsSep =

sep: mapFn: attrs:

concatStringsSep sep (mapAttrsToList mapFn attrs);

{

mkSectionName ? escape [

"["

"]"

mkKeyValue ? mkKeyValueDefault { } "=",

listsAsDuplicateKeys ? false,

let

toKeyValue' = toKeyValue { inherit mkKeyValue listsAsDuplicateKeys; };

mkSection =

sectName: sectValues:

[${mkSectionName sectName}]

+ toKeyValue' sectValues;

# map input to ini sections

mapAttrsToStringsSep "\n" mkSection;

/**

Generate an INI-style config file from an attrset

specifying the global section (no header), and an

attrset of sections to an attrset of key-value pairs.

# Inputs

1\. Structured function argument

: mkSectionName (optional, default: `(name: escape [ "[" "]" ] name)`)

: apply transformations (e.g. escapes) to section names

: mkKeyValue (optional, default: `{} "="`)

: format a setting line from key and value

: listsAsDuplicateKeys (optional, default: `false`)

: allow lists as values for duplicate keys

2\. Structured function argument

: globalSection (required)

: global section key-value pairs

: sections (optional, default: `{}`)

: attrset of sections to key-value pairs

# Examples

:::{.example}

## `lib.generators.toINIWithGlobalSection` usage example

```nix

generators.toINIWithGlobalSection {} {

globalSection = {

someGlobalKey = "hi";

};

sections = {

foo = { hi = "${pkgs.hello}"; ciao = "bar"; };

baz = { "also, integers" = 42; };

}

> someGlobalKey=hi

> [baz]

> also, integers=42

> [foo]

> ciao=bar

> hi=/nix/store/y93qql1p5ggfnaqjjqhxcw0vqw95rlz0-hello-2.10

```

The mk* configuration attributes can generically change

the way sections and key-value strings are generated.

For more examples see the test cases in ./tests/misc.nix.

:::

If you don’t need a global section, you can also use

`generators.toINI` directly, which only takes

the part in `sections`.

toINIWithGlobalSection =

{

mkSectionName ? escape [

"["

"]"

mkKeyValue ? mkKeyValueDefault { } "=",

listsAsDuplicateKeys ? false,

let

toKeyValue' = toKeyValue { inherit mkKeyValue listsAsDuplicateKeys; };

toINI' = toINI { inherit mkSectionName mkKeyValue listsAsDuplicateKeys; };

{

globalSection,

sections ? { },

(if globalSection == { } then "" else (toKeyValue' globalSection) + "\n") + (toINI' sections);

/**

Generate a git-config file from an attrset.

It has two major differences from the regular INI format:

1. values are indented with tabs

2. sections can have sub-sections

Further: [git-config examples](https://git-scm.com/docs/git-config#EXAMPLES)

# Examples

:::{.example}

## `lib.generators.toGitINI` usage example

```nix

generators.toGitINI {

url."ssh://git@github.com/".insteadOf = "https://github.com";

user.name = "edolstra";

}

> [url "ssh://git@github.com/"]

> insteadOf = "https://github.com"

> [user]

> name = "edolstra"

```

:::

# Inputs

`attrs`

: Key-value pairs to be converted to a git-config file.

See the [git-config documentation](https://git-scm.com/docs/git-config#_variables) for possible values.

toGitINI =

let

mkSectionName =

let

containsQuote = hasInfix ''"'';

name:

let

sections = splitString "." name;

if containsQuote name || length sections == 1 then

name

else

''${head sections} "${concatStringsSep "." (tail sections)}"'';

mkValueString =

let

escape = replaceStrings [ "\n" " " ''"'' "\\" ] [ "\\n" "\\t" ''\"'' "\\\\" ];

v: mkValueStringDefault { } (if isString v then ''"${escape v}"'' else v);

# generation for multiple ini values

mkKeyValue =

let

mkKeyValue = mkKeyValueDefault { inherit mkValueString; } " = ";

attrToString = k: v: "\t" + mkKeyValue k v;

k: v: if isList v then concatStringsSep "\n" (map (attrToString k) v) else attrToString k v;

# converts { a.b.c = 5; } to { "a.b".c = 5; } for toINI

gitFlattenAttrs =

let

isNonDrvAttrs = value: isAttrs value && !isDerivation value;

recurse =

path: value:

if isNonDrvAttrs value then

concatMap (name: recurse ([ name ] ++ path) value.${name}) (attrNames value)

else if length path > 1 then

[

{

${concatStringsSep "." (reverseList (tail path))}.${head path} = value;

}

]

else

[

{

${head path} = value;

}

];

attrs:

let

# Filter the names for any that contain nested attrsets. attrs that

# don't contain nested attrsets can stay the same =

namesToRewrite = filter (

) (attrNames attrs);

attrsToRewrite = genAttrs namesToRewrite (name: attrs.${name});

removeAttrs attrs namesToRewrite // foldl recursiveUpdate { } (recurse [ ] attrsToRewrite);

toINI_ = toINI { inherit mkKeyValue mkSectionName; };

attrs: toINI_ (gitFlattenAttrs attrs);

/**

`mkKeyValueDefault` wrapper that handles dconf INI quirks.

The main differences of the format is that it requires strings to be quoted.

mkDconfKeyValue = mkKeyValueDefault { mkValueString = v: toString (gvariant.mkValue v); } "=";

/**

Generates INI in dconf keyfile style. See the [GNOME documentation](https://help.gnome.org/system-admin-guide/dconf-keyfiles.html)

for details.

toDconfINI = toINI { mkKeyValue = mkDconfKeyValue; };

/**

Recurses through a `Value` limited to a certain depth. (`depthLimit`)

If the depth is exceeded, an error is thrown, unless `throwOnDepthLimit` is set to `false`.

# Inputs

Structured function argument

: depthLimit (required)

: If this option is not null, the given value will stop evaluating at a certain depth

: throwOnDepthLimit (optional, default: `true`)

: If this option is true, an error will be thrown, if a certain given depth is exceeded

Value

: The value to be evaluated recursively

withRecursion =

let

specialAttrs = [

"__functor"

"__functionArgs"

"__toString"

"__pretty"

];

stepIntoAttr = evalNext: name: if elem name specialAttrs then id else evalNext;

{

depthLimit,

throwOnDepthLimit ? true,

assert isInt depthLimit;

let

transform =

depth:

if depthLimit != null && depth > depthLimit then

if throwOnDepthLimit then

throw "Exceeded maximum eval-depth limit of ${toString depthLimit} while trying to evaluate with `generators.withRecursion'!"

else

const "<unevaluated>"

else

id;

mapAny =

depth: v:

let

evalNext = x: mapAny (depth + 1) (transform (depth + 1) x);

if isAttrs v then

mapAttrs (stepIntoAttr evalNext) v

else if isList v then

map evalNext v

else

transform (depth + 1) v;

mapAny 0;

/**

Pretty print a value, akin to `builtins.trace`.

Should probably be a builtin as well.

The pretty-printed string should be suitable for rendering default values

in the NixOS manual. In particular, it should be as close to a valid Nix expression

as possible.

# Inputs

Structured function argument

: allowPrettyValues

: If this option is true, attrsets like `{ __pretty = fn; val = …; }`

will use `fn` to convert `val` to a pretty printed representation.

(This means `fn` is type `Val -> String`.)

: multiline

: If this option is true, the output is indented with newlines for attribute sets and lists

: indent

: Initial indentation level

Value

: The value to be pretty printed

toPretty =

let

escapeSingleline = escape [

"\\"

"\""

"\${"

];

escapeMultiline = replaceStrings [ "\${" "''" ] [ "''\${" "'''" ];

{

allowPrettyValues ? false,

multiline ? true,

indent ? "",

let

go =

indent: v:

let

introSpace = if multiline then "\n${indent} " else " ";

outroSpace = if multiline then "\n${indent}" else " ";

if isInt v then

toString v

# toString loses precision on floats, so we use toJSON instead. This isn't perfect

# as the resulting string may not parse back as a float (e.g. 42, 1e-06), but for

# pretty-printing purposes this is acceptable.

else if isFloat v then

builtins.toJSON v

else if isString v then

let

lines = filter (v: !isList v) (split "\n" v);

singlelineResult = "\"" + concatStringsSep "\\n" (map escapeSingleline lines) + "\"";

multilineResult =

let

escapedLines = map escapeMultiline lines;

# The last line gets a special treatment: if it's empty, '' is on its own line at the "outer"

# indentation level. Otherwise, '' is appended to the last line.

lastLine = last escapedLines;

"''"

+ introSpace

+ concatStringsSep introSpace (init escapedLines)

+ (if lastLine == "" then outroSpace else introSpace + lastLine)

+ "''";

if multiline && length lines > 1 then multilineResult else singlelineResult

else if true == v then

"true"

else if false == v then

"false"

else if null == v then

"null"

else if isPath v then

toString v

else if isList v then

if v == [ ] then

"[ ]"

else

"[" + introSpace + concatMapStringsSep introSpace (go (indent + " ")) v + outroSpace + "]"

else if isFunction v then

let

fna = functionArgs v;

showFnas = concatStringsSep ", " (

mapAttrsToList (name: hasDefVal: if hasDefVal then name + "?" else name) fna

);

if fna == { } then "<function>" else "<function, args: {${showFnas}}>"

else if isAttrs v then

# apply pretty values if allowed

if allowPrettyValues && v ? __pretty && v ? val then

v.__pretty v.val

else if v == { } then

"{ }"

else if v ? type && v.type == "derivation" then

"<derivation ${v.name or "???"}>"

else

"{"

+ introSpace

+ concatStringsSep introSpace (

mapAttrsToList (

"${escapeNixIdentifier name} = ${

addErrorContext "while evaluating an attribute `${name}`" (go (indent + " ") value)

};"

) v

)

+ outroSpace

+ "}"

else

abort "generators.toPretty: should never happen (v = ${v})";

go indent;

/**

Translate a simple Nix expression to [Plist notation](https://en.wikipedia.org/wiki/Property_list).

# Inputs

Structured function argument

: escape (optional, default: `false`)

: If this option is true, XML special characters are escaped in string values and keys

Value

: The value to be converted to Plist

toPlist =

{

escape ? false,

let

expr =

ind: x:

if x == null then

else if isBool x then

bool ind x

else if isInt x then

int ind x

else if isString x then

str ind x

else if isList x then

list ind x

else if isAttrs x then

attrs ind x

else if isPath x then

str ind (toString x)

else if isFloat x then

float ind x

else

abort "generators.toPlist: should never happen (v = ${v})";

literal = ind: x: ind + x;

maybeEscapeXML = if escape then escapeXML else x: x;

bool = ind: x: literal ind (if x then "<true/>" else "<false/>");

int = ind: x: literal ind "<integer>${toString x}</integer>";

str = ind: x: literal ind "<string>${maybeEscapeXML x}</string>";

key = ind: x: literal ind "<key>${maybeEscapeXML x}</key>";

float = ind: x: literal ind "<real>${toString x}</real>";

indent = ind: expr "\t${ind}";

item = ind: concatMapStringsSep "\n" (indent ind);

list =

ind: x:

concatStringsSep "\n" [

(literal ind "<array>")

(item ind x)

(literal ind "</array>")

];

attrs =

ind: x:

concatStringsSep "\n" [

(literal ind "<dict>")

(attr ind x)

(literal ind "</dict>")

];

attr =

let

attrFilter = name: value: name != "_module" && value != null;

ind: x:

concatStringsSep "\n" (

flatten (

mapAttrsToList (

optionals (attrFilter name value) [

(key "\t${ind}" name)

(expr "\t${ind}" value)

]

) x

)

);

# TODO: As discussed in #356502, deprecated functionality should be removed sometime after 25.11.

lib.warnIf (!escape && lib.oldestSupportedReleaseIsAtLeast 2505)

"Using `lib.generators.toPlist` without `escape = true` is deprecated"

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">

${expr "" v}

</plist>'';

/**

Translate a simple Nix expression to Dhall notation.

Note that integers are translated to Integer and never

the Natural type.

# Inputs

Options

: Empty set, there may be configuration options in the future

Value

: The value to be converted to Dhall

toDhall =

let

concatItems = concatStringsSep ", ";

{ }@args:

if isAttrs v then

"{ ${concatItems (mapAttrsToList (key: value: "${key} = ${toDhall args value}") v)} }"

else if isList v then

"[ ${concatItems (map (toDhall args) v)} ]"

else if isInt v then

"${if v < 0 then "" else "+"}${toString v}"

else if isBool v then

(if v then "True" else "False")

else if isFunction v then

abort "generators.toDhall: cannot convert a function to Dhall"

else if v == null then

abort "generators.toDhall: cannot convert a null to Dhall"

else

toJSON v;

/**

Translate a simple Nix expression to Lua representation with occasional

Lua-inlines that can be constructed by `mkLuaInline` function.

Configuration:

* `multiline` - by default is true which results in indented block-like view.

* `indent` - initial indent.

* `asBindings` - by default generate single value, but with this use attrset to set global vars.

::: {.note}

Regardless of multiline parameter there is no trailing newline.

:::

# Inputs

Structured function argument

: multiline (optional, default: `true`)

: If this option is true, the output is indented with newlines for attribute sets and lists

: indent (optional, default: `""`)

: Initial indentation level

: asBindings (optional, default: `false`)

: Interpret as variable bindings

Value

: The value to be converted to Lua

# Type

```

toLua :: { multiline :: Bool; indent :: String; asBindings :: Bool; } -> Any -> String

```

# Examples

:::{.example}

## `lib.generators.toLua` usage example

```nix

generators.toLua {}

{

cmd = [ "typescript-language-server" "--stdio" ];

settings.workspace.library = mkLuaInline ''vim.api.nvim_get_runtime_file("", true)'';

}

{

["cmd"] = {

"typescript-language-server",

"--stdio"

["settings"] = {

["workspace"] = {

["library"] = (vim.api.nvim_get_runtime_file("", true))

}

```

:::

toLua =

{

multiline ? true,

indent ? "",

asBindings ? false,

}@args:

let

recurse = toLua innerArgs;

innerIndent = "${indent} ";

introSpace = if multiline then "\n${innerIndent}" else " ";

outroSpace = if multiline then "\n${indent}" else " ";

innerArgs = args // {

indent = if asBindings then indent else innerIndent;

asBindings = false;

};

concatItems = concatStringsSep ",${introSpace}";

isLuaInline =

{

_type ? null,

...

_type == "lua-inline";

generatedBindings =

assert badVarNames == [ ] || throw "Bad Lua var names: ${toPretty { } badVarNames}";

concatStrings (mapAttrsToList (key: value: "${indent}${key} = ${recurse value}\n") v);

# https://en.wikibooks.org/wiki/Lua_Programming/variable#Variable_names

matchVarName = match "[[:alpha:]_][[:alnum:]_]*(\\.[[:alpha:]_][[:alnum:]_]*)*";

badVarNames = filter (name: matchVarName name == null) (attrNames v);

if asBindings then

generatedBindings

else if v == null then

"nil"

else if isInt v || isFloat v || isString v || isBool v then

toJSON v

else if isPath v || isDerivation v then

toJSON "${v}"

else if isList v then

(if v == [ ] then "{}" else "{${introSpace}${concatItems (map recurse v)}${outroSpace}}")

else if isAttrs v then

(

if isLuaInline v then

"(${v.expr})"

else if v == { } then

"{}"

else

"{${introSpace}${

concatItems (mapAttrsToList (key: value: "[${toJSON key}] = ${recurse value}") v)

}${outroSpace}}"

)

else

abort "generators.toLua: type ${typeOf v} is unsupported";

/**

Mark string as Lua expression to be inlined when processed by `toLua`.

# Inputs

`expr`

: 1\. Function argument

# Type

```

mkLuaInline :: String -> { _type = "lua-inline"; expr :: String; }

```

mkLuaInline = expr: {

_type = "lua-inline";

inherit expr;

};

}

// {

/**

Generates JSON from an arbitrary (non-function) value.

For more information see the documentation of the builtin.

# Inputs

Options

: Empty set, there may be configuration options in the future

Value

: The value to be converted to JSON

toJSON = { }: lib.strings.toJSON;

/**

YAML has been a strict superset of JSON since 1.2, so we

use toJSON. Before it only had a few differences referring

to implicit typing rules, so it should work with older

parsers as well.

# Inputs

Options

: Empty set, there may be configuration options in the future

Value

: The value to be converted to YAML

toYAML = { }: lib.strings.toJSON;

}

FilesExpand file tree

generators.nix

Latest commit

History

generators.nix

File metadata and controls